sqlalchemy.orm.path_registry.PropRegistry

class documentation

class PropRegistry(PathRegistry):

Undocumented

Method	`__getitem__`	Undocumented
Method	`__init__`	Undocumented
Method	`__str__`	Undocumented
Class Variable	`inherit_cache`	Indicate if this `.HasCacheKey` instance should make use of the cache key generation scheme used by its immediate superclass.
Class Variable	`is_unnatural`	Undocumented
Instance Variable	`_default_path_loader_key`	Undocumented
Instance Variable	`_loader_key`	Undocumented
Instance Variable	`_wildcard_path_loader_key`	Undocumented
Instance Variable	`natural_path`	Undocumented
Instance Variable	`parent`	Undocumented
Instance Variable	`path`	Undocumented
Instance Variable	`prop`	Undocumented
Property	`entity`	Undocumented
Property	`entity_path`	Undocumented
Property	`has_entity`	Undocumented
Property	`mapper`	Undocumented

Inherited from PathRegistry:

Class Method	`coerce`	Undocumented
Class Method	`deserialize`	Undocumented
Class Method	`deserialize_context_dict`	Undocumented
Class Method	`per_mapper`	Undocumented
Class Method	`serialize_context_dict`	Undocumented
Class Method	`_deserialize_path`	Undocumented
Class Method	`_serialize_path`	Undocumented
Method	`__add__`	Undocumented
Method	`__eq__`	Undocumented
Method	`__hash__`	Undocumented
Method	`__len__`	Undocumented
Method	`__ne__`	Undocumented
Method	`__reduce__`	Undocumented
Method	`__repr__`	Undocumented
Method	`contains`	Undocumented
Method	`contains_mapper`	Undocumented
Method	`get`	Undocumented
Method	`pairs`	Undocumented
Method	`serialize`	Undocumented
Method	`set`	Undocumented
Method	`setdefault`	Undocumented
Method	`token`	Undocumented
Class Variable	`__slots__`	Undocumented
Class Variable	`_cache_key_traversal`	Undocumented
Class Variable	`is_root`	Undocumented
Class Variable	`is_token`	Undocumented
Property	`_path_for_compare`	Undocumented
Property	`length`	Undocumented

Inherited from HasCacheKey (via PathRegistry):

Class Method	`_generate_cache_attrs`	generate cache key dispatcher for a new class.
Class Method	`_generate_cache_key_for_object`	Undocumented
Method	`_gen_cache_key`	return an optional cache key.
Method	`_generate_cache_key`	return a cache key.
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

def __getitem__(self, entity):

Undocumented

def __init__(self, parent, prop):

Undocumented

def __str__(self):

Undocumented

inherit_cache: bool =

overrides sqlalchemy.sql.traversals.HasCacheKey.inherit_cache

Indicate if this .HasCacheKey instance should make use of the cache key generation scheme used by its immediate superclass.

The attribute defaults to None, which indicates that a construct has not yet taken into account whether or not its appropriate for it to participate in caching; this is functionally equivalent to setting the value to False, except that a warning is also emitted.

This flag can be set to True on a particular class, if the SQL that corresponds to the object does not change based on attributes which are local to this class, and not its superclass.