Edit File: attributes.cpython-37.pyc
B ��4]A � @ s d Z ddlZddlmZ ddlmZ ddlmZ ddlmZ ddlm Z dd lm Z dd lm Z dd lm Z dd lm Z dd lmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlm Z dd lm Z dd lm Z dd lm Z dd lm Z d d!lm!Z! d d"lm"Z" d d#lm#Z# e"j$G d$d%� d%ej%ej&ej'��Z(G d&d'� d'e(�Z)d(d)� Z*e#�+d*�Z,e#�+d+�Z-e#�+d,�Z.e#�+d-�Z/e#�+d.�Z0G d/d0� d0e1�Z2G d1d2� d2e1�Z3G d3d4� d4e3�Z4G d5d6� d6e4�Z5G d7d8� d8e3�Z6d9d:� Z7e#�+d;�Z8e9e:e�e:e�e:e�g�Z;e#�<d<d=d>d?g�Z=G d@d<� d<e=�Z=e=ddd�Z>efdAdB�Z?efdCdD�Z@d`dFdG�ZAdHdI� ZBdadJdK�ZCdbdLdM�ZDdNdO� ZEdPdQ� ZFdRdS� ZGdTdU� ZHdcdVdW�ZIdXdY� ZJdZd[� ZKd\d]� ZLd^d_� ZMdS )dz�Defines 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_dict)�instance_state)� instance_str)�LOAD_AGAINST_COMMITTED)�manager_of_class)� NEVER_SET)� NO_AUTOFLUSH)� NO_CHANGE)�NO_RAISE)�NO_VALUE)�NON_PERSISTENT_OK)�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 @ s� e Zd ZdZdZd-dd�Zejdd� �Ze dd � �Z e fd d �Z d d � Z ejdd� �Zejdd� �Ze dd� �Zdd� Zdd� Zdd� Zdd� Zd d � Zd d � Zd d!� Zd"d#� Zd.d%d&�Zd'd(� Zd)d*� Zejd+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:`.Mapper.all_orm_descriptors` :attr:`.Mapper.attrs` TNc C sr || _ || _|| _|| _|| _|| _t|�}|rnx<|jD ]2}||kr8| j� || j� || jj r8d| j_ q8W d S )NT) �class_�key�impl� comparator� _parententity�_of_typer Z_bases�dispatchZ_update�_active_history) �selfr$ r% r& r' � parententity�of_type�manager�base� r1 �L/opt/alt/python37/lib64/python3.7/site-packages/sqlalchemy/orm/attributes.py�__init__N s zQueryableAttribute.__init__c C s | j jS )N)r& �supports_population)r, r1 r1 r2 �_supports_populationi s z'QueryableAttribute._supports_populationc C s | j jS )N)r& � uses_objects)r, r1 r1 r2 �_impl_uses_objectsm s z%QueryableAttribute._impl_uses_objectsc C s | j �t|�t|�|�S )N)r& � get_historyr r )r, �instance�passiver1 r1 r2 r8 q s z QueryableAttribute.get_historyc C s | S )Nr1 )r, r1 r1 r2 �__selectable__v s z!QueryableAttribute.__selectable__c C s | j jS )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:`.Column` object, this attribute will return the :attr:`.SchemaItem.info` dictionary associated with the core-level :class:`.Column` object. * If the attribute is a :class:`.ColumnProperty` but is mapped to any other kind of SQL expression other than a :class:`.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' �info)r, r1 r1 r2 r< z s 'zQueryableAttribute.infoc C s t �| j�S )a Return an inspection instance representing the parent. This will be either an instance of :class:`.Mapper` or :class:`.AliasedInsp`, depending upon the nature of the parent entity which this attribute is associated with. )r! �inspectr( )r, r1 r1 r2 �parent� s zQueryableAttribute.parentc C s | j �� S )N)r' �__clause_element__)r, r1 r1 r2 � expression� s z QueryableAttribute.expressionc C s | j �� S )N)r' r? )r, r1 r1 r2 r? � s z%QueryableAttribute.__clause_element__c C s | j �� S )zhlike __clause_element__(), but called specifically by :class:`.Query` to allow special behavior.)r' �_query_clause_element)r, r1 r1 r2 rA � s z(QueryableAttribute._query_clause_elementc C s | j �|�S )z'Return setter tuples for a bulk UPDATE.)r' �_bulk_update_tuples)r, �valuer1 r1 r2 rB � s z&QueryableAttribute._bulk_update_tuplesc C s, | j r t�| j|j| j| j| j�|�|d�S )N)r& r' r- )r) �AssertionError� __class__�entityr% r& r' �adapt_to_entity)r, rG r1 r1 r2 rG � s z"QueryableAttribute.adapt_to_entityc C s$ t | j| j| j| j�|�| j|d�S )N)r. )r# r$ r% r& r' r. r( )r, �clsr1 r1 r2 r. � s zQueryableAttribute.of_typec C s | � � �|�S )N)rA �label)r, �namer1 r1 r2 rI � s zQueryableAttribute.labelc O s || j f|�|�S )N)r' )r, �op�other�kwargsr1 r1 r2 �operate� s zQueryableAttribute.operatec K s ||| j f|�S )N)r' )r, rK rL rM r1 r1 r2 �reverse_operate� s z"QueryableAttribute.reverse_operateFc C s | j j||d�dk S )N)� optimisticF)r& � hasparent)r, �staterP r1 r1 r2 rQ � s z QueryableAttribute.hasparentc C sH y t | j|�S tk rB tdt| �jt| j�j| |f ��Y nX d S )NzFNeither %r object nor %r object associated with %s has an attribute %r)�getattrr' �AttributeError�type�__name__)r, r% r1 r1 r2 � __getattr__� s z QueryableAttribute.__getattr__c C s d| j j| jf S )Nz%s.%s)r$ rV r% )r, r1 r1 r2 �__str__� s zQueryableAttribute.__str__c C s | j jS )z�Return the :class:`.MapperProperty` associated with this :class:`.QueryableAttribute`. Return values here will commonly be instances of :class:`.ColumnProperty` or :class:`.RelationshipProperty`. )r' �property)r, r1 r1 r2 rY � s zQueryableAttribute.property)NNNN)F) rV � __module__� __qualname__�__doc__Z is_attributer3 r" �memoized_propertyr5 rY r7 r r8 r; r< r> r@ r? rA rB rG r. rI rN rO rQ rW rX r1 r1 r1 r2 r# 4 s2 ) r# c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �InstrumentedAttributez�Class bound instrumented attribute which adds basic :term:`descriptor` methods. See :class:`.QueryableAttribute` for a description of most features. c C s | j �t|�t|�|d � d S )N)r& �setr r )r, r9 rC r1 r1 r2 �__set__ s z InstrumentedAttribute.__set__c C s | j �t|�t|�� d S )N)r& �deleter r )r, r9 r1 r1 r2 � __delete__ s z InstrumentedAttribute.__delete__c C sD |d kr | S t |�}| jr.| j|kr.|| j S | j�t|�|�S d S )N)r r5 r% r& �getr )r, r9 �owner�dict_r1 r1 r2 �__get__ s z InstrumentedAttribute.__get__N)rV rZ r[ r\ r` rb rf r1 r1 r1 r2 r^ s r^ c s> G � fdd�dt �}t� �jd |_tj|t� �d� d� |S )z�Create an QueryableAttribute / user descriptor hybrid. Returns a new QueryableAttribute type that delegates descriptor behavior and getattr() to the given descriptor. c sh e Zd ZdZddd�ZdZedd� �Zedd � �Zej d d � �Z d d � Z dd� Z dd� Z � fdd�ZdS )z'create_proxied_attribute.<locals>.Proxyz�Presents the :class:`.QueryableAttribute` interface as a proxy on top of a Python descriptor / :class:`.PropComparator` combination. Nc S s. || _ || _|| _|| _|| _|| _|| _d S )N)r$ r% � descriptor�original_property� _comparator�_adapt_to_entityr\ )r, r$ r% rg r' rG �docrh r1 r1 r2 r3 . s z0create_proxied_attribute.<locals>.Proxy.__init__Tc S s | j d k ot| j| j�jjS )N)rh rS r$ r% r& r6 )r, r1 r1 r2 r7 B s z:create_proxied_attribute.<locals>.Proxy._impl_uses_objectsc S s | j jS )N)r' rY )r, r1 r1 r2 rY I s z0create_proxied_attribute.<locals>.Proxy.propertyc S s2 t �| j�r| �� | _| jr,| j�| j�| _| jS )N)r" �callableri rj rG )r, r1 r1 r2 r' M s z2create_proxied_attribute.<locals>.Proxy.comparatorc S s | � |j| j| j| j|�S )N)rE rF r% rg ri )r, rG r1 r1 r2 rG W s z7create_proxied_attribute.<locals>.Proxy.adapt_to_entityc S s, | j �||�}|| j kr$|d kr$| S |S d S )N)rg rf )r, r9 rd �retvalr1 r1 r2 rf ` s z/create_proxied_attribute.<locals>.Proxy.__get__c S s d| j j| jf S )Nz%s.%s)r$ rV r% )r, r1 r1 r2 rX j s z/create_proxied_attribute.<locals>.Proxy.__str__c s� y t � |�S tk r� |dkr*td��y | j}W n, tk r` tdt� �j| |f ��Y nBX y t ||�S tk r� tdt� �jt|�j| |f ��Y nX Y nX dS )zNDelegate __getattr__ to the original descriptor and/or comparator.r' z[Neither %r object nor unconfigured comparator object associated with %s has an attribute %rzFNeither %r object nor %r object associated with %s has an attribute %rN)rS rT r' rU rV )r, � attributer' )rg r1 r2 rW m s( z3create_proxied_attribute.<locals>.Proxy.__getattr__)NNN)rV rZ r[ r\ r3 Z_is_internal_proxyrY r7 r" r] r' rG rf rX rW r1 )rg r1 r2 �Proxy' s ro rg )rJ Z from_instance)r# rU rV r" Z monkeypatch_proxied_specials)rg ro r1 )rg r2 �create_proxied_attribute s frp ZREMOVEZAPPENDZREPLACEZ BULK_REPLACEZMODIFIEDc @ s8 e Zd ZdZdZdd� Zdd� Zedd� �Zd d � Z d S ) �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 :var impl: The :class:`.AttributeImpl` which is the current event initiator. :var op: The symbol :attr:`.OP_APPEND`, :attr:`.OP_REMOVE`, :attr:`.OP_REPLACE`, or :attr:`.OP_BULK_REPLACE`, indicating the source operation. )r& rK � parent_tokenc C s || _ || _| j j| _d S )N)r& rK rr )r, Zattribute_implrK r1 r1 r2 r3 � s zEvent.__init__c C s" t |t�o |j| jko |j| jkS )N)� isinstancerq r& rK )r, rL r1 r1 r2 �__eq__� s z Event.__eq__c C s | j jS )N)r& r% )r, r1 r1 r2 r% � s z Event.keyc C s | j �|�S )N)r& rQ )r, rR r1 r1 r2 rQ � s zEvent.hasparentN) rV rZ r[ r\ � __slots__r3 rt rY r% rQ r1 r1 r1 r2 rq � s rq c @ s� e Zd ZdZd&dd�ZdZdd � Zd d � Zd d � Ze ee�Z d'dd�Z dd� Z e fdd�Zefdd�Zdd� Ze fdd�Ze fdd�Ze fd d �Ze fd d �Ze ddfd d!�Ze fd"d#�Zd$d%� ZdS )(� AttributeImplz4internal implementation for instrumented attributes.FNTc K s� || _ || _|| _|| _|| _| p$| | _| | _|dkr@tj| _ n|| _ | dk rV| | _ n| j | _ t |�| }x"t �|pvg �D ]}|�||� qzW |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:`.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_r* � trackparentrr �send_modified_events�operator�eq�is_equal�accepts_scalar_loader� default_accepts_scalar_loaderr r" Zto_listZ_adapt_listenerr+ �expire_missingrq � OP_MODIFIED�_modified_token)r, r$ r% rw r* rx � extension�compare_function�active_historyrr r ry r} rM �attr�extr1 r1 r2 r3 � s( F zAttributeImpl.__init__) r$ r% rw r* rx rr ry r| r r� r} c C s d| j j| jf S )Nz%s.%s)r$ rV r% )r, r1 r1 r2 rX C s zAttributeImpl.__str__c C s | j jS )z(Backwards compat for impl.active_history)r* r+ )r, r1 r1 r2 �_get_active_historyF s z!AttributeImpl._get_active_historyc C s || j _d S )N)r* r+ )r, rC r1 r1 r2 �_set_active_historyK s z!AttributeImpl._set_active_historyc C s* d}| j st|��|j�t| j�|�dk S )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. z6This AttributeImpl is not configured to track parents.F)rx rD �parentsrc �idrr )r, rR rP �msgr1 r1 r2 rQ P s zAttributeImpl.hasparentc C s� d}| j st|��t| j�}|r,||j|< n`||jkr�|j| }|dk r�|j|jkr�|�� dkr~t�dt |�t |�| jf ��dS d|j|< dS )z�Set 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``. z6This AttributeImpl is not configured to track parents.FNz�Removing state %s from parent state %s along attribute '%s', but the parent record has gone stale, can't be sure this is the most recent parent.) rx rD r� rr r� r% �obj�orm_excZStaleDataErrorr )r, rR Z parent_staterC r� Zid_Z last_parentr1 r1 r2 � sethasparentg s" zAttributeImpl.sethasparentc C s t � �d S )N)�NotImplementedError)r, rR re r: r1 r1 r2 r8 � s zAttributeImpl.get_historyc C s t � �dS )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() N)r� )r, rR re r: r1 r1 r2 �get_all_pending� s z AttributeImpl.get_all_pendingc C s2 d}x(| j jD ] }||||�}|tk r|}qW |S )z;Initialize the given state's attribute with an empty value.N)r* Z init_scalarr )r, rR re rC �fn�retr1 r1 r2 � initialize� s zAttributeImpl.initializec C s | j |kr|| j S | j }||jks2|j| tkr�|t@ s>tS ||jkrV|�||�}n8||jkrv|j| }|||�}n| jr�| �||�}nt }|tks�|tkr�|S |t kr�y|| S t k r� t d| ��Y q�X n|t k r�| � |||�S |t @ � s�tS | �||�S dS )z�Retrieve 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 correctlyN)r% �committed_stater r r �expired_attributesZ _load_expiredZ callablesrw r r �KeyError�set_committed_valuer r� )r, rR re r: r% rC rw r1 r1 r2 rc � s: zAttributeImpl.getc C s | j |||||d� d S )N)r: )r_ )r, rR re rC � initiatorr: r1 r1 r2 �append� s zAttributeImpl.appendc C s | j ||d |||d� d S )N)r: � check_old)r_ )r, rR re rC r� r: r1 r1 r2 �remove� s zAttributeImpl.removec C s | j ||d |||dd� d S )NT)r: r� �pop)r_ )r, rR re rC r� r: r1 r1 r2 r� � s zAttributeImpl.popc C s t � �d S )N)r� )r, rR re rC r� r: r� r� r1 r1 r2 r_ � s zAttributeImpl.setc C sB | j |jkr.|j| j }|ttfkr(dS |S n| j|||d�S dS )z,return the unchanged value of this attributeN)r: )r% r� r r rc )r, rR re r: rC r1 r1 r2 �get_committed_value� s z!AttributeImpl.get_committed_valuec C s ||| j < |�|| j g� |S )z=set an attribute value on the given instance and 'commit' it.)r% �_commit)r, rR re rC r1 r1 r2 r� s z!AttributeImpl.set_committed_value)FNNFNTTN)F)rV rZ r[ r\ r3 ru rX r� r� rY r� rQ r� r r8 r r� r� rc r� r� r� r_ r� r� r1 r1 r1 r2 rv � s8 X ' 1 rv c sx e Zd ZdZdZdZdZdZdZdZ � fdd�Z dd� Z e fd d �Z e d dfd d �Zdd� Zdd� Zedd� �Z� ZS )�ScalarAttributeImplz8represents a scalar value-holding InstrumentedAttribute.TF)�_replace_token� _append_token� _remove_tokenc s4 t t| �j||� t| t� | _| _t| t�| _d S )N) �superr� r3 rq � OP_REPLACEr� r� � OP_REMOVEr� )r, �arg�kw)rE r1 r2 r3 s z ScalarAttributeImpl.__init__c C s� | j jr| �||t�}n|�| jt�}| j jr@| �|||| j� |� || |� |� | jt�}|tkr�|tkr�|j s�| j|j kr�t d| ��d S )Nz %s object does not have a value)r* r+ rc r r% r r� �fire_remove_eventr� �_modified_eventr� Zexpiredr� rT )r, rR re �old�existingr1 r1 r2 ra " s zScalarAttributeImpl.deletec C s\ | j |kr t�| ||| j �S |t@ r.|tN }| j|||d�}|tkrJtS t�| ||�S d S )N)r: )r% �History�from_scalar_attributer rc r � HISTORY_BLANK)r, rR re r: �currentr1 r1 r2 r8 5 s z ScalarAttributeImpl.get_historyNc C s\ | j jr| �||t�}n|�| jt�}| j jr@| �|||||�}|�|| |� ||| j< d S )N) r* r+ rc r r% r r_ �fire_replace_eventr� ) r, rR re rC r� r: r� r� r� r1 r1 r2 r_ A s zScalarAttributeImpl.setc C s* x$| j jD ]}|||||p | j�}q W |S )N)r* r_ r� )r, rR re rC �previousr� r� r1 r1 r2 r� W s z&ScalarAttributeImpl.fire_replace_eventc C s( x"| j jD ]}||||p | j� q W d S )N)r* r� r� )r, rR re rC r� r� r1 r1 r2 r� ^ s z%ScalarAttributeImpl.fire_remove_eventc C s | j jd j d S )Nr )rY �columnsrU )r, r1 r1 r2 rU b s zScalarAttributeImpl.type)rV rZ r[ r\ r~ r6 r4 � collection�dynamicru r3 ra r r8 r_ r� r� rY rU � __classcell__r1 r1 )rE r2 r� s r� c @ sd e Zd ZdZdZdZdZdZdZdd� Z e fdd�Z e fd d �Z e d dfd d �Zdd� Zdd� Zd S )�ScalarObjectAttributeImplz�represents a scalar-holding InstrumentedAttribute, where the target object is also instrumented. Adds events to delete/set operations. FTr1 c C s� | j jr"| j||ttB tB d�}n | j||ttA tB tB d�}| � |||| j � |� | j t �}|t kr�|tk r�|j d kr�td| ��d S )N)r: z %s object does not have a value)r* r+ rc r r r r r r r� r� r� r% r r rT )r, rR re r� r� r1 r1 r2 ra v s z ScalarObjectAttributeImpl.deletec C s\ | j |kr t�| ||| j �S |t@ r.|tN }| j|||d�}|tkrJtS t�| ||�S d S )N)r: )r% r� �from_object_attributer rc r r� )r, rR re r: r� r1 r1 r2 r8 � s z%ScalarObjectAttributeImpl.get_historyc C s� | j |kr|| j }n |t@ r0| j|||d�}ng S |d k r\|tk r\|tk r\t|�|fg}ndg}| j |jkr�|j| j }|d k r�|tk r�|tk r�||k r�|�t|�|f� |S )N)r: )NN)r% r rc r r r r� r� )r, rR re r: r� r� �originalr1 r1 r2 r� � s$ z)ScalarObjectAttributeImpl.get_all_pendingNc C s� | j jr"| j||ttB tB d�}n | j||ttA tB tB d�}|dk rz|t k rz||k rz|r^dS t dt |�t |�| j f ��| �|||||�}||| j < dS )z1Set a value on the given InstanceState. )r: Nz2Object %s not associated with %s on attribute '%s')r* r+ rc r r r r r r r � ValueErrorr r r% r� ) r, rR re rC r� r: r� r� r� r1 r1 r2 r_ � s& z ScalarObjectAttributeImpl.setc C sV | j r |d k r | �t|�|d� x"| jjD ]}||||p<| j� q*W |�|| |� d S )NF)rx r� r r* r� r� r� )r, rR re rC r� r� r1 r1 r2 r� � s z+ScalarObjectAttributeImpl.fire_remove_eventc C s� | j r.||k r.|d ttfkr.| �t|�|d� x$| jjD ]}|||||pL| j�}q8W |�|| |� | j r�|d k r�| �t|�|d� |S )NFT) rx r r r� r r* r_ r� r� )r, rR re rC r� r� r� r1 r1 r2 r� � s z,ScalarObjectAttributeImpl.fire_replace_event)rV rZ r[ r\ r~ r6 r4 r� ru ra r r8 r r� r_ r� r� r1 r1 r1 r2 r� g s $ & r� c s� e Zd ZdZdZdZdZdZdZdZ d(� fdd� Z dd � Z e fd d �Z efd d �Zdd� Zdd� Zdd� Zdd� Zdd� Zdd� Ze fdd�Ze fd d �Ze fd d �Zde ddfd d!�Zd"d#� Zd$d%� Zde fd&d'�Z � Z 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)�copy�collection_factoryr� r� �_bulk_replace_token�_duck_typed_asNc s� t t| �j||||f||| d�| �� |d kr4| j}|| _|| _t| t�| _t| t �| _ t| t �| _ t �| �� �| _t| jdd �r�t�| d�dd� �} t�| d�dd� �} d S ) N)rx r� r� � _sa_linker�init_collectionc S s |� |� d S )N)r� )�targetr� �collection_adapterr1 r1 r2 �linkN s z.CollectionAttributeImpl.__init__.<locals>.link�dispose_collectionc S s |� d � d S )N)r� )r� r� r� r1 r1 r2 �unlinkR s z0CollectionAttributeImpl.__init__.<locals>.unlink)r� r� r3 � _CollectionAttributeImpl__copyr� r� rq � OP_APPENDr� r� r� �OP_BULK_REPLACEr� r" �duck_type_collectionr� rS r Z listens_for) r, r$ r% rw r* � typecallablerx r� � copy_functionr� rM r� r� )rE r1 r2 r3 ) s* z CollectionAttributeImpl.__init__c C s dd� t �|�D �S )Nc S s g | ]}|�qS r1 r1 )�.0�yr1 r1 r2 � <listcomp>W s z2CollectionAttributeImpl.__copy.<locals>.<listcomp>)r r� )r, �itemr1 r1 r2 Z__copyV s z CollectionAttributeImpl.__copyc C s. | j |||d�}|tkr tS t�| ||�S d S )N)r: )rc r r� r� �from_collection)r, rR re r: r� r1 r1 r2 r8 Y s z#CollectionAttributeImpl.get_historyc s� | j |krg S || j }t|d�}| j |jkr�|j| j }|ttfkr�dd� |D �}dd� |D �}t|�� t|���fdd�|D ��fdd�|D � � fdd�|D � S dd� |D �S ) N� _sa_adapterc S s$ g | ] }|d k rt |�pd |f�qS )N)r )r� �cr1 r1 r2 r� m s z;CollectionAttributeImpl.get_all_pending.<locals>.<listcomp>c S s$ g | ] }|d k rt |�pd |f�qS )N)r )r� r� r1 r1 r2 r� q s c s g | ]\}}|� kr||f�qS r1 r1 )r� �s�o)� original_setr1 r2 r� z s c s g | ]\}}|� kr||f�qS r1 r1 )r� r� r� )r� r1 r2 r� ~ s c s g | ]\}}|� kr||f�qS r1 r1 )r� r� r� )� current_setr1 r2 r� � s c S s g | ]}t |�|f�qS r1 )r )r� r� r1 r1 r2 r� � s )r% rS r� r r �dict)r, rR re r: r� r� �current_states�original_statesr1 )r� r� r2 r� ` s" " z'CollectionAttributeImpl.get_all_pendingc C sX x"| j jD ]}||||p | j�}q W |�|| td� | jrT|d k rT| �t|�|d� |S )NT)r* r� r� r� r rx r� r )r, rR re rC r� r� r1 r1 r2 �fire_append_event� s z)CollectionAttributeImpl.fire_append_eventc C s |� || td� 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 )r, rR re r� r1 r1 r2 �fire_pre_remove_event� s z-CollectionAttributeImpl.fire_pre_remove_eventc C sX | j r |d k r | �t|�|d� x"| jjD ]}||||p<| j� q*W |�|| td� d S )NFT)rx r� r r* r� r� r� r )r, rR re rC r� r� r1 r1 r2 r� � s z)CollectionAttributeImpl.fire_remove_eventc C s@ | j |krd S |�|| td� | �||j�}|�� || j = d S )NT)r% r� r �get_collectionr� Zclear_with_event)r, rR re r� r1 r1 r2 ra � s z CollectionAttributeImpl.deletec C s | � |�\}}||| j< |S )z3Initialize this attribute with an empty collection.)�_initialize_collectionr% )r, rR re �_� user_datar1 r1 r2 r� � s z"CollectionAttributeImpl.initializec C s0 |j �| j|| j�\}}| j�|||� ||fS )N)r/ Zinitialize_collectionr% r� r* r� )r, rR �adapterr� r1 r1 r2 r� � s z.CollectionAttributeImpl._initialize_collectionc C s^ | j |||d�}|tkrN| �||||�}| j|ks:td��|�| j��|� n |�||� d S )N)r: z,Collection was loaded during event handling.)r� r r� r% rD �_get_pending_mutationr� Zappend_with_event)r, rR re rC r� r: r� r1 r1 r2 r� � s z CollectionAttributeImpl.appendc C s` | j ||j|d�}|tkrP| �||||� | j|ks<td��|�| j��|� n |�||� d S )N)r: z,Collection was loaded during event handling.) r� r� r r� r% rD r� r� Zremove_with_event)r, rR re rC r� r: r� r1 r1 r2 r� � s z CollectionAttributeImpl.removec C s8 y| j |||||d� W n tttfk r2 Y nX d S )N)r: )r� r� r� � IndexError)r, rR re rC r� r: r1 r1 r2 r� � s zCollectionAttributeImpl.popc C sV | }} | � |�\} } |r�| jd k r0| �|�}n�t�|�} | j} | | k rt|d krTdpZ|jj}| jj}td||f ��t|d�r�|� � }n2| t kr�tj r�|� � }q�t |d|j �� }nt|�}t|�}| j}| j�|||� | j||td�}|tkr�| �||�}n|| k�r d S |�|| |d� |j}| || j< tj||| |d� |`| j�|||� d S )N�Nonez/Incompatible collection type: %s is not %s-like� _sa_iteratorZ itervalues)r: T)r� ) r� Z _converterr" r� r� rE rV � TypeError�hasattrr� r� Zpy3k�valuesrS �iter�listr� r* Z bulk_replacerc r r r� r� r� r% r r� )r, rR re rC r� r: r� Z_adapt�iterableZ orig_iterableZnew_collectionr� Z setting_typeZreceiving_type�givenZwanted� new_valuesZevtr� Zold_collectionr1 r1 r2 r_ � sL zCollectionAttributeImpl.setc C s t |d�}d|_d S )Nr� T)rS Z invalidated)r, r� r� r1 r1 r2 �_invalidate_collection/ s z.CollectionAttributeImpl._invalidate_collectionc C s� | � |�\}}|r |�|� ||j| j< |�|| jg� | j|jkr�|�|| |d� |j�| j�}|j}|j }x|D ]} |� | � qtW x|D ]} |� | � q�W |S )z=Set an attribute value on the given instance and 'commit' it.T) r� Z append_multiple_without_eventr� r% r� Z_pending_mutationsr� r� Z added_itemsZ deleted_itemsZappend_without_eventZremove_without_event) r, rR re rC r� r� �pending�added�removedr� r1 r1 r2 r� 3 s z+CollectionAttributeImpl.set_committed_valuec C s. |dkr$| j |||d�}|tkr$|S t|d�S )z�Retrieve the CollectionAdapter associated with the given state. Creates a new CollectionAdapter if one does not exist. N)r: r� )rc r rS )r, rR re r� r: r1 r1 r2 r� N s z&CollectionAttributeImpl.get_collection)NFNNN) rV rZ r[ r\ r~ r6 r4 r� r� ru r3 r� r r8 r r� r� r� r� ra r� r� r� r� r� r_ r� r� r� r� r1 r1 )rE r2 r� s> # ( C r� c s� �j j��j ��fdd�� � ���fdd�}� ��fdd�}���fdd�}�rftj�d |d d d � ntj�d |d d d � tj�d |d d d � dS )z6Apply listeners to synchronize a two-way relationship.c s$ t dt| �|j|j� jjf ��d S )Nz�Bidirectional attribute conflict detected: Passing object %s to attribute "%s" triggers a modify event on attribute "%s" via the backref "%s".)r� r rr r& )� child_stater� � child_impl)rn r1 r2 �_acceptable_key_errl s z.backref_listeners.<locals>._acceptable_key_errc s ||kr |S |d k r~|t k r~|tk r~t|�t|� }}|j� j}|jsV|jsV|j}n|j }||k r~|j ||| � � �j t d� |d k �r t|�t|� }} |j� j} |j�k r�|j| jk rȈ | || � | j } | jr�| jnd } || k �r || k �r | j|| | � � |t d� |S )N)r: )r r r r r/ r& r� r� r� r� r� r� r� r rr r� r� ) rR �childZoldchildr� Z old_stateZold_dictr& Zcheck_recursive_tokenr� � child_dictr� �check_append_token�check_bulk_replace_token)r� r% � parent_implrr r1 r2 �"emit_backref_from_scalar_set_eventz sJ z=backref_listeners.<locals>.emit_backref_from_scalar_set_eventc s� |d kr d S t |�t|� }}|j� j}|j�k rL|j|jk rL� | ||� |j}|jr^|jnd }||k r�||k r�|j||| � � |t d� |S )N)r: ) r r r/ r& rr r� r� r� r� r� r )rR r� r� r� r� r� r� r� )r� r% rr r1 r2 �)emit_backref_from_collection_append_event� s$ zDbackref_listeners.<locals>.emit_backref_from_collection_append_eventc s� |d k r�|t k r�|tk r�t|�t|� }}|j� j}|js\|js\|j}|j }�oX�j }n|j}|jrn|j nd }d}||k r�||k r�|r�t � | j �j |�s�|j||| �� |td� d S )NF)r: )r r r r r/ r& r� r� r� r� r� r" Z has_dupesr� r% r� r� r ) rR r� r� r� r� r� Zcheck_remove_tokenZcheck_replace_tokenZcheck_for_dupes_on_remove)r% r� �uselistr1 r2 �)emit_backref_from_collection_remove_event� s2 zDbackref_listeners.<locals>.emit_backref_from_collection_remove_eventr� T)rm �rawr_ r� N)r& rr r �listen)rn r% r� r� r� r� r1 )r� rn r% r� rr r� r2 �backref_listeners^ s2 A - r� Z NO_HISTORYr� r� � unchanged�deletedc @ sp e Zd ZdZdd� ZeZdd� Zdd� Zdd � Zd d � Z d d � Z dd� Z e dd� �Z e dd� �Ze dd� �ZdS )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:`.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 C s | t kS )N)r� )r, r1 r1 r2 �__bool__C s zHistory.__bool__c C s t | jp| jp| j� S )zhReturn True if this :class:`.History` has no changes and no existing, unchanged state. )�boolr� r r )r, r1 r1 r2 �emptyH s z History.emptyc C s | j pg | jpg | jpg S )z3Return a collection of added + unchanged + deleted.)r� r r )r, r1 r1 r2 �sumP s z History.sumc C s | j pg | jpg S )z)Return a collection of added + unchanged.)r� r )r, r1 r1 r2 � non_deletedW s zHistory.non_deletedc C s | j pg | jpg S )z+Return a collection of unchanged + deleted.)r r )r, r1 r1 r2 � non_added\ s zHistory.non_addedc C s t | jp | j�S )z2Return True if this :class:`.History` has changes.)r r� r )r, r1 r1 r2 � has_changesa s zHistory.has_changesc C s0 t dd� | jD �dd� | jD �dd� | jD ��S )Nc S s g | ]}|d k rt |�pd �qS )N)r )r� r� r1 r1 r2 r� i s z$History.as_state.<locals>.<listcomp>c S s g | ]}|d k rt |�pd �qS )N)r )r� r� r1 r1 r2 r� m s c S s g | ]}|d k rt |�pd �qS )N)r )r� r� r1 r1 r2 r� q s )r� r� r r )r, r1 r1 r2 �as_statef s zHistory.as_statec C s� |j �|jt�}|tkr<|tkr,| ddd�S | d|gd�S nh|�||�dkrZ| d|gd�S t|�tkr|d}t|�tkr�d }n|g}|tkr�| dd|�S | |gd|�S d S )Nr1 T)r� rc r% � _NO_HISTORYr r| r� �_NO_STATE_SYMBOLS)rH rn rR r� r� r r1 r1 r2 r� v s z History.from_scalar_attributec C s� |j �|jt�}|tkrD|tks(|tkr4| ddd�S | d|gd�S nx||krb|tk rb| d|gd�S t|�tksv|d kr�d}t|�tkr�d }n|g}|tks�|tkr�| dd|�S | |gd|�S d S )Nr1 )r� rc r% r r r r� r )rH rn rR r� r� r r1 r1 r2 r� � s z History.from_object_attributec s� |j �|jt�}|tks |tkr,| ddd�S t|d�}|ttfkrR| t|�dd�S |tkrj| dt|�d�S dd� |D �}dd� |D �}t|�� t|��| �fdd�|D ��fdd�|D �� fdd�|D ��S d S ) Nr1 r� c S s$ g | ] }|d k rt |�pd |f�qS )N)r )r� r� r1 r1 r2 r� � s z+History.from_collection.<locals>.<listcomp>c S s$ g | ] }|d k rt |�pd |f�qS )N)r )r� r� r1 r1 r2 r� � s c s g | ]\}}|� kr|�qS r1 r1 )r� r� r� )r� r1 r2 r� � s c s g | ]\}}|� kr|�qS r1 r1 )r� r� r� )r� r1 r2 r� � s c s g | ]\}}|� kr|�qS r1 r1 )r� r� r� )r� r1 r2 r� � s ) r� rc r% r r r rS r� r� )rH rn rR r� r� r� r� r1 )r� r� r2 r� � s$ zHistory.from_collectionN)rV rZ r[ r\ r � __nonzero__r r r r r r � classmethodr� r� r� r1 r1 r1 r2 r� * s c C s> |dkrt �d� t}n|dkr.t �d� t}tt| �||�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" Zwarn_deprecatedr r �get_state_historyr )r� r% r: r1 r1 r2 r8 � s "r8 c C s | � ||�S )N)r8 )rR r% r: r1 r1 r2 r s r Fc C s t | �}t|�}|�|||�S )ZTODO)r r � has_parent)rH r� r% rP r/ rR r1 r1 r2 r s r c K sH |� dd �}|� dd �}|� dd �}t| ||||d�}t| |f|� |S )Nr' r- rk )rk )r� �register_descriptor�register_attribute_impl)r$ r% r� r' r- rk �descr1 r1 r2 �register_attribute s r c K s� t | �}|r*|�dd �} |�|| p$t�} n |�dd �} || j} |rX|| || | f|�} nJ|rxt| ||| fd| i|��} n*|r�t| ||| f|�} nt| ||| f|�} | || _|r�t || ||� |� |� || S )Nr� ) r r� Zinstrument_collection_classr� r* r� r� r� r& r� Zpost_configure_attribute) r$ r% r� rw Z useobjectZ impl_classZbackrefr� r/ �factoryr� r* r& r1 r1 r2 r s* r c C s. t | �}t| |||d�}||_|�||� |S )N)r' r- )r r^ r\ Zinstrument_attribute)r$ r% r' r- rk r/ rg r1 r1 r2 r I s r c C s t | ��|� d S )N)r Zuninstrument_attribute)r$ r% r1 r1 r2 �unregister_attributeX s r c C s 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 re r1 r1 r2 r� \ s r� c C s& | j | j}|�| |�}|�| ||�S )zDInitialize a collection attribute and return the collection adapter.)r/ r& r� r� )rR re r% r� r� r1 r1 r2 r s s r c C s, 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 r/ r& r� )r9 r% rC rR re r1 r1 r2 r� { s r� c C s. 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 r/ r& r_ )r9 r% rC r� rR re r1 r1 r2 � set_attribute� s r c C s& 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 r/ r& rc )r9 r% rR re r1 r1 r2 � get_attribute� s r c C s* 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 r/ r& ra )r9 r% rR re r1 r1 r2 � del_attribute� s r c C sD t | �t| � }}|j| j}|j�||j� |j||tdd� 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 r/ r& r* �modifiedr� r� r )r9 r% rR re r& r1 r1 r2 � flag_modified� s r c C s( t | �t| � }}|j|dtdd� 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` NT)r )r r r� r )r9 rR re r1 r1 r2 � flag_dirty� s r )F)FNFNN)NNN)N)Nr\ rz � r r r� r r0 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" Z_self_inspectsZ_MappedAttributeZInspectionAttrZPropComparatorr# r^ rp �symbolr� r� r� r� r� �objectrq rv r� r� r� r� r � frozensetr� r � namedtupler� r� r8 r r r r r r r� r r� r r r r r r1 r1 r1 r2 �<module> s� J x 2 FU ( R E + 2 &