lb > d Z ddlZddlmZ ddlmZ ddlmZ ddlmZ ddlmZ dd lm Z dd
lm
Z
dd lm Z dd lm Z dd
lm
Z
ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ej G d dej Z G d de Z G d de ZdS )zDefines instrumentation of instances.
This module is usually not directly visible to user applications, but
defines a large part of the ORM's interactivity.
N )base)exc)
interfaces) ATTR_WAS_SET)INIT_OK) NEVER_SET)NO_VALUE)PASSIVE_NO_INITIALIZE)PASSIVE_NO_RESULT) PASSIVE_OFF)SQL_OK) PathRegistry )
inspection)utilc e Zd ZdZdZdZdZej Z e
j Z dZ
dZdZdZdZdZdZdZdZdZdZ d ZdZ ej d Ze d Z e d Z e d
Z e d Z e d Z!e d
Z"e ej# d d Z$d Z%e ej# d d Z&e d Z'e d Z(e d Z)ej d Z*ej d Z+ej d Z,e d Z-e.d5d Z/d6dZ0d Z1d Z2d Z3e d Z4d Z5d Z6d! Z7d" Z8d# Z9d$ Z:d% Z;d& Zd5d)Z?d* Z@e d+ ZAd, ZBe d- ZCe d. ZDe d/ ZEd0 ZF d7d1ZGd2 ZHd6d3ZIe.d6d4 ZJdS )8
InstanceStatea 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`
NFT c |j | _ || _ t j || j | _ i | _ t | _ d S N)
__class__class_managerweakrefref_cleanupobjcommitted_statesetexpired_attributes)selfr r s h/builddir/build/BUILD/cloudlinux-venv-1.0.10/venv/lib64/python3.11/site-packages/sqlalchemy/orm/state.py__init__zInstanceState.__init__Y sA m ;sDM22 ! "%%% c h t j t fd j D S )aa Return a namespace representing each attribute on
the mapped object, including its current value
and history.
The returned object is an instance of :class:`.AttributeState`.
This object allows inspection of the current data
within an attribute as well as attribute history
since the last flush.
c 3 < K | ]}|t | fV d S r )AttributeState).0keyr" s r# z&InstanceState.attrs..u s2 JJc#~dC001JJJJJJr% )r ImmutablePropertiesdictr r" s `r# attrszInstanceState.attrsh s< ' JJJJT\JJJ J J
r% c $ | j du o| j S )z}Return ``True`` if the object is :term:`transient`.
.. seealso::
:ref:`session_object_states`
Nr* _attachedr. s r# transientzInstanceState.transientx s x4 6$66r% c " | j du o| j S )z|Return ``True`` if the object is :term:`pending`.
.. seealso::
:ref:`session_object_states`
Nr1 r. s r# pendingzInstanceState.pending s x4 2DN2r% c 0 | j duo
| j o| j S )a Return ``True`` if the object is :term:`deleted`.
An object that is in the deleted state is guaranteed to
not be within the :attr:`.Session.identity_map` of its parent
:class:`.Session`; however if the session's transaction is rolled
back, the object will be restored to the persistent state and
the identity map.
.. note::
The :attr:`.InstanceState.deleted` attribute refers to a specific
state of the object that occurs between the "persistent" and
"detached" states; once the object is :term:`detached`, the
:attr:`.InstanceState.deleted` attribute **no longer returns
True**; in order to detect that a state was deleted, regardless
of whether or not the object is associated with a
:class:`.Session`, use the :attr:`.InstanceState.was_deleted`
accessor.
.. versionadded: 1.1
.. seealso::
:ref:`session_object_states`
Nr* r2 _deletedr. s r# deletedzInstanceState.deleted s 8 xt#HH4=Hr% c | j S )a Return True if this object is or was previously in the
"deleted" state and has not been reverted to persistent.
This flag returns True once the object was deleted in flush.
When the object is expunged from the session either explicitly
or via transaction commit and enters the "detached" state,
this flag will continue to report True.
.. versionadded:: 1.1 - added a local method form of
:func:`.orm.util.was_deleted`.
.. seealso::
:attr:`.InstanceState.deleted` - refers to the "deleted" state
:func:`.orm.util.was_deleted` - standalone function
:ref:`session_object_states`
)r8 r. s r# was_deletedzInstanceState.was_deleted s , } r% c 2 | j duo| j o| j S )a{ Return ``True`` if the object is :term:`persistent`.
An object that is in the persistent state is guaranteed to
be within the :attr:`.Session.identity_map` of its parent
:class:`.Session`.
.. versionchanged:: 1.1 The :attr:`.InstanceState.persistent`
accessor no longer returns True for an object that was
"deleted" within a flush; use the :attr:`.InstanceState.deleted`
accessor to detect this state. This allows the "persistent"
state to guarantee membership in the identity map.
.. seealso::
:ref:`session_object_states`
Nr7 r. s r#
persistentzInstanceState.persistent s" & xt#LLt};LLr% c $ | j duo| j S )z|Return ``True`` if the object is :term:`detached`.
.. seealso::
:ref:`session_object_states`
Nr1 r. s r# detachedzInstanceState.detached s xt#:DN(::r% zsqlalchemy.orm.sessionc 0 | j d uo
| j |j v S r )
session_id _sessionsr"
sessionlibs r# r2 zInstanceState._attached s%
O4 '
8:#77
r% c l || j vr*t | j | _ t | j |< dS dS )z|Track the last known value of a particular key after expiration
operations.
.. versionadded:: 1.3
N)_last_known_valuesr- r
r" r* s r# _track_last_known_valuez%InstanceState._track_last_known_value s@ d- - -&*4+B&C&CD #+3D #C ( ( ( . -r% c , | | S )a Return the owning :class:`.Session` for this instance,
or ``None`` if none available.
Note that the result here can in some cases be *different*
from that of ``obj in session``; an object that's been deleted
will report as not ``in session``, however if the transaction is
still in progress, this attribute will still refer to that session.
Only when the transaction is completed does the object become
fully detached under normal circumstances.
)_state_sessionrC s r# sessionzInstanceState.session s ((...r% c * | S )zMReturn the mapped object represented by this
:class:`.InstanceState`.)r r. s r# objectzInstanceState.object s xxzzr% c . | j dS | j d S )a Return the mapped identity of the mapped object.
This is the primary key identity as persisted by the ORM
which can always be passed directly to
:meth:`_query.Query.get`.
Returns ``None`` if the object has no primary key identity.
.. note::
An object which is :term:`transient` or :term:`pending`
does **not** have a mapped identity until it is flushed,
even if its attributes include primary key values.
Nr r* r. s r# identityzInstanceState.identity s 8 48A; r% c | j S )zReturn the identity key for the mapped object.
This is the key used to locate the object within
the :attr:`.Session.identity_map` mapping. It contains
the identity as returned by :attr:`.identity` within it.
rO r. s r# identity_keyzInstanceState.identity_key# s xr% c i S r r r. s r# parentszInstanceState.parents1 r% c i S r r r. s r# _pending_mutationsz InstanceState._pending_mutations5 rU r% c | j j S )z s DH~~ r% c d |j j pd }|j j pd }|j j pd }|j j pd }|D ]t}|j } |j d u }
|
o| } d |_ |r |j r|`| r |r| ||| n0| ||| n!| r|
||| n|
r| ||| d |_ ud S r ) dispatchpersistent_to_detacheddeleted_to_detachedpending_to_transientpersistent_to_transientr8 r* rA _strong_obj) r" statesrK to_transientr_ r` ra rb stater9 r5 r= s r# _detach_statesz InstanceState._detach_statesH s<
3 ;t & . B Jd & / D L 4 < % %EnGi4'G $4WJ #E
I
5 ;.://???+7**7E:::
5 0 <##GU3333
5 1 =$$We444 $E ) % %r% c b |r t | g| d S d x| _ | _ d S r )r rg rA rc )r" rK s r# _detachzInstanceState._detachi s= 6 ( ($ 9 9 9 9 915 5DOd . . .r% c 2 | | `d S r )ri r r. s r# _disposezInstanceState._disposeo s HHHr% c t dS | }|| | | `dx| _ | _ | `dS )zWeakref callback cleanup.
This callable cleans out the state when it is being garbage
collected.
this _cleanup **assumes** that there are no strong refs to us!
Will not work otherwise!
N)r- _instance_dict
_fast_discardrA rc r )r" r
instance_dicts r# r zInstanceState._cleanups sY < F ++--
$ ' ' - - -# .21$* HHHr% c d S r r r. s r# r zInstanceState.obj tr% c Z | }|t j | S i S )a Return the instance dict used by the object.
Under normal circumstances, this is always synonymous
with the ``__dict__`` attribute of the mapped object,
unless an alternative instrumentation system has been
configured.
In the case that the actual object has been garbage
collected, this accessor returns a blank dictionary.
)r r ro )r" os r# r- zInstanceState.dict s,
HHJJ =%a(( (Ir% c J | d | d | dd }}}|j }|j ||| |j | dd i |S # t j 5 |j ||| d d d Y d S # 1 swxY w Y Y d S xY w)Nr r r )r r^ init
original_initr safe_reraise init_failure)mixedkwargsr" instanceargsr s r# _initialize_instancez"InstanceState._initialize_instance s $Qxq59h, dD&111 B(7(%)>v>> > B"$$
B
B --dD&AAA
B
B
B
B
B
B
B
B
B
B
B
B
B
B
B
B
B
B
B
Bs/ A B") B B"B B"B B"c Z | j | j | | j | S r )r impl get_historyr- )r" r* passives r# r zInstanceState.get_history s& |C %11$ 7KKKr% c & | j | j S r )r r rG s r# get_implzInstanceState.get_impl s |C %%r% c Z || j vrt | j |< | j | S r )rW PendingCollectionrG s r# _get_pending_mutationz#InstanceState._get_pending_mutation s1 d- - -+<+>+>D #C (&s++r% c d i}| fddD j r j |d< j | |d< |S )Nr{ c 3 H K | ] }|j v |j | fV d S r )__dict__)r) kr" s r# r+ z-InstanceState.__getstate__.. sL
DM!!
a ! "!!!
r% ) r rW modifiedexpired callablesr* rT load_optionsr r! info load_pathr )r updater serializer
_serialize)r"
state_dicts ` r# __getstate__zInstanceState.__getstate__ s $((**-
" > A&*n&>&>&@&@J{ # $ 7 7j I I
9 r% c d }|,t j || j | _ |j | _ nd | _ d | _ di | _ di | _ di | _ dd | _
dd | _ d v r | j
d d
v rd
| _ d | _ n# t $ r^ t# | _ t% | j D ]3}| j | | u r"| j | | j |= 4Y n)w xY wd v rd | _ nt# | _ | j
fd d
D | j rT | j d | _ n@# t. $ r3 t1 | j dk sJ | j dz | _ d | _ Y nw xY wdv r t3 j d | _ d | | d S )Nr{ r r rW rT r Fr r r r! c , g | ]}|v || fS r r )r) r r s r#
z.InstanceState.__setstate__.. s3
?? JqM""??r% )r* r r r r r ) r r r r r r getr rW rT r r r r r r! KeyErrorr listaddr r* identity_token
IndexErrorlenr deserializer )r" r instr s ` r# __setstate__zInstanceState.__setstate__ s *% {4 77DH .DKK
DH$X.DK )~~.? D D ",..1Er"J"J !~~i44 "z599
!~~i77 Z I Z / 0 0 0 * $ $ ' 4DN
.*45I*J''
.
.
.*-%%' dn-- . .A~a(D00 /33A666 N1 -. .
. $z11*45I*J''*-%%'
0
8 +
+&*hqk##
+
+
+48}})))) 8g-&*###
+ * $ $ ) 5j6M N NDN
9 dD*55555s%
D A%E?>E?G( (:H%$H%c * | |d }|<| j | j j r%| j | j | | j | | j r | j |d dS dS )zHRemove the given attribute and any
callables associated with it.N)popr r
collection_invalidate_collectionr! discardr )r" dict_r* olds r# _resetzInstanceState._reset s iiT"" ?t|C 0 5 @? L " 9 9# > > > '',,, > * N sD ) ) ) ) ) * *r% c N d|j v rt |j | _ d S d S Nr )r r- r )r" from_s r# _copy_callablesz InstanceState._copy_callables s, %. ( ( !%/ 2 2DNNN ) (r% c P | j j rfd}nfd}|S )Nc d| j vri | _ | d }| | | j < d S r )r r r r )rf r rowr fnr r* s r#
_set_callablezGInstanceState._instance_level_callable_processor.._set_callable& sU en44&(EOiiT**?//444')$$$r% c < d| j vri | _ | j < d S r )r r )rf r r r r* s r# r zGInstanceState._instance_level_callable_processor.._set_callable0 s) en44&(EO')$$$r% )r r )clsr r r* r r s `` @r# "_instance_level_callable_processorz0InstanceState._instance_level_callable_processor! si s| ? *
*
*
*
*
*
*
*
*
*
*
*
*
*
*
r% c d| _ | j r5| | | j d| _ d | _ d| j v r| j d= d| j v r| j d= | j fd| j j
D | j r*| j | j D ]
}| j |= | j j
D ]#} | }d|j _ $| j r+| j fd| j D | j j D ]}|= | j j | d d S )NTFrW rT c > g | ]}|j s |j v |j S r )expire_missingr* )r) r r s r# r z)InstanceState._expire..H s?
&
+/(e*;*; *;*;*;r% c 3 4 K | ]}|v || fV d S r r )r) r r s r# r+ z(InstanceState._expire..X s8 + +"#!u**E!H
****+ +r% )r r r r clearrc r r! r r _scalar_loader_implsr intersection_collection_impl_keysr _sa_adapter invalidatedrF _all_key_setr^ expire)r" r modified_setr r r* s ` r# _expirezInstanceState._expire7 s = " & & & & & ( ( ( !DM 4= 0 0
23
% %
i( &&
L =
> &,99$.II
&
&N1%% 3@@GG 6 6A 1 J15J " . . " # * * + + + +'+'>+ + +
<,99%@@ Cc
$$T400000r% c T | j dd }| j }|D ]}| j | j }|j r1|r |j s||v r)| j | |r||v r||= | |t }|j r |t ur| | | j
r || j
v r|t ur
|| j
|< | j |d |r| |d | j j | | d S )NrW )r r r r r accepts_scalar_loader callable_r! r r r
r r rF r r^ r ) r" r attribute_names no_loaderr5 r r* r r s r# _expire_attributesz InstanceState._expire_attributesa s] -##$8$??N " ' 'C<$)D)
' $. C94D4D '++C000 ' !1!1!#))C**C
13h#6#6++C000 '
34222x''/2', $ $S$ / / /
' C&&& $$T?;;;;;r% c |t z st S | j | j }| j | | | j t S )z__call__ allows the InstanceState to act as a deferred
callable for loading expired attributes, which is also
serializable (picklable).
) r r r! r
unmodifiedr deferred_scalar_loaderr r )r" rf r toloads r#
_load_expiredzInstanceState._load_expired sd %$ $(55doFF ++D&999
%%'''r% c Z t | j | j S )z8Return the set of keys which have no uncommitted changes)r r
differencer r. s r# r zInstanceState.unmodified s% 4< ++D,@AAAr% c t | | j | j S )z*Return self.unmodified.intersection(keys).)r r r r r )r" keyss r# unmodified_intersectionz%InstanceState.unmodified_intersection s1
II
\$,
'
'
Z,
-
-
r% c t | j | j | j S )Return the set of keys which do not have a loaded value.
This includes expired attributes and any other attribute that
was never populated or modified.
)r r r r r- r. s r# unloadedzInstanceState.unloaded s5
Z,
-
-
Z
"
"
r% c Z j fd j D S )r c 3 J K | ] }j | j j |V d S r )r r r r) attrr" s r# r+ z3InstanceState.unloaded_expirable.. sJ *
*
|D!&5*
*
*
*
*
*
*
r% r r r r. s `r# unloaded_expirablez InstanceState.unloaded_expirable sG })) *
*
*
*
*
*
*
r% c Z j fd j D S )Nc 3 J K | ] }j | j j |V d S r )r r r r s r# r+ z5InstanceState._unloaded_non_object.. sJ *
*
|D!&<*
*
*
*
*
*
*
r% r r. s `r# _unloaded_non_objectz"InstanceState._unloaded_non_object sE })) *
*
*
*
*
*
*
r% c d S r r r. s r# rm z InstanceState._instance_dict rq r% c |r|j sd S |r%|j |vr t j d|j z |j | j vs|rV|rE|t
u r|j |v r
||j }|d t t
fvr| | }|| j |j < |j | j v rt | j |j < | j r| j
| j sd| _ | }|r|j
| | }| j r|| _
|A|rAt! j d| j |j dt' j | d d S d S d S )NzHCan't flag attribute '%s' modified; it's not present in the object stateTz'Can't emit change event for attribute 'z' - parent object of type z has been garbage collected.)send_modified_eventsr* sa_excInvalidRequestErrorr r r
copyrF rA rc r rm _modifiedr r orm_excObjectDereferencedErrorr r state_class_str)r" r r previousr is_userlandro r s r# _modified_eventz InstanceState._modified_event s =,
txu 4 4 0')-2 xt 333{3 7 9,, 8u,,',TXH h 'BBB#'99X#6#619$TX.x42224<'1
O 0 8 8 DM / / 1 1M
2 '++D111
88::D
(#' || 55 |DH---t/CD/I/I/I/IK !9 8 |||r% c d |D ] }| j |d d| _ | j t | | | j rEt | j | | D ] }| j |= dS dS )a8 Commit attributes.
This is used by a partial-attribute load operation to mark committed
those attributes which were refreshed from the database.
Attributes marked as "expired" can potentially remain "expired" after
this step if a value was not populated in state.dict.
NF)r r r r! difference_updater r r )r" r r r* s r# _commitzInstanceState._commit s 0 0C $ $S$ / / / / 11 II " "5 ) )
> (DN##0066CCEJJ
(
( N3'' ( (
(
(r% c 8 | | |fg| dS )aS commit all attributes unconditionally.
This is used after a flush() or a full load/refresh
to remove all pending state from the instance.
- all attributes are marked as "committed"
- the "strong dirty reference" is removed
- the "modified" flag is set to False
- any "expired" markers for scalar attributes loaded are removed.
- lazy load callables for objects / collections *stay*
Attributes marked as "expired" can potentially remain
"expired" after this step if a value was not populated in state.dict.
N)_commit_all_states)r" r ro s r# _commit_allzInstanceState._commit_all s&
$ ?????r% c |D ]~\ }}|j }|j d|v r|d= |j | |r!|j r|j | dx|_ |_ d|_ dS )z.Mass / highly inlined version of commit_all().rW FN)
r r r r! r r r r r rc )r" iter_ro rf r r s r# r z InstanceState._commit_all_states* s " % %LE5 J ! ' ' ) ) )#z11 34 $ 6 6u = = =
7
7 '//666-2 2ENU] $E % %r% )Fr )FF)K__name__
__module__ __qualname____doc__rA r* runidr EMPTY_SETr r rootr insert_orderrc r r r8
_load_pending _orphaned_outside_of_session is_instancer rF r r$ r! memoized_propertyr/ propertyr3 r5 r9 r; r= r? dependenciesr2 rH rK rM rP rR rT rW rY r\ classmethodrg ri rk r r r- r} r r r r r r r r r r r r r r r r rm r r r r r r% r# r r " s 2 J
C E>L !ILKHGHM#( KNI ( ( ( <
7 7 X7 3 3 X 3 I I XI: X . M M XM( ; ; X; T/00
10 X
4
4
4 T/00 / / 10 X / X
X & X
# # # X % % % [ %@6 6 6 6 < X$
B
B
BL L L& & &, , ,
486 86 86t * * *3 3 3 [ *(1 (1 (1T < < < <> , B B XB
X
X
X
DI- - - -^( ( (:@ @ @ @$ % % % [% % %r% r c ` e Zd ZdZd Zed Zed Zed Zd Z dS )r( a Provide an inspection interface corresponding
to a particular attribute on a particular mapped object.
The :class:`.AttributeState` object is accessed
via the :attr:`.InstanceState.attrs` collection
of a particular :class:`.InstanceState`::
from sqlalchemy import inspect
insp = inspect(some_mapped_object)
attr_state = insp.attrs.some_attribute
c " || _ || _ d S r )rf r* )r" rf r* s r# r$ zAttributeState.__init__N s
r% c V | j j | j t S )zThe current value of this attribute as loaded from the database.
If the value has not been loaded, or is otherwise not present
in the object's dictionary, returns NO_VALUE.
)rf r- r r* r
r. s r# loaded_valuezAttributeState.loaded_valueR s z""48X666r% c | j j | j | j | j j S )zReturn the value of this attribute.
This operation is equivalent to accessing the object's
attribute directly or via ``getattr()``, and will fire
off any pending loader callables if needed.
)rf r r* __get__r r r. s r# valuezAttributeState.value\ s> z!$(+33 JNN dj /
r% c L | j | j t S )ai Return the current **pre-flush** change history for
this attribute, via the :class:`.History` interface.
This method will **not** emit loader callables if the value of the
attribute is unloaded.
.. note::
The attribute history system tracks changes on a **per flush
basis**. Each time the :class:`.Session` is flushed, the history
of each attribute is reset to empty. The :class:`.Session` by
default autoflushes each time a :class:`_query.Query` is invoked.
For
options on how to control this, see :ref:`session_flushing`.
.. seealso::
:meth:`.AttributeState.load_history` - retrieve history
using loader callables if the value is not locally present.
:func:`.attributes.get_history` - underlying function
)rf r r* r r. s r# historyzAttributeState.historyi s 4 z%%dh0EFFFr% c \ | j | j t t z S )a% Return the current **pre-flush** change history for
this attribute, via the :class:`.History` interface.
This method **will** emit loader callables if the value of the
attribute is unloaded.
.. note::
The attribute history system tracks changes on a **per flush
basis**. Each time the :class:`.Session` is flushed, the history
of each attribute is reset to empty. The :class:`.Session` by
default autoflushes each time a :class:`_query.Query` is invoked.
For
options on how to control this, see :ref:`session_flushing`.
.. seealso::
:attr:`.AttributeState.history`
:func:`.attributes.get_history` - underlying function
.. versionadded:: 0.9.0
)rf r r* r
r r. s r# load_historyzAttributeState.load_history s# 2 z%%dh g0EFFFr% N)
r r r r r$ r r r r
r r r% r# r( r( ? s 7 7 X7
X
G G XG6G G G G Gr% r( c $ e Zd ZdZd Zd Zd ZdS )r a A writable placeholder for an unloaded collection.
Stores items appended to and removed from a collection that has not yet
been loaded. When the collection is loaded, the changes stored in
PendingCollection are applied to it to produce the final result.
c f t j | _ t j | _ d S r )r IdentitySet
deleted_itemsOrderedIdentitySet added_itemsr. s r# r$ zPendingCollection.__init__ s* ! - / / 244r% c || j v r | j | d S | j | d S r )r remover r r" r s r# appendzPendingCollection.append sJ D& & & % %e , , , , , ' ' ' ' 'r% c || j v r | j | d S | j | d S r )r r r r r s r# r zPendingCollection.remove sJ D$ $ $ # #E * * * * * " "5 ) ) ) ) )r% N)r r r r r$ r r r r% r# r r sK 5 5 5( ( ( * * * * *r% r )r r r r r r r r r r
r r r
r
path_registryr r r r _self_inspectsInspectionAttrInfor rM r( r r r% r# r s ' ' ' ' ' ' # # # # # # ' ' ' ' ' ' Y % Y % Y % Y % Y %J1 Y % Y % Y %x_G _G _G _G _GV _G _G _GD* * * * * * * * * *r%