G d= d;e> Z> e>ddd Z?e fd>Z@e fd?ZAdNdAZBdB ZC dOdCZD dPdDZEdE ZFdF ZGdG ZHdH ZIdQdIZJdJ ZKdK ZLdL ZMdM ZNdS )RzDefines instrumentation for class attributes and their interaction
with instances.
This module is usually not directly visible to user applications, but
defines a large part of the ORM's interactivity.
N ) collections)exc)
interfaces)
ATTR_EMPTY) ATTR_WAS_SET) CALLABLES_OK)INIT_OK)
instance_dictinstance_state) instance_str)LOAD_AGAINST_COMMITTED)manager_of_class) NEVER_SET) NO_AUTOFLUSH) NO_CHANGE)NO_RAISE)NO_VALUE)NON_PERSISTENT_OK)PASSIVE_CLASS_MISMATCH)PASSIVE_NO_FETCH)PASSIVE_NO_FETCH_RELATED)PASSIVE_NO_INITIALIZE)PASSIVE_NO_RESULT) PASSIVE_OFF)PASSIVE_ONLY_PERSISTENT)PASSIVE_RETURN_NEVER_SET)RELATED_OBJECT_OK)SQL_OK) state_str )event)
inspection)utilc & e Zd ZdZdZ ddZej d Ze d Z
e fdZ d Z
ej d Zej d
Ze d Zd Zd
Zd Zd Zd Zd Zd Zd ZddZd Zd Zej d Z dS )QueryableAttributea Base class for :term:`descriptor` objects that intercept
attribute events on behalf of a :class:`.MapperProperty`
object. The actual :class:`.MapperProperty` is accessible
via the :attr:`.QueryableAttribute.property`
attribute.
.. seealso::
:class:`.InstrumentedAttribute`
:class:`.MapperProperty`
:attr:`_orm.Mapper.all_orm_descriptors`
:attr:`_orm.Mapper.attrs`
TNc " || _ || _ || _ || _ || _ || _ t
| }|rQ|j D ]K}||v rC| j || j || j j
r d| j _
Jd S d S NT) class_keyimpl
comparator
_parententity_of_typer _basesdispatch_update_active_history) selfr* r+ r, r- parententityof_typemanagerbases P/opt/cloudlinux/venv/lib64/python3.11/site-packages/sqlalchemy/orm/attributes.py__init__zQueryableAttribute.__init__O s $ )
"6** =
=
=$;;M))$s)*<===Cy)9 =8<
5 = =
=
= c | j j S N)r, supports_populationr4 s r9 _supports_populationz'QueryableAttribute._supports_populationj s
y,,r; c | j j S r= )r, uses_objectsr? s r9 _impl_uses_objectsz%QueryableAttribute._impl_uses_objectsn s
y%%r; c n | j t | t | | S r= )r, get_historyr
r )r4 instancepassives r9 rE z QueryableAttribute.get_historyr s3 y$$ 8 $ $mH&=&=w
r; c | S r= r? s r9 __selectable__z!QueryableAttribute.__selectable__w s r; c | j j S )a Return the 'info' dictionary for the underlying SQL element.
The behavior here is as follows:
* If the attribute is a column-mapped property, i.e.
:class:`.ColumnProperty`, which is mapped directly
to a schema-level :class:`_schema.Column` object, this attribute
will return the :attr:`.SchemaItem.info` dictionary associated
with the core-level :class:`_schema.Column` object.
* If the attribute is a :class:`.ColumnProperty` but is mapped to
any other kind of SQL expression other than a
:class:`_schema.Column`,
the attribute will refer to the :attr:`.MapperProperty.info`
dictionary associated directly with the :class:`.ColumnProperty`,
assuming the SQL expression itself does not have its own ``.info``
attribute (which should be the case, unless a user-defined SQL
construct has defined one).
* If the attribute refers to any other kind of
:class:`.MapperProperty`, including :class:`.RelationshipProperty`,
the attribute will refer to the :attr:`.MapperProperty.info`
dictionary associated with that :class:`.MapperProperty`.
* To access the :attr:`.MapperProperty.info` dictionary of the
:class:`.MapperProperty` unconditionally, including for a
:class:`.ColumnProperty` that's associated directly with a
:class:`_schema.Column`, the attribute can be referred to using
:attr:`.QueryableAttribute.property` attribute, as
``MyClass.someattribute.property.info``.
.. seealso::
:attr:`.SchemaItem.info`
:attr:`.MapperProperty.info`
)r- infor? s r9 rL zQueryableAttribute.info{ s P ##r; c 4 t j | j S )a Return an inspection instance representing the parent.
This will be either an instance of :class:`_orm.Mapper`
or :class:`.AliasedInsp`, depending upon the nature
of the parent entity which this attribute is associated
with.
)r$ inspectr. r? s r9 parentzQueryableAttribute.parent s !$"4555r; c 4 | j S )zThe SQL expression object represented by this
:class:`.QueryableAttribute`.
This will typically be an instance of a :class:`.ColumnElement`
subclass representing a column expression.
r- __clause_element__r? s r9
expressionz QueryableAttribute.expression s 11333r; c 4 | j S r= rQ r? s r9 rR z%QueryableAttribute.__clause_element__ s 11333r; c 4 | j S )znlike __clause_element__(), but called specifically
by :class:`_query.Query` to allow special behavior.)r- _query_clause_elementr? s r9 rV z(QueryableAttribute._query_clause_element s 44666r; c 6 | j | S )z'Return setter tuples for a bulk UPDATE.)r- _bulk_update_tuplesr4 values r9 rX z&QueryableAttribute._bulk_update_tuples s 225999r; c | j rJ | |j | j | j | j | | S )N)r, r- r5 )r/ __class__entityr+ r, r- adapt_to_entityr4 r^ s r9 r^ z"QueryableAttribute.adapt_to_entity sQ = ~~ " H66GG(
r; c t | j | j | j | j | | j | S )N)r6 )r' r* r+ r, r- r6 r. )r4 clss r9 r6 zQueryableAttribute.of_type sD ! K H I O # #C ( (
r; c P | | S r= )rV label)r4 names r9 rc zQueryableAttribute.label s" ))++11$777r; c $ || j g|R i |S r= r- r4 opotherkwargss r9 operatezQueryableAttribute.operate s$ r$/4E444V444r; c ||| j fi |S r= rf rg s r9 reverse_operatez"QueryableAttribute.reverse_operate s r% 33F333r; Fc > | j || duS )N)
optimisticFr, hasparent)r4 statero s r9 rq z QueryableAttribute.hasparent s" y""5Z"@@MMr; c
t | j | S # t $ rc}t j t dt | j dt | j j d| d| | Y d }~d S d }~ww xY w)NNeither object nor object associated with has an attribute replace_context)getattrr- AttributeErrorr% raise_type__name__)r4 r+ errs r9 __getattr__z QueryableAttribute.__getattr__ s 4?C00 0
K T
+++ T_--666
!$
s
BAA??Bc . | j j d| j S N.r* r~ r+ r? s r9 __str__zQueryableAttribute.__str__ +...99r; c | j j S )zReturn the :class:`.MapperProperty` associated with this
:class:`.QueryableAttribute`.
Return values here will commonly be instances of
:class:`.ColumnProperty` or :class:`.RelationshipProperty`.
r- propertyr? s r9 r zQueryableAttribute.property s ''r; )NNNNF) r~
__module__ __qualname____doc__ is_attributer: r% memoized_propertyr@ r rC r rE rJ rL rO rS rR rV rX r^ r6 rc rk rm rq r r rI r; r9 r' r' 5 s $ L = = = =6
- - - & & X& -8
'$ '$ '$R
6 6 6 4 4 X44 4 47 7 7 : : :
8 8 85 5 54 4 4N N N N $: : :
(
(
(
(
(r; r' c $ e Zd ZdZd Zd Zd ZdS )InstrumentedAttributezClass bound instrumented attribute which adds basic
:term:`descriptor` methods.
See :class:`.QueryableAttribute` for a description of most features.
c t | j t | t | |d d S r= )r, setr
r )r4 rF rZ s r9 __set__z InstrumentedAttribute.__set__ s=
8 $ $mH&=&=ud
r; c p | j t | t | d S r= )r, deleter
r )r4 rF s r9
__delete__z InstrumentedAttribute.__delete__ s0 11=3J3JKKKKKr; c || S t | }| j r| j |v r
|| j S | j t | | S r= )r r@ r+ r, getr
)r4 rF ownerdict_s r9 __get__z InstrumentedAttribute.__get__ s\ K h'' $ BU):):? "9== !9!95AA Ar; N)r~ r r r r r r rI r; r9 r r
sS
L L LB B B B Br; r c G fddt }t j dz |_ t j |t d |S )zCreate an QueryableAttribute / user descriptor hybrid.
Returns a new QueryableAttribute type that delegates descriptor
behavior and getattr() to the given descriptor.
c e Zd ZdZ d dZdZed Zed Zej d Z
d Z d Z d
Z
fd ZdS )
'create_proxied_attribute..ProxyzPresents the :class:`.QueryableAttribute` interface as a
proxy on top of a Python descriptor / :class:`.PropComparator`
combination.
Nc h || _ || _ || _ || _ || _ || _ || _ d S r= )r* r+
descriptororiginal_property _comparator_adapt_to_entityr )r4 r* r+ r r- r^ docr s r9 r: z0create_proxied_attribute..Proxy.__init__: s< !DKDH (DO%6D " )D $3D ! DLLLr; Tc \ | j d uo#t | j | j j j S r= )r rz r* r+ r, rB r? s r9 rC z:create_proxied_attribute..Proxy._impl_uses_objectsN s1 &d2 EDK227D
r; c | j j S r= r r? s r9 r z0create_proxied_attribute..Proxy.propertyU s
?+ +r; c t j | j r| | _ | j r$| j | j | _ | j S r= )r% callabler r r^ r? s r9 r- z2create_proxied_attribute..Proxy.comparatorY sb }T -..
6#'#3#3#5#5 $
#'#3#C#C)$ $ # #r; c \ | |j | j | j | j | S r= )r\ r] r+ r r r_ s r9 r^ z7create_proxied_attribute..Proxy.adapt_to_entityc s1 >> &
r; c V | j || }|| j u r|| S |S r= )r r )r4 rF r retvals r9 r z/create_proxied_attribute..Proxy.__get__l s7 _,,Xu==F ((X-=
r; c . | j j d| j S r r r? s r9 r z/create_proxied_attribute..Proxy.__str__v s "k 2 2 2DHH= =r; c p t | S # t $ r}|dk r#t j t d | | j } t || cY d}~S # t $ r]}t j t dt j dt | j d| d| | Y d}~n]d}~ww xY w# t $ rH}t j t dt j d| d| | Y d}~nd}~ww xY wY d}~dS Y d}~dS d}~ww xY w) zNDelegate __getattr__ to the original descriptor and/or
comparator.r- rx Nrt ru rv rw z; object nor unconfigured comparator object associated with )rz r{ r% r| r- r} r~ )r4 attributer r- err3err2r s r9 r z3create_proxied_attribute..Proxy.__getattr__y s #
z9555! !
!
!
,,K&|44c !% J &z9 = =======)
*N %)$4$4$=$=$=$($4$4$=$=$=$(DD$-I
!" -1
& K& $J / / 8 8 8$$$ K
)-
!
sc D5)D0CA% D5%
C /ACD0C D0
D!>D D0 D!!D00D5NNN)r~ r r r r: _is_internal_proxyr rC r% r r- r^ r r r )r s r9 Proxyr 3 s ! " $ "
, ,
,
$ $
$ > > >& & & & & & & r; r r )rd
from_instance)r' r} r~ r% monkeypatch_proxied_specials)r r s ` r9 create_proxied_attributer ) s l l l l l l l" l l l\ *%%.8EN%
tJ l* Lr; REMOVEAPPENDREPLACE BULK_REPLACEMODIFIEDc > e Zd ZdZdZd Zd Zed Zd Z dS )Eventa A token propagated throughout the course of a chain of attribute
events.
Serves as an indicator of the source of the event and also provides
a means of controlling propagation across a chain of attribute
operations.
The :class:`.Event` object is sent as the ``initiator`` argument
when dealing with events such as :meth:`.AttributeEvents.append`,
:meth:`.AttributeEvents.set`,
and :meth:`.AttributeEvents.remove`.
The :class:`.Event` object is currently interpreted by the backref
event handlers, and is used to control the propagation of operations
across two mutually-dependent attributes.
.. versionadded:: 0.9.0
:attribute impl: The :class:`.AttributeImpl` which is the current event
initiator.
:attribute op: The symbol :attr:`.OP_APPEND`, :attr:`.OP_REMOVE`,
:attr:`.OP_REPLACE`, or :attr:`.OP_BULK_REPLACE`, indicating the
source operation.
r, rh parent_tokenc D || _ || _ | j j | _ d S r= r )r4 attribute_implrh s r9 r: zEvent.__init__ s# " I 2r; c h t |t o |j | j u o|j | j k S r= )
isinstancer r, rh )r4 ri s r9 __eq__z Event.__eq__ s6 ue $ $
$
di'
$DG#
r; c | j j S r= )r, r+ r? s r9 r+ z Event.key s y} r; c 6 | j | S r= rp )r4 rr s r9 rq zEvent.hasparent s y""5)))r; N)
r~ r r r __slots__r: r r r+ rq rI r; r9 r r sm 6 -I3 3 3
X * * * * *r; r c e Zd ZdZ ddZdZd Zd Zd Z e ee Z
dd
Z d Z e
fd Zefd
Zd Ze
fdZe
fdZe
fdZe
fdZe
ddfdZe
fdZd ZdS )
AttributeImplz4internal implementation for instrumented attributes.FNTc
|| _ || _ || _ || _ || _ | p| | _ | | _ |t j | _ n|| _ | | | _
n | j | _
t | | }t j |pg D ]}| || |r d| j _ |
| _ t% | t& | _ dS )a* Construct an AttributeImpl.
:param \class_: associated class
:param key: string name of the attribute
:param \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.
:param trackparent:
if True, attempt to track if an instance has a parent attached
to it via this attribute.
:param extension:
a single or list of AttributeExtension object(s) which will
receive set/delete/append/remove/etc. events.
The event package is now used.
.. deprecated:: 1.3
The :paramref:`.AttributeImpl.extension` parameter is deprecated
and will be removed in a future release, corresponding to the
"extension" parameter on the :class:`.MapperProprty` classes
like :func:`.column_property` and :func:`_orm.relationship` The
events system is now used.
:param compare_function:
a function that compares two values which are normally
assignable to this attribute.
:param active_history:
indicates that get_history() should always return the "old" value,
even if it means executing a lazy callable upon attribute change.
:param 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.
:param expire_missing:
if False, don't add an "expiry" callable to this attribute
during state.expire_attributes(None), if no value is present
for this key.
:param 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.
NT)r* r+ callable_r1 trackparentr send_modified_eventsoperatoreqis_equalaccepts_scalar_loader default_accepts_scalar_loaderr r% to_list_adapt_listenerr3 expire_missingr OP_MODIFIED_modified_token)r4 r* r+ r r1 r extensioncompare_functionactive_historyr r r r rj attrexts r9 r: zAttributeImpl.__init__ s L "
& ( 0D$8! # $KDMM ,DM ,)>D & &)-)KD & '',< R00 + +C c * * * * 1,0DM ) , $T; 7 7 r; ) r* r+ r r1 r r r r r r r c . | j j d| j S r r r? s r9 r zAttributeImpl.__str__W r r; c | j j S )z(Backwards compat for impl.active_historyr1 r3 r? s r9 _get_active_historyz!AttributeImpl._get_active_historyZ s },,r; c || j _ d S r= r rY s r9 _set_active_historyz!AttributeImpl._set_active_history_ s (-
%%%r; c d}| j s
J | |j t | j | duS )a4 Return the boolean value of a `hasparent` flag attached to
the given state.
The `optimistic` flag determines what the default return value
should be if no `hasparent` flag can be located.
As this function is used to determine if an instance is an
*orphan*, instances that were loaded from storage should be
assumed to not be orphans, until a True/False value for this
flag is set.
An instance attribute that is loaded by a callable function
will also not have a `hasparent` flag.
6This AttributeImpl is not configured to track parents.F)r parentsr idr )r4 rr ro msgs r9 rq zAttributeImpl.hasparentd sM G $$$$
M b!2 3 3Z @ @ M
r; c ~ d}| j s
J | t | j }|r ||j |< dS ||j v rt|j | }|durc|j |j k rS| =t
j dt | dt | d| j d dS d|j |< dS )zSet 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``.
r FNzRemoving state z from parent state z along attribute 'zV', but the parent record has gone stale, can't be sure this is the most recent parent.) r r r r r+ objorm_excStaleDataErrorr! )r4 rr parent_staterZ r id_ last_parents r9 sethasparentzAttributeImpl.sethasparent{ s G $$$$ "## '!-EM# em## #mC 0 u,,#<+;;; #((0 % 4 4 !*% 0 0 0 0 ), 7 7 7 7 $ F!&EM# r; c t r= NotImplementedErrorr4 rr r rG s r9 rE zAttributeImpl.get_history s !###r; c t )a 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()
r r s r9 get_all_pendingz AttributeImpl.get_all_pending s "###r; c X d}| j j D ]} |||| }|t ur|}|S )z;Initialize the given state's attribute with an empty value.N)r1 init_scalarr )r4 rr r rZ fnrets r9
initializezAttributeImpl.initialize sF -+ B"UE5))C*$$ r; c | j |v r
|| j S | j }||j vs|j | t u r|t z st S ||j v r| || }nH||j v r|j | } ||| }n%| j r| || }nt }|t u s |t u r|S |t u rF || S # t $ r0}t j
t d|z | Y d}~n(d}~ww xY w|t ur| ||| S |t z st S | || S )zRetrieve 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.
z=Deferred loader for attribute %r failed to populate correctlyrx N)r+ committed_stater r r expired_attributes
_load_expired callablesr r r KeyErrorr% r| set_committed_valuer
r )r4 rr r rG r+ rZ r r s r9 r zAttributeImpl.get s 8u ? " (C5000(-:: - -,,%222 ! / /w ? ?EEEO++ % 4I %IeW 5 5EE^ ' NN5' : :EE &E ---)1C1C Ll** $Sz)# $!,.1!2
-0
*,, 33E5%HHHW$
5 ue444s C
D$&DDc : | ||||| d S NrG r r4 rr r rZ initiatorrG s r9 appendzAttributeImpl.append s$ uiAAAAAr; c < | ||d ||| d S )N)rG check_oldr r s r9 removezAttributeImpl.remove s4 5$ 7e
r; c > | ||d |||d d S )NT)rG r popr r s r9 r zAttributeImpl.pop s<
r; c t r= r )r4 rr r rZ r rG r r s r9 r zAttributeImpl.set s "###r; c | j |j v r&|j | j }|t t fv rdS |S | ||| S )z,return the unchanged value of this attributeNr )r+ r r r r )r4 rr r rG rZ s r9 get_committed_valuez!AttributeImpl.get_committed_value sU 8u, , ,)$(3E9---t 88E5'8:: :r; c R ||| j < | || j g |S )z=set an attribute value on the given instance and 'commit' it.)r+ _commit)r4 rr r rZ s r9 r z!AttributeImpl.set_committed_value! s, dh
edhZ((( r; )FNNFNTTNr )r~ r r r r: r r r r r r rq r r rE r r r r r r r r r r rI r; r9 r r s >> ! "b8 b8 b8 b8H I : : :- - -
. . . X 13FGGN
.%' %' %'N 1< $ $ $ $ 5J $ $ $ $$ )4 25 25 25 25h >I B B B B >I
;F
"
$
$
$
$ 9D
;
;
;
; r; r c z e Zd ZdZdZdZdZdZdZdZ fdZ
d Z e fdZ
e ddfd Zd
Zd Zed Z xZS )
ScalarAttributeImplz8represents a scalar value-holding InstrumentedAttribute.TF)_replace_token
_append_token
_remove_tokenc t t | j |i | t | t x| _ | _ t | t | _ d S r= ) superr r: r
OP_REPLACEr r OP_REMOVEr )r4 argkwr\ s r9 r: z ScalarAttributeImpl.__init__4 sX 1!4((13="===38z3J3JJd 0 "4 3 3r; c | j j r | ||t }n | | j t
}| j j r | |||| j | || | |
| j t
}|t
u r0|t
u r)|j s$| j |j vrt d| z d S d S d S d S )N %s object does not have a value)r1 r3 r r r+ r r fire_remove_eventr _modified_eventr expiredr r{ r4 rr r oldexistings r9 r zScalarAttributeImpl.delete9 s = ( 0((5%)ABBCC))DHh//C = J " "5%d6H I I I
eT3///99TXx00 xM 888 !BT!IJJ J
! 88r; c | j |v r't | ||| j S |t z r
|t z }| ||| }|t
u rt S t | || S r )r+ Historyfrom_scalar_attributer
r r
HISTORY_BLANKr4 rr r rG currents r9 rE z ScalarAttributeImpl.get_historyL 8u 00ueDHoNN N
#7"hhueWh==G+++$$ 44T5'JJJr; Nc $ | j j r | ||t }n | | j t
}| j j r| ||||| }| || | ||| j < d S r= ) r1 r3 r r r+ r r fire_replace_eventr" r4 rr r rZ r rG r r r% s r9 r zScalarAttributeImpl.setX s = ( 0((5%)ABBCC))DHh//C = ++ueS) E eT3/// dhr; c N | j j D ]} |||||p| j }|S r= )r1 r r r4 rr r rZ previousr r s r9 r/ z&ScalarAttributeImpl.fire_replace_eventn sA -# BBuh (HT5H EE r; c L | j j D ]} ||||p| j d S r= )r1 r r r4 rr r rZ r r s r9 r! z%ScalarAttributeImpl.fire_remove_eventu s? -& > >B BueY <$*< = = = = > >r; c 4 | j j d j d S )Nr )r columnsr} r? s r9 r} zScalarAttributeImpl.typey s
a %%%%r; )r~ r r r r rB r>
collectiondynamicr r: r r rE r r/ r! r r}
__classcell__r\ s @r9 r r ) s BB$(!L JGBI4 4 4 4 4
K K K& 1<
K
K
K
K$ , > > > & & X& & & & &r; r c Z e Zd ZdZdZdZdZdZdZd Z e
fdZ e fdZ
e
ddfd Zd
Zd ZdS ) ScalarObjectAttributeImplzrepresents a scalar-holding InstrumentedAttribute,
where the target object is also instrumented.
Adds events to delete/set operations.
FTrI c | j j r.| ||t t z t
z }n5| ||t t z t
z t z }| |||| j
| | j t }|t u r"|t ur|j t d| z d S d S d S )Nr r )r1 r3 r r r r r r
r r! r r r+ r r r{ r$ s r9 r z ScalarObjectAttributeImpl.delete s = ( ((/ () CC (((72() C
ueS$2DEEE99TXx00
,,, ! !BT!IJJ J
! ,,!!r; c | j |v r't | ||| j S |t z r
|t z }| ||| }|t
u rt S t | || S r )r+ r( from_object_attributer
r r r* r+ s r9 rE z%ScalarObjectAttributeImpl.get_history r- r; c | j |v r|| j }n%|t z r| ||| }ng S |%|t ur |t urt | |fg}ndg}| j |j v rN|j | j }|:|t ur1|t ur(||ur$| t | |f |S )Nr )NN)r+ r r r r r
r r )r4 rr r rG r, r originals r9 r z)ScalarObjectAttributeImpl.get_all_pending s 8u DHoGG
|
# hhueWh==GGI
000y(("7++W56CC .C 8u, , , ,TX6H$ $555 I-- G++
N8 4 4h?@@@
r; Nc | j j r.| ||t t z t
z }n5| ||t t z t
z t z }|I|t ur@||ur<|rdS t dt | dt | d| j
d | ||||| }||| j
< dS )z'Set a value on the given InstanceState.r NzObject z not associated with z on attribute '')r1 r3 r r r r r r
r r
ValueErrorr r! r+ r/ r0 s r9 r z ScalarObjectAttributeImpl.set s = ( ((/ () CC (((72() C
!,,,$$
j#I.... %0@0@0@0@$(((L
''ueS)LL dhr; c | j r&|$| t | |d | j j D ]} ||||p| j | || | d S )NF)r r r
r1 r r r" r5 s r9 r! z+ScalarObjectAttributeImpl.fire_remove_event s C 1 nU 3 3UE B B B-& > >B BueY <$*< = = = =
eT511111r; c V | j r9||ur5|d t t fvr$| t | |d | j j D ]} |||||p| j }| || | | j r&|$| t | |d |S NFT) r r r r r
r1 r r r" r2 s r9 r/ z,ScalarObjectAttributeImpl.fire_replace_event s Ju$$!: * *
!!.":":E5III-# BBuh (HT5H EE eT8444 F !!."7"7EEE r; )r~ r r r r rB r> r8 r r r rE r r r r! r/ rI r; r9 r= r= ~ s %*!L JI K K K@ 1<
K
K
K
K 5J H * * * * X2 2 2 r; r= c e Zd ZdZdZdZdZdZdZdZ d fd Z
d Z e fdZ
efd Zd
Zd Zd Zd
Zd Zd Ze fdZe fdZe fdZde ddfdZd Zd Zde fdZ xZ S )CollectionAttributeImpla A collection-holding attribute that instruments changes in membership.
Only handles collections of instrumented objects.
InstrumentedCollectionAttribute holds an arbitrary, user-specified
container object (defaulting to a list) and brokers access to the
CollectionAdapter, a "view" onto that object that presents consistent bag
semantics to the orm layer independent of the user data implementation.
FT)copycollection_factoryr r _bulk_replace_token_duck_typed_asNc
t t | j ||||f||| d|
|| j }|| _ || _ t
| t | _ t
| t | _
t
| t | _ t j | | _ t! | j dd r>t# j | d d } t# j | d d } d S d S )N)r r r
_sa_linkerinit_collectionc 0 | | d S r= rP targetr8 collection_adapters r9 linkz.CollectionAttributeImpl.__init__..linkc s %%&899999r; dispose_collectionc 0 | d d S r= rS rT s r9 unlinkz0CollectionAttributeImpl.__init__..unlinkg s %%d+++++r; )r rJ r: _CollectionAttributeImpl__copyrK rL r OP_APPENDr r r OP_BULK_REPLACErM r% duck_type_collectionrN rz r# listens_for)r4 r* r+ r r1 typecallabler r
copy_functionr rj rW rZ r\ s r9 r: z CollectionAttributeImpl.__init__> sI 6%t,,5
$ -
KM! ". "4 3 3 "4 3 3#(#?#? " 7 # # % %
4*L$ ? ? ,
t%6
7
7
:
: 8
7
:
t%9
:
:
,
, ;
:
,
,
, , ,r; c > d t j | D S )Nc g | ]}|S rI rI ).0ys r9
z2CollectionAttributeImpl.__copy..l s @@@a@@@r; )r rV )r4 items r9 __copyz CollectionAttributeImpl.__copyk s! @@;9$??@@@@r; c | ||| }|t u rt S t | || S r )r r r* r( from_collectionr+ s r9 rE z#CollectionAttributeImpl.get_historyn sC ((5%(99 ' ' ' **4@@ @r; c | j |vrg S || j }t |d }| j |j v r|j | j }|t t fvrbd |D }d |D }t | t | fd|D fd|D z fd|D z S d |D S )N _sa_adapterc < g | ]}|d urt | pd |fS r= r rd cs r9 rf z;CollectionAttributeImpl.get_all_pending.. sC " " " tm: ):):BdAF" " "r; c < g | ]}|d urt | pd |fS r= r rn s r9 rf z;CollectionAttributeImpl.get_all_pending.. sC # # # tm: ):):BdAF# # #r; c & g | ]
\ }}|v ||fS rI rI rd so original_sets r9 rf z;CollectionAttributeImpl.get_all_pending.. s6 Aq L00 A000r; c & g | ]
\ }}|v ||fS rI rI rr s r9 rf z;CollectionAttributeImpl.get_all_pending.. s+ NNN$!QA . s6 Aq K// A///r; c 0 g | ]}t | |fS rI r )rd rt s r9 rf z;CollectionAttributeImpl.get_all_pending.. s% 8881 ""A&888r; )r+ rz r r r dict)
r4 rr r rG r, rB current_statesoriginal_statesry ru s
@@r9 r z'CollectionAttributeImpl.get_all_pendingu sE 85 I/'=11 8u, , , ,TX6H) 444" " $" " "# # %# # #
#> 2 2 #O 4 4 $2
ONNN.NNN O $3
988888r; c | j j D ]} ||||p| j }| || t d | j r&|$| t | |d |S r) )r1 r r r" r r r r
r5 s r9 fire_append_eventz)CollectionAttributeImpl.fire_append_event s -& F FBBueY%D$2DEEEE
eT9d;;; B 1 nU 3 3UD A A A r; c @ | || t d dS )af A special event used for pop() operations.
The "remove" event needs to have the item to be removed passed to
it, which in the case of pop from a set, we don't have a way to access
the item before the operation. the event is used for all pop()
operations (even though set.pop is the one where it is really needed).
TN)r" r )r4 rr r r s r9 fire_pre_remove_eventz-CollectionAttributeImpl.fire_pre_remove_event s$ eT9d;;;;;r; c | j r&|$| t | |d | j j D ]} ||||p| j | || t d d S rH )r r r
r1 r r r" r r5 s r9 r! z)CollectionAttributeImpl.fire_remove_event s C 1 nU 3 3UE B B B-& > >B BueY <$*< = = = =
eT9d;;;;;r; c | j |vrd S | || t d | ||j }| || j = d S r) )r+ r" r get_collectionr{ clear_with_event)r4 rr r r8 s r9 r z CollectionAttributeImpl.delete sf 85 F
eT9d;;;((
;;
##%%%
$(OOOr; c J | | \ }}||| j < |S )z3Initialize this attribute with an empty collection.)_initialize_collectionr+ )r4 rr r _ user_datas r9 r z"CollectionAttributeImpl.initialize s, 22599 9#dhr; c |j | j || j \ }}| j ||| ||fS r= )r7 initialize_collectionr+ rL r1 rQ )r4 rr adapterr8 s r9 r z.CollectionAttributeImpl._initialize_collection sQ #m A A HeT 4
%%eZAAA
""r; c ( | ||| }|t u rZ| |||| }| j |vs
J d | | j | d S | || d S Nr z,Collection was loaded during event handling.)r r r r+ _get_pending_mutationr append_with_eventr4 rr r rZ r rG r8 s r9 r z CollectionAttributeImpl.append s ((w(GG
* * ***5% JJE%%%= &%% ' ' 1 1 8 8 ? ? ? ? ? ( ( : : : : :r; c 2 | ||j | }|t u rZ| |||| | j |vs
J d | | j | d S | || d S r )r r{ r r! r+ r r remove_with_eventr s r9 r z CollectionAttributeImpl.remove s ((
G(LL
* * * " "5% B B B%%%= &%% ' ' 1 1 8 8 ? ? ? ? ? ( ( : : : : :r; c x | ||||| d S # t t t f$ r Y d S w xY wr )r rE r
IndexErrorr s r9 r zCollectionAttributeImpl.pop sT
KKueYK H H H H HHj1 DD s 99c |x}} | | \ }
} |r|
j |
| }nt j | } | j }
| |
ur4|d u rdp |j j }| j j }t d|d|d t |d r| }nX| t u r@t j r| }n. t |d|j }nt | }t | }| j }| j ||| | ||t( }|t* u r| || }n|| u rd S | || |d |j }| || j < t5 j |||
| |`| j ||| d S )
NNonez Incompatible collection type: z is not z-like _sa_iterator
itervaluesr T)r ) r
_converterr% r^ rN r\ r~ TypeErrorhasattrr r{ py3kvaluesrz iterlistrM r1 bulk_replacer r r r r" rl r+ r rX )r4 rr r rZ r rG r _adaptiterable
orig_iterablenew_collectionr setting_typereceiving_typegivenwanted
new_valuesevtr% old_collections r9 r zCollectionAttributeImpl.set s9 $)(= %)$?$?$F$F! . (4)44X>> # 8 B B !%!4 ~55 D( # "7#-6
" 0 9F#) 55&&&* 8^44
. ' 4 4 6 6HH!T))y #+??#4#4$7 $lHO$ $ $ $ $H~~H(^^
&
""5*c:::hhue-DhEE # # #//%//CC
M
!
!
F eT3555 #dh #
O
((^DDDDDr; c 4 t |d }d|_ d S )Nrl T)rz invalidated)r4 r8 r s r9 _invalidate_collectionz.CollectionAttributeImpl._invalidate_collectionD s *m44 "r; c | | \ }}|r| | ||j | j < | || j g | j |j v ry| || |d |j | j }|j }|j }|D ]} |
| |D ]} | | |S )z=Set an attribute value on the given instance and 'commit' it.T) r append_multiple_without_eventr{ r+ r _pending_mutationsr" r added_items
deleted_itemsappend_without_eventremove_without_event)
r4 rr r rZ r8 r pendingaddedremovedrg s
r9 r z+CollectionAttributeImpl.set_committed_valueH s !% ; ;E B B
I < 4 4U ; ; ; (
48
edhZ((( 8u/ / /
! !%y$ ? ? ?.2248< r8 r9 r r: r[ r rE r r r r r! r r r r r r r r r r r: r; s @r9 rJ rJ # s %*!L JGI +, +, +, +, +, +,ZA A A 1< A A A A 5J &9 &9 &9 &9P < < << < < # # # >I ; ; ; ; >I ; ; ; ; ;F IE IE IE IEV# # # 8 '+K
1
1
1
1
1
1
1
1r; rJ c
j j j fdfd}fd}fd}rt j d|dd nt j d|dd t j d |dd d
S ) z6Apply listeners to synchronize a two-way relationship.c ~ t dt | d|j d|j dj j d )Nz:Bidirectional attribute conflict detected: Passing object z to attribute "z(" triggers a modify event on attribute "z" via the backref "z".)rE r! r r, ) child_stater
child_implr s r9 _acceptable_key_errz.backref_listeners.._acceptable_key_err sU j +&&&&&&&'''+++
r; c ||u r|S ||t ur|t urt | t | }}|j j }|j s|j s|j }n|j }||ur6|
||| j t |t | t | } }|j j }
|j ur|j |
j ur
| ||
|
j } |
j r|
j nd } || ur5|| ur1|
|| | |t |S r )r r r
r r7 r, r8 r9 r r r r r r r rM r )rr childoldchildr old_stateold_dictr, check_recursive_tokenr
child_dictr check_append_tokencheck_bulk_replace_tokenr r+ parent_implr s r9 "emit_backref_from_scalar_set_eventz=backref_listeners..emit_backref_from_scalar_set_event s u L 111 ))
x(( h'' I $S).D ?
;4<
;(,(;%%(,(:% 555 IIKK - , u%% e$$ $K %,S16J &l:: **2III##E9jAAA ",!9 (
..
% !333 %===!! IIKK , " r; c X |d S t | t | }}|j j }|j
ur|j |j ur
| || |j }|j r|j nd }||ur5||ur1| ||| |t |S r ) r
r r7 r, r r r8 rM r r r ) rr r r r r r r r r r+ r s r9 )emit_backref_from_collection_append_eventzDbackref_listeners..emit_backref_from_collection_append_event s = F"0"7"7 u9M9MZ (-2
", 6 6&j.EEE y* = = = ( 5.8.C MJ * * !
/ / /!999 (
r; c ||t ur|t urt | t | }}|j j }|j s |j s|j }|j } o
j }n|j }|j r|j
nd }d}||urd||urb|r%t j | j
j | s=| ||| |t" d S d S d S d S d S d S d S )NFr )r r r
r r7 r, r8 r9 r r rM r% has_dupesr{ r+ r r r ) rr r r r r r check_remove_tokencheck_replace_tokencheck_for_dupes_on_remover+ r uselists r9 )emit_backref_from_collection_remove_eventzDbackref_listeners..emit_backref_from_collection_remove_event so ...Y&& u%% e$$ $K %,S16J (
21C
2%/%="&0&?#,3,OK.L.K
? ? ? ? ? ? ? ?B @+ + + + + + +Z
5
.
L1 r;
NO_HISTORYr( r unchangeddeletedc e Zd ZdZd ZeZd Zd Zd Zd Z d Z
d Z e d Z
e d
Ze d Zd S )
r( a A 3-tuple of added, unchanged and deleted values,
representing the changes which have occurred on an instrumented
attribute.
The easiest way to get a :class:`.History` object for a particular
attribute on an object is to use the :func:`_sa.inspect` function::
from sqlalchemy import inspect
hist = inspect(myobject).attrs.myattribute.history
Each tuple member is an iterable sequence:
* ``added`` - the collection of items added to the attribute (the first
tuple element).
* ``unchanged`` - the collection of items that have not changed on the
attribute (the second tuple element).
* ``deleted`` - the collection of items that have been removed from the
attribute (the third tuple element).
c | t k S r= )r* r? s r9 __bool__zHistory.__bool__X s
}$$r; c H t | j p
| j p| j S )zhReturn True if this :class:`.History` has no changes
and no existing, unchanged state.
)boolr r r r? s r9 emptyz
History.empty] s% 3t|FGGGGr; c < | j pg | j pg z | j pg z S )z3Return a collection of added + unchanged + deleted.r r? s r9 sumz History.sume s+ Z
2$."6B 74<;M2 N
r; c ( | j pg | j pg z S )z)Return a collection of added + unchanged.)r r r? s r9 non_deletedzHistory.non_deletedl s
bT^%9r::r; c ( | j pg | j pg z S )z+Return a collection of unchanged + deleted.)r r r? s r9 non_addedzHistory.non_addedq s $" );<.} >
$ 5N1$5$5=
r; c 8 g | ]}|d urt | pd S r= r rn s r9 rf z$History.as_state.. r r; c 8 g | ]}|d urt | pd S r= r rn s r9 rf z$History.as_state.. r r; )r( r r r r? s r9 as_statezHistory.as_state{ sn
r; c |j |j t }|t u r$|t u r
| ddd S | d|gd S | || du r | d|gd S t
| t v rd}t
| t v rd }n|g}|t u r
| dd| S | |gd| S )NrI T)r r r+ _NO_HISTORYr r r _NO_STATE_SYMBOLSra r rr r, rB r s r9 r) z History.from_scalar_attribute s (,,Y]KHH { " ")##s2r2&s2y"---
2
2d
:
:3rG9b)) ) (|| 000 g;;"333 "G#*)##s2r7+++sG9b'222r; c |j |j t }|t u r-|t u s |t
u r
| ddd S | d|gd S ||u r|t
ur | d|gd S t
| t v s|d}t
| t v rd }n|g}|t u s |t
u r
| dd| S | |gd| S )NrI )r r r+ r r r r r r s r9 r@ z History.from_object_attribute s
(,,Y]KHH { " "(""g&:&:s2r2&s2y"---
WI%=%=3rG9b)) ) (|| 000H4D g;;"333 "G#*(""g&:&:s2r7+++sG9b'222r; c |j |j t }|t u s |t
u r
| ddd S t
|d }|t t
fv r | t | dd S |t u r | dt | d S d |D }d |D }t | t | | fd|D fd|D fd|D S )NrI rl c < g | ]}|d urt | pd |fS r= r rn s r9 rf z+History.from_collection.. sC 4-6^A%6%6>$B r; c < g | ]}|d urt | pd |fS r= r rn s r9 rf z+History.from_collection.. sC 4-6^A%6%6>$B r; c " g | ] \ }}|v | S rI rI rr s r9 rf z+History.from_collection.. s' GGGtq!,1F1F1F1F1Fr; c " g | ] \ }}|v | S rI rI rr s r9 rf z+History.from_collection.. s' CCCtq!l1B1B1B1B1Br; c " g | ] \ }}|v | S rI rI rx s r9 rf z+History.from_collection.. s' GGGtq!!;2F2F2F2F2Fr; ) r r r+ r r r rz r r{ ) ra r rr r, rB r| r} ry ru s @@r9 rj zHistory.from_collection sT (,,Y]KHH h 'Y"6"63r2r?? "'=11 ), , ,3tG}}b"-- -
$
$3r4=="-- - N ! O
~..K 00L3GGGG~GGGCCCC~CCCGGGGGGG
r; N)r~ r r r r __nonzero__r r r r r r classmethodr) r@ rj rI r; r9 r( r( ? s 0% % % KH H H
; ; ;
= = =
0 0 0
3 3 [ 3< 3 3 [3: [ r; c |du r t j d t }n |du rt j d t }t t | || S )a
Return a :class:`.History` record for the given object
and attribute key.
This is the **pre-flush** history for a given attribute, which is
reset each time the :class:`.Session` flushes changes to the
current database transaction.
.. note::
Prefer to use the :attr:`.AttributeState.history` and
:meth:`.AttributeState.load_history` accessors to retrieve the
:class:`.History` for instance attributes.
:param obj: an object whose class is instrumented by the
attributes package.
:param key: string attribute name.
:param passive: indicates loading behavior for the attribute
if the value is not already present. This is a
bitflag attribute, which defaults to the symbol
:attr:`.PASSIVE_OFF` indicating all necessary SQL
should be emitted.
.. seealso::
:attr:`.AttributeState.history`
:meth:`.AttributeState.load_history` - retrieve history
using loader callables if the value is not locally present.
TzNPassing True for 'passive' is deprecated. Use attributes.PASSIVE_NO_INITIALIZEFzFPassing False for 'passive' is deprecated. Use attributes.PASSIVE_OFF)r% warn_deprecatedr r get_state_historyr
)r r+ rG s r9 rE rE sw D $
3
( E
6
^C 0 0#w ? ??r; c . | || S r= )rE )rr r+ rG s r9 r r s S' * **r; Fc l t | }t | }| ||| S )TODO)r r
has_parent)ra r r+ ro r7 rr s r9 r r " s4 s##G 3 E eS* 5 55r; c | dd }| dd }| dd }t | |||| }t | |fi | |S )Nr- r5 r )r )r register_descriptorregister_attribute_impl)r* r+ r r- r5 r descs r9 register_attributer ) sp d++J66.$//L
&&
C vsJ # N N NDFC..2... Kr; c t | }|r4| dd } | || pt }
n| dd }
|| j } |r
|| ||
| fi |} n8|rt | ||| fd|
i|} n#|rt
| ||| fi |} nt | ||| fi |} | || _ |rt || || |
| || S )Nr` ) r r instrument_collection_classr r1 rJ r= r r, r post_configure_attribute)
r* r+ r r useobject
impl_classbackrefr r7 factoryr` r1 r, s
r9 r r 2 sd v&&G 4&& .. :: D
vvnd33 s|$H Kz&#|XDDDD K& CH
;G
KM
K( CH
02
#63 8JJrJJ GCL :'#,999 $$S))) 3<r; c t | }t | ||| }||_ | || |S )N)r- r5 )r r r instrument_attribute)r* r+ r- r5 r r7 r s r9 r r ^ sT v&&G&
J J j111 r; c J t | | d S r= )r uninstrument_attribute)r* r+ s r9 unregister_attributer m s$ V 33C88888r; c P t | }|j }t ||| S )a4 Initialize a collection attribute and return the collection adapter.
This function is used to provide direct access to collection internals
for a previously unloaded attribute. e.g.::
collection_adapter = init_collection(someobject, 'elements')
for elem in values:
collection_adapter.append_without_event(elem)
For an easier way to do the above, see
:func:`~sqlalchemy.orm.attributes.set_committed_value`.
:param obj: a mapped object
:param key: string attribute name where the collection is located.
)r
r{ init_state_collection)r r+ rr r s r9 rQ rQ q s* $
3 E JE s 3 33r; c | j | j }| | | }| | || S )zDInitialize a collection attribute and return the collection adapter.)r7 r, r r )rr r r+ r r s r9 r r s> = "Du--I ueY 7 77r; c t | t | }}|j | j ||| dS )a[ Set the value of an attribute with no history events.
Cancels any previous history present. The value should be
a scalar value for scalar-holding attributes, or
an iterable for any collection-holding attribute.
This is the same underlying method used when a lazy loader
fires off and loads additional data from the database.
In particular, this method can be used by application code
which has loaded additional attributes or collections through
separate queries, which can then be attached to an instance
as though it were part of its original loaded state.
N)r
r r7 r, r )rF r+ rZ rr r s r9 r r sE "(++]8-D-D5E M#//ueDDDDDr; c t | t | }}|j | j |||| dS )as Set the value of an attribute, firing history events.
This function may be used regardless of instrumentation
applied directly to the class, i.e. no descriptors are required.
Custom attribute management schemes will need to make usage
of this method to establish attribute state as understood
by SQLAlchemy.
:param instance: the object that will be modified
:param key: string name of the attribute
:param value: value to assign
:param initiator: an instance of :class:`.Event` that would have
been propagated from a previous event listener. This argument
is used when the :func:`.set_attribute` function is being used within
an existing event listening function where an :class:`.Event` object
is being supplied; the object may be used to track the origin of the
chain of events.
.. versionadded:: 1.2.3
N)r
r r7 r, r )rF r+ rZ r rr r s r9
set_attributer sG 2 "(++]8-D-D5E M# ueY?????r; c t | t | }}|j | j || S )aZ Get the value of an attribute, firing any callables required.
This function may be used regardless of instrumentation
applied directly to the class, i.e. no descriptors are required.
Custom attribute management schemes will need to make usage
of this method to make usage of attribute state as understood
by SQLAlchemy.
)r
r r7 r, r rF r+ rr r s r9
get_attributer s= "(++]8-D-D5E = " & &ue 4 44r; c t | t | }}|j | j || dS )aQ Delete the value of an attribute, firing history events.
This function may be used regardless of instrumentation
applied directly to the class, i.e. no descriptors are required.
Custom attribute management schemes will need to make usage
of this method to establish attribute state as understood
by SQLAlchemy.
N)r
r r7 r, r r s r9
del_attributer sC "(++]8-D-D5E M#""5%00000r; c t | t | }}|j | j }|j ||j | ||t d dS )a Mark an attribute on an instance as 'modified'.
This sets the 'modified' flag on the instance and
establishes an unconditional change event for the given attribute.
The attribute must have a value present, else an
:class:`.InvalidRequestError` is raised.
To mark an object "dirty" without referring to any specific attribute
so that it is considered within a flush, use the
:func:`.attributes.flag_dirty` call.
.. seealso::
:func:`.attributes.flag_dirty`
T is_userlandN) r
r r7 r, r1 modifiedr r" r )rF r+ rr r r, s r9
flag_modifiedr# sj " "(++]8-D-D5E = "DM5$"6777 %xTBBBBBr; c ~ t | t | }}| |dt d dS )a Mark an instance as 'dirty' without any specific attribute mentioned.
This is a special operation that will allow the object to travel through
the flush process for interception by events such as
:meth:`.SessionEvents.before_flush`. Note that no SQL will be emitted in
the flush process for an object that has no changes, even if marked dirty
via this method. However, a :meth:`.SessionEvents.before_flush` handler
will be able to see the object in the :attr:`.Session.dirty` collection and
may establish changes on it, which will then be included in the SQL
emitted.
.. versionadded:: 1.2
.. seealso::
:func:`.attributes.flag_modified`
NTr )r
r r" r )rF rr r s r9
flag_dirtyr% s@ ( "(++]8-D-D5E %xTBBBBBr; r )FNFNNr r= )Or r r r r r r8 r r r r
r r
r r r r r r r r r r r r r r r r r r r r! r# r$ r% _self_inspects_MappedAttributeInspectionAttrPropComparatorr' r r symbolr r\ r r] r objectr r r r= rJ r r frozensetr r
namedtupler( r* rE r r r r r r rQ r r r r r r# r% rI r; r9 r/ sA ( ( ( ( ( ( " " " " " " # # # # # # ( ( ( ( ( ( " " " " " " * * * * * * ' ' ' ' ' ' # # # # # # ) ) ) ) ) ) * * * * * * # # # # # # T( T( T( T( T( T( T( T(nB B B B B . B B B8} } }@
DK ! ! DK ! !
T[
#
#
$+n--dk*%% /* /* /* /* /*F /* /* /*dD D D D DF D D DN
R& R& R& R& R&- R& R& R&jb b b b b 3 b b bJM1 M1 M1 M1 M1m M1 M1 M1`
A A AH dk,'' IRBBxLL""Y--8 $/)%F%F%F
G
Gg g g g gg g g gT dD))
#. /@ /@ /@ /@d +6 + + + +6 6 6 6
) ) ) )Z :> 9 9 94 4 4.8 8 8E E E&@ @ @ @: 5 5 5 1 1 1 C C C.C C C C Cr;