sqlalchemy.orm.attributes.ScalarAttributeImpl

class documentation

class ScalarAttributeImpl(AttributeImpl):

Known subclasses: sqlalchemy.orm.attributes.ScalarObjectAttributeImpl

View In Hierarchy

represents a scalar value-holding InstrumentedAttribute.
Method __init__ Construct an AttributeImpl.
Method delete Undocumented
Method fire​_remove​_event Undocumented
Method fire​_replace​_event Undocumented
Method get​_history Undocumented
Method set Undocumented
Class Variable __slots__ Undocumented
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 ​_append​_token Undocumented
Instance Variable ​_remove​_token Undocumented
Instance Variable ​_replace​_token Undocumented
Property type 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 append 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​_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 ​_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, *arg, **kw):
overrides sqlalchemy.orm.attributes.AttributeImpl.__init__
Construct an AttributeImpl.
Parameters
*argUndocumented
**kwUndocumented
class​_associated class
keystring name of the attribute
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.
trackparentif True, attempt to track if an instance has a parent attached to it via this attribute.
compare​_functiona function that compares two values which are normally assignable to this attribute.
active​_historyindicates that get_history() should always return the "old" value, even if it means executing a lazy callable upon attribute change.
parent​_tokenUsually 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​_unexpireif 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​_eventsif 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 delete(self, state, dict_):
overridden in sqlalchemy.orm.attributes.ScalarObjectAttributeImpl

Undocumented

def fire_remove_event(self, state, dict_, value, initiator):
overridden in sqlalchemy.orm.attributes.ScalarObjectAttributeImpl

Undocumented

def fire_replace_event(self, state, dict_, value, previous, initiator):
overridden in sqlalchemy.orm.attributes.ScalarObjectAttributeImpl

Undocumented

def get_history(self, state, dict_, passive=PASSIVE_OFF):
overrides sqlalchemy.orm.attributes.AttributeImpl.get_history
overridden in sqlalchemy.orm.attributes.ScalarObjectAttributeImpl

Undocumented

def set(self, state, dict_, value, initiator, passive=PASSIVE_OFF, check_old=None, pop=False):
overrides sqlalchemy.orm.attributes.AttributeImpl.set
overridden in sqlalchemy.orm.attributes.ScalarObjectAttributeImpl

Undocumented

__slots__: tuple[str, ...] =
overrides sqlalchemy.orm.attributes.AttributeImpl.__slots__
overridden in sqlalchemy.orm.attributes.ScalarObjectAttributeImpl

Undocumented

collection: bool =
overridden in sqlalchemy.orm.attributes.ScalarObjectAttributeImpl

Undocumented

default_accepts_scalar_loader: bool =
overridden in sqlalchemy.orm.attributes.ScalarObjectAttributeImpl

Undocumented

dynamic: bool =

Undocumented

supports_population: bool =
overridden in sqlalchemy.orm.attributes.ScalarObjectAttributeImpl

Undocumented

uses_objects: bool =
overridden in sqlalchemy.orm.attributes.ScalarObjectAttributeImpl

Undocumented

_append_token =

Undocumented

_remove_token =

Undocumented

_replace_token =

Undocumented

@property
type =

Undocumented