U
|
¸ý°dyb ã
|
@ s¸ d Z ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlm Z dd lm
|
Z
|
dd
|
lm Z dd lm Z dd lm Z dd lmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlZddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddl m Z dd lm Z dd l m Z dd l m!Z! dd l"m#Z# dd l"m$Z$ erÚdd!lm%Z% dd"l m&Z& dd#l m'Z' dd$lm(Z( dd%lm)Z) dd&l*m+Z+ dd'l,m-Z- dd(l.m/Z/ dd)lm0Z0 dd*l m1Z1 ed+ed,Z2e 3d-¡Z4G d.d/ d/e$Z5G d0d1 d1e$Z6G d2d3 d3e!ee7d4f e e e Z8G d5d6 d6Z9G d7d8 d8e Z:e: Z;ej< Z<Z=ej> Z>Z?ej@ Z@ZAejB ZBZCdKd:d;d<d=d>d?d@dAdBdCdDZDdEdF ZEdGdH ZFdIdJ ZGdS )La Defines SQLAlchemy's system of class instrumentation.
|
|
This module is usually not directly visible to user applications, but
|
defines a large part of the ORM's interactivity.
|
|
instrumentation.py deals with registration of end-user classes
|
for state tracking. It interacts closely with state.py
|
and attributes.py which establish per-instance and per-class-attribute
|
instrumentation, respectively.
|
|
The class instrumentation system can be customized on a per-class
|
or global basis using the :mod:`sqlalchemy.ext.instrumentation`
|
module, which provides the means to build and specify
|
alternate instrumentation forms.
|
|
.. versionchanged: 0.8
|
The instrumentation extension system was moved out of the
|
ORM and into the external :mod:`sqlalchemy.ext.instrumentation`
|
package. When that package is imported, it installs
|
itself within sqlalchemy.orm so that its more comprehensive
|
resolution mechanics take effect.
|
|
é )Ú annotations)ÚAny)ÚCallable)Úcast)Ú
|
Collection)ÚDict)ÚGeneric)ÚIterable)ÚList)ÚOptional)ÚSet)ÚTuple)ÚType)Ú TYPE_CHECKING)ÚTypeVar)ÚUnionNé )Úbase)Ú collections)Úexc)Ú
|
interfaces)Ústate)Ú_O)Ú _is_collection_attribute_implé )Úutil)Ú EventTarget)Ú HasMemoized)ÚLiteral)ÚProtocol)Ú _RegistryType)Ú AttributeImpl)ÚQueryableAttribute)Ú_AdaptedCollectionProtocol)Ú_CollectionFactoryType)Ú _MapperConfig)ÚInstanceEvents)ÚMapper)Ú InstanceState)Ú
|
dispatcherÚ_T)ÚboundÚDEL_ATTRc @ s e Zd ZdddddddZdS ) Ú _ExpiredAttributeLoaderProtoústate.InstanceState[Any]zSet[str]zbase.PassiveFlagÚNone)r ÚtoloadÚpassiveÚreturnc C s d S ©N© )Úselfr r0 r1 r4 r4 úUd:\z\workplace\vscode\pyvenv\venv\Lib\site-packages\sqlalchemy/orm/instrumentation.pyÚ__call__S s z%_ExpiredAttributeLoaderProto.__call__N©Ú__name__Ú
|
__module__Ú __qualname__r7 r4 r4 r4 r6 r- R s r- c @ s e Zd ZdddddZdS )Ú_ManagerFactoryúType[_O]úClassManager[_O]©Úclass_r2 c C s d S r3 r4 ©r5 r@ r4 r4 r6 r7 ] s z_ManagerFactory.__call__Nr8 r4 r4 r4 r6 r< \ s r< c @ sb e Zd ZU dZded< ejZejZ e
|
e e ¡Z ded< ded< dZded < d
|
ed < dZd ed < ded< espdZded< ded< ee jddddd Zeje jddddd Zdd Zdd d d d d!dd"d#d$d%Zd"d&d'd(Zd)d&d*d+Zd,d d-d.d/Zed d&d0d1Ze j d2d3 Z e j d4d5 Z e j d6d7 Z e j d8d9 Z!e j"d:d&d;d<Z#dd=d>Z$dd?d@Z%dAd dBdCdDZ&dEdFdGdHdIZ'dJdK Z(e j"dLd&dMdNZ)dOdP Z*e j+dQdR Z,e j+dSdT Z-e j+dUdV Z.ddAdWd d"dXdYdZZ/d[d\ Z0d]d^ Z1d d_d`Z2d"d&dadbZ3dAdWd"dcdddeZ4dAd"dBdfdgZ5dAd,d"dhdidjZ6dAd"dBdkdlZ7dAdmdndodpdqZ8dAdrdndsdtdudvZ9d¡dAd d dwdxdyZ:dAdzdBd{d|Z;ed}d&d~dZ<d¢dddddZ=d£ddd"d
ddZ>dd"dddZ?drdddddZ@dddddZAdd dddZBd¤drdAd d dddZCd d&ddZDdAd&ddZEdS )¥Ú ClassManagerz,Tracks state information at the class level.z dispatcher[ClassManager[_O]]Údispatchr- Úexpired_attribute_loaderú$Optional[Callable[(Ellipsis, None)]]Ú init_methodNÚ original_initzOptional[_ManagerFactory]Úfactoryz$Optional[weakref.ref[_MapperConfig]]Údeclarative_scanr Úregistryr= r@ zList[ClassManager[Any]]Ú_basesz1.4zWThe ClassManager.deferred_scalar_loader attribute is now named expired_attribute_loader)Úmessagec C s | j S r3 ©rD ©r5 r4 r4 r6 Údeferred_scalar_loader s z#ClassManager.deferred_scalar_loaderc C s
|
|| _ d S r3 rM )r5 Úobjr4 r4 r6 rO s c C sÎ || _ i | _d | _i | _i | _d| _d | _d | _dd tddd | j j D D | _
|
| j
|
D ]}| |¡ qZtd| j j || ¡ |jD ]"}t|}|d k r| j |j ¡ q| ¡ d|jkrÊt d| ¡ d S ) NFc S s g | ]}|d k r|qS r3 r4 )Ú.0Úmgrr4 r4 r6 Ú
|
<listcomp> s ÷z)ClassManager.__init__.<locals>.<listcomp>z!List[Optional[ClassManager[Any]]]c S s g | ]}t |trt|qS r4 )Ú
|
isinstanceÚtypeÚopt_manager_of_class)rQ r r4 r4 r6 rS ¤ s
|
þr& Ú__del__z¦__del__() method on class %s will cause unreachable cycles and memory leaks, as SQLAlchemy instrumentation often creates reference cycles. Please remove this method.)r@ ÚinfoÚnew_initÚ local_attrsÚ originalsÚ
|
_finalizedrH rF r Ú __bases__rK ÚupdaterC Z_eventsZ_new_classmanager_instanceÚ__mro__rV Ú_updateÚmanageÚ__dict__r Úwarn)r5 r@ Zbase_ZbaseclsrR r4 r4 r6 Ú__init__ sH þþþ
|
ÿ þ
|
|
ýÿzClassManager.__init__FÚboolúOptional[Mapper[_O]]úOptional[_RegistryType]úOptional[_MapperConfig]ú&Optional[_ExpiredAttributeLoaderProto]r/ )ÚfinalizeÚmapperrJ rI rD rF r2 c C s |r
|
|| _ |r| | ¡ |r(t |¡| _|r2|| _|rN| jrHtd| || _| js|| jd k rr| j j
|
t j
|
krr| jn| j j
|
| _ |r| js| ¡ d S )Nz>class is already instrumented, init_method %s can't be applied)rk Z _add_managerÚweakrefÚrefrI rD r\ ÚAssertionErrorrF r@ rd ÚobjectrG Ú _finalize)r5 rj rk rJ rI rD rF r4 r4 r6 Ú _update_stateà s0
|
ÿÿÿ þü
|
zClassManager._update_state)r2 c C s* | j r
|
d S d| _ | ¡ tj | j¡ d S ©NT)r\ Ú_instrument_initÚ_instrumentation_factoryrC Zclass_instrumentr@ rN r4 r4 r6 rp ê s
|
zClassManager._finalizeÚintc C s t | S r3 )ÚidrN r4 r4 r6 Ú__hash__ó s zClassManager.__hash__r )Úotherr2 c C s || kS r3 r4 )r5 rx r4 r4 r6 Ú__eq__ö s zClassManager.__eq__c C s
|
d| j kS )Nrk )rb rN r4 r4 r6 Ú is_mappedù s zClassManager.is_mappedc C s t | S r3 )Ú frozensetrN r4 r4 r6 Ú _all_key_setý s zClassManager._all_key_setc C s t dd | ¡ D S )Nc S s g | ]}|j jr|jqS r4 )ÚimplZ
|
collectionÚkey©rQ Úattrr4 r4 r6 rS s z6ClassManager._collection_impl_keys.<locals>.<listcomp>©r{ ÚvaluesrN r4 r4 r6 Ú_collection_impl_keys s ÿz"ClassManager._collection_impl_keysc C s t dd | ¡ D S )Nc S s g | ]}|j jr|j qS r4 )r} Zaccepts_scalar_loaderr r4 r4 r6 rS
|
s þz5ClassManager._scalar_loader_impls.<locals>.<listcomp>r rN r4 r4 r6 Ú_scalar_loader_impls s
|
þÿz!ClassManager._scalar_loader_implsc C s t dd | ¡ D S )Nc S s g | ]
|
}|j qS r4 ©r} r r4 r4 r6 rS s z.ClassManager._loader_impls.<locals>.<listcomp>r rN r4 r4 r6 Ú _loader_impls s zClassManager._loader_implsz
|
Mapper[_O]c C s t | j¡d S r3 )r ZUnmappedClassErrorr@ rN r4 r4 r6 rk s zClassManager.mapperc c sv i }| j jdd
D ]\}|jd }|jD ]F}| ||¡ ||jkrDq(|| j| }t|tjr(|jr(||fV q(qdS )a return an iterator of all classbound attributes that are
|
implement :class:`.InspectionAttr`.
|
|
This includes :class:`.QueryableAttribute` as well as extension
|
types such as :class:`.hybrid_property` and
|
:class:`.AssociationProxy`.
|
|
r éÿÿÿÿr N)r@ r_ rb Ú
|
setdefaultrT r ZInspectionAttrZ is_attribute)r5 ÚexcludeÚfoundÚsuperclsZinheritsr~ Úvalr4 r4 r6 Ú_all_sqla_attributes s
|
|
|
|
|
|
ÿþz!ClassManager._all_sqla_attributesc C s* | j jD ] }||jkr|j| S q|S )z5return an attribute on the class without tripping it.N)r@ r_ rb )r5 r~ Údefaultr r4 r4 r6 Ú_get_class_attr_mro; s
|
z ClassManager._get_class_attr_mroÚstr)r~ r2 c C s || ko| | j dk S )z\Return True if the given attribute is fully initialized.
|
|
i.e. has an impl.
|
Nr
©r5 r~ r4 r4 r6 Ú_attr_has_implD s zClassManager._attr_has_implzType[_T]zClassManager[_T])Úclsr2 c C s t |ddS )aÏ Create a new ClassManager for a subclass of this ClassManager's
|
class.
|
|
This is called automatically when attributes are instrumented so that
|
the attributes can be propagated to subclasses against their own
|
class-local manager, without the need for mappers etc. to have already
|
pre-configured managers for the full class hierarchy. Mappers
|
can post-configure the auto-generated ClassManager when needed.
|
|
F)rj )Úregister_class)r5 r r4 r4 r6 Ú_subclass_managerL s z ClassManager._subclass_managerc C s$ t | j| | j| _| d| j¡ d S )Nrd )Ú_generate_initr@ rG rY Úinstall_memberrN r4 r4 r6 rs Y s z ClassManager._instrument_initz Type[state.InstanceState[_O]]c C s | j | | j¡ tjS r3 )rC Z
|
first_initr@ r r( rN r4 r4 r6 Ú_state_constructor] s z ClassManager._state_constructorc C s t | j| j| dS )z0Mark this instance as the manager for its class.N)Úsetattrr@ Ú MANAGER_ATTRrN r4 r4 r6 ra b s zClassManager.managec C s t S r3 )Ú_default_manager_getterrN r4 r4 r6 Úmanager_getterg s zClassManager.manager_getterc C s t S )zÍReturn a (instance) -> InstanceState callable.
|
|
"state getter" callables should raise either KeyError or
|
AttributeError if no InstanceState could be found for the
|
instance.
|
)Ú_default_state_getterrN r4 r4 r6 Ú state_getterk s zClassManager.state_getterc C s t S r3 )Ú_default_dict_getterrN r4 r4 r6 Ú dict_getterv s zClassManager.dict_getterúQueryableAttribute[Any])r~ ÚinstÚ
|
propagatedr2 c C sf |r|| j kr*d S n|| j |< | ||¡ | ¡ || |< | j ¡ D ] }| |¡}| ||d¡ qDd S rr )rZ Úinstall_descriptorÚ_reset_memoizationsr@ Ú__subclasses__r Úinstrument_attribute)r5 r~ r¢ r£ r Úmanagerr4 r4 r6 r§ z s
|
|
|
z!ClassManager.instrument_attributec c sF | j ¡ D ]6}t|}|d k r
|
|| k r
|
|V |r
|
| d¡E d H q
|
d S rr )r@ r¦ rV Úsubclass_managers)r5 Ú recursiver rR r4 r4 r6 r© s z ClassManager.subclass_managersc C s t j | j|| | ¡ d S r3 )rt rC Zattribute_instrumentr@ r r4 r4 r6 Úpost_configure_attribute s
|
ÿz%ClassManager.post_configure_attributec C sl || kr d S |r || j kr2d S n| j |= | |¡ | ¡ | |= | j ¡ D ] }t|}|rJ| |d¡ qJd S rr )rZ Úuninstall_descriptorr¥ r@ r¦ rV Úuninstrument_attribute)r5 r~ r£ r r¨ r4 r4 r6 r s
|
|
z#ClassManager.uninstrument_attributec C sx t | jD ]}| |¡ q
|
d| _d| _d| _| j ¡ t | D ]}|| jkr>| |¡ q>| j
|
| j j krtt | j | j
|
dS )z<remove all instrumentation established by this ClassManager.N)Úlistr[ Úuninstall_memberrk rC rY rX ÚclearrZ r r r@ rb Údelattrr r4 r4 r6 Ú
|
unregisterª s
|
|
zClassManager.unregister)r~ r¢ r2 c C s. || j | jfkr td| t| j|| d S ©NzW%r: requested attribute name conflicts with instrumentation attribute of the same name.)Ú
|
STATE_ATTRr ÚKeyErrorr r@ )r5 r~ r¢ r4 r4 r6 r¤ ¼ s ÿÿz ClassManager.install_descriptorc C s t | j| d S r3 )r± r@ r r4 r4 r6 r¬ Æ s z!ClassManager.uninstall_descriptor)r~ Úimplementationr2 c C sH || j | jfkr td| | j || jj |t¡¡ t | j|| d S r³ )
|
r´ r rµ r[ r r@ rb Úgetr, r )r5 r~ r¶ r4 r4 r6 r É s ÿÿzClassManager.install_memberc C s6 | j |d ¡}|tk r&t| j|| n t| j| d S r3 )r[ Úpopr, r r@ r± )r5 r~ Úoriginalr4 r4 r6 r¯ Ò s z ClassManager.uninstall_memberzType[Collection[Any]]r$ )r~ Úcollection_classr2 c C s
|
t |¡S r3 )r Zprepare_instrumentation)r5 r~ rº r4 r4 r6 Úinstrument_collection_classÙ s z(ClassManager.instrument_collection_classzInstanceState[_O]z@Tuple[collections.CollectionAdapter, _AdaptedCollectionProtocol])r~ r rH r2 c C s2 | }| |¡}t|s tt |||¡}||fS r3 )Úget_implr rn r ZCollectionAdapter)r5 r~ r rH Ú user_datar} Úadapterr4 r4 r6 Úinitialize_collectionÞ s
|
|
z"ClassManager.initialize_collection)r~ Úsearchr2 c C s |r || kS || j kS d S r3 )rZ )r5 r~ rÀ r4 r4 r6 Úis_instrumentedê s z ClassManager.is_instrumentedr! c C s
|
| | j S r3 r
r r4 r4 r6 r¼ ð s zClassManager.get_implz Iterable[Any]c C s t | ¡ S r3 )Úiterr rN r4 r4 r6 Ú
|
attributesó s zClassManager.attributeszOptional[InstanceState[_O]]r )r r2 c C s2 | j | j ¡}|d kr"| || ¡}| ||¡ |S r3 )r@ Ú__new__r Ú _state_setter)r5 r Úinstancer4 r4 r6 Ú new_instanceù s
|
zClassManager.new_instance)rÆ r r2 c C s$ |d kr| || ¡}| ||¡ d S r3 )r rÅ ©r5 rÆ r r4 r4 r6 Úsetup_instance s zClassManager.setup_instance)rÆ r2 c C s t || j d S r3 )r± r´ ©r5 rÆ r4 r4 r6 Úteardown_instance s z ClassManager.teardown_instanceúDict[str, Any]Ú_SerializeManager)r Ú
|
state_dictr2 c C s
|
t ||S r3 )rÍ )r5 r rÎ r4 r4 r6 Ú
|
_serialize s zClassManager._serializez(Union[Literal[False], InstanceState[_O]]c C sT t || jrdS | j|jk r4| jr4| |j¡ |¡S | || ¡}| ||¡ |S dS )zInstall a default InstanceState if none is present.
|
|
A private convenience method used by the __init__ decorator.
|
|
FN) Úhasattrr´ r@ Ú __class__rz r Ú_new_state_if_noner rÅ rÈ r4 r4 r6 rÒ s ÿþ z ClassManager._new_state_if_nonec C s t || jS r3 )rÐ r´ rÊ r4 r4 r6 Ú has_state+ s zClassManager.has_state)r r~ Ú
|
optimisticr2 c C s | |¡j||dS )ZTODO)rÔ )r¼ Z hasparent)r5 r r~ rÔ r4 r4 r6 Ú
|
has_parent. s zClassManager.has_parentc C s dS )z=All ClassManagers are non-zero regardless of attribute state.Tr4 rN r4 r4 r6 Ú__bool__4 s zClassManager.__bool__c C s d| j j| jt| f S )Nz<%s of %r at %x>)rÑ r9 r@ rv rN r4 r4 r6 Ú__repr__8 s
|
ýzClassManager.__repr__)FNNNNN)N)N)F)F)F)N)N)F)Fr9 r: r; Ú__doc__Ú__annotations__r ZDEFAULT_MANAGER_ATTRr ZDEFAULT_STATE_ATTRr´ Ú staticmethodr Z
|
attrsetterrÅ rG rI r rJ ÚpropertyÚ
|
deprecatedrO Úsetterrd rq rp rw ry rz r Zmemoized_attributer| r r r Zmemoized_propertyrk r r r r rs r ra Z hybridmethodr 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× r4 r4 r4 r6 rB a s¶
|
þ þ / ÷ '
|
|
|
|
|
!
|
|
|
|
|
ü
|
|
ÿ ÿrB r¡ c @ s( e Zd ZdZdddddZdd Zd S )
|
rÍ z¡Provide serialization of a :class:`.ClassManager`.
|
|
The :class:`.InstanceState` uses ``__init__()`` on serialize
|
and ``__call__()`` on deserialize.
|
|
r. rÌ )r Údc C s |j | _ |j}|j ||¡ d S r3 )r@ r¨ rC Úpickle)r5 r rÞ r¨ r4 r4 r6 rd H s z_SerializeManager.__init__c C sj t | j |_}|d kr,t |d| j ¡n|jrD|jjsD|j ¡ |d k rX| ||¡ |j
|
||¡ d S )NzxCannot deserialize object of type %r - no mapper() has been configured for this class within the current Python process!) rV r@ r¨ r ZUnmappedInstanceErrorrz rk Z
|
configuredZ_check_configurerÉ rC Zunpickle)r5 r r¢ rÎ r¨ r4 r4 r6 r7 M s ýþ
|
z_SerializeManager.__call__N)r9 r: r; rØ rd r7 r4 r4 r4 r6 rÍ @ s rÍ c @ s\ e Zd ZU dZded< dddddZdd dd
|
d Zdd d dddZdd dddZdS )ÚInstrumentationFactoryz'Factory for new ClassManager instances.z"dispatcher[InstrumentationFactory]rC r= r> r? c C sb |d k s t t|d ks t | |¡\}}|d kr@t}t|}n |d k sLt | ||¡ ||_|S r3 )rn rV Ú_locate_extended_factoryrB Ú_check_conflictsrH )r5 r@ r¨ rH r4 r4 r6 Úcreate_manager_for_clsg s
|
z-InstrumentationFactory.create_manager_for_clsz<Tuple[Optional[ClassManager[_O]], Optional[_ManagerFactory]]c C s dS )z2Overridden by a subclass to do an extended lookup.)NNr4 rA r4 r4 r6 rá { s z/InstrumentationFactory._locate_extended_factoryz&Callable[[Type[_O]], ClassManager[_O]]r/ )r@ rH r2 c C s dS )z;Overridden by a subclass to test for conflicting factories.Nr4 )r5 r@ rH r4 r4 r6 râ s z'InstrumentationFactory._check_conflictsc C s t |}| ¡ | j |¡ d S r3 )Úmanager_of_classr² rC Zclass_uninstrument)r5 r@ r¨ r4 r4 r6 r² s z!InstrumentationFactory.unregisterN) r9 r: r; rØ rÙ rã rá râ r² r4 r4 r4 r6 rà b s
|
rà Tr= re rf rg rh ri rE r> )r@ rj rk rJ rI rD rF r2 c C s4 t | }|dkrt | ¡}|j||||||d |S )z_Register class instrumentation.
|
|
Returns the existing or newly created class manager.
|
|
N)rk rJ rI rD rF rj )rV rt rã rq )r@ rj rk rJ rI rD rF r¨ r4 r4 r6 r s
|
ú r c C s t | ¡ dS )z!Unregister class instrumentation.N)rt r² )r@ r4 r4 r6 Úunregister_class¹ s rå c C s t | jj|ddS )zïReturn True if the given attribute on the given instance is
|
instrumented by the attributes package.
|
|
This function may be used regardless of instrumentation
|
applied directly to the class, i.e. no descriptors are required.
|
|
T)rÀ )rä rÑ rÁ )rÆ r~ r4 r4 r6 rÁ ¿ s
|
ÿrÁ c
|
C s |dkr| j }d}tj|dd}|| }t|dd}t|dd}t ¡ }t|d< t|| |d } |j| _|| _ |r||| _
|
|r|| _ | S ) z>Build an __init__ decorator that triggers ClassManager events.Nzßdef __init__(%(apply_pos)s):
|
new_state = class_manager._new_state_if_none(%(self_arg)s)
|
if new_state:
|
return new_state._initialize_instance(%(apply_kw)s)
|
else:
|
return original_init(%(apply_kw)s)
|
F)ZgroupedÚ __defaults__Ú__kwdefaults__r9 rd ) rd r Zformat_argspec_initÚgetattrÚlocalsÚcopyr9 ÚexecrØ Z_sa_original_initræ rç )
|
r@ Z class_managerrG Z func_bodyZ func_varsZ func_textZ func_defaultsZfunc_kw_defaultsÚenvrd r4 r4 r6 r Ì s$
|
|
r )TNNNNN)HrØ Ú
|
__future__r Útypingr r r r r r r r
|
r r r r r r r rl Ú r r r r r Ú_typingr rà r r Úeventr r Z util.typingr r r r! r" r# r$ Z decl_baser% Úeventsr& rk r' r( r) r* Úsymbolr, r- r< r rB rÍ rà rt Zinstance_stater Ú instance_dictr rä r rV Z_default_opt_manager_getterr rå rÁ r r4 r4 r4 r6 Ú<module> s
|
|
|
|
ü b",
|
|
|
|
ù
|
