`magpie.datamodel_patch`¶

Module Contents¶

`patch_all`
`patch_iter_methods`
`patch_display_methods`
`patch_other`
`base__format`
`twig__str__`
`folder__str__`
`folder_iter_twigs`	Return a generator that iterates over all `Twig` instances contained in this folder and its sub-folders, recursively.
`folder_iter_urls`	Return a generator that iterates over all `Url` instances contained in the Twigs and related URLs, in this folder and its sub-folders, recursively.
`folder_iter_tree`	Return a generator that iterates over all `Twig` or `Folder` instances contained in this folder and its sub-folders, recursively.
`folder_iter_with_id`
`folder_find`
`folder_find_path`
`base_follow`
`patch_content_serialization_methods`	Content serialization methods that will be used to provide comparable snapshot to embedding model TODO: allow different levels of abstraction e.g. title/abstract/full
`contentinformationbase_snapshot`

magpie.datamodel_patch.base__format(self: magpie.datamodel.Base, fmt: magpie.datamodel.FormatSpec, level: int = 0) → str[source]¶

magpie.datamodel_patch.folder__str__(self: magpie.datamodel.Folder) → str[source]¶

magpie.datamodel_patch.folder_iter_twigs(self: magpie.datamodel.Folder, *, depth_first=True)[source]¶

Return a generator that iterates over all Twig instances contained in this folder and its sub-folders, recursively.

You can choose to iterate either depth-first or breadth-first.

magpie.datamodel_patch.folder_iter_urls(self: magpie.datamodel.Folder, *, depth_first=True)[source]¶

Return a generator that iterates over all Url instances contained in the Twigs and related URLs, in this folder and its sub-folders, recursively.

You can choose to iterate either depth-first or breadth-first.

magpie.datamodel_patch.folder_iter_tree(self: magpie.datamodel.Folder, *, depth_first=True, depth=0)[source]¶

Return a generator that iterates over all Twig or Folder instances contained in this folder and its sub-folders, recursively.

You can choose to iterate either depth-first or breadth-first.

Useful for printing a Tree

magpie.datamodel_patch.folder_iter_with_id(self: magpie.datamodel.Folder, path=None, path_as_str: bool = False)[source]¶

magpie.datamodel_patch.folder_find(self: magpie.datamodel.Folder, uuid: magpie.datamodel_patch.folder_find.uuid) → magpie.datamodel.WithID[source]¶

magpie.datamodel_patch.folder_find_path(self: magpie.datamodel.Folder, obj: magpie.datamodel.WithID | None = None, uuid: magpie.datamodel_patch.folder_find_path.uuid | None = None, as_str: bool = False) → magpie.datamodel.Path[source]¶

magpie.datamodel_patch.base_follow(self: magpie.datamodel.Base, path: magpie.datamodel.Path | magpie.datamodel.PathSegment) → magpie.datamodel.Base[source]¶

magpie.datamodel_patch.patch_content_serialization_methods()[source]¶: Content serialization methods that will be used to provide comparable snapshot to embedding model TODO: allow different levels of abstraction e.g. title/abstract/full