sqlalchemy.orm.path_registry.PathToken

class documentation

class PathToken(orm_base.InspectionAttr, HasCacheKey, str): (source)

cacheable string token

Class Method	`intern`	Undocumented
Method	`_gen_cache_key`	return an optional cache key.
Class Variable	`_intern`	Undocumented
Property	`_path_for_compare`	Undocumented

Inherited from InspectionAttr:

Class Variable	`__slots__`	Undocumented
Class Variable	`is_aliased_class`	True if this object is an instance of :class:`.AliasedClass`.
Class Variable	`is_attribute`	True if this object is a Python :term:`descriptor`.
Class Variable	`is_bundle`	True if this object is an instance of :class:`.Bundle`.
Class Variable	`is_clause_element`	True if this object is an instance of :class:`_expression.ClauseElement`.
Class Variable	`is_instance`	True if this object is an instance of :class:`.InstanceState`.
Class Variable	`is_mapper`	True if this object is an instance of :class:`_orm.Mapper`.
Class Variable	`is_property`	True if this object is an instance of :class:`.MapperProperty`.
Class Variable	`is_selectable`	Return True if this object is an instance of :class:`_expression.Selectable`.
Class Variable	`_is_internal_proxy`	True if this object is an internal proxy object.

Inherited from HasCacheKey (via InspectionAttr):

Class Variable	`inherit_cache`	Indicate if this :class:`.HasCacheKey` instance should make use of the cache key generation scheme used by its immediate superclass.
Class Method	`_generate_cache_attrs`	generate cache key dispatcher for a new class.
Class Method	`_generate_cache_key_for_object`	Undocumented
Method	`_generate_cache_key`	return a cache key.
Class Variable	`_generated_cache_key_traversal`	Undocumented
Class Variable	`_hierarchy_supports_caching`	private attribute which may be set to False to prevent the inherit_cache warning from being emitted for a hierarchy of subclasses.
Class Variable	`_is_has_cache_key`	Undocumented

@classmethod
def intern(cls, strvalue: str) -> PathToken: (source) ¶

Undocumented

def _gen_cache_key(self, anon_map: anon_map, bindparams: List[BindParameter[Any]]) -> Tuple[Any, ...]: (source) ¶

overrides sqlalchemy.sql.cache_key.HasCacheKey._gen_cache_key

return an optional cache key. The cache key is a tuple which can contain any series of objects that are hashable and also identifies this object uniquely within the presence of a larger SQL expression or statement, for the purposes of caching the resulting query. The cache key should be based on the SQL compiled structure that would ultimately be produced. That is, two structures that are composed in exactly the same way should produce the same cache key; any difference in the structures that would affect the SQL string or the type handlers should result in a different cache key. If a structure cannot produce a useful cache key, the NO_CACHE symbol should be added to the anon_map and the method should return None.

_intern: Dict[str, PathToken] = (source) ¶

Undocumented

@property
_path_for_compare: Optional[_PathRepresentation] = (source) ¶

Undocumented