core.skeleton.utils¶

Classes¶

SkelList

This class is used to hold multiple skeletons together with other, commonly used information.

Functions¶

`skeletonByKind`(kindName)	Returns the Skeleton-Class for the given kindName. That skeleton must exist, otherwise an exception is raised.
`listKnownSkeletons`()
`iterAllSkelClasses`()
`remove_render_preparation_deep`(skel)	Remove renderPreparation of nested skeletons

Module Contents¶

core.skeleton.utils.skeletonByKind(kindName)¶

Returns the Skeleton-Class for the given kindName. That skeleton must exist, otherwise an exception is raised. :param kindName: The kindname to retreive the skeleton for :return: The skeleton-class for that kind

Parameters:: kindName (str)
Return type:: Type[Skeleton]

core.skeleton.utils.listKnownSkeletons()¶

Returns:: A list of all known kindnames (all kindnames for which a skeleton is defined)
Return type:: list[str]

core.skeleton.utils.iterAllSkelClasses()¶

Returns:: An iterator that yields each Skeleton-Class once. (Only top-level skeletons are returned, so no RefSkel classes will be included)
Return type:: Iterable[Skeleton]

class core.skeleton.utils.SkelList(skel, *items)¶

Bases: list

This class is used to hold multiple skeletons together with other, commonly used information.

SkelLists are returned by Skel().all()…fetch()-constructs and provide additional information about the data base query, for fetching additional entries.

Variables:: cursor (str) – Holds the cursor within a query.
Parameters:: baseSkel – The baseclass for all entries in this list

__slots__ = ('baseSkel', 'customQueryInfo', 'getCursor', 'get_orders', 'renderPreparation')¶

baseSkel¶

getCursor¶

get_orders¶

renderPreparation = None¶

customQueryInfo¶

core.skeleton.utils.remove_render_preparation_deep(skel)¶

Remove renderPreparation of nested skeletons

_refSkelCache can have renderPreparation too.

Parameters:: skel (Any)
Return type:: Any