sqlalchemy.orm.attributes.ScalarObjectAttributeImpl

class documentation

class ScalarObjectAttributeImpl(ScalarAttributeImpl): (source)

View In Hierarchy

represents a scalar-holding InstrumentedAttribute, where the target object is also instrumented. Adds events to delete/set operations.

Method delete Undocumented
Method fire_remove_event Undocumented
Method fire_replace_event Undocumented
Method get_all_pending Return a list of tuples of (state, obj) for all objects in this attribute's current state + history.
Method get_history Undocumented
Method set Set a value on the given InstanceState.
Class Variable __slots__ Undocumented
Class Variable collection Undocumented
Class Variable default_accepts_scalar_loader Undocumented
Class Variable supports_population Undocumented
Class Variable uses_objects Undocumented

Inherited from ScalarAttributeImpl:

Method __init__ Construct an AttributeImpl.
Class Variable dynamic Undocumented
Instance Variable _append_token Undocumented
Instance Variable _remove_token Undocumented
Instance Variable _replace_token Undocumented

Inherited from AttributeImpl (via ScalarAttributeImpl):

Method __str__ Undocumented
Method append 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_committed_value return the unchanged value of this attribute
Method hasparent Return the boolean value of a `hasparent` flag attached to the given state.
Method pop Undocumented
Method remove Undocumented
Method set_committed_value 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 active_history Undocumented
Instance Variable accepts_scalar_loader Undocumented
Instance Variable callable_ Undocumented
Instance Variable class_ Undocumented
Instance Variable dispatch Undocumented
Instance Variable is_equal Undocumented
Instance Variable key Undocumented
Instance Variable load_on_unexpire Undocumented
Instance Variable parent_token Undocumented
Instance Variable send_modified_events Undocumented
Instance Variable trackparent Undocumented
Method _default_value Produce an empty value for an uninitialized scalar attribute.
Method _fire_loader_callables Undocumented
Method _get_active_history Backwards compat for impl.active_history
Method _set_active_history Undocumented
Class Variable _is_has_collection_adapter Undocumented
Instance Variable _deferred_history Undocumented
Instance Variable _modified_token Undocumented
def delete(self, state: InstanceState[Any], dict_: _InstanceDict): (source)
overrides sqlalchemy.orm.attributes.ScalarAttributeImpl.delete

Undocumented

def fire_remove_event(self, state: InstanceState[Any], dict_: _InstanceDict, value: Any, initiator: Optional[AttributeEventToken]): (source)
overrides sqlalchemy.orm.attributes.ScalarAttributeImpl.fire_remove_event

Undocumented

def fire_replace_event(self, state: InstanceState[Any], dict_: _InstanceDict, value: _T, previous: Any, initiator: Optional[AttributeEventToken]) -> _T: (source)
overrides sqlalchemy.orm.attributes.ScalarAttributeImpl.fire_replace_event

Undocumented

def get_all_pending(self, state: InstanceState[Any], dict_: _InstanceDict, passive: PassiveFlag = PASSIVE_NO_INITIALIZE) -> _AllPendingType: (source)
overrides sqlalchemy.orm.attributes.AttributeImpl.get_all_pending

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()

def get_history(self, state: InstanceState[Any], dict_: _InstanceDict, passive: PassiveFlag = PASSIVE_OFF) -> History: (source)
overrides sqlalchemy.orm.attributes.ScalarAttributeImpl.get_history

Undocumented

def set(self, state: InstanceState[Any], dict_: _InstanceDict, value: Any, initiator: Optional[AttributeEventToken] = None, passive: PassiveFlag = PASSIVE_OFF, check_old: Any = None, pop: bool = False): (source)
overrides sqlalchemy.orm.attributes.ScalarAttributeImpl.set

Set a value on the given InstanceState.

__slots__: tuple = (source)
overrides sqlalchemy.orm.attributes.ScalarAttributeImpl.__slots__

Undocumented

collection: bool = (source)
overrides sqlalchemy.orm.attributes.ScalarAttributeImpl.collection

Undocumented

default_accepts_scalar_loader: bool = (source)
overrides sqlalchemy.orm.attributes.ScalarAttributeImpl.default_accepts_scalar_loader

Undocumented

supports_population: bool = (source)
overrides sqlalchemy.orm.attributes.ScalarAttributeImpl.supports_population

Undocumented

uses_objects: bool = (source)
overrides sqlalchemy.orm.attributes.ScalarAttributeImpl.uses_objects

Undocumented