Classe « InstanceState »

Informations générales

Héritage

    builtins.object
        Generic
builtins.object
    InspectionAttr
        InspectionAttrInfo
            InstanceState

Définition

class InstanceState(InspectionAttrInfo, Generic):

help(InstanceState)

Tracks state information at the instance level.

The :class:`.InstanceState` is a key object used by the
SQLAlchemy ORM in order to track the state of an object;
it is created the moment an object is instantiated, typically
as a result of :term:`instrumentation` which SQLAlchemy applies
to the ``__init__()`` method of the class.

:class:`.InstanceState` is also a semi-public object,
available for runtime inspection as to the state of a
mapped instance, including information such as its current
status within a particular :class:`.Session` and details
about data on individual attributes.  The public API
in order to acquire a :class:`.InstanceState` object
is to use the :func:`_sa.inspect` system::

    >>> from sqlalchemy import inspect
    >>> insp = inspect(some_mapped_object)
    >>> insp.attrs.nickname.history
    History(added=['new nickname'], unchanged=(), deleted=['nickname'])

.. seealso::

    :ref:`orm_mapper_inspection_instancestate`

Constructeur(s)

Signature du constructeur	Description
__init__(self, obj: '_O', manager: 'ClassManager[_O]')

Liste des attributs statiques

Nom de l'attribut	Valeur
attrs	<sqlalchemy.util.langhelpers._memoized_property object at 0x0000020DA0F6AED0>
callables	immutabledict({})
class_	<member 'class_' of 'InstanceState' objects>
committed_state	<member 'committed_state' of 'InstanceState' objects>
expired	False
expired_attributes	<member 'expired_attributes' of 'InstanceState' objects>
extension_type	NotExtension.NOT_EXTENSION
identity_token	None
info	<sqlalchemy.util.langhelpers._memoized_property object at 0x0000020DA0E1F470>
insert_order	None
is_aliased_class	False
is_attribute	False
is_bundle	False
is_clause_element	False
is_instance	True
is_mapper	False
is_property	False
is_selectable	False
key	None
load_options	()
load_path	ORM Path[]
manager	<member 'manager' of 'InstanceState' objects>
mapper	<sqlalchemy.util.langhelpers._memoized_property object at 0x0000020DA0FA40B0>
modified	False
obj	<member 'obj' of 'InstanceState' objects>
parents	<sqlalchemy.util.langhelpers._memoized_property object at 0x0000020DA0F6B3B0>
runid	None
session_id	None

Liste des propriétés

Nom de la propriété	Description
async_session	Return the owning :class:`_asyncio.AsyncSession` for this instance, _{[extrait de async_session.__doc__]}
deleted	Return ``True`` if the object is :term:`deleted`. _{[extrait de deleted.__doc__]}
detached	Return ``True`` if the object is :term:`detached`. _{[extrait de detached.__doc__]}
dict	Return the instance dict used by the object. _{[extrait de dict.__doc__]}
has_identity	Return ``True`` if this object has an identity key. _{[extrait de has_identity.__doc__]}
identity	Return the mapped identity of the mapped object. _{[extrait de identity.__doc__]}
identity_key	Return the identity key for the mapped object. _{[extrait de identity_key.__doc__]}
object	Return the mapped object represented by this _{[extrait de object.__doc__]}
pending	Return ``True`` if the object is :term:`pending`. _{[extrait de pending.__doc__]}
persistent	Return ``True`` if the object is :term:`persistent`. _{[extrait de persistent.__doc__]}
session	Return the owning :class:`.Session` for this instance, _{[extrait de session.__doc__]}
transient	Return ``True`` if the object is :term:`transient`. _{[extrait de transient.__doc__]}
unloaded	Return the set of keys which do not have a loaded value. _{[extrait de unloaded.__doc__]}
unloaded_expirable	Synonymous with :attr:`.InstanceState.unloaded`. _{[extrait de unloaded_expirable.__doc__]}
unmodified	Return the set of keys which have no uncommitted changes _{[extrait de unmodified.__doc__]}
was_deleted	Return True if this object is or was previously in the _{[extrait de was_deleted.__doc__]}

Liste des opérateurs

Opérateurs hérités de la classe object

__eq__, __ge__, __gt__, __le__, __lt__, __ne__

Liste des méthodes

Toutes les méthodes Méthodes d'instance Méthodes statiques

Signature de la méthode	Description
__class_getitem__	Parameterizes a generic class. _{[extrait de __class_getitem__.__doc__]}
__getstate__(self) -> 'Dict[str, Any]'
__setstate__(self, state_dict: 'Dict[str, Any]') -> 'None'
get_history(self, key: 'str', passive: 'PassiveFlag') -> 'History'
get_impl(self, key: 'str') -> 'AttributeImpl'
unmodified_intersection(self, keys: 'Iterable[str]') -> 'Set[str]'	Return self.unmodified.intersection(keys). _{[extrait de unmodified_intersection.__doc__]}