module documentation

Path tracking utilities, representing mapper graph traversals.

Class AbstractEntityRegistry Undocumented
Class CachingEntityRegistry Undocumented
Class CreatesToken Undocumented
Class PathRegistry Represent query load paths and registry functions.
Class PathToken cacheable string token
Class PropRegistry Undocumented
Class RootRegistry Root registry, defers to mappers so that paths are maintained per-root-mapper.
Class SlotsEntityRegistry Undocumented
Class TokenRegistry Undocumented
Function is_entity Undocumented
Function is_root Undocumented
Function path_is_entity Undocumented
Function path_is_property Undocumented
Variable log Undocumented
Class _ERDict Undocumented
Function _unreduce_path Undocumented
Constant _DEFAULT_TOKEN Undocumented
Constant _WILDCARD_TOKEN Undocumented
Type Alias _EvenPathRepresentation Undocumented
Type Alias _OddPathRepresentation Undocumented
Type Alias _PathElementType Undocumented
Type Alias _PathRepresentation Undocumented
Type Alias _SerializedPath Undocumented
def is_entity(path: PathRegistry) -> TypeGuard[AbstractEntityRegistry]: (source)

Undocumented

def is_root(path: PathRegistry) -> TypeGuard[RootRegistry]: (source)

Undocumented

def path_is_entity(path: PathRegistry) -> TypeGuard[AbstractEntityRegistry]: (source)

Undocumented

def path_is_property(path: PathRegistry) -> TypeGuard[PropRegistry]: (source)

Undocumented

Undocumented

def _unreduce_path(path: _SerializedPath) -> PathRegistry: (source)

Undocumented

_DEFAULT_TOKEN: str = (source)

Undocumented

Value
'_sa_default'
_WILDCARD_TOKEN: _LiteralStar = (source)

Undocumented

Value
'*'
_EvenPathRepresentation = (source)

Undocumented

Value
Sequence[Union['MapperProperty[Any]', str]]
_OddPathRepresentation = (source)

Undocumented

Value
Sequence['_InternalEntityType[Any]']
_PathElementType = (source)

Undocumented

Value
Union[str, '_InternalEntityType[Any]', 'MapperProperty[Any]']
_PathRepresentation = (source)

Undocumented

Value
Tuple[_PathElementType, ...]
_SerializedPath = (source)

Undocumented

Value
List[Any]