pyquibbler.iquib

pyquibbler.iquib(value: Any, allow_overriding: bool = True, save_format: None | str | SaveFormat = None, save_directory: None | str | Path = None, assigned_name: str | None = missing, assignment_template: None | tuple | AssignmentTemplate = None, quibify_even_if_quibbler_not_initialized: bool = False) → Quib

Returns an input-quib that represents a given object

Parameters:

  • value (Any) – The value returned by the quib.

  • allow_overriding (bool, default True) – Whether to allow overriding assignments to the quib.

  • save_format ({None, 'off', 'txt', 'bin'} or SaveFormat) – The format in which quib assignments are saved to file. default: None

  • save_directory (None, str, pathlib.Path) – The directory in which quib assignments are to be saved. default: None

  • assigned_name (None, str) – A name assigned to the quib. If assigned_name is not specified, the name is assigned based on the name of the variable to which the quib is assigned. default: None

  • assignment_template (None, tuple, AssignmentTemplate) – A template to restrict quib assignments default: None

Return type:

Quib

See also

q, quiby, Quib.get_value, Quib.allow_overriding, Quib.save_format, Quib.save_directory, Quib.assigned_name, Quib.assignment_template, initialize_quibbler

Note

If Quibbler has not been initialized, iquib will simply return the value argument, not as a quib. This allows checking how your code works without quibs.