sqlalchemy.orm.dynamic.DynamicAttributeImpl

class documentation

class DynamicAttributeImpl(attributes.AttributeImpl):

Undocumented

Method	`__init__`	Construct an AttributeImpl.
Method	`_get_collection_history`	Undocumented
Method	`_modified_event`	Undocumented
Method	`append`	Undocumented
Method	`delete`	Undocumented
Method	`fire_append_event`	Undocumented
Method	`fire_remove_event`	Undocumented
Method	`get`	No summary
Method	`get_all_pending`	Return a list of tuples of (state, obj) for all objects in this attribute's current state + history.
Method	`get_collection`	Undocumented
Method	`get_history`	Undocumented
Method	`pop`	Undocumented
Method	`remove`	Undocumented
Method	`set`	Undocumented
Method	`set_committed_value`	set an attribute value on the given instance and 'commit' it.
Class Variable	`collection`	Undocumented
Class Variable	`default_accepts_scalar_loader`	Undocumented
Class Variable	`dynamic`	Undocumented
Class Variable	`supports_population`	Undocumented
Class Variable	`uses_objects`	Undocumented
Instance Variable	`order_by`	Undocumented
Instance Variable	`query_class`	Undocumented
Instance Variable	`target_mapper`	Undocumented
Property	`_append_token`	Undocumented
Property	`_remove_token`	Undocumented

Inherited from AttributeImpl:

Method	`__str__`	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
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	`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_history`	Undocumented
Instance Variable	`_deferred_history`	Undocumented
Instance Variable	`_modified_token`	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

def __init__(self, class_, key, typecallable, dispatch, target_mapper, order_by, query_class=None, **kw):

overrides sqlalchemy.orm.attributes.AttributeImpl.__init__

Construct an AttributeImpl.

Parameters
class_	associated class
key	string name of the attribute
typecallable	Undocumented
dispatch	Undocumented
target_mapper	Undocumented
order_by	Undocumented
query_class	Undocumented
**kw	Undocumented
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.
trackparent	if True, attempt to track if an instance has a parent attached to it via this attribute.
compare_function	a function that compares two values which are normally assignable to this attribute.
active_history	indicates that get_history() should always return the "old" value, even if it means executing a lazy callable upon attribute change.
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.
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.
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.

def _get_collection_history(self, state, passive=attributes.PASSIVE_OFF):

Undocumented

def _modified_event(self, state, dict_):

Undocumented

def append(self, state, dict_, value, initiator, passive=attributes.PASSIVE_OFF):

overrides sqlalchemy.orm.attributes.AttributeImpl.append

Undocumented

def delete(self, *args, **kwargs):

Undocumented

def fire_append_event(self, state, dict_, value, initiator, collection_history=None):

Undocumented

def fire_remove_event(self, state, dict_, value, initiator, collection_history=None):

Undocumented

def get(self, state, dict_, passive=attributes.PASSIVE_OFF):

overrides sqlalchemy.orm.attributes.AttributeImpl.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.

def get_all_pending(self, state, dict_, passive=attributes.PASSIVE_NO_INITIALIZE):

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_collection(self, state, dict_, user_data=None, passive=attributes.PASSIVE_NO_INITIALIZE):

Undocumented

def get_history(self, state, dict_, passive=attributes.PASSIVE_OFF):

overrides sqlalchemy.orm.attributes.AttributeImpl.get_history

Undocumented

def pop(self, state, dict_, value, initiator, passive=attributes.PASSIVE_OFF):

overrides sqlalchemy.orm.attributes.AttributeImpl.pop

Undocumented

def remove(self, state, dict_, value, initiator, passive=attributes.PASSIVE_OFF):

overrides sqlalchemy.orm.attributes.AttributeImpl.remove

Undocumented

def set(self, state, dict_, value, initiator=None, passive=attributes.PASSIVE_OFF, check_old=None, pop=False, _adapt=True):

overrides sqlalchemy.orm.attributes.AttributeImpl.set

Undocumented

def set_committed_value(self, state, dict_, value):

overrides sqlalchemy.orm.attributes.AttributeImpl.set_committed_value

set an attribute value on the given instance and 'commit' it.

collection: bool =

Undocumented

default_accepts_scalar_loader: bool =

Undocumented

dynamic: bool =

Undocumented

supports_population: bool =

Undocumented

uses_objects: bool =

Undocumented

order_by =

Undocumented

query_class =

Undocumented

target_mapper =

Undocumented

@util.memoized_property
_append_token =

Undocumented

@util.memoized_property
_remove_token =

Undocumented