Edit File: descriptor_props.cpython-37.pyc
B ��4])n � @ s4 d Z ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlm Z dd lm Z dd lm Z dd lm Z dd lmZ dd lmZ ddlmZ G dd� de�Zejjddd�G dd� de��Zejjddd�G dd� de��Zejjddd�G dd� de��Zejjddd�e�dd�G d d � d e���Zd S ) z�Descriptor properties are more "auxiliary" properties that exist as configurational elements, but don't participate as actively in the load/persist ORM loop. � )� attributes)� properties)�query)�MapperProperty)�PropComparator)� _none_set� )�event)�exc)�schema)�sql)�util)� expressionc @ s e Zd ZdZdZdd� ZdS )�DescriptorPropertyzS:class:`.MapperProperty` which proxies access to a user-defined descriptor.Nc s� ��G � �fdd�dt �}�jd krDt� j�jd �}� �|�rD|�_�jd kr��fdd�}�fdd�}�fdd�}t|||d ��_t��j��j j�j�j� �fd d ��j �d �}|�j�|_ � j � �j|� d S ) Nc sN e Zd ZdZdZdZe� �fdd��Zdd� Ze �d�rJe j f�fdd � Z d S ) z7DescriptorProperty.instrument_class.<locals>._ProxyImplFTc s t � j�j�jjS )N)�getattr�class_�name�impl� uses_objects)�self)�mapper�prop� �R/opt/alt/python37/lib64/python3.7/site-packages/sqlalchemy/orm/descriptor_props.pyr * s zDDescriptorProperty.instrument_class.<locals>._ProxyImpl.uses_objectsc S s || _ d S )N)�key)r r r r r �__init__. s z@DescriptorProperty.instrument_class.<locals>._ProxyImpl.__init__� get_historyc s � � |||�S )N)r )r �state�dict_�passive)r r r r 3 s zCDescriptorProperty.instrument_class.<locals>._ProxyImpl.get_historyN) �__name__� __module__� __qualname__Zaccepts_scalar_loaderZexpire_missingZ collection�propertyr r �hasattrr � PASSIVE_OFFr r )r r r r � _ProxyImpl% s r& c s t | � j|� d S )N)�setattrr )�obj�value)r r r �fset? s z1DescriptorProperty.instrument_class.<locals>.fsetc s t | � j� d S )N)�delattrr )r( )r r r �fdelB s z1DescriptorProperty.instrument_class.<locals>.fdelc s t | � j�S )N)r r )r( )r r r �fgetE s z1DescriptorProperty.instrument_class.<locals>.fget)r- r* r, c s �� � �S )N)�_comparator_factoryr )r r r r �<lambda>N � z5DescriptorProperty.instrument_class.<locals>.<lambda>)�docZoriginal_property)�object� descriptorr r r Z_is_userland_descriptorr# r Zcreate_proxied_attribute�parentr1 r Z class_managerZinstrument_attribute)r r r& �descr* r, r- Z proxy_attrr )r r r r �instrument_class" s( z#DescriptorProperty.instrument_class)r r! r" �__doc__r1 r6 r r r r r s r zsqlalchemy.orm.propertiesT)Z add_to_allc s� e Zd ZdZejdd�� fdd��Z� fdd�Zdd � Zd d � Z ej d d � �Z ej dd� �Z e dd� �Zdd� Zdd� Zej dd� �Zejfdd�Zdd� ZG d d � d ej�ZG d d � d e�Zd d!� Z� Z S )"�CompositePropertyz�Defines a "composite" mapped attribute, representing a collection of columns as one attribute. :class:`.CompositeProperty` is constructed using the :func:`.composite` function. .. seealso:: :ref:`mapper_composite` )z0.7z�:class:`.AttributeExtension` is deprecated in favor of the :class:`.AttributeEvents` listener interface. The :paramref:`.composite.extension` parameter will be removed in a future release.)� extensionc s� t t| ��� || _|| _|�dd�| _|�dd�| _|�dd�| _|� d| j j �| _ d|krj|� d�| _ t�| � | �� dS )aQ Return a composite column-based property for use with a Mapper. See the mapping documentation section :ref:`mapper_composite` for a full usage example. The :class:`.MapperProperty` returned by :func:`.composite` is the :class:`.CompositeProperty`. :param class\_: The "composite type" class, or any classmethod or callable which will produce a new instance of the composite object given the column values in order. :param \*cols: List of Column objects to be mapped. :param active_history=False: When ``True``, indicates that the "previous" value for a scalar attribute should be loaded when replaced, if not already loaded. See the same flag on :func:`.column_property`. :param group: A group name for this property when marked as deferred. :param deferred: When True, the column property is "deferred", meaning that it does not load immediately, and is instead loaded when the attribute is first accessed on an instance. See also :func:`~sqlalchemy.orm.deferred`. :param comparator_factory: a class which extends :class:`.CompositeProperty.Comparator` which provides custom SQL clause generation for comparison operations. :param doc: optional string that will be applied as the doc on the class-bound descriptor. :param info: Optional data dictionary which will be populated into the :attr:`.MapperProperty.info` attribute of this object. :param extension: an :class:`.AttributeExtension` instance, or list of extensions, which will be prepended to the list of attribute listeners for the resulting descriptor placed on the class. �active_historyF�deferred�groupN�comparator_factory�info)�superr8 r �attrs�composite_class�getr: r; r< �pop� __class__� Comparatorr= r> r �set_creation_order�_create_descriptor)r r r@ �kwargs)rD r r r d s : zCompositeProperty.__init__c s t t| ��|� | �� d S )N)r? r8 r6 �_setup_event_handlers)r r )rD r r r6 � s z"CompositeProperty.instrument_classc C s | � � dS )zInitialization which occurs after the :class:`.CompositeProperty` has been associated with its parent mapper. N)�_setup_arguments_on_columns)r r r r �do_init� s zCompositeProperty.do_initc s6 � fdd�}� fdd�}� fdd�}t |||�� _dS )ztCreate the Python descriptor that will serve as the access point on instances of the mapped class. c s� t �� �}t �� �}�j|krv� fdd��jD �}�j|krv|jd k sPt�|�sv�j|� |�j< |jj � |d �jg� |� �jd �S )Nc s g | ]}t � |��qS r )r )�.0r )�instancer r � <listcomp>� s zFCompositeProperty._create_descriptor.<locals>.fget.<locals>.<listcomp>) r � instance_dict�instance_stater �_attribute_keysr � issupersetrA �manager�dispatch�refreshrB )rM r r �values)r )rM r r- � s z2CompositeProperty._create_descriptor.<locals>.fgetc s� t �| �}t �| �}|j� j }|�� jt j�}x |jjD ]}|||||j �}q:W ||� j< |d kr�xF� j D ]}t | |d � qlW n*x(t � j |� � �D ]\}}t | ||� q�W d S )N)r rO rP rS r rB �NO_VALUErT �setr rQ r' �zip�__composite_values__)rM r) r r �attr�previous�fnr )r r r r* � s z2CompositeProperty._create_descriptor.<locals>.fsetc sb t �| �}t �| �}|�� jt j�}|j� j }|j�|||j � x� j D ]}t | |d � qJW d S )N) r rP rO rC r rW rS rT �remover rQ r' )rM r r r\ r[ r )r r r r, � s z2CompositeProperty._create_descriptor.<locals>.fdelN)r# r3 )r r- r* r, r )r r rG � s z$CompositeProperty._create_descriptorc s � fdd�� j D �S )Nc s g | ]}t � jj|j��qS r )r r4 r r )rL r )r r r rN � s z:CompositeProperty._comparable_elements.<locals>.<listcomp>)�props)r r )r r �_comparable_elements� s z&CompositeProperty._comparable_elementsc C s| g }xr| j D ]h}t|t�r,| jj|dd�}n>t|tj�rF| jj| }n$t|tj �rZ|j }nt � d|f ��|� |� q W |S )NF)Z_configure_mappersz[Composite expects Column objects or mapped attributes/attribute names as arguments, got: %r)r@ � isinstance�strr4 Z get_propertyr �Column�_columntopropertyr ZInstrumentedAttributer# �sa_exc� ArgumentError�append)r r_ r[ r r r r r_ � s zCompositeProperty.propsc C s dd� | j D �S )Nc S s g | ]}t |tj�r|�qS r )ra r rc )rL �ar r r rN s z-CompositeProperty.columns.<locals>.<listcomp>)r@ )r r r r �columns s zCompositeProperty.columnsc C s8 x2| j D ](}| j|_| jr(| j|_d|_| j|_qW dS )zwPropagate configuration arguments made on this composite to the target columns, for those that apply. ))r; T)Z instrumentTN)r_ r: r; Z strategy_keyr< )r r r r r rJ s z-CompositeProperty._setup_arguments_on_columnsc s� � fdd�}� fdd�}�fdd�� �fdd�}�fd d �}t j�jd |d d � t j�jd|d d � t j�jd|d d d� t j�jd|d d d� t j�jd|d d d� dS )z>Establish events that populate/expire the composite attribute.c s � | |dd� d S )NF)� is_refreshr )r �args)�_load_refresh_handlerr r � load_handler s z=CompositeProperty._setup_event_handlers.<locals>.load_handlerc s � | |dd� d S )NT)rj r )r rk )rl r r �refresh_handler! s z@CompositeProperty._setup_event_handlers.<locals>.refresh_handlerc sX � j }|s�j|krd S x�jD ]}||kr d S q W �j� fdd��jD �� |�j< d S )Nc s g | ]}� j | �qS r )�dict)rL r )r r r rN 2 s zZCompositeProperty._setup_event_handlers.<locals>._load_refresh_handler.<locals>.<listcomp>)ro r rQ rA )r rk rj r �k)r )r r rl $ s zFCompositeProperty._setup_event_handlers.<locals>._load_refresh_handlerc s, |d kst � j��|�r(| j�� jd � d S )N)rX rQ � intersectionro rC r )r �keys)r r r �expire_handler5 s z?CompositeProperty._setup_event_handlers.<locals>.expire_handlerc s |j �� jd� dS )z�After an insert or update, some columns may be expired due to server side defaults, or re-populated due to client side defaults. Pop out the composite value here so that it recreates. N)ro rC r )r Z connectionr )r r r �insert_update_handler9 s zFCompositeProperty._setup_event_handlers.<locals>.insert_update_handlerZ after_insertT)�rawZ after_update�load)ru � propagaterU ZexpireN)r �listenr4 )r rm rn rs rt r )rl r r rI s z'CompositeProperty._setup_event_handlersc C s dd� | j D �S )Nc S s g | ] }|j �qS r )r )rL r r r r rN W s z5CompositeProperty._attribute_keys.<locals>.<listcomp>)r_ )r r r r rQ U s z!CompositeProperty._attribute_keysc C s� g }g }d}xt| j D ]j}|j}|j| j�||�} | �� r>d}| �� } | rV|�| � n |�d� | j rt|�| j � q|�d� qW |r�t � | j |� gd| j |� g�S t � d| j |� gd�S dS )z>Provided for userland code that uses attributes.get_history().FTNr ) r_ r rS r r Z has_changes� non_deleted�extendrg �deletedr ZHistoryrA ) r r r r Zaddedr{ Z has_historyr r Zhistry r r r r Y s* z CompositeProperty.get_historyc C s | � | |�S )N)r= )r r r r r r. y s z%CompositeProperty._comparator_factoryc s$ e Zd Z� fdd�Zdd� Z� ZS )z!CompositeProperty.CompositeBundlec s$ || _ ttj| �j|jf|�� d S )N)r# r? r8 �CompositeBundler r )r Z property_�expr)rD r r r } s z*CompositeProperty.CompositeBundle.__init__c s � �fdd�}|S )Nc s �j j� fdd��D �� S )Nc s g | ] }|� ��qS r r )rL �proc)�rowr r rN � s zXCompositeProperty.CompositeBundle.create_row_processor.<locals>.proc.<locals>.<listcomp>)r# rA )r )�procsr )r r r~ � s zDCompositeProperty.CompositeBundle.create_row_processor.<locals>.procr )r r r� �labelsr~ r )r� r r �create_row_processor� s z6CompositeProperty.CompositeBundle.create_row_processor)r r! r" r r� � __classcell__r r )rD r r| | s r| c @ sV e Zd ZdZdZedd� �Zdd� Zdd� Zd d � Z e j d d � �Z d d� Z dd� ZdS )z CompositeProperty.Comparatora� Produce boolean, comparison, and other operators for :class:`.CompositeProperty` attributes. See the example in :ref:`composite_operations` for an overview of usage , as well as the documentation for :class:`.PropComparator`. .. seealso:: :class:`.PropComparator` :class:`.ColumnOperators` :ref:`types_operators` :attr:`.TypeEngine.comparator_factory` Nc C s | � � S )N)�__clause_element__)r r r r �clauses� s z$CompositeProperty.Comparator.clausesc C s t j| jddi�S )Nr< F)r Z ClauseListr` )r r r r r� � s z/CompositeProperty.Comparator.__clause_element__c C s t �| j| �� �S )N)r8 r| r r� )r r r r �_query_clause_element� s z2CompositeProperty.Comparator._query_clause_elementc C sT |d kr dd� | j jD �}n,t|| j j�r4|�� }nt�d| j |f ��t| j|�S )Nc S s g | ]}d �qS )Nr )rL r r r r rN � s zDCompositeProperty.Comparator._bulk_update_tuples.<locals>.<listcomp>z)Can't UPDATE composite attribute %s to %r) r rQ ra rA rZ re rf rY r` )r r) rV r r r �_bulk_update_tuples� s z0CompositeProperty.Comparator._bulk_update_tuplesc s( � j r � fdd�� jjD �S � jjS d S )Nc s g | ]}t � jj|j��qS r )r �_adapt_to_entity�entityr )rL r )r r r rN � s zECompositeProperty.Comparator._comparable_elements.<locals>.<listcomp>)r� r r` )r r )r r r` � s z1CompositeProperty.Comparator._comparable_elementsc s^ |d kr d gt � jj� }n|�� }dd� t� jj|�D �}� jrT� fdd�|D �}tj|� S )Nc S s g | ]\}}||k�qS r r )rL rh �br r r rN � s z7CompositeProperty.Comparator.__eq__.<locals>.<listcomp>c s g | ]}� � |��qS r )Zadapter)rL �x)r r r rN � s )�lenr r` rZ rY r� r �and_)r �otherrV Z comparisonsr )r r �__eq__� s z#CompositeProperty.Comparator.__eq__c C s t �| �|��S )N)r �not_r� )r r� r r r �__ne__� s z#CompositeProperty.Comparator.__ne__)r r! r" r7 �__hash__r# r� r� r� r� r �memoized_propertyr` r� r� r r r r rE � s rE c C s t | jjj�d | j S )N�.)rb r4 r r r )r r r r �__str__� s zCompositeProperty.__str__) r r! r" r7 r Zdeprecated_paramsr r6 rK rG r� r` r_ r# ri rJ rI rQ r r% r r. r ZBundler| r rE r� r� r r )rD r r8 V s" H ; : Ir8 c s( e Zd ZdZdd� Z� fdd�Z� ZS )�ConcreteInheritedPropertya4 A 'do nothing' :class:`.MapperProperty` that disables an attribute on a concrete subclass that is only present on the inherited mapper, not the concrete classes' mapper. Cases where this occurs include: * When the superclass mapper is mapped against a "polymorphic union", which includes all attributes from all subclasses. * When a relationship() is configured on an inherited mapper, but not on the subclass mapper. Concrete mappers require that relationship() is configured explicitly on each subclass. c C s: d }x0| j �� D ]"}|j| j }t|t�s|j}P qW |S )N)r4 Ziterate_to_rootZ_propsr ra r� r= )r r Zcomparator_callable�m�pr r r r. � s z-ConcreteInheritedProperty._comparator_factoryc s< t t� ��� � fdd��G � �fdd�dt�}|� � _d S )Nc s t d� j� j� jf ��d S )NzgConcrete %s does not implement attribute %r at the instance level. Add this property explicitly to %s.)�AttributeErrorr4 r r )r r r �warn� s z0ConcreteInheritedProperty.__init__.<locals>.warnc s2 e Zd Z�fdd�Z�fdd�Z� �fdd�ZdS )zDConcreteInheritedProperty.__init__.<locals>.NoninheritedConcretePropc s � � d S )Nr )�sr( r) )r� r r �__set__ s zLConcreteInheritedProperty.__init__.<locals>.NoninheritedConcreteProp.__set__c s � � d S )Nr )r� r( )r� r r � __delete__ s zOConcreteInheritedProperty.__init__.<locals>.NoninheritedConcreteProp.__delete__c s |d kr� j S �� d S )N)r3 )r� r( �owner)r r� r r �__get__ s zLConcreteInheritedProperty.__init__.<locals>.NoninheritedConcreteProp.__get__N)r r! r" r� r� r� r )r r� r r �NoninheritedConcreteProp� s r� )r? r� r r2 r3 )r r� )rD )r r� r r � s z"ConcreteInheritedProperty.__init__)r r! r" r7 r. r r� r r )rD r r� � s r� c sD e Zd Zd � fdd� Zejdd� �Zdd� Zdd � Zd d � Z � Z S ) �SynonymPropertyNc sR t t| ��� || _|| _|| _|| _|p6|r4|jp6d| _|rD|| _ t � | � dS )a} Denote an attribute name as a synonym to a mapped property, in that the attribute will mirror the value and expression behavior of another attribute. e.g.:: class MyClass(Base): __tablename__ = 'my_table' id = Column(Integer, primary_key=True) job_status = Column(String(50)) status = synonym("job_status") :param name: the name of the existing mapped property. This can refer to the string name ORM-mapped attribute configured on the class, including column-bound attributes and relationships. :param descriptor: a Python :term:`descriptor` that will be used as a getter (and potentially a setter) when this attribute is accessed at the instance level. :param map_column: **For classical mappings and mappings against an existing Table object only**. if ``True``, the :func:`.synonym` construct will locate the :class:`.Column` object upon the mapped table that would normally be associated with the attribute name of this synonym, and produce a new :class:`.ColumnProperty` that instead maps this :class:`.Column` to the alternate name given as the "name" argument of the synonym; in this way, the usual step of redefining the mapping of the :class:`.Column` to be under a different name is unnecessary. This is usually intended to be used when a :class:`.Column` is to be replaced with an attribute that also uses a descriptor, that is, in conjunction with the :paramref:`.synonym.descriptor` parameter:: my_table = Table( "my_table", metadata, Column('id', Integer, primary_key=True), Column('job_status', String(50)) ) class MyClass(object): @property def _job_status_descriptor(self): return "Status: %s" % self._job_status mapper( MyClass, my_table, properties={ "job_status": synonym( "_job_status", map_column=True, descriptor=MyClass._job_status_descriptor) } ) Above, the attribute named ``_job_status`` is automatically mapped to the ``job_status`` column:: >>> j1 = MyClass() >>> j1._job_status = "employed" >>> j1.job_status Status: employed When using Declarative, in order to provide a descriptor in conjunction with a synonym, use the :func:`sqlalchemy.ext.declarative.synonym_for` helper. However, note that the :ref:`hybrid properties <mapper_hybrids>` feature should usually be preferred, particularly when redefining attribute behavior. :param info: Optional data dictionary which will be populated into the :attr:`.InspectionAttr.info` attribute of this object. .. versionadded:: 1.0.0 :param comparator_factory: A subclass of :class:`.PropComparator` that will provide custom comparison behavior at the SQL expression level. .. note:: For the use case of providing an attribute which redefines both Python-level and SQL-expression level behavior of an attribute, please refer to the Hybrid attribute introduced at :ref:`mapper_hybrids` for a more effective technique. .. seealso:: :ref:`synonyms` - Overview of synonyms :func:`.synonym_for` - a helper oriented towards Declarative :ref:`mapper_hybrids` - The Hybrid Attribute extension provides an updated approach to augmenting attribute behavior more flexibly than can be achieved with synonyms. N) r? r� r r � map_columnr3 r= r7 r1 r> r rF )r r r� r3 r= r1 r> )rD r r r s lzSynonymProperty.__init__c C sH t | jj| j�}t|d�r&t|jt�sBt� d| jjj | j|f ��|jS )Nr# zGsynonym() attribute "%s.%s" only supports ORM mapped attributes, got %r) r r4 r r r$ ra r# r re ZInvalidRequestErrorr )r r[ r r r �_proxied_property� s z!SynonymProperty._proxied_propertyc C s* | j }| jr| �||�}n |�||�}|S )N)r� r= )r r r �compr r r r. � s z#SynonymProperty._comparator_factoryc O s t | jj| j�}|jj||�S )N)r r4 r r r r )r �arg�kwr[ r r r r � s zSynonymProperty.get_historyc C s� | j r�| j|jjkr2t�d| j|jj| jf ��nN|jj| j |jkr�|j|jj| j j| jkr�t�d| j| j| j| jf ��t � |jj| j �}|j | j||dd� | j|_ || _ d S )Nz>Can't compile synonym '%s': no column on table '%s' named '%s'zpCan't call map_column=True for synonym %r=%r, a ColumnProperty already exists keyed to the name %r for column %rT)�initZ setparent)r� r Zpersist_selectable�cre rf r � descriptionrd r ZColumnPropertyZ_configure_propertyZ_mapped_by_synonymr4 )r r4 r� r� r r r � set_parent� s( zSynonymProperty.set_parent)NNNNN) r r! r" r r r� r� r. r r� r� r r )rD r r� s t r� z0.7z�:func:`.comparable_property` is deprecated and will be removed in a future release. Please refer to the :mod:`~sqlalchemy.ext.hybrid` extension.c s* e Zd ZdZd� fdd� Zdd� Z� ZS )�ComparablePropertyz;Instruments a Python property for use in query expressions.Nc sF t t| ��� || _|| _|p*|r(|jp*d| _|r8|| _t� | � dS )a� Provides a method of applying a :class:`.PropComparator` to any Python descriptor attribute. Allows any Python descriptor to behave like a SQL-enabled attribute when used at the class level in queries, allowing redefinition of expression operator behavior. In the example below we redefine :meth:`.PropComparator.operate` to wrap both sides of an expression in ``func.lower()`` to produce case-insensitive comparison:: from sqlalchemy.orm import comparable_property from sqlalchemy.orm.interfaces import PropComparator from sqlalchemy.sql import func from sqlalchemy import Integer, String, Column from sqlalchemy.ext.declarative import declarative_base class CaseInsensitiveComparator(PropComparator): def __clause_element__(self): return self.prop def operate(self, op, other): return op( func.lower(self.__clause_element__()), func.lower(other) ) Base = declarative_base() class SearchWord(Base): __tablename__ = 'search_word' id = Column(Integer, primary_key=True) word = Column(String) word_insensitive = comparable_property(lambda prop, mapper: CaseInsensitiveComparator( mapper.c.word, mapper) ) A mapping like the above allows the ``word_insensitive`` attribute to render an expression like:: >>> print SearchWord.word_insensitive == "Trucks" lower(search_word.word) = lower(:lower_1) :param comparator_factory: A PropComparator subclass or factory that defines operator behavior for this property. :param descriptor: Optional when used in a ``properties={}`` declaration. The Python descriptor or property to layer comparison behavior on top of. The like-named descriptor will be automatically retrieved from the mapped class if left blank in a ``properties`` declaration. :param info: Optional data dictionary which will be populated into the :attr:`.InspectionAttr.info` attribute of this object. .. versionadded:: 1.0.0 N) r? r� r r3 r= r7 r1 r> r rF )r r= r3 r1 r> )rD r r r � s BzComparableProperty.__init__c C s | � | |�S )N)r= )r r r r r r. s z&ComparableProperty._comparator_factory)NNN)r r! r" r7 r r. r� r r )rD r r� � s Ir� N)r7 � r r r Z interfacesr r r r r r re r r r r Z langhelpersZdependency_forr8 r� r� Zdeprecated_clsr� r r r r �<module> s8 : 5 ;