관리-도구
편집 파일: interfaces.cpython-38.pyc
U -?�fv� � @ s� d Z ddlmZ ddlZddlZddlZddlmZ ddlmZ ddlmZ ddlm Z ddlm Z dd lm Z dd lm Z dd lm Z dd lmZ dd lmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddl m Z ddl m Z ddl m Z dd l m Z dd l m!Z! dd l m"Z" dd l m#Z# dd l m$Z$ dd!l m%Z% dd"l m&Z& dd#l m'Z' dd$l m(Z( dd%l m)Z) dd&l m*Z* d'd(lm+Z+ d'dlmZ, d'd)lm-Z- d'd*lm.Z. d'd+l/m0Z0 d'd,l/m1Z1 d'd-l/m2Z2 d'd.l3m4Z4 d'd/l3m5Z5 d'd0l6m7Z7 d'd1l8m9Z9 d'd2l:m;Z; d'd3l<m=Z= d'd4l.m>Z> d'd5l?m@Z@ d'd6l?mAZA ej�r�dd7lBmCZC dd8lBmDZD dd9lBmEZE dd:lBmFZF dd;lBmGZG dd<lHmIZI dd=l mJZJ dd>lKmLZL dd?lKmMZM dd@lKmNZN ddAlOmPZP ddBlQmRZR ddClSmTZT ddDlUmVZV ddElmWZW ddFlXmYZY ddGlZm[Z[ ddHl\m]Z] ddIl^m_Z_ ddJl.m`Z` ddKl.maZa d'dLlbmcZc d'dMldmeZe d'dNldmfZf d'dOldmgZg d'dPldmhZh d'dQl8miZi d'dRljmkZk d'dSl?mlZl eedTf ZmedUedV�ZnedWedXdY�ZoedZd[dV�ZpG d\d]� d]e1jq�ZrG d^d_� d_e1jse1jten �ZuG d`da� daeuen �ZvG dbdc� dce1jw�ZxG ddde� deeA�ZyG dfdg� dg�ZzG dhdi� die�Z{e{e4j|e4j|e4j|e4j|e4j|e4j|�Z}e{dje4j|e4j|e4j|e4j|e4j|�Z~G dkdl� dl�ZG dmdn� dnee en �Z�e-j�G dodp� dpe7ee en e"e.j���Z�e-j�G dqdr� dre*eo e eo e9��Z�G dsdt� dte�en �Z�G dudv� dve5�Z�G dwdx� dxe7e��Z�G dydz� dze��Z�G d{d|� d|e��Z�G d}d~� d~e��Z�e.j�dd�dd��G d�d�� d�e���Z�G d�d�� d��Z�dS )�z� Contains various base classes used throughout the ORM. Defines some key base classes prominent within the internals. This module and the classes within are mostly private, though some attributes are exposed when inspecting mappings. � )� annotationsN)�Any)�Callable)�cast)�ClassVar)�Dict)�Generic)�Iterator)�List)� NamedTuple)�NoReturn)�Optional)�Sequence)�Set)�Tuple)�Type)� TYPE_CHECKING)�TypeVar)�Union� )�exc)� path_registry)�_MappedAttribute)� EXT_CONTINUE)�EXT_SKIP)�EXT_STOP)�InspectionAttr)�InspectionAttrInfo)� MANYTOMANY)� MANYTOONE)�NO_KEY)�NO_VALUE)� NotExtension)� ONETOMANY)�RelationshipDirection)�SQLORMOperations� )� ColumnElement)� inspection)�util)� operators)�roles)�visitors)�_NoArg)�ExecutableOption)� HasCacheKey)�ColumnOperators)�Column)� TypeEngine)�warn_deprecated)�RODescriptorReference)� TypedDict)� _EntityType)�_IdentityKeyType)� _InstanceDict)�_InternalEntityType)�_ORMAdapterProto)�InstrumentedAttribute)�Mapped)� _MapperEntity)�ORMCompileState)� QueryContext)� RegistryType)�_ClassScanMapperConfig)�_PopulatorDict)�Mapper)�AbstractEntityRegistry)�Query)�Session)� InstanceState)� _LoadElement)� AliasedInsp)� ORMAdapter)�Result)�_ColumnExpressionArgument)�_ColumnsClauseArgument)�_DMLColumnArgument)� _InfoType)� OperatorType)�_TraverseInternalsType)�_AnnotationScanType.�_T)�bound�_T_coT)rT � covariant�_TLS�Type[LoaderStrategy]c @ s e Zd ZdZdZdS )�ORMStatementRole� z?Executable SQL or text() construct, including ORM aware objectsN��__name__� __module__� __qualname__� __slots__Z _role_namerZ rZ rZ �I/opt/hc_python/lib64/python3.8/site-packages/sqlalchemy/orm/interfaces.pyrY s s �rY c @ s e Zd ZdZdZdS )�ORMColumnsClauseRolerZ z7ORM mapped entity, aliased entity, or Column expressionNr[ rZ rZ rZ r` ra z s ra c @ s e Zd ZdZdZdS )�ORMEntityColumnsClauseRolerZ z ORM mapped or aliased entityNr[ rZ rZ rZ r` rb � s rb c @ s e Zd ZdZdZdS )�ORMFromClauseRolerZ z5ORM mapped entity, aliased entity, or FROM expressionNr[ rZ rZ rZ r` rc � s rc c @ s6 e Zd ZU ded< ded< ded< ded< d ed < d S ) �ORMColumnDescription�str�namez!Union[Type[Any], TypeEngine[Any]]�type�bool�aliasedz_ColumnsClauseArgument[Any]�exprz%Optional[_ColumnsClauseArgument[Any]]�entityN)r\ r] r^ �__annotations__rZ rZ rZ r` rd � s rd c @ sb e Zd ZdZedd�dd��Zdd�dd�Zd d d d dd ddddd� dd�Zdd dd�dd�ZdS )�_IntrospectsAnnotationsrZ re ��returnc C s | j S �N)r\ )�clsrZ rZ r` �_mapper_property_name� s z-_IntrospectsAnnotations._mapper_property_namer c C s t d| �� �d���dS )zrreturn a copy of this object to use in declarative when the object is found inside of an Annotated object.z Use of the z> construct inside of an Annotated object is not yet supported.N)�NotImplementedErrorrr ��selfrZ rZ r` �found_in_pep593_annotated� s �z1_IntrospectsAnnotations.found_in_pep593_annotatedrA r@ z Type[Any]� Optional[str]zOptional[Type[Mapped[Any]]]z Optional[_AnnotationScanType]rh �None) � decl_scan�registryrq �originating_module�key�mapped_container� annotation�extracted_mapped_annotation�is_dataclass_fieldro c C s dS )zyPerform class-specific initializaton at early declarative scanning time. .. versionadded:: 2.0 NrZ ) ru ry rz rq r{ r| r} r~ r r� rZ rZ r` �declarative_scan� s z(_IntrospectsAnnotations.declarative_scanr )r| rq ro c C s( t �d|j� d|� d| �� � d���d S )Nz4Python typing annotation is required for attribute "�.z " when primary argument(s) for "z#" construct are None or not present)�sa_exc� ArgumentErrorr\ rr )ru r| rq rZ rZ r` �_raise_for_required� s �z+_IntrospectsAnnotations._raise_for_requiredN) r\ r] r^ r_ � classmethodrr rv r� r� rZ rZ rZ r` rm � s rm c @ sl e Zd ZU dZded< ded< ded< ded< ded < ded < d d d �dd�Zed ddddd�dd��ZdS )�_AttributeOptionsz�define Python-local attribute behavior options common to all :class:`.MapperProperty` objects. Currently this includes dataclass-generation arguments. .. versionadded:: 2.0 zUnion[_NoArg, bool]�dataclasses_init�dataclasses_reprzUnion[_NoArg, Any]�dataclasses_defaultz Union[_NoArg, Callable[[], Any]]�dataclasses_default_factory�dataclasses_compare�dataclasses_kw_onlyre r �r| ro c s i }| j tjk r| j |d< | jtjk r0| j|d< | jtjk rF| j|d< | jtjk r\| j|d< | jtjk rr| j|d< | jtjk r�| j|d< d|kr�t|d �r�t d|�d�d � d|kr�|d s�d|kr�t|d �s�d|kr�|� d�� � fd d �|d< t j f |�S ) z<Return a ``dataclasses.Field`` object given these arguments.�default_factory�default�init�repr�compareZkw_onlyzBCallable object passed to the ``default`` parameter for attribute a� in a ORM-mapped Dataclasses context is ambiguous, and this use will raise an error in a future release. If this callable is intended to produce Core level INSERT default values for an underlying ``Column``, use the ``mapped_column.insert_default`` parameter instead. To establish this callable as providing a default value for instances of the dataclass itself, use the ``default_factory`` dataclasses parameter.z2.0c s � S rp rZ rZ �r� rZ r` �<lambda>� � z7_AttributeOptions._as_dataclass_field.<locals>.<lambda>) r� r- �NO_ARGr� r� r� r� r� �callabler3 �pop� dataclasses�field)ru r| �kwrZ r� r` �_as_dataclass_field� s> ���� �� z%_AttributeOptions._as_dataclass_fieldrR � Optional[Any]rS z_Union[Tuple[str, _AnnotationScanType], Tuple[str, _AnnotationScanType, dataclasses.Field[Any]]])r| r~ r} �elemro c C sV t |t�r |j�|�}|||fS |tjk r4|||fS |dk rJdsRtd��n||fS dS )z�given attribute key, annotation, and value from a class, return the argument tuple we would pass to dataclasses.make_dataclass() for this attribute. NFz/Mapped[] received without a mapping declaration)� isinstance�_DCAttributeOptions�_attribute_optionsr� r- r� �AssertionError)rq r| r~ r} r� Zdc_fieldrZ rZ r` �!_get_arguments_for_make_dataclass s z3_AttributeOptions._get_arguments_for_make_dataclassN)r\ r] r^ �__doc__rl r� r� r� rZ rZ rZ r` r� � s /r� Fc @ s& e Zd ZU dZdZded< ded< dS )r� aw mixin for descriptors or configurational objects that include dataclass field options. This includes :class:`.MapperProperty`, :class:`._MapsColumn` within the ORM, but also includes :class:`.AssociationProxy` within ext. Can in theory be used for other descriptors that serve a similar role as association proxy. (*maybe* hybrids, not sure yet.) rZ r� r� rh �_has_dataclass_argumentsN)r\ r] r^ r� r_ rl rZ rZ rZ r` r� = s r� c @ s8 e Zd ZdZdZedd�dd��Zedd�dd ��Zd S ) � _MapsColumnsz�interface for declarative-capable construct that delivers one or more Column objects to the declarative process to be part of a Table. rZ z Optional[MapperProperty[_T]]rn c C s t � �dS )zAreturn a MapperProperty to be assigned to the declarative mappingN�rs rt rZ rZ r` �mapper_property_to_assign[ s z&_MapsColumns.mapper_property_to_assignz List[Tuple[Column[_T], int]]c C s t � �dS )zfA list of Column objects that should be declaratively added to the new Table object. Nr� rt rZ rZ r` �columns_to_assign` s z _MapsColumns.columns_to_assignN)r\ r] r^ r� r_ �propertyr� r� rZ rZ rZ r` r� T s r� c @ sr e Zd ZU dZdZdejjfdejjfgZ de d< e s:dZ dZ d e d < d e d< d e d< d Zde d< de d< de d< dd�dd�Zdddddd d �d d �Zdddd d dd!d d"�d#d$�ZdHd d%d&d'd(d)d*�d+d,�Zd dd d-�d.d/�Zd d d0�d1d2�ZdId3dd d4�d5d6�Zd d�d7d8�Zed9d�d:d;��Zd d�d<d=�Zd d d0�d>d?�Zd@d%d&d%d&ddAdBd dC� dDdE�Zd d�dFdG�Z dS )J�MapperPropertya� Represent a particular class attribute mapped by :class:`_orm.Mapper`. The most common occurrences of :class:`.MapperProperty` are the mapped :class:`_schema.Column`, which is represented in a mapping as an instance of :class:`.ColumnProperty`, and a reference to another class produced by :func:`_orm.relationship`, represented in the mapping as an instance of :class:`.Relationship`. )�_configure_started�_configure_finishedr� r� �parentr| �info�docr� r| rQ �_cache_key_traversalNTzPropComparator[_T]� comparatorre � Mapper[Any]Frh Z_links_to_entityrw r� rO r� rn c C s i S )a� Info dictionary associated with the object, allowing user-defined data to be associated with this :class:`.InspectionAttr`. The dictionary is generated when first accessed. Alternatively, it can be specified as a constructor argument to the :func:`.column_property`, :func:`_orm.relationship`, or :func:`.composite` functions. .. seealso:: :attr:`.QueryableAttribute.info` :attr:`.SchemaItem.info` rZ rt rZ rZ r` �_memoized_attr_info� s z"MapperProperty._memoized_attr_infor> r= rD �Optional[ORMAdapter]r rx ��context� query_entity�path�adapter�kwargsro c K s dS )a Called by Query for the purposes of constructing a SQL statement. Each MapperProperty associated with the target mapper processes the statement referenced by the query context, adding columns and/or criterion as appropriate. NrZ )ru r� r� r� r� r� rZ rZ r` �setup� s zMapperProperty.setup� Result[Any]rB �r� r� r� �mapper�resultr� � populatorsro c C s dS )zcProduce row processing functions and append to the given set of populators lists. NrZ )ru r� r� r� r� r� r� r� rZ rZ r` �create_row_processor� s z#MapperProperty.create_row_processorzInstanceState[Any]r8 zSet[InstanceState[Any]]z.Optional[Callable[[InstanceState[Any]], bool]]zGIterator[Tuple[object, Mapper[Any], InstanceState[Any], _InstanceDict]])�type_�state�dict_�visited_states�halt_onro c C s t d�S )a� Iterate through instances related to the given instance for a particular 'cascade', starting with this MapperProperty. Return an iterator3-tuples (instance, mapper, state). Note that the 'cascade' collection on this MapperProperty is checked first for the given type before cascade_iterator is called. This method typically only applies to Relationship. rZ )�iter)ru r� r� r� r� r� rZ rZ r` �cascade_iterator� s z MapperProperty.cascade_iterator)r� r� ro c C s || _ dS )z�Set the parent mapper that references this MapperProperty. This method is overridden by some subclasses to perform extra setup when the mapper is first known. N)r� )ru r� r� rZ rZ r` � set_parent s zMapperProperty.set_parent�r� ro c C s dS )aI Hook called by the Mapper to the property to initiate instrumentation of the class attribute managed by this MapperProperty. The MapperProperty here will typically call out to the attributes module to set up an InstrumentedAttribute. This step is the first of two steps to set up an InstrumentedAttribute, and is called early in the mapper setup process. The second step is typically the init_class_attribute step, called from StrategizedProperty via the post_instrument_class() hook. This step assigns additional state to the InstrumentedAttribute (specifically the "impl") which has been determined after the MapperProperty has determined what kind of persistence management it needs to do (e.g. scalar, object, collection, etc). NrZ �ru r� rZ rZ r` �instrument_class s z MapperProperty.instrument_classzOptional[_AttributeOptions])�attribute_options� _assume_readonly_dc_attributesro c C sD d| _ d| _|rt}nt}|r4||kr4d| _|| _n d| _|| _d S )NFT)r� r� �#_DEFAULT_READONLY_ATTRIBUTE_OPTIONS�_DEFAULT_ATTRIBUTE_OPTIONSr� r� )ru r� r� Z default_attrsrZ rZ r` �__init__, s zMapperProperty.__init__c C s d| _ | �� d| _dS )z�Called after all mappers are created to assemble relationships between mappers and perform other post-mapper-creation initialization steps. TN)r� �do_initr� rt rZ rZ r` r� @ s zMapperProperty.initzInstrumentedAttribute[_T]c C s t | jj| j�S )a� Return the class-bound descriptor corresponding to this :class:`.MapperProperty`. This is basically a ``getattr()`` call:: return getattr(self.parent.class_, self.key) I.e. if this :class:`.MapperProperty` were named ``addresses``, and the class to which it is mapped is ``User``, this sequence is possible:: >>> from sqlalchemy import inspect >>> mapper = inspect(User) >>> addresses_property = mapper.attrs.addresses >>> addresses_property.class_attribute is User.addresses True >>> User.addresses.property is addresses_property True )�getattrr� �class_r| rt rZ rZ r` �class_attributeK s z MapperProperty.class_attributec C s dS )z�Perform subclass-specific initialization post-mapper-creation steps. This is a template method called by the ``MapperProperty`` object's init() method. NrZ rt rZ rZ r` r� e s zMapperProperty.do_initc C s dS )a Perform instrumentation adjustments that need to occur after init() has completed. The given Mapper is the Mapper invoking the operation, which may not be the same Mapper as self.parent in an inheritance scenario; however, Mapper will always at least be a sub-mapper of self.parent. This method is typically used by StrategizedProperty, which delegates it to LoaderStrategy.init_class_attribute() to perform final setup on the class-bound InstrumentedAttribute. NrZ r� rZ rZ r` �post_instrument_classn s z$MapperProperty.post_instrument_classrF zDict[Any, object]z#Dict[_IdentityKeyType[Any], object]) �session� source_state� source_dict� dest_state� dest_dict�load� _recursive�_resolve_conflict_mapro c C s dS )zoMerge the attribute represented by this ``MapperProperty`` from source to destination object. NrZ ) ru r� r� r� r� r� r� r� r� rZ rZ r` �merge} s zMapperProperty.mergec C s d| j jt| �t| dd�f S )Nz<%s at 0x%x; %s>r| zno key)� __class__r\ �idr� rt rZ rZ r` �__repr__� s �zMapperProperty.__repr__)N)NF) r\ r] r^ r� r_ r, ZExtendedInternalTraversalZdp_has_cache_keyZ dp_stringr� rl r ZcascadeZ is_propertyZ_is_relationshipr� r� r� r� r� r� r� r� r� r� r� r� r� r� rZ rZ rZ r` r� r s@ � � � r� c @ s� e Zd ZU dZdZdZded< ded< ded < dKd ddd �d d�Zej dd�dd��Z dd�dd�Z ddd�dd�Z dd d �d d �Z ejd d�d!d"��ZdLd#dd$d%�d&d'�Zejd(d�d)d*��Zejd+d�d,d-��Zeddddd.�d/d0��Zeddddd1�d2d3��Zedddd4�d5d6��Zeeje�Zeeje�Zeeje�Z e j �rnd7ddd$d8�d9d:�Z d7ddd$d8�d;d<�Z d=d d>�d?d@�Z!dAdBdC�dDdE�Z"dMd#ddFd%�dGdH�Z#dNd#ddFd%�dIdJ�Z$d S )O�PropComparatora� Defines SQL operations for ORM mapped attributes. SQLAlchemy allows for operators to be redefined at both the Core and ORM level. :class:`.PropComparator` is the base class of operator redefinition for ORM-level operations, including those of :class:`.ColumnProperty`, :class:`.Relationship`, and :class:`.Composite`. User-defined subclasses of :class:`.PropComparator` may be created. The built-in Python comparison and math operator methods, such as :meth:`.operators.ColumnOperators.__eq__`, :meth:`.operators.ColumnOperators.__lt__`, and :meth:`.operators.ColumnOperators.__add__`, can be overridden to provide new operator behavior. The custom :class:`.PropComparator` is passed to the :class:`.MapperProperty` instance via the ``comparator_factory`` argument. In each case, the appropriate subclass of :class:`.PropComparator` should be used:: # definition of custom PropComparator subclasses from sqlalchemy.orm.properties import \ ColumnProperty,\ Composite,\ Relationship class MyColumnComparator(ColumnProperty.Comparator): def __eq__(self, other): return self.__clause_element__() == other class MyRelationshipComparator(Relationship.Comparator): def any(self, expression): "define the 'any' operation" # ... class MyCompositeComparator(Composite.Comparator): def __gt__(self, other): "redefine the 'greater than' operation" return sql.and_(*[a>b for a, b in zip(self.__clause_element__().clauses, other.__composite_values__())]) # application of custom PropComparator subclasses from sqlalchemy.orm import column_property, relationship, composite from sqlalchemy import Column, String class SomeMappedClass(Base): some_column = column_property(Column("some_column", String), comparator_factory=MyColumnComparator) some_relationship = relationship(SomeOtherClass, comparator_factory=MyRelationshipComparator) some_composite = composite( Column("a", String), Column("b", String), comparator_factory=MyCompositeComparator ) Note that for column-level operator redefinition, it's usually simpler to define the operators at the Core level, using the :attr:`.TypeEngine.comparator_factory` attribute. See :ref:`types_operators` for more detail. .. seealso:: :class:`.ColumnProperty.Comparator` :class:`.Relationship.Comparator` :class:`.Composite.Comparator` :class:`.ColumnOperators` :ref:`types_operators` :attr:`.TypeEngine.comparator_factory` ��prop� _parententity�_adapt_to_entityZorm_prop_comparatorz_InternalEntityType[Any]r� zOptional[AliasedInsp[Any]]r� z,RODescriptorReference[MapperProperty[_T_co]]r� NzMapperProperty[_T])r� � parentmapper�adapt_to_entityc C s || _ |p || _|| _d S rp r� )ru r� r� r� rZ rZ r` r� � s zPropComparator.__init__zMapperProperty[_T_co]rn c C s | j S )z�Return the :class:`.MapperProperty` associated with this :class:`.PropComparator`. Return values here will commonly be instances of :class:`.ColumnProperty` or :class:`.Relationship`. )r� rt rZ rZ r` r� � s zPropComparator.propertyzroles.ColumnsClauseRolec C s t d| ��d S )Nz%rr� rt rZ rZ r` �__clause_element__ s z!PropComparator.__clause_element__r z(Sequence[Tuple[_DMLColumnArgument, Any]])�valuero c C s t d| �� �|fgS )z�Receive a SQL expression that represents a value in the SET clause of an UPDATE statement. Return a tuple that can be passed to a :class:`_expression.Update` construct. rN )r r� )ru r� rZ rZ r` �_bulk_update_tuples s z"PropComparator._bulk_update_tupleszAliasedInsp[Any]zPropComparator[_T_co])r� ro c C s | � | j| j|�S )z�Return a copy of this PropComparator which will use the given :class:`.AliasedInsp` to produce corresponding expressions. )r� r� r� )ru r� rZ rZ r` r� s z PropComparator.adapt_to_entityr� c C s | j jS )zZlegacy; this is renamed to _parententity to be compatible with QueryableAttribute.)r� r� rt rZ rZ r` � _parentmapper s z PropComparator._parentmapperz)Optional[_ColumnExpressionArgument[bool]]zColumnElement[Any])� criterionr� ro c K s | j jj|f|�S rp )r� r� �_criterion_exists�ru r� r� rZ rZ r` r� % s z PropComparator._criterion_existszOptional[_ORMAdapterProto]c C s | j dkrdS | j jS dS )zrProduce a callable that adapts column expressions to suit an aliased version of this comparator. N)r� Z_orm_adapt_elementrt rZ rZ r` r� , s zPropComparator.adapterrO c C s | j jS rp )r� r� rt rZ rZ r` r� 7 s zPropComparator.info)�a�br� ro c K s | j |f|�S rp )�any)r� r� r� rZ rZ r` �_any_op; s zPropComparator._any_op)�left�otherr� ro c K s | j |f|�S rp )�has)r� r� r� rZ rZ r` �_has_op? s zPropComparator._has_op)r� r� ro c C s | � |�S rp )�of_type)r� r� rZ rZ r` � _of_type_opC s zPropComparator._of_type_oprP )�opr� r� ro c O s d S rp rZ �ru r� r� r� rZ rZ r` �operateM s zPropComparator.operatec K s d S rp rZ r� rZ rZ r` �reverse_operateQ s z PropComparator.reverse_operatez_EntityType[Any])r� ro c C s | � tj|�S )a� Redefine this object in terms of a polymorphic subclass, :func:`_orm.with_polymorphic` construct, or :func:`_orm.aliased` construct. Returns a new PropComparator from which further criterion can be evaluated. e.g.:: query.join(Company.employees.of_type(Engineer)).\ filter(Engineer.name=='foo') :param \class_: a class or mapper indicating that criterion will be against this specific subclass. .. seealso:: :ref:`orm_queryguide_joining_relationships_aliased` - in the :ref:`queryguide_toplevel` :ref:`inheritance_of_type` )r� r� � of_type_op)ru r� rZ rZ r` r� U s zPropComparator.of_typez _ColumnExpressionArgument[bool]zPropComparator[bool])�criteriaro c G s | j tjf|�� S )a? Add additional criteria to the ON clause that's represented by this relationship attribute. E.g.:: stmt = select(User).join( User.addresses.and_(Address.email_address != 'foo') ) stmt = select(User).options( joinedload(User.addresses.and_(Address.email_address != 'foo')) ) .. versionadded:: 1.4 .. seealso:: :ref:`orm_queryguide_join_on_augmented` :ref:`loader_option_criteria` :func:`.with_loader_criteria` )r� r* �and_)ru r rZ rZ r` r p s zPropComparator.and_zColumnElement[bool]c K s | j tj|f|�S )a Return a SQL expression representing true if this element references a member which meets the given criterion. The usual implementation of ``any()`` is :meth:`.Relationship.Comparator.any`. :param criterion: an optional ClauseElement formulated against the member class' table or attributes. :param \**kwargs: key/value pairs corresponding to member class attribute names which will be compared via equality to the corresponding values. )r� r� �any_opr� rZ rZ r` r� � s zPropComparator.anyc K s | j tj|f|�S )a Return a SQL expression representing true if this element references a member which meets the given criterion. The usual implementation of ``has()`` is :meth:`.Relationship.Comparator.has`. :param criterion: an optional ClauseElement formulated against the member class' table or attributes. :param \**kwargs: key/value pairs corresponding to member class attribute names which will be compared via equality to the corresponding values. )r� r� �has_opr� rZ rZ r` r� � s zPropComparator.has)N)N)N)N)%r\ r] r^ r� r_ Z__visit_name__rl r� r) Znon_memoized_propertyr� r� r� r� Zro_non_memoized_propertyr� r� r� r� � staticmethodr� r� r� r r* rP r r r �typingr r� r r� r r� r� rZ rZ rZ r` r� � sN Q � � � �r� c @ s� e Zd ZU dZdZdZded< ded< ded < d d �d d �Zdd �dd�Zdddd�dd�Z ddd�dd�Z dddd d d d �d d!�Z dddd"d#d d$d d%�d&d'�Z d d �d(d)�Z d"d d*�d+d,�Ze�e�Zd-ed.< ed d/d0�d1d2��Zed3d d4d5�d6d7��Zd8S )9�StrategizedPropertya� A MapperProperty which uses selectable strategies to affect loading behavior. There is a single strategy selected by default. Alternate strategies can be selected at Query time through the usage of ``StrategizedOption`` objects via the Query.options() method. The mechanics of StrategizedProperty are used for every Query invocation for every mapped attribute participating in that Query, to determine first how the attribute will be rendered in SQL and secondly how the attribute will retrieve a value from a result row and apply it to a mapped object. The routines here are very performance-critical. )� _strategies�strategyZ_wildcard_token�_default_path_loader_key� strategy_keyTz ClassVar[str]�strategy_wildcard_key� _StrategyKeyr z"Dict[_StrategyKey, LoaderStrategy]r z Tuple[str]rn c C s | j � dtj� �fS )N�:)r r Z_WILDCARD_TOKENrt rZ rZ r` � _memoized_attr__wildcard_token� s �z2StrategizedProperty._memoized_attr__wildcard_tokenzTuple[str, Tuple[str]]c C s d| j � dtj� �ffS )N�loaderr )r r Z_DEFAULT_TOKENrt rZ rZ r` �'_memoized_attr__default_path_loader_key� s �z;StrategizedProperty._memoized_attr__default_path_loader_keyr> rD �Optional[_LoadElement])r� r� ro c C s> d }|| }|j |j|jfD ] }||jkr |j| } q:q |S rp )Z _loader_keyZ_wildcard_path_loader_keyr � attributes)ru r� r� r� � search_pathZpath_keyrZ rZ r` �_get_context_loader� s � z'StrategizedProperty._get_context_loader�LoaderStrategyr� c C sJ z | j | W S tk r Y nX | j| f|�� }|| |� | j |< }|S rp )r �KeyError�_strategy_lookup)ru r| rq r rZ rZ r` � _get_strategy s z!StrategizedProperty._get_strategyr= r� r rx r� c K sD | � ||�}|r$|jr$| �|j�}n| j}|j|||||f|� d S rp )r r r � setup_query)ru r� r� r� r� r� r �stratrZ rZ r` r� s ��zStrategizedProperty.setupr� r� rB r� c C sF | � ||�}|r$|jr$| �|j�} n| j} | �||||||||� d S rp )r r r r� ) ru r� r� r� r� r� r� r� r r rZ rZ r` r� ! s �z(StrategizedProperty.create_row_processorc C s i | _ | �| j�| _d S rp )r r r r rt rZ rZ r` r� ; s zStrategizedProperty.do_initr� c C s& | j js"|j�| j�s"| j�|� d S rp )r� Z non_primaryZ class_managerZ_attr_has_implr| r �init_class_attributer� rZ rZ r` r� ? s � �z)StrategizedProperty.post_instrument_classz\collections.defaultdict[Type[MapperProperty[Any]], Dict[_StrategyKey, Type[LoaderStrategy]]]�_all_strategieszCallable[[_TLS], _TLS])r� ro c s ddd�� �fdd� }|S )NrW )�dec_clsro c s> d| j krg | _tt��� ��}| � j� |< | j�|� | S )N�_strategy_keys)�__dict__r �tuple�sorted�itemsr �append)r r| �rq r� rZ r` �decorateL s z2StrategizedProperty.strategy_for.<locals>.decoraterZ )rq r� r' rZ r& r` � strategy_forJ s z StrategizedProperty.strategy_for�MapperProperty[Any]rX )�requesting_propertyr| ro c G s� |j j | jD ]N}|| jkrtr.t|t�s.t�| j| }z|| W S tk rZ Y qX q| j� � D ] \}}||krh|}|| } q�qhd }d }t � | ||||��d S rp ) r� Z_with_polymorphic_mappers�__mro__r r � issubclassr� r� r r$ �orm_excZLoaderStrategyException) rq r* r| Zprop_clsZ strategiesZ property_typeZstratsZintended_property_typeZactual_strategyrZ rZ r` r X s0 �z$StrategizedProperty._strategy_lookupN)r\ r] r^ r� r_ Z inherit_cacherl r r r r r� r� r� r� � collections� defaultdict�dictr r� r( r rZ rZ rZ r` r � s( � r c @ sB e Zd ZdZdZdZdZdZdZdZ dZ dZ dd d d�dd�Z dS ) � ORMOptiona� Base class for option objects that are passed to ORM queries. These options may be consumed by :meth:`.Query.options`, :meth:`.Select.options`, or in a more general sense by any :meth:`.Executable.options` method. They are interpreted at statement compile time or execution time in modern use. The deprecated :class:`.MapperOption` is consumed at ORM query construction time. .. versionadded:: 1.4 rZ Fr? )r� � uncached_optro c C s |dk r |S | S dS )a� adapt this option to the "uncached" version of itself in a loader strategy context. given "self" which is an option from a cached query, as well as the corresponding option from the uncached version of the same query, return the option we should use in a new query, in the context of a loader strategy being asked to load related rows on behalf of that cached query, which is assumed to be building a new query based on entities passed to us from the cached query. Currently this routine chooses between "self" and "uncached" without manufacturing anything new. If the option is itself a loader strategy option which has a path, that path needs to match to the entities being passed to us by the cached query, so the :class:`_orm.Load` subclass overrides this to return "self". For all other options, we return the uncached form which may have changing state, such as a with_loader_criteria() option which will very often have new state. This routine could in the future involve generating a new option based on both inputs if use cases arise, such as if with_loader_criteria() needed to match up to ``AliasedClass`` instances given in the parent query. However, longer term it might be better to restructure things such that ``AliasedClass`` entities are always matched up on their cache key, instead of identity, in things like paths and such, so that this whole issue of "the uncached option does not match the entities" goes away. However this would make ``PathRegistry`` more complicated and difficult to debug as well as potentially less performant in that it would be hashing enormous cache keys rather than a simple AliasedInsp. UNLESS, we could get cache keys overall to be reliably hashed into something like an md5 key. .. versionadded:: 1.4.41 NrZ )ru r� r2 rZ rZ r` �'_adapt_cached_option_to_uncached_option� s 'z1ORMOption._adapt_cached_option_to_uncached_optionN) r\ r] r^ r� r_ �_is_legacy_option�propagate_to_loadersZ_is_core�_is_user_defined�_is_compile_state�_is_criteria_optionZ_is_strategy_optionr3 rZ rZ rZ r` r1 z s r1 c @ s: e Zd ZdZdZdZddd�dd�Zdd dd �d d �Zd S )�CompileStateOptiona� base for :class:`.ORMOption` classes that affect the compilation of a SQL query and therefore need to be part of the cache key. .. note:: :class:`.CompileStateOption` is generally non-public and should not be used as a base class for user-defined options; instead, use :class:`.UserDefinedOption`, which is easier to use as it does not interact with ORM compilation internals or caching. :class:`.CompileStateOption` defines an internal attribute ``_is_compile_state=True`` which has the effect of the ORM compilation routines for SELECT and other statements will call upon these options when a SQL string is being compiled. As such, these classes implement :class:`.HasCacheKey` and need to provide robust ``_cache_key_traversal`` structures. The :class:`.CompileStateOption` class is used to implement the ORM :class:`.LoaderOption` and :class:`.CriteriaOption` classes. .. versionadded:: 1.4.28 rZ Tr> rx )� compile_statero c C s dS )z�Apply a modification to a given :class:`.ORMCompileState`. This method is part of the implementation of a particular :class:`.CompileStateOption` and is only invoked internally when an ORM query is compiled. NrZ )ru r: rZ rZ r` �process_compile_state� s z(CompileStateOption.process_compile_state�Sequence[_MapperEntity]�r: �mapper_entitiesro c C s dS )aq Apply a modification to a given :class:`.ORMCompileState`, given entities that were replaced by with_only_columns() or with_entities(). This method is part of the implementation of a particular :class:`.CompileStateOption` and is only invoked internally when an ORM query is compiled. .. versionadded:: 1.4.19 NrZ �ru r: r> rZ rZ r` �'process_compile_state_replaced_entities� s z:CompileStateOption.process_compile_state_replaced_entitiesN)r\ r] r^ r� r_ r7 r; r@ rZ rZ rZ r` r9 � s r9 c @ s& e Zd ZdZdZdddd�dd�Zd S ) � LoaderOptionzhDescribe a loader modification to an ORM statement at compilation time. .. versionadded:: 1.4 rZ r> r< rx r= c C s | � |� d S rp )r; r? rZ rZ r` r@ s z4LoaderOption.process_compile_state_replaced_entitiesN)r\ r] r^ r� r_ r@ rZ rZ rZ r` rA s rA c @ s( e Zd ZdZdZdZddd�dd�Zd S ) �CriteriaOptionztDescribe a WHERE criteria modification to an ORM statement at compilation time. .. versionadded:: 1.4 rZ TzDict[str, Any]rx )r ro c C s dS )z_update additional entity criteria options in the given attributes dictionary. NrZ )ru r rZ rZ r` �get_global_criteria s z"CriteriaOption.get_global_criteriaN)r\ r] r^ r� r_ r8 rC rZ rZ rZ r` rB s rB c @ s0 e Zd ZdZdZdZdZdZd dd�dd�ZdS ) �UserDefinedOptionz~Base class for a user-defined option that can be consumed from the :meth:`.SessionEvents.do_orm_execute` event hook. ��payloadFTNr� c C s || _ d S rp rE )ru rF rZ rZ r` r� 8 s zUserDefinedOption.__init__)N) r\ r] r^ r� r_ r4 r6 r5 r� rZ rZ rZ r` rD % s rD z1.4aK The :class:`.MapperOption class is deprecated and will be removed in a future release. For modifications to queries on a per-execution basis, use the :class:`.UserDefinedOption` class to establish state within a :class:`.Query` or other Core statement, then use the :meth:`.SessionEvents.before_orm_execute` hook to consume them.)� constructorc @ s< e Zd ZdZdZdZdZddd�dd �Zddd�d d �Zd S ) � MapperOptionz"Describe a modification to a QueryrZ TFz Query[Any]rx )�queryro c C s dS )z8Apply a modification to the given :class:`_query.Query`.NrZ �ru rI rZ rZ r` � process_queryT s zMapperOption.process_queryc C s | � |� dS )ao same as process_query(), except that this option may not apply to the given query. This is typically applied during a lazy load or scalar refresh operation to propagate options stated in the original Query to the new Query being used for the load. It occurs for those options that specify propagate_to_loaders=True. N)rK rJ rZ rZ r` �process_query_conditionallyW s z(MapperOption.process_query_conditionallyN) r\ r] r^ r� r_ r4 r5 rK rL rZ rZ rZ r` rH < s rH c @ s� e Zd ZU dZdZded< ddd�dd �Zd d d �d d�Zddddddd d�dd�Zddddd dddd d� dd �Z d d �d d �Z d!S )"r a� Describe the loading behavior of a StrategizedProperty object. The ``LoaderStrategy`` interacts with the querying process in three ways: * it controls the configuration of the ``InstrumentedAttribute`` placed on a class to handle the behavior of the attribute. this may involve setting up class-level callable functions to fire off a select operation when the attribute is first accessed (i.e. a lazy load) * it processes the ``QueryContext`` at statement construction time, where it can modify the SQL statement that is being produced. For example, simple column attributes will add their represented column to the list of selected columns, a joined eager loader may establish join clauses to add to the statement. * It produces "row processor" functions at result fetching time. These "row processor" functions populate a particular attribute on a particular mapped instance. )�parent_property�is_class_levelr� r| r � strategy_optsz ClassVar[List[_StrategyKey]]r r) r )r� r c C s4 || _ d| _| j j| _| j j| _|| _t|�| _d S )NF)rM rN r� r| r r0 rO )ru r� r rZ rZ r` r� � s zLoaderStrategy.__init__r� rx r� c C s d S rp rZ r� rZ rZ r` r � s z#LoaderStrategy.init_class_attributer> r= rD r r� r )r: r� r� �loadoptr� r� ro c K s dS )z�Establish column and other state for a given QueryContext. This method fulfills the contract specified by MapperProperty.setup(). StrategizedProperty delegates its setup() method directly to this method. NrZ )ru r: r� r� rP r� r� rZ rZ r` r � s zLoaderStrategy.setup_queryr� rB ) r� r� r� rP r� r� r� r� ro c C s dS )a Establish row processing functions for a given QueryContext. This method fulfills the contract specified by MapperProperty.create_row_processor(). StrategizedProperty delegates its create_row_processor() method directly to this method. NrZ ) ru r� r� r� rP r� r� r� r� rZ rZ r` r� � s z#LoaderStrategy.create_row_processorre rn c C s t | j�S rp )re rM rt rZ rZ r` �__str__� s zLoaderStrategy.__str__N) r\ r] r^ r� r_ rl r� r r r� rQ rZ rZ rZ r` r e s r )�r� � __future__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 �baser r r r r r r r r r! r" r# r$ r% r' r� r( r) �sqlr* r+ r, Zsql.baser- r. Z sql.cache_keyr/ Z sql.operatorsr0 Z sql.schemar1 Z sql.type_apir2 r3 Z util.typingr4 r5 Z_typingr6 r7 r8 r9 r: r r; r< r� r= r> r? Zdecl_apir@ Z decl_baserA ZloadingrB r� rC rD rI rE r� rF r� rG Zstrategy_optionsrH rI rJ Z engine.resultrK Z sql._typingrL rM rN rO rP Z sql.visitorsrQ rR r rS rU rW Z StatementRolerY ZColumnsClauseRoleZTypedColumnsClauseRolera rb ZStrictFromClauseRolerc rd rm r� r� r� r� r� r� Z_self_inspectsZ MemoizedSlotsr� r� r r1 r9 rA rB rD Zdeprecated_clsrH r rZ rZ rZ r` �<module> s � ,i� � � $ ' @P7�