Edit File: strategy_options.cpython-37.pyc
B ��4]�� � @ s d Z ddlmZ ddlmZ ddlmZ ddlmZ ddlm Z ddlm Z ddl m Z dd l m Z dd lmZ dd lmZ dd lmZ dd lmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlm Z G dd� de e �Z G dd� de �Z G dd� de �Z e � dRd d ��Z!e!j"d d � �Z!e � d d � �Z#e#j"d!d � �Z#e � dSd"d#��Z$e$j"d$d#� �Z$e$j%d%d&� �Z&e � d'd(� �Z'e'j"d)d(� �Z'e'j%d*d+� �Z(e � d,d-� �Z)e)j"d.d-� �Z)e)j%d/d0� �Z*e � d1d2� �Z+e+j"d3d2� �Z+e+j%d4d5� �Z,e � d6d7� �Z-e-j"d8d7� �Z-e � d9d:� �Z.e.j"d;d:� �Z.e � dTd=d>��Z/e/j"d?d>� �Z/e � d@dA� �Z0e0j"dBdA� �Z0e � dCdD� �Z1e1j"dEdD� �Z1e � dFdG� �Z2e2j"dHdG� �Z2e � dIdJ� �Z3e3j"dKdJ� �Z3e � dLdM� �Z4e4j"dNdM� �Z4e � dOdP� �Z5e5j"dQdP� �Z5dS )Uz � )�util)�QueryableAttribute)�_class_to_mapper)�_is_aliased_class)�_is_mapped_class)�InspectionAttr)� MapperOption)�PropComparator)�_DEFAULT_TOKEN)�_WILDCARD_TOKEN)� PathRegistry)� TokenRegistry)�_orm_full_deannotate� )�exc)�inspect)� expression)� _generative)� Generativec s� e Zd ZdZdd� Zedd� �Zdd� Z� fdd �Zd Z d Z d Z d Z d d � Z dd� Zdd� Zd/dd�Zdd� Zdd� Zdd� Zedd � �Zed0d d ��Zed1d d ��Zed!d"� �Zed#d$� �Zd2d%d&�Zd'd(� Zd)d*� Z d+d,� Z d-d.� Z � Z S )3�Loadaq Represents loader options which modify the state of a :class:`.Query` in order to affect how various mapped attributes are loaded. The :class:`.Load` object is in most cases used implicitly behind the scenes when one makes use of a query option like :func:`.joinedload`, :func:`.defer`, or similar. However, the :class:`.Load` object can also be used directly, and in some cases can be useful. To use :class:`.Load` directly, instantiate it with the target mapped class as the argument. This style of usage is useful when dealing with a :class:`.Query` that has multiple entities:: myopt = Load(MyClass).joinedload("widgets") The above ``myopt`` can now be used with :meth:`.Query.options`, where it will only take effect for the ``MyClass`` entity:: session.query(MyClass, MyOtherClass).options(myopt) One case where :class:`.Load` is useful as public API is when specifying "wildcard" options that only take effect for a certain class:: session.query(Order).options(Load(Order).lazyload('*')) Above, all relationships on ``Order`` will be lazy-loaded, but other attributes on those descendant objects will load using their normal loader strategy. .. seealso:: :ref:`deferred_options` :ref:`deferred_loading_w_multiple` :ref:`relationship_loader_options` c C s0 t |�}|j| _t�� | _i | _d | _d| _d S )NF) r Z_path_registry�pathr � OrderedDict�context� local_opts�_of_type�is_class_strategy)�self�entityZinsp� r �R/opt/alt/python37/lib64/python3.7/site-packages/sqlalchemy/orm/strategy_options.py�__init__H s z Load.__init__c C s& | � | �}||_i |_i |_d |_|S )N)�__new__r r r r )�clsr �loadr r r �for_existing_pathR s zLoad.for_existing_pathc s� |j d jrdS g }�xV| j�� D �]F\\}}� |dkr:q"�x,t| j j |�D ]\}}||k rLP qLW � jpr� j j d }| �||�}|d ks"|s�� js�q"g } xX|D ]P} t| tj �r�| � | � q�| jr�dS | j r�| � | j � q�| j s�t�| � | j� q�W | �r|| d k�r(|j �r | � |j� n |j�r(dS |� t| �� j�p<d � j�rbt� fdd�t� j�D ��nd � q"W |�sxd S t|�S d S )N� F�loader���r c s g | ]}|� j | f�qS r )r )�.0�key)�objr r � <listcomp>� s z,Load._generate_cache_key.<locals>.<listcomp>)r �is_aliased_classr �items�zipr � _chop_path� isinstancer � string_types�appendZ is_propertyr) � is_mapper�AssertionError�class_�tuple�strategyr �sorted) r r � serializedr) Z loader_path� local_elemZobj_elemZendpointZchoppedZserialized_path�tokenr )r* r �_generate_cache_key[ sL $ zLoad._generate_cache_keyc s t t| ��� }i |_|S )N)�superr � _generater )r �cloned)� __class__r r r> � s zLoad._generateFNc C s | � |d� d S )NT)�_process)r �queryr r r � process_query� s zLoad.process_queryc C s | � |d� d S )NF)rA )r rB r r r �process_query_conditionally� s z Load.process_query_conditionallyc C s\ |j }|rJxL| j�� D ].\\}}}| �||�}|d k r||j||f< qW n|j�| j� d S )N)� _current_pathr r- r/ � _attributes�update)r rB �raiseerr� current_pathr; � start_pathr& Zchopped_start_pathr r r rA � s z Load._processTc C s� | j }d | _ |r>|js>t|t�r,t�d��nt�d|jf ��t|tj��r|� t �}|� t �sd|r�|rnd| _ |r~d||f }|r�|j s�|j| }|�|�}|| _|S |r�t|�}n|j}yt|j|�}W n0 tk r� |r�t�d||f ��nd S Y n X |j }} || }�nHt|��rTt�|j|d ��sZ|�rLt�d||jf ��nd S �n|j } } t�|j|d ��s�|�r�t�d||jt|�d k�r�|jj�r�|jj �r�d |d |jj f nd f ��nd S t|d d ��rR|j } t| � } } |j | � | j d�}| j �s(tj | j!j"| j!dd|d�} t| �} |j | �#| j d| � || | }| | _ n|| }|d k �rn| �$|� |j�r||j }|| _|S )Nz3Wildcard token cannot be followed by another entityz7Mapped attribute '%s' does not refer to a mapped entityFz%s:%sz3Can't find property named "%s" on %s in this Query.r' z.Attribute '%s' does not link from element '%s'z1Attribute "%s" does not link from element "%s".%sr z% Did you mean to use %s.of_type(%s)?���� r Zpath_with_polymorphicT)�aliasedZ_use_mapper_pathZ_existing_alias)%r � has_entityr0 r �sa_exc� ArgumentError�propr r1 �endswithr r �propagate_to_loadersr, �parentr; r r r �getattrr5 �AttributeError�propertyr �orm_utilZ$_entity_corresponds_to_use_path_impl�lenr3 �__name__Z entity_path�getr Zwith_polymorphic�mapperZ base_mapper�setZ _get_strategy)r r �attr� for_strategy� wildcard_keyrH Zexisting_of_typeZ default_token�entZfound_propertyrQ ZacZext_infoZ of_type_info�existingr r r �_generate_path� s� zLoad._generate_pathc C s d| j f S )NzLoad(strategy=%r))r7 )r r r r �__str__> s z Load.__str__c C s |d k rt t|�� ��}|S )N)r6 r8 r- )r r7 r r r � _coerce_stratA s zLoad._coerce_stratc C s t d��d S )NzHOnly 'unbound' loader options may be used with the Load.options() method)�NotImplementedError)r rT �applied�boundr r r �_apply_to_parentF s zLoad._apply_to_parentc G s< i }t | t� }|r td��x|D ]}|�| ||� q"W dS )am Apply a series of options as sub-options to this :class:`.Load` object. E.g.:: query = session.query(Author) query = query.options( joinedload(Author.book).options( load_only("summary", "excerpt"), joinedload(Book.citations).options( joinedload(Citation.author) ) ) ) :param \*opts: A series of loader option objects (ultimately :class:`.Load` objects) which should be applied to the path specified by this :class:`.Load` object. .. versionadded:: 1.3.6 .. seealso:: :func:`.defaultload` :ref:`relationship_loader_options` :ref:`deferred_loading_w_multiple` zMThe options() method is currently only supported for 'unbound' loader optionsN)r0 � _UnboundLoadrf ri )r �optsZ apply_cacherh �optr r r �optionsL s z Load.optionsc C sB | � |�}d| _|| _| �| j||d� || _|d k r>| �� d S )NFZ relationship)re r rS rc r r7 �_set_path_strategy)r r^ r7 rS r r r �set_relationship_strategyv s z Load.set_relationship_strategyc C sp | � |�}d| _xT|D ]L}| �� }||_|�| j||d� d|_|rP|j�|� |rZd|_ |� � qW d| _d S )NF�columnT) re r r> r7 rc r rS r rG � is_opts_onlyrn )r �attrsr7 rk � opts_onlyr^ r? r r r �set_column_strategy� s zLoad.set_column_strategyc C sP | � |�}x@|D ]8}| �| j||d �}| �� }||_||_d|_|�� qW d S )NT)re rc r r> r7 rS rn )r rr r7 r^ r r? r r r �set_generic_strategy� s zLoad.set_generic_strategyc C sT | � |�}| �� }d|_|�| jd |d �}||_||_d|_|�� |j� |� d S )NT) re r> r rc r r7 rS rn r rG )r r7 rk r? r r r r �set_class_strategy� s zLoad.set_class_strategyc C sv |s|s>|� | jd�}|r.|r<|j�| j� qr|�|d| � n4|� | jd�}|�|d| � |rr|jrr| j�|j� d S )Nr& )r[ r r rG r] rq )r r r �replace� merge_optsrb r r r � _set_for_path� s zLoad._set_for_pathc C sh | j s| jjr| jj}n| j}|jrNx>|�� D ]}| j| j|d| jd� q.W n| j| j|d| jd� d S )NT)rw rx ) r r rN rT �is_token�generate_for_superclassesry r rq )r �effective_pathr r r r rn � s zLoad._set_path_strategyc C s | j �� }| j�� |d< |S )Nr )�__dict__�copyr � serialize)r �dr r r � __getstate__� s zLoad.__getstate__c C s | j �|� t�| j�| _d S )N)r} rG r Z deserializer )r �stater r r � __setstate__� s zLoad.__setstate__c C s� d}x�t t||j��D ]�\}\}}t|tj�rd|dkrH|�dt �rH|S |dtf krd||j krdd S ||krpqqt|t �r�|j r�|j r�|� |�r�qqd S qW ||d d � S )Nr' r% �:zrelationship:%sr ) � enumerater. r r0 r r1 rR r r r) r r3 �isa)r �to_chopr �i�c_tokenZp_tokenr r r r/ � s" zLoad._chop_path)T)T)NF)TF) rZ � __module__� __qualname__�__doc__r � classmethodr$ r< r> rq r r7 rS rC rD rA rc rd re ri r rm ro rt ru rv ry rn r� r� r/ � __classcell__r r )r@ r r s: & F * r c @ s� e Zd ZdZdd� ZdZdd� Zdd� Zd d � Zd d � Z d d� Z dd� Z dd� Z e dd� �Zdd� Zd dd�Zdd� Zdd � Zd d � Zd S )!rj a2 Represent a loader option that isn't tied to a root entity. The loader option will produce an entity-linked :class:`.Load` object when it is passed :meth:`.Query.options`. This provides compatibility with the traditional system of freestanding options, e.g. ``joinedload('x.y.z')``. c C s d| _ g | _i | _d S )Nr )r �_to_bindr )r r r r r s z_UnboundLoad.__init__Fc C s� d}xr| j D ]h}xbt| j|j�D ]\}}||k r P q W |�|jd gd d d�}|r |�|�}|dkrhdS |r ||7 }q W |s�d S |S d S )Nr r% F)r� r. r � _bind_loaderr< )r r r9 �valr: Zval_elemrl Zc_keyr r r r< s z _UnboundLoad._generate_cache_keyc C s | j �| � d S )N)r� r2 )r r r r rn s z _UnboundLoad._set_path_strategyc s� | � kr� | S | � � }|� | < | j|_| jr�| jd }t|tj�rd|�t�rd|�d�d d t }|� �j| jdd� || jd � |j | j ks�t �|j | j ks�t �|j| jks�t �� ��fdd�| jD �}�j|_|j�|� |j�| j� |S )Nr' r� r% c s h | ]}|� �� ���qS r )ri )r( �elem)rg rh rT r r � <setcomp>9 s z0_UnboundLoad._apply_to_parent.<locals>.<setcomp>)r> r7 r r0 r r1 rR r �splitr rc rS r4 r rq r� �extendr rG )r rT rg rh r? r^ Z new_to_bindr )rg rh rT r ri s* z _UnboundLoad._apply_to_parentc C sp |r6t |tj�r6|ttfkr6|tkr*d| _d||f }|rXt|d �rX| jsX|dd� }|rf||f }|| _|S )NFz%s:%sr' r% ) r0 r r1 r r rS r r r )r r r^ r_ r` r r r rc C s z_UnboundLoad._generate_pathc C s" | j �� }| j| jdd�|d< |S )NT)�filter_aliased_classr )r} r~ �_serialize_pathr )r r� r r r r� S s z_UnboundLoad.__getstate__c C s� g }xl|d D ]`}t |t�rdt|�dkr6|\}}d }n |\}}}t||�}|rX|�|�}|�|� q|�|� qW t|�|d< || _d S )Nr r )r0 r6 rY rU �of_typer2 r} )r r� �retr) r" Zpropkeyr� rQ r r r r� X s z_UnboundLoad.__setstate__c C sP |j d }x@| jD ]6}||kr|�|� |�dd� |jD �|j|j |� qW d S )NZ_unbound_load_dedupesc S s g | ] }|j �qS r )Z entity_zero)r( ra r r r r+ q s z)_UnboundLoad._process.<locals>.<listcomp>)rF r� �addr� Z_mapper_entitiesrE )r rB rH Zdedupesr� r r r rA k s z_UnboundLoad._processc sv t � }dd� � � fdd�|D �}x8|dd� D ](}|rF|||f|�}n |�|�}d|_q.W |||d f|�}d|_|S ) Nc S sH t | tj�r>| tkrtfS | �dt �r4| dd � } | �d�S | fS d S )N�.r )r0 r r1 r r � startswithr� )r) r r r � _split_key{ s z+_UnboundLoad._from_keys.<locals>._split_keyc s g | ]}� |�D ]}|�qqS r r )r( r) r; )r� r r r+ � s z+_UnboundLoad._from_keys.<locals>.<listcomp>r% r' TF)rj � defaultload�_is_chain_link)r" �meth�keysZchained�kwrl Z all_tokensr; r )r� r � _from_keysw s z_UnboundLoad._from_keysc C s� d}x�t t||�� ��D ]�\}\}\}}t|tj�rl|dkrN|�dt �rN|S |dtf kr�||j kr�d S qt|t �r|j |k s�|j |k r|j j r�|j �|�sd S qW |d7 }||d � S )Nr' r% r� zrelationship:%sr )r� r. �pairsr0 r r1 rR r r r) r rW � _parententityr3 r� )r r� r r� r� Zp_entityZp_propr r r r/ � s" z_UnboundLoad._chop_pathc C s� g }x�|D ]�}t |t�r`|rF|jrFt|j�jrF|�|jj|jd f� q�|�|jj|j|jf� q t |t �r�|�|jj|jd f� q |�|� q W |S )N) r0 r r r r, r2 Z _parentmapperr5 r) r )r r r� r� r; r r r r� � s z _UnboundLoad._serialize_pathc C s� | j }| jr |r ||d f7 }|r.| �||�}|s6dS |d }t|tj�rZ| �|||�}nRt|t�r~|j}| � |||j |�}n.| jr�t |�r�t |�}||kr�d}n t �d��|s�dS |} t| �} |dk r�|| _n| j}| j| _| j| _| j| _| j } | j�sFxHt|�D ]<\} }| �| j || t|�d k�r0| jndd|��sdS �qW | j�| j� | j�sp| j j�rp| j j} n| j } | j�r�xD| �� D ] } | j || | j | jd� �q�W n| j || | j | jd� | S )a] Convert from an _UnboundLoad() object into a Load() object. The _UnboundLoad() uses an informal "path" and does not necessarily refer to a lead entity as it may use string tokens. The Load() OTOH refers to a complete path. This method reconciles from a given Query into a Load. Example:: query = session.query(User).options( joinedload("orders").joinedload("items")) The above options will be an _UnboundLoad object along the lines of (note this is not the exact API of _UnboundLoad):: _UnboundLoad( _to_bind=[ _UnboundLoad(["orders"], {"lazy": "joined"}), _UnboundLoad(["orders", "items"], {"lazy": "joined"}), ] ) After this method, we get something more like this (again this is not exact API):: Load( User, (User, User.orders.property)) Load( User, (User, User.orders.property, Order, Order.items.property)) r% Nz6mapper option expects string key or list of attributesr )rw rx ) r r r/ r0 r r1 �_find_entity_basestringr rW � _find_entity_prop_comparatorr� r r rO rP r r r7 rq r� rc rY r rG rN rT rz r{ ry r� )r �entitiesrI r rH rJ r; r rQ Z path_elementr& r �idxr| r r r r� � sr $ z_UnboundLoad._bind_loaderc C s� t |�r|}nt|�}xn|D ]}t�||�r |S q W |r�t|�s^t�dt�t |��|f ��q�t�d|d� dd� |D ��f ��nd S d S )NzGQuery has only expression-based entities, which do not apply to %s "%s"z�Mapped attribute "%s" does not apply to any of the root entities in this query, e.g. %s. Please specify the full path from one of the root entities to the target attribute. z, c s s | ]}t |�V qd S )N)�str)r( �xr r r � <genexpr>^ s z<_UnboundLoad._find_entity_prop_comparator.<locals>.<genexpr>) r r rX Z_entity_corresponds_to�listrO rP r Zclsname_as_plain_name�type�join)r r� rQ r\ rH Z searchforra r r r r� G s z)_UnboundLoad._find_entity_prop_comparatorc C s� |� dt �rVtt|��dkrd|rdt�dd�dd� |D ��d�dd� |D ��f ��n|� t�rdd}x(|D ]}|S W |r�t�d |f ��nd S d S ) Nr� r z�Can't apply wildcard ('*') or load_only() loader option to multiple entities %s. Specify loader options for each entity individually, such as %s.z, c s s | ]}t |�V qd S )N)r� )r( ra r r r r� m s z7_UnboundLoad._find_entity_basestring.<locals>.<genexpr>c s s | ]}d | V qdS )zLoad(%s).some_option('*')Nr )r( ra r r r r� o s FzJQuery has only expression-based entities - can't find property named "%s".)rR r rY r� rO rP r� r )r r� r; rH ra r r r r� c s$ z$_UnboundLoad._find_entity_basestringN)F)rZ r� r� r� r r� r< rn ri rc r� r� rA r� r� r/ r� r� r� r� r r r r rj � s" # rj c @ s, e Zd Zdd� Zdd� Zdd� Zdd� Zd S ) � loader_optionc C s d S )Nr )r r r r r � s zloader_option.__init__c C s8 |j | _}|| _tt|�r(td| ��tt||� | S )Nz#Load class already has a %s method.)rZ �name�fn�hasattrr � TypeError�setattr)r r� r� r r r �__call__� s zloader_option.__call__c C s* || _ | jj}dd| ji | j_||_| S )Nz�Produce a new :class:`.Load` object with the :func:`.orm.%(name)s` option applied. See :func:`.orm.%(name)s` for usage examples. r� )Z _unbound_fnr� r� r� )r r� Zfn_docr r r �_add_unbound_fn� s z loader_option._add_unbound_fnc C s8 dd| j i |_tjddd| j i dd�|�}|| _| S )Nau Produce a standalone "all" option for :func:`.orm.%(name)s`. .. deprecated:: 0.9 The :func:`.%(name)s_all` function is deprecated, and will be removed in a future release. Please use method chaining with :func:`.%(name)s` instead, as in:: session.query(MyClass).options( %(name)s("someattribute").%(name)s("anotherattribute") ) r� z0.9z�The :func:`.%(name)s_all` function is deprecated, and will be removed in a future release. Please use method chaining with :func:`.%(name)s` insteadF)Z add_deprecation_to_docstring)r� r� r Z deprecatedZ_unbound_all_fn)r r� r r r �_add_unbound_all_fn� s z!loader_option._add_unbound_all_fnN)rZ r� r� r r� r� r� r r r r r� � s r� Nc C s` |dk r"t |t�s>t|�}|j}n t|dd�r>t|j�}|j}| j|ddidd�}||jd< |S )an Indicate that the given attribute should be eagerly loaded from columns stated manually in the query. This function is part of the :class:`.Load` interface and supports both method-chained and standalone operation. The option is used in conjunction with an explicit join that loads the desired rows, i.e.:: sess.query(Order).\ join(Order.user).\ options(contains_eager(Order.user)) The above query would join from the ``Order`` entity to its related ``User`` entity, and the returned ``Order`` objects would have the ``Order.user`` attribute pre-populated. :func:`.contains_eager` also accepts an `alias` argument, which is the string name of an alias, an :func:`~sqlalchemy.sql.expression.alias` construct, or an :func:`~sqlalchemy.orm.aliased` construct. Use this when the eagerly-loaded rows are to come from an aliased table:: user_alias = aliased(User) sess.query(Order).\ join((user_alias, Order.user)).\ options(contains_eager(Order.user, alias=user_alias)) When using :func:`.contains_eager` in conjunction with inherited subclasses, the :meth:`.RelationshipProperty.of_type` modifier should also be used in order to set up the pathing properly:: sess.query(Company).\ outerjoin(Company.employees.of_type(Manager)).\ options( contains_eager( Company.employees.of_type(Manager), alias=Manager) ) .. seealso:: :ref:`loading_toplevel` :ref:`contains_eager` Nr �lazy�joinedF)rS Zeager_from_alias)r0 r� r Z selectablerU r ro r )�loadoptr^ �alias�infoZotr? r r r �contains_eager� s 0 r� c O s t � �t j| d|�S )NT)rj r� r� )r� r� r r r r� � s c G s. | � |ddd��}|� dddd�ddi� |S )a� Indicate that for a particular entity, only the given list of column-based attribute names should be loaded; all others will be deferred. This function is part of the :class:`.Load` interface and supports both method-chained and standalone operation. Example - given a class ``User``, load only the ``name`` and ``fullname`` attributes:: session.query(User).options(load_only("name", "fullname")) Example - given a relationship ``User.addresses -> Address``, specify subquery loading for the ``User.addresses`` collection, but on each ``Address`` object load only the ``email_address`` attribute:: session.query(User).options( subqueryload("addresses").load_only("email_address") ) For a :class:`.Query` that has multiple entities, the lead entity can be specifically referred to using the :class:`.Load` constructor:: session.query(User, Address).join(User.addresses).options( Load(User).load_only("name", "fullname"), Load(Address).load_only("email_addres") ) .. versionadded:: 0.9.0 FT)�deferred� instrument�*Z undefer_pks)rt )r� rr r? r r r � load_only s "r� c G s t � j| � S )N)rj r� )rr r r r r� 0 s c C s& | � |ddi�}|dk r"||jd< |S )a Indicate that the given attribute should be loaded using joined eager loading. This function is part of the :class:`.Load` interface and supports both method-chained and standalone operation. examples:: # joined-load the "orders" collection on "User" query(User).options(joinedload(User.orders)) # joined-load Order.items and then Item.keywords query(Order).options( joinedload(Order.items).joinedload(Item.keywords)) # lazily load Order.items, but when Items are loaded, # joined-load the keywords collection query(Order).options( lazyload(Order.items).joinedload(Item.keywords)) :param innerjoin: if ``True``, indicates that the joined eager load should use an inner join instead of the default of left outer join:: query(Order).options(joinedload(Order.user, innerjoin=True)) In order to chain multiple eager joins together where some may be OUTER and others INNER, right-nested joins are used to link them:: query(A).options( joinedload(A.bs, innerjoin=False). joinedload(B.cs, innerjoin=True) ) The above query, linking A.bs via "outer" join and B.cs via "inner" join would render the joins as "a LEFT OUTER JOIN (b JOIN c)". When using older versions of SQLite (< 3.7.16), this form of JOIN is translated to use full subqueries as this syntax is otherwise not directly supported. The ``innerjoin`` flag can also be stated with the term ``"unnested"``. This indicates that an INNER JOIN should be used, *unless* the join is linked to a LEFT OUTER JOIN to the left, in which case it will render as LEFT OUTER JOIN. For example, supposing ``A.bs`` is an outerjoin:: query(A).options( joinedload(A.bs). joinedload(B.cs, innerjoin="unnested") ) The above join will render as "a LEFT OUTER JOIN b LEFT OUTER JOIN c", rather than as "a LEFT OUTER JOIN (b JOIN c)". .. note:: The "unnested" flag does **not** affect the JOIN rendered from a many-to-many association table, e.g. a table configured as :paramref:`.relationship.secondary`, to the target table; for correctness of results, these joins are always INNER and are therefore right-nested if linked to an OUTER join. .. versionchanged:: 1.0.0 ``innerjoin=True`` now implies ``innerjoin="nested"``, whereas in 0.9 it implied ``innerjoin="unnested"``. In order to achieve the pre-1.0 "unnested" inner join behavior, use the value ``innerjoin="unnested"``. See :ref:`migration_3008`. .. note:: The joins produced by :func:`.orm.joinedload` are **anonymously aliased**. The criteria by which the join proceeds cannot be modified, nor can the :class:`.Query` refer to these joins in any way, including ordering. See :ref:`zen_of_eager_loading` for further detail. To produce a specific SQL JOIN which is explicitly available, use :meth:`.Query.join`. To combine explicit JOINs with eager loading of collections, use :func:`.orm.contains_eager`; see :ref:`contains_eager`. .. seealso:: :ref:`loading_toplevel` :ref:`joined_eager_loading` r� r� N� innerjoin)ro r )r� r^ r� r& r r r � joinedload5 s V r� c O s t �t j| d|�S )NF)rj r� r� )r� r� r r r r� � s c O s t �t j| d|�S )NT)rj r� r� )r� r� r r r �joinedload_all� s r� c C s | � |ddi�S )a Indicate that the given attribute should be loaded using subquery eager loading. This function is part of the :class:`.Load` interface and supports both method-chained and standalone operation. examples:: # subquery-load the "orders" collection on "User" query(User).options(subqueryload(User.orders)) # subquery-load Order.items and then Item.keywords query(Order).options( subqueryload(Order.items).subqueryload(Item.keywords)) # lazily load Order.items, but when Items are loaded, # subquery-load the keywords collection query(Order).options( lazyload(Order.items).subqueryload(Item.keywords)) .. seealso:: :ref:`loading_toplevel` :ref:`subquery_eager_loading` r� Zsubquery)ro )r� r^ r r r � subqueryload� s r� c G s t �t j| di �S )NF)rj r� r� )r� r r r r� � s c G s t �t j| di �S )NT)rj r� r� )r� r r r �subqueryload_all� s r� c C s | � |ddi�S )a5 Indicate that the given attribute should be loaded using SELECT IN eager loading. This function is part of the :class:`.Load` interface and supports both method-chained and standalone operation. examples:: # selectin-load the "orders" collection on "User" query(User).options(selectinload(User.orders)) # selectin-load Order.items and then Item.keywords query(Order).options( selectinload(Order.items).selectinload(Item.keywords)) # lazily load Order.items, but when Items are loaded, # selectin-load the keywords collection query(Order).options( lazyload(Order.items).selectinload(Item.keywords)) .. versionadded:: 1.2 .. seealso:: :ref:`loading_toplevel` :ref:`selectin_eager_loading` r� Zselectin)ro )r� r^ r r r � selectinload� s r� c G s t �t j| di �S )NF)rj r� r� )r� r r r r� � s c G s t �t j| di �S )NT)rj r� r� )r� r r r �selectinload_all� s r� c C s | � |ddi�S )a Indicate that the given attribute should be loaded using "lazy" loading. This function is part of the :class:`.Load` interface and supports both method-chained and standalone operation. .. seealso:: :ref:`loading_toplevel` :ref:`lazy_loading` r� �select)ro )r� r^ r r r �lazyload� s r� c G s t �t j| di �S )NF)rj r� r� )r� r r r r� s c G s t �t j| di �S )NT)rj r� r� )r� r r r � lazyload_all s r� c C s | � |ddi�}|S )a Indicate that the given attribute should be loaded using an immediate load with a per-attribute SELECT statement. The :func:`.immediateload` option is superseded in general by the :func:`.selectinload` option, which performs the same task more efficiently by emitting a SELECT for all loaded objects. This function is part of the :class:`.Load` interface and supports both method-chained and standalone operation. .. seealso:: :ref:`loading_toplevel` :ref:`selectin_eager_loading` r� Z immediate)ro )r� r^ r& r r r � immediateload s r� c G s t �t j| di �S )NF)rj r� r� )r� r r r r� % s c C s | � |ddi�S )ax Indicate that the given relationship attribute should remain unloaded. This function is part of the :class:`.Load` interface and supports both method-chained and standalone operation. :func:`.orm.noload` applies to :func:`.relationship` attributes; for column-based attributes, see :func:`.orm.defer`. .. seealso:: :ref:`loading_toplevel` r� �noload)ro )r� r^ r r r r� * s r� c G s t �t j| di �S )NF)rj r� r� )r� r r r r� = s Fc C s | � |d|rdndi�S )a� Indicate that the given relationship attribute should disallow lazy loads. A relationship attribute configured with :func:`.orm.raiseload` will raise an :exc:`~sqlalchemy.exc.InvalidRequestError` upon access. The typical way this is useful is when an application is attempting to ensure that all relationship attributes that are accessed in a particular context would have been already loaded via eager loading. Instead of having to read through SQL logs to ensure lazy loads aren't occurring, this strategy will cause them to raise immediately. :param sql_only: if True, raise only if the lazy load would emit SQL, but not if it is only checking the identity map, or determining that the related value should just be None due to missing keys. When False, the strategy will raise for all varieties of lazyload. This function is part of the :class:`.Load` interface and supports both method-chained and standalone operation. :func:`.orm.raiseload` applies to :func:`.relationship` attributes only. .. versionadded:: 1.1 .. seealso:: :ref:`loading_toplevel` :ref:`prevent_lazy_with_raiseload` r� Z raise_on_sql�raise)ro )r� r^ Zsql_onlyr r r � raiseloadB s r� c O s t �t j| d|�S )NF)rj r� r� )r� r� r r r r� g s c C s | � |d�S )a6 Indicate an attribute should load using its default loader style. This method is used to link to other loader options further into a chain of attributes without altering the loader style of the links along the chain. For example, to set joined eager loading for an element of an element:: session.query(MyClass).options( defaultload(MyClass.someattribute). joinedload(MyOtherClass.someotherattribute) ) :func:`.defaultload` is also useful for setting column-level options on a related class, namely that of :func:`.defer` and :func:`.undefer`:: session.query(MyClass).options( defaultload(MyClass.someattribute). defer("some_column"). undefer("some_other_column") ) .. seealso:: :meth:`.Load.options` - allows for complex hierarchical loader option structures with less verbosity than with individual :func:`.defaultload` directives. :ref:`relationship_loader_options` :ref:`deferred_loading_w_multiple` N)ro )r� r^ r r r r� l s "r� c G s t �t j| di �S )NF)rj r� r� )r� r r r r� � s c C s | � |fddd��S )at Indicate that the given column-oriented attribute should be deferred, e.g. not loaded until accessed. This function is part of the :class:`.Load` interface and supports both method-chained and standalone operation. e.g.:: from sqlalchemy.orm import defer session.query(MyClass).options( defer("attribute_one"), defer("attribute_two")) session.query(MyClass).options( defer(MyClass.attribute_one), defer(MyClass.attribute_two)) To specify a deferred load of an attribute on a related class, the path can be specified one token at a time, specifying the loading style for each link along the chain. To leave the loading style for a link unchanged, use :func:`.orm.defaultload`:: session.query(MyClass).options(defaultload("someattr").defer("some_column")) A :class:`.Load` object that is present on a certain path can have :meth:`.Load.defer` called multiple times, each will operate on the same parent entity:: session.query(MyClass).options( defaultload("someattr"). defer("some_column"). defer("some_other_column"). defer("another_column") ) :param key: Attribute to be deferred. :param \*addl_attrs: This option supports the old 0.8 style of specifying a path as a series of attributes, which is now superseded by the method-chained style. .. deprecated:: 0.9 The \*addl_attrs on :func:`.orm.defer` is deprecated and will be removed in a future release. Please use method chaining in conjunction with defaultload() to indicate a path. .. seealso:: :ref:`deferred` :func:`.orm.undefer` T)r� r� )rt )r� r) r r r �defer� s :r� c G s& |rt �d� t�tj| f| di �S )Nz}The *addl_attrs on orm.defer is deprecated. Please use method chaining in conjunction with defaultload() to indicate a path.F)r �warn_deprecatedrj r� r� )r) � addl_attrsr r r r� � s c C s | � |fddd��S )ac Indicate that the given column-oriented attribute should be undeferred, e.g. specified within the SELECT statement of the entity as a whole. The column being undeferred is typically set up on the mapping as a :func:`.deferred` attribute. This function is part of the :class:`.Load` interface and supports both method-chained and standalone operation. Examples:: # undefer two columns session.query(MyClass).options(undefer("col1"), undefer("col2")) # undefer all columns specific to a single class using Load + * session.query(MyClass, MyOtherClass).options( Load(MyClass).undefer("*")) # undefer a column on a related object session.query(MyClass).options( defaultload(MyClass.items).undefer('text')) :param key: Attribute to be undeferred. :param \*addl_attrs: This option supports the old 0.8 style of specifying a path as a series of attributes, which is now superseded by the method-chained style. .. deprecated:: 0.9 The \*addl_attrs on :func:`.orm.undefer` is deprecated and will be removed in a future release. Please use method chaining in conjunction with defaultload() to indicate a path. .. seealso:: :ref:`deferred` :func:`.orm.defer` :func:`.orm.undefer_group` FT)r� r� )rt )r� r) r r r �undefer� s ,r� c G s& |rt �d� t�tj| f| di �S )NzThe *addl_attrs on orm.undefer is deprecated. Please use method chaining in conjunction with defaultload() to indicate a path.F)r r� rj r� r� )r) r� r r r r� s c C s | j ddd| didd�S )a Indicate that columns within the given deferred group name should be undeferred. The columns being undeferred are set up on the mapping as :func:`.deferred` attributes and include a "group" name. E.g:: session.query(MyClass).options(undefer_group("large_attrs")) To undefer a group of attributes on a related entity, the path can be spelled out using relationship loader options, such as :func:`.orm.defaultload`:: session.query(MyClass).options( defaultload("someattr").undefer_group("large_attrs")) .. versionchanged:: 0.9.0 :func:`.orm.undefer_group` is now specific to a particular entity load path. .. seealso:: :ref:`deferred` :func:`.orm.defer` :func:`.orm.undefer` r� Nzundefer_group_%sT)rs )rt )r� r� r r r � undefer_group s r� c C s t � �| �S )N)rj r� )r� r r r r� D s c C s( t �t|��}| j|fddid|id�S )aY Apply an ad-hoc SQL expression to a "deferred expression" attribute. This option is used in conjunction with the :func:`.orm.query_expression` mapper-level construct that indicates an attribute which should be the target of an ad-hoc SQL expression. E.g.:: sess.query(SomeClass).options( with_expression(SomeClass.x_y_expr, SomeClass.x + SomeClass.y) ) .. versionadded:: 1.2 :param key: Attribute to be undeferred. :param expr: SQL expression to be applied to the attribute. .. seealso:: :ref:`mapper_query_expression` Zquery_expressionTr )rk )�sql_exprZ_labeledr rt )r� r) r r r r �with_expressionI s r� c C s t �t j| fdd|i�S )NFr )rj r� r� )r) r r r r r� k s c C s0 | j ddidttdd� |D �td��id� | S )a� Indicate an eager load should take place for all attributes specific to a subclass. This uses an additional SELECT with IN against all matched primary key values, and is the per-query analogue to the ``"selectin"`` setting on the :paramref:`.mapper.polymorphic_load` parameter. .. versionadded:: 1.2 .. seealso:: :ref:`inheritance_polymorphic_load` Zselectinload_polymorphicTr� c s s | ]}t |�V qd S )N)r )r( r" r r r r� � s z'selectin_polymorphic.<locals>.<genexpr>)r) )rk )rv r6 r8 �id)r� �classesr r r �selectin_polymorphicr s r� c C s& t � }d|_t| �f|_|�|� |S )NT)rj r r r r� )Zbase_clsr� Zulr r r r� � s )N)N)F)6r� rL r rX Z attributesr �baser r r r Z interfacesr r Z path_registryr r r r r r rO r Zsqlr r� Zsql.baser r r rj �objectr� 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 �<module> s� [ 8 ?+ [!" $%? 1 $"