class AttributeImpl: (source)
Known subclasses: sqlalchemy.orm.attributes.CollectionAttributeImpl
, sqlalchemy.orm.attributes.ScalarAttributeImpl
, sqlalchemy.orm.writeonly.WriteOnlyAttributeImpl
internal implementation for instrumented attributes.
Method | __init__ |
Construct an AttributeImpl. |
Method | __str__ |
Undocumented |
Method | append |
Undocumented |
Method | delete |
Undocumented |
Method | get |
Retrieve a value from the given object. If a callable is assembled on this object's attribute, and passive is False, the callable will be executed and the resulting value will be set as the new value for this attribute. |
Method | get |
Return a list of tuples of (state, obj) for all objects in this attribute's current state + history. |
Method | get |
return the unchanged value of this attribute |
Method | get |
Undocumented |
Method | hasparent |
Return the boolean value of a `hasparent` flag attached to the given state. |
Method | pop |
Undocumented |
Method | remove |
Undocumented |
Method | set |
Undocumented |
Method | set |
set an attribute value on the given instance and 'commit' it. |
Method | sethasparent |
Set a boolean flag on the given item corresponding to whether or not it is attached to a parent object via the attribute represented by this ``InstrumentedAttribute``. |
Class Variable | __slots__ |
Undocumented |
Class Variable | active |
Undocumented |
Class Variable | collection |
Undocumented |
Class Variable | default |
Undocumented |
Class Variable | dynamic |
Undocumented |
Class Variable | supports |
Undocumented |
Class Variable | uses |
Undocumented |
Instance Variable | accepts |
Undocumented |
Instance Variable | callable_ |
Undocumented |
Instance Variable | class_ |
Undocumented |
Instance Variable | dispatch |
Undocumented |
Instance Variable | is |
Undocumented |
Instance Variable | key |
Undocumented |
Instance Variable | load |
Undocumented |
Instance Variable | parent |
Undocumented |
Instance Variable | send |
Undocumented |
Instance Variable | trackparent |
Undocumented |
Method | _default |
Produce an empty value for an uninitialized scalar attribute. |
Method | _fire |
Undocumented |
Method | _get |
Backwards compat for impl.active_history |
Method | _set |
Undocumented |
Class Variable | _append |
Undocumented |
Class Variable | _is |
Undocumented |
Class Variable | _remove |
Undocumented |
Class Variable | _replace |
Undocumented |
Instance Variable | _deferred |
Undocumented |
Instance Variable | _modified |
Undocumented |
_ExternalEntityType[ _O]
, key: str
, callable_: _LoaderCallable
, dispatch: _Dispatch[ QueryableAttribute[ Any]]
, trackparent: bool
= False, compare_function: Optional[ Callable[ ..., bool]]
= None, active_history: bool
= False, parent_token: Optional[ AttributeEventToken]
= None, load_on_unexpire: bool
= True, send_modified_events: bool
= True, accepts_scalar_loader: Optional[ bool]
= None, **kwargs: Any
):
(source)
¶
sqlalchemy.orm.attributes.CollectionAttributeImpl
, sqlalchemy.orm.attributes.ScalarAttributeImpl
, sqlalchemy.orm.writeonly.WriteOnlyAttributeImpl
Construct an AttributeImpl. :param \class_: associated class :param key: string name of the attribute :param \callable_: optional function which generates a callable based on a parent instance, which produces the "default" values for a scalar or collection attribute when it's first accessed, if not present already. :param trackparent: if True, attempt to track if an instance has a parent attached to it via this attribute. :param compare_function: a function that compares two values which are normally assignable to this attribute. :param active_history: indicates that get_history() should always return the "old" value, even if it means executing a lazy callable upon attribute change. :param parent_token: Usually references the MapperProperty, used as a key for the hasparent() function to identify an "owning" attribute. Allows multiple AttributeImpls to all match a single owner attribute. :param load_on_unexpire: if False, don't include this attribute in a load-on-expired operation, i.e. the "expired_attribute_loader" process. The attribute can still be in the "expired" list and be considered to be "expired". Previously, this flag was called "expire_missing" and is only used by a deferred column attribute. :param send_modified_events: if False, the InstanceState._modified_event method will have no effect; this means the attribute will never show up as changed in a history entry.
InstanceState[ Any]
, dict_: _InstanceDict
, value: Any
, initiator: Optional[ AttributeEventToken]
, passive: PassiveFlag
= PASSIVE_OFF):
(source)
¶
sqlalchemy.orm.attributes.CollectionAttributeImpl
, sqlalchemy.orm.writeonly.WriteOnlyAttributeImpl
Undocumented
InstanceState[ Any]
, dict_: _InstanceDict
, passive: PassiveFlag
= PASSIVE_OFF) -> Any
:
(source)
¶
sqlalchemy.orm.writeonly.WriteOnlyAttributeImpl
Retrieve a value from the given object. If a callable is assembled on this object's attribute, and passive is False, the callable will be executed and the resulting value will be set as the new value for this attribute.
InstanceState[ Any]
, dict_: _InstanceDict
, passive: PassiveFlag
= PASSIVE_NO_INITIALIZE) -> _AllPendingType
:
(source)
¶
sqlalchemy.orm.attributes.CollectionAttributeImpl
, sqlalchemy.orm.attributes.ScalarObjectAttributeImpl
, sqlalchemy.orm.writeonly.WriteOnlyAttributeImpl
Return a list of tuples of (state, obj) for all objects in this attribute's current state + history. Only applies to object-based attributes. This is an inlining of existing functionality which roughly corresponds to: get_state_history( state, key, passive=PASSIVE_NO_INITIALIZE).sum()
InstanceState[ Any]
, dict_: _InstanceDict
, passive: PassiveFlag
= PASSIVE_OFF) -> Any
:
(source)
¶
return the unchanged value of this attribute
InstanceState[ Any]
, dict_: _InstanceDict
, passive: PassiveFlag
= PASSIVE_OFF) -> History
:
(source)
¶
Return the boolean value of a `hasparent` flag attached to the given state. The `optimistic` flag determines what the default return value should be if no `hasparent` flag can be located. As this function is used to determine if an instance is an *orphan*, instances that were loaded from storage should be assumed to not be orphans, until a True/False value for this flag is set. An instance attribute that is loaded by a callable function will also not have a `hasparent` flag.
InstanceState[ Any]
, dict_: _InstanceDict
, value: Any
, initiator: Optional[ AttributeEventToken]
, passive: PassiveFlag
= PASSIVE_OFF):
(source)
¶
sqlalchemy.orm.attributes.CollectionAttributeImpl
, sqlalchemy.orm.writeonly.WriteOnlyAttributeImpl
Undocumented
InstanceState[ Any]
, dict_: _InstanceDict
, value: Any
, initiator: Optional[ AttributeEventToken]
, passive: PassiveFlag
= PASSIVE_OFF):
(source)
¶
sqlalchemy.orm.attributes.CollectionAttributeImpl
, sqlalchemy.orm.writeonly.WriteOnlyAttributeImpl
Undocumented
InstanceState[ Any]
, dict_: _InstanceDict
, value: Any
, initiator: Optional[ AttributeEventToken]
= None, passive: PassiveFlag
= PASSIVE_OFF, check_old: Any
= None, pop: bool
= False):
(source)
¶
sqlalchemy.orm.attributes.CollectionAttributeImpl
, sqlalchemy.orm.writeonly.WriteOnlyAttributeImpl
set an attribute value on the given instance and 'commit' it.
InstanceState[ Any]
, parent_state: InstanceState[ Any]
, value: bool
):
(source)
¶
Set a boolean flag on the given item corresponding to whether or not it is attached to a parent object via the attribute represented by this ``InstrumentedAttribute``.
sqlalchemy.orm.attributes.CollectionAttributeImpl
, sqlalchemy.orm.attributes.ScalarAttributeImpl
Undocumented
sqlalchemy.orm.attributes.CollectionAttributeImpl
Produce an empty value for an uninitialized scalar attribute.
InstanceState[ Any]
, key: str
, passive: PassiveFlag
) -> Any
:
(source)
¶
Undocumented