Edit File: state.cpython-37.pyc
B ��4]Dy � @ s� 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 ejG dd� dej��ZG dd� de�ZG dd� de�ZdS )z�Defines 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 @ sN e Zd ZdZdZdZdZejZ dZ dZ dZ dZ dZdZdZdZdZdZdZdZdd� ZdZejdd � �Zed d � �Zed d � �Z edd� �Z edd� �Z edd� �Z edd� �Z ee�!d�dd� ��Z"dd� Z#ee�!d�dd � ��Z$ed d � �Z%ed d � �Z&ed!d"� �Z'ejd#d$� �Z(ejd%d&� �Z)ejd'd(� �Z*ed)d*� �Z+e,dcd+d,��Z-ddd-d.�Z.d/d0� Z/d1d2� Z0d3d4� Z1ed5d6� �Z2d7d8� Z3d9d:� Z4d;d<� Z5d=d>� Z6d?d@� Z7dAdB� Z8dCdD� Z9dEdF� Z:e,dGdH� �Z;dIdJ� Z<dedKdL�Z=dMdN� Z>edOdP� �Z?dQdR� Z@edSdT� �ZAedUdV� �ZBedWdX� �ZCdYdZ� ZDdfd[d\�ZEd]d^� ZFdgd_d`�ZGe,dhdadb��ZHdS )i� 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:`.inspect` system:: >>> from sqlalchemy import inspect >>> insp = inspect(some_mapped_object) .. seealso:: :ref:`core_inspection_toplevel` N� FTc C s0 |j | _|| _t�|| j�| _i | _t� | _ d S )N) � __class__�class_�manager�weakref�ref�_cleanup�obj�committed_state�set�expired_attributes)�selfr r r r �G/opt/alt/python37/lib64/python3.7/site-packages/sqlalchemy/orm/state.py�__init__Y s zInstanceState.__init__c s t �t� fdd�� jD ���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 s | ]}|t � |�fV qd S )N)�AttributeState)�.0�key)r r r � <genexpr>u s z&InstanceState.attrs.<locals>.<genexpr>)r ZImmutableProperties�dictr )r r )r r �attrsh s zInstanceState.attrsc C s | j dko| j S )zyReturn true if the object is :term:`transient`. .. seealso:: :ref:`session_object_states` N)r# � _attached)r r r r � transientx s zInstanceState.transientc C s | j dko| jS )zxReturn true if the object is :term:`pending`. .. seealso:: :ref:`session_object_states` N)r# r' )r r r r �pending� s zInstanceState.pendingc C s | j dk o| jo| jS )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` N)r# r' �_deleted)r r r r �deleted� s zInstanceState.deletedc C s | 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` )r* )r r r r � was_deleted� s zInstanceState.was_deletedc C s | j dk o| jo| 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` N)r# r' r* )r r r r � persistent� s zInstanceState.persistentc C s | j dk o| j S )zxReturn true if the object is :term:`detached`. .. seealso:: :ref:`session_object_states` N)r# r' )r r r r �detached� s zInstanceState.detachedzsqlalchemy.orm.sessionc C s | j d k o| j |jkS )N)� session_idZ _sessions)r � sessionlibr r r r' � s zInstanceState._attachedc C s$ || j kr t| j �| _ t| j |< dS )z|Track the last known value of a particular key after expiration operations. .. versionadded:: 1.3 N)�_last_known_valuesr% r )r r# r r r �_track_last_known_value� s z%InstanceState._track_last_known_valuec C s |� | �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. )Z_state_session)r r0 r r r �session� s zInstanceState.sessionc C s | � � S )zMReturn the mapped object represented by this :class:`.InstanceState`.)r )r r r r �object s zInstanceState.objectc C s | j dkrdS | j d S dS )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.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 r r r �identity s zInstanceState.identityc C s | j S )z�Return 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. )r# )r r r r � identity_key# s zInstanceState.identity_keyc C s i S )Nr )r r r r �parents1 s zInstanceState.parentsc C s i S )Nr )r r r r �_pending_mutations5 s z InstanceState._pending_mutationsc C s | j jS )z8Return the :class:`.Mapper` used for this mapped object.)r �mapper)r r r r r9 9 s zInstanceState.mapperc C s t | j�S )z�Return ``True`` if this object has an identity key. This should always have the same value as the expression ``state.persistent or state.detached``. )�boolr# )r r r r � has_identity> s zInstanceState.has_identityc C s |j jp d }|j jpd }|j jp"d }|j jp.d }x�|D ]�}|j} |jd k} | oT| } d |_|rj|jrj|`| r�|r�|d k r�|�� } | d k r�||| � n"|d k r�|�� } | d k r�||| � nT| r�|d k r�|�� } | d k r�||| � n,| �r|d k �r|�� } | d k �r||| � d |_ q6W d S )N) �dispatch�persistent_to_detached�deleted_to_detached�pending_to_transient�persistent_to_transientr* r# r/ r � _strong_obj) r Zstatesr3 Z to_transientr= r> r? r@ �stater+ r) r- r r r r �_detach_statesH s< z InstanceState._detach_statesc C s$ |rt �| g|� n d | _| _d S )N)r rC r/ rA )r r3 r r r �_detachq s zInstanceState._detachc C s | � � | `d S )N)rD r )r r r r �_disposew s zInstanceState._disposec C s> t dkr dS | �� }|dk r*|�| � | `d | _| _| `dS )z�Weakref 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_dictZ _fast_discardr/ rA r )r r � instance_dictr r r r { s zInstanceState._cleanupc C s d S )Nr )r r r r r � s zInstanceState.objc C s" | � � }|dk rt�|�S i S dS )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. N)r r rG )r �or r r r% � s zInstanceState.dictc O s� | d | d | dd � }}}|j }|j�|||� y|j| dd � |�S t�� � |j�|||� W d Q R X Y nX d S )Nr r r )r r< �initZ original_initr Z safe_reraiseZ init_failure)�mixed�kwargsr �instance�argsr r r r �_initialize_instance� s z"InstanceState._initialize_instancec C s | j | j�| | j|�S )N)r �impl� get_historyr% )r r# �passiver r r rP � s zInstanceState.get_historyc C s | j | jS )N)r rO )r r# r r r �get_impl� s zInstanceState.get_implc C s || j krt� | j |< | j | S )N)r8 �PendingCollection)r r# r r r �_get_pending_mutation� s z#InstanceState._get_pending_mutationc sN d� � � i}|�� fdd�dD �� � jr8� j�� |d< � j�� |�|d< |S )NrL c 3 s& | ] }|� j kr|� j | fV qd S )N)�__dict__)r" �k)r r r r$ � s z-InstanceState.__getstate__.<locals>.<genexpr>) r r8 �modified�expired� callablesr# r7 � load_optionsr r �info� load_pathr )r �updater\ � serializer Z _serialize)r � state_dictr )r r � __getstate__� s zInstanceState.__getstate__c s� � d }|d k r*t �|| j�| _|j| _nd | _� d | _� �di �| _� �di �| _� �di �| _ � �dd�| _ � �dd�| _ d � kr�| j � � d � d � k�r� d | _y� d | _W nT tk �r t� | _x4t| j�D ]&}| j| | kr�| j�|� | j|= q�W Y nX n d � k�r(� d | _nt� | _| j� � fd d �dD �� | j�r�y| jd | _W n< tk �r� t| j�dk�s�t�| jd | _d | _Y nX d� k�r�t�� d �| _ � d | |� � d S )NrL r r r8 r7 rW FrX r[ rY r c s g | ]}|� kr|� | f�qS r r )r" rV )r_ r r � <listcomp> s z.InstanceState.__setstate__.<locals>.<listcomp>)r# rZ r )Nr\ r ) r r r r r r �getr r8 r7 rW rX r[ r] rY r �KeyErrorr �list�addrU r# �identity_token� IndexError�len�AssertionErrorr Z deserializer\ )r r_ �instrV r )r_ r � __setstate__� sN zInstanceState.__setstate__c C sX |� |d�}|dk r4| j| jjr4| j| j�|� | j�|� | jrT| j� |d� dS )zKRemove the given attribute and any callables associated with it.N)�popr rO � collection�_invalidate_collectionr �discardrY )r �dict_r# �oldr r r �_reset s zInstanceState._resetc C s d|j krt|j�| _d S )NrY )rU r% rY )r �from_r r r �_copy_callables% s z InstanceState._copy_callablesc s4 |� j ��jr"� ��fdd�}n� �fdd�}|S )Nc s< d| j kri | _|��d �}|d k r.��|� � | j�< d S )NrY )rU rY rl rn )rB rp �rowrq )�fnrO r# r r � _set_callable. s zGInstanceState._instance_level_callable_processor.<locals>._set_callablec s d| j kri | _� | j�< d S )NrY )rU rY )rB rp ru )rv r# r r rw 8 s )rO rm )�clsr rv r# rw r )rv rO r# r �"_instance_level_callable_processor) s z0InstanceState._instance_level_callable_processorc s d| _ | jr&|�| � | j�� d| _d | _d| jkr>| jd= d| jkrP| jd= | j�� fdd�| j j D �� | j r�x | j� | j �D ] }| j |= q�W x(| j j � � �D ]}� �|�}d|j_q�W | jr�| j�� fdd�| jD �� x | j j� � �D ] }� |= q�W | j j�| d � d S ) NTFr8 r7 c s" g | ]}|j s|j� kr|j�qS r )�expire_missingr# )r" rO )rp r r ra Q s z)InstanceState._expire.<locals>.<listcomp>c 3 s" | ]}|� kr|� | fV qd S )Nr )r" rV )rp r r r$ a s z(InstanceState._expire.<locals>.<genexpr>)rX rW ro r �clearrA rU r r] r Z_scalar_loader_implsrY � intersectionZ_collection_impl_keysrl Z _sa_adapterZ invalidatedr1 Z _all_key_setr< �expire)r rp Z modified_setrV rm r# r )rp r �_expire? s2 zInstanceState._expirec C s� | j �dd �}| j}x�|D ]�}| j| j}|jrb|rD|js||krDq| j�|� |rb||krb||= |� |t �}|j r�|t k r�|� |� | j r�|| j kr�|t k r�|| j |< | j� |d � |r|� |d � qW | jj�| |� d S )Nr8 )rU rb rY r rO �accepts_scalar_loaderZ callable_r re rl r rm rn r1 r r< r} ) r rp Zattribute_namesZ no_loaderr) rY r# rO rq r r r �_expire_attributesi s* z InstanceState._expire_attributesc C s6 |t @ s tS | j�| j�}| j�| |� | j�� tS )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 Zdeferred_scalar_loaderr{ r )r rB rQ Ztoloadr r r � _load_expired� s zInstanceState._load_expiredc C s t | j��| j�S )z8Return the set of keys which have no uncommitted changes)r r � differencer )r r r r r� � s zInstanceState.unmodifiedc C s t |��| j��| j�S )z*Return self.unmodified.intersection(keys).)r r| r r� r )r �keysr r r �unmodified_intersection� s z%InstanceState.unmodified_intersectionc C s t | j��| j��| j�S )z�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 r r r �unloaded� s zInstanceState.unloadedc s � j �� fdd�� jD ��S )z�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. c 3 s | ]}� j | jjr|V qd S )N)r rO rz )r" �attr)r r r r$ � s z3InstanceState.unloaded_expirable.<locals>.<genexpr>)r� r| r )r r )r r �unloaded_expirable� s z InstanceState.unloaded_expirablec s � j �� fdd�� jD ��S )Nc 3 s | ]}� j | jjr|V qd S )N)r rO r )r" r� )r r r r$ � s z5InstanceState._unloaded_non_object.<locals>.<genexpr>)r� r| r )r r )r r �_unloaded_non_object� s z"InstanceState._unloaded_non_objectc C s d S )Nr )r r r r rF � s z InstanceState._instance_dictc C s |r�|j sd S |r,|j|kr,t�d|j ��|j| jks<|r�|rt|tkr\|j|kr\||j }|d ttfkrt|�|�}|| j|j< |j| jkr�t| j|j< | j r�| j d ks�| j �sd| _ | � � }|r�|j �| � | �� }| j r�|| _ |d k�r|�rt�d| j|j t�| �f ��d S )NzHCan't flag attribute '%s' modified; it's not present in the object stateTzaCan't emit change event for attribute '%s' - parent object of type %s has been garbage collected.)Zsend_modified_eventsr# �sa_excZInvalidRequestErrorr r r �copyr1 r/ rA rW rF � _modifiedre r �orm_excZObjectDereferencedErrorr r Zstate_class_str)r rp r� Zpreviousrm Z is_userlandrG rj r r r �_modified_event� s: z InstanceState._modified_eventc C sj x|D ]}| j �|d� qW d| _| j�t|��|�� | jrfx&t| j��|��|�D ] }| j|= qVW 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 rl rX r �difference_updater r| rY )r rp r� r# r r r �_commit s zInstanceState._commitc C s | � | |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 rp rG r r r � _commit_all s zInstanceState._commit_allc C sh xb|D ]Z\}}|j }|j�� d|kr,|d= |j�|� |rN|jrN|j�|� d |_|_d|_ qW dS )z.Mass / highly inlined version of commit_all().r8 FN) rU r r{ r r� rW r� ro rX rA )r Ziter_rG rB rp r_ r r r r� 2 s z InstanceState._commit_all_states)F)N)F)FF)N)N)I�__name__� __module__� __qualname__�__doc__r/ r# Zrunidr Z EMPTY_SETrZ r\ Z insert_orderrA rW rX r* Z _load_pendingZ _orphaned_outside_of_sessionZ is_instancerf r1 rY r r Zmemoized_propertyr& �propertyr( r) r+ r, r- r. Z dependenciesr' r2 r3 r4 r5 r6 r7 r8 r9 r; � classmethodrC rD rE r r r% rN rP rR rT r` rk rr rt ry r~ r� r� r� r� r� r� r� rF r� r� r� r� r r r r r " s� ( : * . r c @ sD e Zd ZdZdd� Zedd� �Zedd� �Zedd � �Zd d � Z d S ) 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 C s || _ || _d S )N)rB r# )r rB r# r r r r V s zAttributeState.__init__c C s | j j�| jt�S )z�The 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. )rB r% rb r# r )r r r r � loaded_valueZ s zAttributeState.loaded_valuec C s | j j| j �| j �� | j j�S )z�Return 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. )rB r r# �__get__r r )r r r r �valued s zAttributeState.valuec C s | j �| jt�S )aX 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` 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 )rB rP r# r )r r r r �historyq s zAttributeState.historyc C s | j �| jttA �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` 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 )rB rP r# r r )r r r r � load_history� s zAttributeState.load_historyN) r� r� r� r� r r� r� r� r� r� r r r r r! G s r! c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) rS 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 C s t �� | _t �� | _d S )N)r Z IdentitySet� deleted_itemsZOrderedIdentitySet� added_items)r r r r r � s zPendingCollection.__init__c C s( || j kr| j �|� n | j�|� d S )N)r� �remover� re )r r� r r r �append� s zPendingCollection.appendc C s( || j kr| j �|� n | j�|� d S )N)r� r� r� re )r r� r r r r� � s zPendingCollection.removeN)r� r� r� r� r r� r� r r r r rS � s rS )r� r � r r r� r r r r r r r r r Z path_registryr r� r r Z_self_inspectsZInspectionAttrInfor r4 r! rS r r r r �<module> s4 *`