Classe « InstanceState »

Informations générales

Héritage

builtins.object
    InspectionAttr
        InspectionAttrInfo
            InstanceState

Définition

class InstanceState(InspectionAttrInfo):

Description _{[extrait de InstanceState.doc]}

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)

    .. seealso::

        :ref:`core_inspection_toplevel`

Constructeur(s)

Signature du constructeur	Description
__init__(self, obj, manager)

Liste des attributs statiques

Nom de l'attribut	Valeur
attrs	<sqlalchemy.util.langhelpers.memoized_property object at 0x7f40cb8fb190>
callables	()
expired	False
expired_attributes	None
extension_type	symbol('NOT_EXTENSION')
identity_token	None
info	<sqlalchemy.util.langhelpers.memoized_property object at 0x7f40cbad16f0>
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	frozenset()
load_path	RootRegistry(())
mapper	<sqlalchemy.util.langhelpers.memoized_property object at 0x7f40cb8fb340>
modified	False
parents	<sqlalchemy.util.langhelpers.memoized_property object at 0x7f40cb8fb220>
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 __doc__]}
deleted	Return ``True`` if the object is :term:`deleted`. _{[extrait de __doc__]}
detached	Return ``True`` if the object is :term:`detached`. _{[extrait de __doc__]}
dict	Return the instance dict used by the object. _{[extrait de __doc__]}
has_identity	Return ``True`` if this object has an identity key. _{[extrait de __doc__]}
identity	Return the mapped identity of the mapped object. _{[extrait de __doc__]}
identity_key	Return the identity key for the mapped object. _{[extrait de __doc__]}
object	Return the mapped object represented by this _{[extrait de __doc__]}
pending	Return ``True`` if the object is :term:`pending`. _{[extrait de __doc__]}
persistent	Return ``True`` if the object is :term:`persistent`. _{[extrait de __doc__]}
session	Return the owning :class:`.Session` for this instance, _{[extrait de __doc__]}
transient	Return ``True`` if the object is :term:`transient`. _{[extrait de __doc__]}
unloaded	Return the set of keys which do not have a loaded value. _{[extrait de __doc__]}
unloaded_expirable	Return the set of keys which do not have a loaded value. _{[extrait de __doc__]}
unmodified	Return the set of keys which have no uncommitted changes _{[extrait de __doc__]}
was_deleted	Return True if this object is or was previously in the _{[extrait de __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
__getstate__(self)
__setstate__(self, state_dict)
get_history(self, key, passive)
get_impl(self, key)
obj(self)
unmodified_intersection(self, keys)	Return self.unmodified.intersection(keys). _{[extrait de unmodified_intersection.__doc__]}