o
    [hH                     @   s   d Z ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ e Z	G d	d
 d
e
ZG dd deZG dd deZe Zej ZZej ZZej ZZdd Zdd Zdd Zdd ZdS )a  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.

   )base)collections)exc)
interfaces)state   )utilc                   @   s  e Zd ZdZejZejZe	e
eZdZejZdZdd Zdd Zdd Zed	d
 Zedd Zedd Zedd Ze
jdd ZdZddZdZddZdd Zdd Zdd Z dd Z!e
jdd  Z"d!d" Z#d#d$ Z$e
j%d%d& Z&e
j%d'd( Z'e
j%d)d* Z(d[d,d-Z)d.d/ Z*d0d1 Z+d[d2d3Z,d4d5 Z-d6d7 Z.d8d9 Z/d:d; Z0d<d= Z1d>d? Z2d@dA Z3d[dBdCZ4dDdE Z5edFdG Z6dZdHdIZ7dZdJdKZ8dLdM Z9dNdO Z:dPdQ Z;dRdS Z<d[dTdUZ=dVdW Z>e>Z?dXdY Z@dS )\ClassManagerz,Tracks state information at the class level.Nc                 C   s   || _ i | _d | _i | _i | _dd dd | j jD D | _| jD ]}| | q!| jj	
||  |jD ]}t|}|d urE| j|j q4|   |   d|jv r\td|  d S d S )Nc                 S   s   g | ]}|d ur|qS N ).0mgrr   r   /home/ubuntu/experiments/live_experiments/Pythonexperiments/Otree/venv/lib/python3.10/site-packages/sqlalchemy/orm/instrumentation.py
<listcomp>A   s
    z)ClassManager.__init__.<locals>.<listcomp>c                 S   s   g | ]}t |trt|qS r   )
isinstancetypemanager_of_class)r   r   r   r   r   r   C   s    __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.)class_infonew_initlocal_attrs	originals	__bases__Z_basesupdatedispatchZ_eventsZ_new_classmanager_instance__mro__r   _updatemanage_instrument_init__dict__r   warn)selfr   Zbase_Zbaseclsr   r   r   r   __init__:   s6   



zClassManager.__init__c                 C      t | S r
   )idr"   r   r   r   __hash__`      zClassManager.__hash__c                 C   s   || u S r
   r   )r"   otherr   r   r   __eq__c   r(   zClassManager.__eq__c                 C   s
   d| j v S )Nmapper)r    r&   r   r   r   	is_mappedf   s   
zClassManager.is_mappedc                 C   r$   r
   )	frozensetr&   r   r   r   _all_key_setj   s   zClassManager._all_key_setc                 C      t dd |  D S )Nc                 S   s   g | ]	}|j jr|jqS r   )implZ
collectionkeyr   attrr   r   r   r   q   s    z6ClassManager._collection_impl_keys.<locals>.<listcomp>r-   valuesr&   r   r   r   _collection_impl_keysn   s   z"ClassManager._collection_impl_keysc                 C   r/   )Nc                 S   s   g | ]	}|j jr|j qS r   )r0   Zaccepts_scalar_loaderr2   r   r   r   r   w   s    z5ClassManager._scalar_loader_impls.<locals>.<listcomp>r4   r&   r   r   r   _scalar_loader_implst   s
   z!ClassManager._scalar_loader_implsc                 C   s   t | jr
   )r   ZUnmappedClassErrorr   r&   r   r   r   r+   ~   s   zClassManager.mapperc                 c   sx    i }| j jdd D ].}|jd }|jD ]#}||| ||jv r#q|| j| }t|tjr8|jr8||fV  qqdS )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   N)r   r   r    
setdefaultr   r   ZInspectionAttrZis_attribute)r"   excludefoundsuperclsZinheritsr1   valr   r   r   _all_sqla_attributes   s"   






z!ClassManager._all_sqla_attributesc                 C   s*   | j jD ]}||jv r|j|   S q|S )z5return an attribute on the class without tripping it.)r   r   r    )r"   r1   defaultr=   r   r   r   _get_class_attr_mro   s
   
z ClassManager._get_class_attr_mroc                 C   s   || v o
| | j duS )z\Return True if the given attribute is fully initialized.

        i.e. has an impl.
        Nr0   r"   r1   r   r   r   _attr_has_impl   s   zClassManager._attr_has_implc                 C   s   t |}|du rt|}|S )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.

        Nr   _instrumentation_factorycreate_manager_for_cls)r"   clsmanagerr   r   r   _subclass_manager   s   
zClassManager._subclass_managerc                 C   s*   | j j| _t| j | | _| d| j d S Nr#   )r   r#   original_init_generate_initr   install_memberr&   r   r   r   r      s   
zClassManager._instrument_initc                 C   s   | j r| d d | _ d S d S rK   )r   uninstall_memberr&   r   r   r   _uninstrument_init   s   

zClassManager._uninstrument_initc                 C   s   | j | | j tjS r
   )r   Z
first_initr   r   ZInstanceStater&   r   r   r   _state_constructor   s   zClassManager._state_constructorc                 C   s   t | j| j|  dS )z0Mark this instance as the manager for its class.N)setattrr   MANAGER_ATTRr&   r   r   r   r      s   zClassManager.managec                 C   s   t | j| j dS )z)Disassociate this manager from its class.N)delattrr   rS   r&   r   r   r   dispose   s   zClassManager.disposec                 C      t S r
   )_default_manager_getterr&   r   r   r   manager_getter      zClassManager.manager_getterc                 C   rV   )zReturn a (instance) -> InstanceState callable.

        "state getter" callables should raise either KeyError or
        AttributeError if no InstanceState could be found for the
        instance.
        )_default_state_getterr&   r   r   r   state_getter   s   	zClassManager.state_getterc                 C   rV   r
   )_default_dict_getterr&   r   r   r   dict_getter   rY   zClassManager.dict_getterFc                 C   sh   |r
|| j v r	d S n|| j |< | || t|  || |< | j D ]}| |}|||d q#d S NT)r   install_descriptor_memoized_key_collectionexpire_instancer   __subclasses__rJ   instrument_attribute)r"   r1   inst
propagatedrH   rI   r   r   r   rc      s   



z!ClassManager.instrument_attributec                 c   sN    | j  D ]}t|}|d ur$|| ur$|V  |r$|dD ]}|V  qqd S r^   )r   rb   r   subclass_managers)r"   	recursiverH   r   mr   r   r   rf     s   zClassManager.subclass_managersc                 C   s   t j| j|| |  d S r
   )rF   r   Zattribute_instrumentr   rC   r   r   r   post_configure_attribute  s   z%ClassManager.post_configure_attributec                 C   sn   || vrd S |r|| j v rd S n	| j |= | | t|  | |= | j D ]}t|}|r4||d q&d S r^   )r   uninstall_descriptorr`   ra   r   rb   r   uninstrument_attribute)r"   r1   re   rH   rI   r   r   r   rk     s    


z#ClassManager.uninstrument_attributec                 C   sD   |    d | _| _| j  t| D ]}|| jv r| | qdS )z<remove all instrumentation established by this ClassManager.N)rP   r+   r   r   clearlistr   rk   rC   r   r   r   
unregister"  s   


zClassManager.unregisterc                 C   s.   || j | jfv rtd| t| j|| d S NzW%r: requested attribute name conflicts with instrumentation attribute of the same name.)
STATE_ATTRrS   KeyErrorrR   r   )r"   r1   rd   r   r   r   r_   .  s   zClassManager.install_descriptorc                 C   s   t | j| d S r
   )rT   r   rC   r   r   r   rj   6     z!ClassManager.uninstall_descriptorc                 C   sF   || j | jfv rtd| | j|t| j|d  t| j|| d S ro   )rp   rS   rq   r   r:   getattrr   rR   )r"   r1   implementationr   r   r   rN   9  s   zClassManager.install_memberc                 C   s,   | j |d }|d urt| j|| d S d S r
   )r   poprR   r   )r"   r1   originalr   r   r   rO   B  s   zClassManager.uninstall_memberc                 C   s
   t |S r
   )r   Zprepare_instrumentation)r"   r1   Zcollection_classr   r   r   instrument_collection_classG     
z(ClassManager.instrument_collection_classc                 C   s"   | }t | |||}||fS r
   )r   ZCollectionAdapterget_impl)r"   r1   r   factory	user_dataadapterr   r   r   initialize_collectionJ  s
   z"ClassManager.initialize_collectionc                 C   s   |r|| v S || j v S r
   )r   )r"   r1   searchr   r   r   is_instrumentedQ  s   
zClassManager.is_instrumentedc                 C   s
   | | j S r
   rB   rC   r   r   r   ry   W  rx   zClassManager.get_implc                 C   s   t |  S r
   )iterr5   r&   r   r   r   
attributesZ  s   zClassManager.attributesc                 C   s2   | j | j }|d u r| || }| || |S r
   )r   __new__rQ   _state_setter)r"   r   instancer   r   r   new_instance`  s
   zClassManager.new_instancec                 C   s$   |d u r
|  || }| || d S r
   )rQ   r   r"   r   r   r   r   r   setup_instanceg  s   zClassManager.setup_instancec                 C   s   t || j d S r
   )rT   rp   r"   r   r   r   r   teardown_instancel  rr   zClassManager.teardown_instancec                 C   s
   t ||S r
   )_SerializeManager)r"   r   
state_dictr   r   r   
_serializeo  rx   zClassManager._serializec                 C   sP   t || jrdS | j|jur| jr| |j|S | || }| || |S )zInstall a default InstanceState if none is present.

        A private convenience method used by the __init__ decorator.

        F)	hasattrrp   r   	__class__r,   rJ   _new_state_if_nonerQ   r   r   r   r   r   r   r  s   zClassManager._new_state_if_nonec                 C   s   t || jS r
   )r   rp   r   r   r   r   	has_state  s   zClassManager.has_statec                 C   s   |  |j||dS )TODO)
optimistic)ry   Z	hasparent)r"   r   r1   r   r   r   r   
has_parent  s   zClassManager.has_parentc                 C      dS )z=All ClassManagers are non-zero regardless of attribute state.Tr   r&   r   r   r   __bool__  rY   zClassManager.__bool__c                 C   s   d| j j| jt| f S )Nz<%s of %r at %x>)r   __name__r   r%   r&   r   r   r   __repr__  s
   zClassManager.__repr__r
   )F)Ar   
__module____qualname____doc__r   ZDEFAULT_MANAGER_ATTRrS   ZDEFAULT_STATE_ATTRrp   staticmethodr   Z
attrsetterr   Zdeferred_scalar_loaderobjectr#   rL   rz   r'   r*   propertyr,   r`   r.   r6   r7   Zmemoized_propertyr+   r?   rA   rD   rJ   r   rP   rQ   r   rU   ZhybridmethodrX   r[   r]   rc   rf   ri   rk   rn   r_   rj   rN   rO   rw   r}   r   ry   r   r   r   r   r   r   r   r   r   __nonzero__r   r   r   r   r   r	   ,   s|    &



	


!	






	
	




r	   c                   @   s    e Zd ZdZdd Zdd ZdS )r   zProvide serialization of a :class:`.ClassManager`.

    The :class:`.InstanceState` uses ``__init__()`` on serialize
    and ``__call__()`` on deserialize.

    c                 C   s    |j | _ |j}|j|| d S r
   )r   rI   r   pickle)r"   r   drI   r   r   r   r#     s   z_SerializeManager.__init__c                 C   sh   t | j |_}|d u rt|d| j |jr!|jjs!|j  |d ur+|	|| |j
|| d S )NzxCannot deserialize object of type %r - no mapper() has been configured for this class within the current Python process!)r   r   rI   r   ZUnmappedInstanceErrorr,   r+   Z
configuredZ_configure_allr   r   Zunpickle)r"   r   rd   r   rI   r   r   r   __call__  s   
z_SerializeManager.__call__N)r   r   r   r   r#   r   r   r   r   r   r     s    r   c                   @   s0   e Zd ZdZdd Zdd Zdd Zdd	 Zd
S )InstrumentationFactoryz'Factory for new ClassManager instances.c                 C   s`   |d usJ t |d u sJ | |\}}|d u rt}||}| || ||_| j| |S r
   )r   _locate_extended_factoryr	   _check_conflictsrz   r   Zclass_instrument)r"   r   rI   rz   r   r   r   rG     s   z-InstrumentationFactory.create_manager_for_clsc                 C   r   )z2Overridden by a subclass to do an extended lookup.)NNr   )r"   r   r   r   r   r     rY   z/InstrumentationFactory._locate_extended_factoryc                 C   r   )z;Overridden by a subclass to test for conflicting factories.Nr   )r"   r   rz   r   r   r   r     rY   z'InstrumentationFactory._check_conflictsc                 C   sD   t |}|  |  | j| tj|jv r t|tj d S d S r
   )	r   rn   rU   r   Zclass_uninstrumentr	   rS   r    rT   )r"   r   rI   r   r   r   rn     s   z!InstrumentationFactory.unregisterN)r   r   r   r   rG   r   r   rn   r   r   r   r   r     s    r   c                 C   s   t | }|du rt| }|S )z_Register class instrumentation.

    Returns the existing or newly created class manager.

    NrE   )r   rI   r   r   r   register_class  s   
r   c                 C   s   t |  dS )z!Unregister class instrumentation.N)rF   rn   )r   r   r   r   unregister_class  s   r   c                 C   s   t | jj|ddS )zReturn 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   r1   r   r   r   r     s   
r   c                 C   s   | j }|sJ d}tj|dd}|| }tjr$t|d|}t|dd}nt|dd}t|dd}t  }	t||	 |	d	 }
|j|
_||
_	|rJ||
_
tjsR|rR||
_|
S )
z>Build an __init__ decorator that triggers ClassManager events.zdef __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)groupedZim_funcfunc_defaultsN__defaults____kwdefaults__r#   )r#   r   Zformat_argspec_initZpy2krs   localscopyexecr   Z_sa_original_initr   r   )r   Zclass_managerZoriginal__init__Z	func_bodyZ	func_varsZ	func_textfuncr   Zfunc_kw_defaultsenvr#   r   r   r   rM     s(   


rM   N)r    r   r   r   r   r   r   Z!group_expirable_memoized_propertyr`   dictr	   r   r   r   rF   Zinstance_staterZ   instance_dictr\   r   rW   r   r   r   rM   r   r   r   r   <module>   s*     s")


