관리-도구
편집 파일: elements.cpython-38.pyc
U -?�f�� � @ s� d Z ddlmZ ddlmZ ddlmZ ddlZddlZddl Z ddl Z ddl m Z ddl m Z ddl m Z dd l mZ dd l mZ dd l mZ dd l mZ dd l mZ ddl mZ ddl mZ ddl mZ ddl mZ ddl mZ ddl mZ ddl mZ ddl mZ ddl m Z ddl m Z 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/ dd'l.m0Z0 dd(l.m1Z1 dd)l.m2Z2 dd*l.m3Z3 dd+l.m4Z4 dd,l.m5Z5 dd-l.m6Z6 dd.l.m7Z7 dd/l.m8Z8 dd0l9m:Z: dd1l9m;Z; dd2l!m<Z< dd3l"m=Z= dd4l$m>Z> dd5l?m@Z@ dd6l?mAZA dd7l?mBZB dd8l?mCZC dd9l?mDZD d:d;l mEZE d:d<l mFZF d:d=l mGZG d:d>lGmHZH d:d?lGmIZI d:d@lJmKZK d:dAlJmLZL d:dBlJmMZM e j �r�ddCl&mNZN ddDl&mOZO ddEl&mPZP ddFl&mQZQ ddGl&mRZR ddHl&mSZS ddIl&mTZT ddJl9mUZU ddKl9mVZV ddLlWmXZX ddMlWmYZY ddNlZm[Z[ ddOl"m\Z\ ddPl]m^Z^ ddQl]m_Z_ ddRl]m`Z` ddSl]maZa ddTlbmcZc ddUlbmdZd ddVlbmeZe ddWlbmfZf ddXlgmhZh ddYl%miZi ddZl?mjZj dd[l?mkZk dd\l?mlZl d:d]lmmnZn d:d^lmmoZo d:d_lpmqZq d:d`lpmrZr d:dalpmsZs d:dblpmtZt d:dclpmuZu d:ddlvmwZw e exef Zye exezef Z{e dedfdg�Z|e dhe didj�Z}e dkdfdg�Z~e dldmdg�Ze dndodg�Z�ed�dfdqdrdsdt�dudv��Z�ed�dedwdrdsdt�dxdv��Z�e�d dfdydrdzdt�d{dv��Z��ddfdydrdzdt�d|dv�Z��dd}d~dd��d�d��Z�G d�d�� d�eD�Z�eFj�G d�d�� d�e-e:e>eAe���Z�G d�d�� d�e��Z�G d�d�� d�e#j�e#j�e#j�e��Z�G d�d�� d�ee} e=eI�Z�G d�d�� d�e�e} e#j�e} eI�Z�e�Z�G d�d�� d�e#j�e#j�e#j�e#j�e| e#j�e#j�e#j�e#j�e#j�e#j�e�e| e��Z�G d�d�� d�e�e| �Z�G d�d�� d�e�e| �Z�G d�d�� d�e#j�e�e| �Z�G d�d�� d�e��Z�G d�d�� d�e#j�e#j�e#j�e#j�e#j�e#j�e#j�e#j�e4e3e�e#j�e eFj�d� �Z�G d�d�� d�e8e#j�d e�d �Z�e���� G d�d�� d�e8e#j�e� e�e� �Z�e���� G d�d�� d�e8e#j�e� e�e� �Z�e���� G d�d�� d�e#j�e#j�e#j�e#j�e��Z�G d�d�� d�e�e| �Z�G d�d�� d�e�e| �Z�G d�d�� d�e�e� �Z�e�j�Z�e�j�Z�G d�d�� d�e�e�ee d�f �ZG d�d�� d�e�e| �Z�G d�d�� d�e�e| �Z�G d�d�� d�e�e| �Z�G d�d�� d�e�e| �Z�G d�d�� d�e�ez �Z�G d�d�� d�e�e| �Z�G d�d�� d�e�e �Z�G d�d�� d�e�e| �Z�G d�d�� d�e�e| �Z�G d�d�� d�e�e� e�e� �Z�G d�d�� d�e�e| �Z�G d�dÄ d�e�e �Z�G d�dń d�e�e �Z�G d�dDŽ d�e��Z�G d�dɄ d�e�e�e| �Z�G d�d˄ d�e�e| �Z�G d�d̈́ d�e�Z�e�j�Z�e�j�Z�e eze�f Z�G d�dτ d�e�e| �Z�G d�dф d�e�e| �Z�G d�dӄ d�e4e�e| �Z�G d�dՄ d�e�e| �Z�eLdփZ�G d�d d�e#j�e| e�e| �Z�G d�dڄ d�e#j�e#j�e| e#j�e6e�e| �Z�G d�d܄ d�e�e| �Z�G d�dބ d�e�e� �Z�G d�d� d�e3e��Z�G d�d� d�e̓Z�G d�d� d�e̓Z�G d�d� d�e̓Z�G d�d� d�eGj�e˃Z�d�d�d�d�d�Z�d�d�d�d�d�ZԐdd�d�Z�G d�d�� d�eGj�d� �Z�G d�d�� d�e,�Z�G d�d�� d�e҃Z�G d�d�� d�eكZ�e�Z�G d�d�� d�eكZ�dS ( z�Core SQL expression elements, including :class:`_expression.ClauseElement`, :class:`_expression.ColumnElement`, and derived classes. � )� annotations)�Decimal)�EnumN)� AbstractSet)�Any)�Callable)�cast)�Dict)� FrozenSet)�Generic)�Iterable)�Iterator)�List)�Mapping)�Optional)�overload)�Sequence)�Set)�Tuple)�Type)� TYPE_CHECKING)�TypeVar)�Union� )� coercions)� operators)�roles)� traversals)�type_api)�has_schema_attr)�is_named_from_clause)�is_quoted_name)� is_tuple_type)� Annotated)�SupportsWrappingAnnotations)�_clone)�_expand_cloned)� _generative)�_NoArg)� Executable)� Generative)� HasMemoized)� Immutable)�NO_ARG)�SingletonConstant)�MemoizedHasCacheKey)�NO_CACHE)�_document_text_coercion)�ColumnOperators)�HasCopyInternals)�cloned_traverse)�ExternallyTraversible)�InternalTraversal)�traverse)� Visitable� )�exc)� inspection)�util)�!HasMemoized_ro_memoized_attribute)� TypingOnly)�Literal)� ParamSpec)�Self)� _ByArgument)�_ColumnExpressionArgument)�#_ColumnExpressionOrStrLabelArgument)� _HasDialect)� _InfoType)�_PropagateAttrsType)�_TypeEngineArgument)�_CacheKeyTraversalType)�CacheKey)�Compiled)� SQLCompiler)�FunctionElement)� OperatorType)�Column)�DefaultGenerator)� FetchedValue)� ForeignKey)�_SelectIterable)� FromClause)�NamedFromClause)� TextualSelect)� TupleType)� TypeEngine)�_CloneCallableType)�_TraverseInternalsType)�anon_map)� Connection)�Dialect)�_CoreMultiExecuteParams)� CacheStats)�CompiledCacheType)�CoreExecuteOptionsParameter)�SchemaTranslateMapType)�Result�_Tr )�bound�_T_coT)re � covariant�_OPT�_NT�_NUMERIC�_NMT�_NUMBERF�_TypeEngineArgument[_T]�bool�BindParameter[_T])�value�type_�literal_execute�returnc C s d S �N� �rp rq rr ru ru �G/opt/hc_python/lib64/python3.8/site-packages/sqlalchemy/sql/elements.py�literal� s rx �Nonec C s d S rt ru rv ru ru rw rx � s �"Optional[_TypeEngineArgument[Any]]�BindParameter[Any]c C s d S rt ru rv ru ru rw rx � s c C s t jtj| ||d�S )a Return a literal clause, bound to a bind parameter. Literal clauses are created automatically when non- :class:`_expression.ClauseElement` objects (such as strings, ints, dates, etc.) are used in a comparison operation with a :class:`_expression.ColumnElement` subclass, such as a :class:`~sqlalchemy.schema.Column` object. Use this function to force the generation of a literal clause, which will be created as a :class:`BindParameter` with a bound value. :param value: the value to be bound. Can be any Python object supported by the underlying DB-API, or is translatable via the given type argument. :param type\_: an optional :class:`~sqlalchemy.types.TypeEngine` which will provide bind-parameter translation for this literal. :param literal_execute: optional bool, when True, the SQL engine will attempt to render the bound value directly in the SQL statement at execution time rather than providing as a parameter value. .. versionadded:: 2.0 )rq rr )r �expectr ZLiteralValueRolerv ru ru rw rx � s ��str�!Optional[_TypeEngineArgument[_T]]zColumnClause[_T])�textrq rs c C s t | |dd�S )a� Produce a :class:`.ColumnClause` object that has the :paramref:`_expression.column.is_literal` flag set to True. :func:`_expression.literal_column` is similar to :func:`_expression.column`, except that it is more often used as a "standalone" column expression that renders exactly as stated; while :func:`_expression.column` stores a string name that will be assumed to be part of a table and may be quoted as such, :func:`_expression.literal_column` can be that, or any other arbitrary column-oriented expression. :param text: the text of the expression; can be any SQL expression. Quoting rules will not be applied. To specify a column-name expression which should be subject to quoting rules, use the :func:`column` function. :param type\_: an optional :class:`~sqlalchemy.types.TypeEngine` object which will provide result-set translation and additional expression semantics for this column. If left as ``None`` the type will be :class:`.NullType`. .. seealso:: :func:`_expression.column` :func:`_expression.text` :ref:`tutorial_select_arbitrary_text` T)rq � is_literal�� ColumnClause)r rq ru ru rw �literal_column� s #r� c @ sj e Zd ZdZdZdZdZdZe� d�e� d�dd d d d d �dd���Z dd d d�dd�Z dd�dd�Z dS )�CompilerElementznbase class for SQL elements that can be compiled to produce a SQL string. .. versionadded:: 2.0 ru Zcompiler_elementF�defaultzsqlalchemy.engine.defaultzsqlalchemy.engine.urlN�Optional[_HasDialect]�Optional[Dialect]r rK ��bind�dialect�kwrs c K sZ |dkrL|r|j }n8| jdkr0tjj}|�� }n tjj}|j�| j�� � � }| j |f|�S )a� Compile this SQL expression. The return value is a :class:`~.Compiled` object. Calling ``str()`` or ``unicode()`` on the returned value will yield a string representation of the result. The :class:`~.Compiled` object also can return a dictionary of bind parameter names and values using the ``params`` accessor. :param bind: An :class:`.Connection` or :class:`.Engine` which can provide a :class:`.Dialect` in order to generate a :class:`.Compiled` object. If the ``bind`` and ``dialect`` parameters are both omitted, a default SQL compiler is used. :param column_keys: Used for INSERT and UPDATE statements, a list of column names which should be present in the VALUES clause of the compiled statement. If ``None``, all columns from the target table object are rendered. :param dialect: A :class:`.Dialect` instance which can generate a :class:`.Compiled` object. This argument takes precedence over the ``bind`` argument. :param compile_kwargs: optional dictionary of additional parameters that will be passed through to the compiler within all "visit" methods. This allows any custom flag to be passed through to a custom compilation construct, for example. It is also used for the case of passing the ``literal_binds`` flag through:: from sqlalchemy.sql import table, column, select t = table('t', column('x')) s = select(t).where(t.c.x == 5) print(s.compile(compile_kwargs={"literal_binds": True})) .. seealso:: :ref:`faq_sql_expression_string` Nr� ) r� �stringify_dialectr< � preloadedZengine_defaultZStrCompileDialectZ engine_url�URL�create� get_dialect� _compiler)�selfr� r� r� r� �urlru ru rw �compile� s 4 � zCompilerElement.compiler] �r� r� rs c K s" t rt| t�st�|j|| f|�S )zNReturn a compiler appropriate for this ClauseElement, given a Dialect.)r � isinstance� ClauseElement�AssertionErrorZstatement_compiler�r� r� r� ru ru rw r� 6 s zCompilerElement._compilerr} �rs c C s t | �� �S rt )r} r� �r� ru ru rw �__str__> s zCompilerElement.__str__)NN) �__name__� __module__� __qualname__�__doc__� __slots__�__visit_name__�supports_executionr� r< �preload_moduler� r� r� ru ru ru rw r� � s �@r� c @ sT e Zd ZU dZdZer,ejdd�dd��Znej Zej dd�dd ��Z d Z d e d < d ZdZdZdZdZdZdZdZdZdZdZdZdZdZdZ dZ dZ dZ dZ dZ!dZ"e#dd�dd��Z$d Z%de d< de d< e&jr�dd�dddd�d d �Z'ej(d d�d d ��Z)d!d"d#�d$d%�Z*dd"d&�d'd(�Z+d)d*� Z,d+d,� Z-e#d-d.� �Z.e/j0d/d0� �Z1d1d2� Z2e#d3d4� �Z3d5d6� Z4d7d8d9d:d;�d<d=�Z5d7d8d9dd;�d>d?�Z6d@d�dAdB�Z7didCdd"dD�dEdF�Z8djdGdd"dD�dHdI�Z9dJdGdKd"dL�dMdN�Z:d ddJdO�dPdQ�Z;dkdRd dS�dTdU�Z<d d�dVdW�Z=dd dX�dYdZd[dJd\dd]d^�d_d`�Z>dadb� Z?d d�dcdd�Z@dedf� ZAdgdh� ZBd S )lr� zSBase class for elements of a programmatically constructed SQL expression. �clauserG r� c C s dS )z�like annotations, however these propagate outwards liberally as SQL constructs are built, and are set up at construction time. Nru r� ru ru rw �_propagate_attrsS s z ClauseElement._propagate_attrs� Optional[str]c C s d S rt ru r� ru ru rw � description^ s zClauseElement.descriptionNzOptional[Self]� _is_clone_ofTF�Optional[Label[Any]]c C s d S rt ru r� ru ru rw �_order_by_label_elementz s z%ClauseElement._order_by_label_elementrI �_cache_key_traversal�ColumnElement[bool]�negation_clause.)� omit_attrsztyping_Tuple[str, ...]r zIterable[ClauseElement])r� r� rs c K s d S rt ru )r� r� r� ru ru rw � get_children� s zClauseElement.get_children�List[FromClause]c C s g S rt ru r� ru ru rw � _from_objects� s zClauseElement._from_objects�Mapping[str, Any]rA )�valuesrs c C s t �|�| _| S rt )r< Z immutabledictr� )r� r� ru ru rw �_set_propagate_attrs� s z"ClauseElement._set_propagate_attrs)r� rs c s` | j � | j�| j�}� r8� fdd�| j�� �� D �|_n | j�� |_| j}|dk rV|n| |_|S )z�Create a shallow copy of this ClauseElement. This method may be used by a generative API. Its also used as part of the "deep" copy afforded by a traversal that combines the _copy_internals() method. c s i | ]\}}|� kr||�qS ru ru ��.0�k�v��skipru rw � <dictcomp>� s z(ClauseElement._clone.<locals>.<dictcomp>N)Z_memoized_keys� __class__�__new__�__dict__�copy�itemsr� )r� r� �c�ccru r� rw r% � s � zClauseElement._clonec C s | S )z�a hook to allow the right side of a binary expression to respond to a negation of the binary expression. Used for the special case of expanding bind parameter with IN. ru )r� � negated_op� original_opru ru rw �_negate_in_binary� s z ClauseElement._negate_in_binaryc C s | S )z�in the context of binary expression, convert the type of this object to the one given. applies only to :class:`_expression.ColumnElement` classes. ru �r� rq ru ru rw �_with_binary_element_type� s z'ClauseElement._with_binary_element_typec C s | j S )a. return the 'constructor' for this ClauseElement. This is for the purposes for creating a new object of this type. Usually, its just the element's __class__. However, the "Annotated" version of the object overrides to return the class of its proxied element. �r� r� ru ru rw � _constructor� s zClauseElement._constructorc C s* t �� }| }|dk r&|�|� |j}q |S )a Return the set consisting all cloned ancestors of this ClauseElement. Includes this ClauseElement. This accessor tends to be used for FromClause objects to identify 'equivalent' FROM clauses, regardless of transformative operations. N)r< Z column_set�addr� )r� �s�fru ru rw � _cloned_set� s zClauseElement._cloned_setc C s | j d k r| j } q | S rt )r� r� ru ru rw � _de_clone� s zClauseElement._de_clonec C s t d��d S )NzFThis SQL expression has no entity namespace with which to filter from.)�AttributeErrorr� ru ru rw �entity_namespace� s �z ClauseElement.entity_namespacec C s& | j �� }|�dd � |�dd � |S )Nr� �_generate_cache_key)r� r� �pop)r� �dru ru rw � __getstate__� s zClauseElement.__getstate__r\ r^ ra z Result[Any])� connection�distilled_params�execution_optionsrs c C s4 | j r&trt| t�st�|�| ||�S t�| ��d S rt )r� r r� r) r� Z_execute_clauseelementr: ZObjectNotExecutableError�r� r� r� r� ru ru rw �_execute_on_connection� s �z$ClauseElement._execute_on_connectionc C s | � |||��� S )z�an additional hook for subclasses to provide a different implementation for connection.scalar() vs. connection.execute(). .. versionadded:: 2.0 )r� Zscalarr� ru ru rw �_execute_on_scalar s �z ClauseElement._execute_on_scalar� Sequence[BindParameter[Any]]c C s4 | � � }|dkr*g }t| i d|ji� |S |jS dS )a� Return the list of :class:`.BindParameter` objects embedded in the object. This accomplishes the same purpose as ``visitors.traverse()`` or similar would provide, however by making use of the cache key it takes advantage of memoization of the key to result in fewer net method calls, assuming the statement is also going to be executed. N� bindparam)r� r7 �append� bindparams)r� �keyr� ru ru rw �_get_embedded_bindparams s z&ClauseElement._get_embedded_bindparamszOptional[Dict[str, Any]])� _ClauseElement__optionaldict�kwargsrs c K s | � d||�S )a Return a copy with :func:`_expression.bindparam` elements replaced. Same functionality as :meth:`_expression.ClauseElement.params`, except adds `unique=True` to affected bind parameters so that multiple statements can be used. T��_replace_params�r� r� r� ru ru rw � unique_params/ s zClauseElement.unique_params�Optional[Mapping[str, Any]]c K s | � d||�S )a� Return a copy with :func:`_expression.bindparam` elements replaced. Returns a copy of this ClauseElement with :func:`_expression.bindparam` elements replaced with values taken from the given dictionary:: >>> clause = column('x') + bindparam('foo') >>> print(clause.compile().params) {'foo':None} >>> print(clause.params({'foo':7}).compile().params) {'foo':7} Fr� r� ru ru rw �params? s zClauseElement.paramsrn zDict[str, Any])�unique� optionaldictr� rs c s: |r� � |� ddd�� �fdd� }t| ddd�d|i�S ) Nr{ ry )r� rs c s, | j � kr � | j | _d| _�r(| �� d S )NF)r� rp �required�_convert_to_unique)r� �r� r� ru rw �visit_bindparam] s z6ClauseElement._replace_params.<locals>.visit_bindparamT)� maintain_key�detect_subquery_colsr� )�updater4 )r� r� r� r� r� ru r� rw r� T s �z ClauseElement._replace_params��otherr� rs c K s t j| |f|�S )a� Compare this :class:`_expression.ClauseElement` to the given :class:`_expression.ClauseElement`. Subclasses should override the default behavior, which is a straight identity comparison. \**kw are arguments consumed by subclass ``compare()`` methods and may be used to modify the criteria for comparison (see :class:`_expression.ColumnElement`). )r �compare�r� r� r� ru ru rw r� j s zClauseElement.compare�Optional[OperatorType]��againstrs c C s | S )a� Apply a 'grouping' to this :class:`_expression.ClauseElement`. This method is overridden by subclasses to return a "grouping" construct, i.e. parenthesis. In particular it's used by "binary" expressions to provide a grouping around themselves when placed into a larger expression, as well as by :func:`_expression.select` constructs when placed into the FROM clause of another :func:`_expression.select`. (Note that subqueries should be normally created using the :meth:`_expression.Select.alias` method, as many platforms require nested SELECT statements to be named). As expressions are composed together, the application of :meth:`self_group` is automatic - end-user code should never need to use this method directly. Note that SQLAlchemy's clause constructs take operator precedence into account - so parenthesis might not be needed, for example, in an expression like ``x OR (y AND z)`` - AND takes precedence over OR. The base :meth:`self_group` method of :class:`_expression.ClauseElement` just returns self. ru �r� r� ru ru rw � self_groupx s zClauseElement.self_groupc C s | S )zVReturn this :class:`_expression.ClauseElement` without any groupings. ru r� ru ru rw �_ungroup� s zClauseElement._ungroup)�for_executemany�schema_translate_mapr] zOptional[CompiledCacheType]z List[str]z Optional[SchemaTranslateMapType]zJtyping_Tuple[Compiled, Optional[Sequence[BindParameter[Any]]], CacheStats])r� �compiled_cache� column_keysr� r� r� rs c K s� |d k r|j r| �� }nd }|d k r�tr4|d k s4t�|\}} ||t|�t|�|f} |�| �} | d kr�|j} | j|f||||d�|��} | || < q�|j } nDd } | j|f||||d�|��} |j s�|j } n|d kr�|j } n|j } | | | fS )N)� cache_keyr r� r� ) Z_supports_statement_cacher� r r� �tuplern �getZ CACHE_MISSr� Z CACHE_HITZNO_DIALECT_SUPPORTZCACHING_DISABLEDZ NO_CACHE_KEY) r� r� r� r r� r� r� Zelem_cache_keyr Zextracted_paramsr� Z compiled_sqlZ cache_hitru ru rw �_compile_w_cache� sZ � ��� ��� z ClauseElement._compile_w_cachec C s t | d�r| jS | �� S d S )Nr� )�hasattrr� �_negater� ru ru rw � __invert__� s zClauseElement.__invert__c C s* | j tjd�}t|t�s t�t|tjd�S )N�r� ��operator�r� r �invr� � ColumnElementr� �UnaryExpression�r� �groupedru ru rw r � s zClauseElement._negatec C s t d��d S )N�+Boolean value of this clause is not defined)� TypeErrorr� ru ru rw �__bool__� s zClauseElement.__bool__c C s6 | j }|d krt�| �S d| j| jjt| �|f S d S )Nz<%s.%s at 0x%x; %s>)r� �object�__repr__r� r� r� �id)r� �friendlyru ru rw r � s �zClauseElement.__repr__)N)N)N)Cr� r� r� r� r� r r< �memoized_propertyr� � EMPTY_DICT�ro_memoized_propertyr� r� �__annotations__Zis_clause_elementZ is_selectableZis_dml�_is_column_element�_is_keyed_column_elementZ _is_tableZ!_gen_static_annotations_cache_key� _is_textualZ_is_from_clauseZ_is_returns_rows�_is_text_clauseZ_is_from_containerZ_is_select_containerZ_is_select_baseZ_is_select_statement�_is_bind_parameter�_is_clause_listZ_is_lambda_elementZ_is_singleton_constant� _is_immutable�_is_star�propertyr� r� �typingr� �ro_non_memoized_propertyr� r� r% r� r� r� r+ �memoized_attributer� r� r� r� r� r� r� r� r� r� r� r� r� r r r r r ru ru ru rw r� B s� � � � � � Br� c @ s> e Zd ZdZejr:dddd�dd�Zdd d ddd �d d �ZdS )�DQLDMLClauseElementz|represents a :class:`.ClauseElement` that compiles to a DQL or DML expression, not DDL. .. versionadded:: 2.0 r] r rL r� c K s dS )zRReturn a compiler appropriate for this ClauseElement, given a Dialect.Nru r� ru ru rw r� s z DQLDMLClauseElement._compilerNr� r� r� c K s d S rt ru )r� r� r� r� ru ru rw r� s zDQLDMLClauseElement.compile)NN)r� r� r� r� r% r r� r� ru ru ru rw r( � s �r( c @ s e Zd ZdZdZejZdZdS )�CompilerColumnElementzdA compiler-only column element used for ad-hoc string compilations. .. versionadded:: 2.0 ru FN) r� r� r� r� r� r< r r� �_is_collection_aggregateru ru ru rw r) s r) c @ s� e Zd ZdZej�r�ejdd�dd��Zddddd �d d �Z ddddd �d d �Z e d�dd�ddddddd�dd��Z e d�ddddddd�d d��Z d�ddddddd�d d�Z d�dddd d!�d"d#�Z dd$d%�d&d'�Zdd$d%�d(d)�Zd*d�d+d,�Zdd-d%�d.d/�Zdd-d%�d0d1�Zdd�d2d3�Zdd-d%�d4d5�Zdd-d%�d6d7�Zdd-d%�d8d9�Zdd-d%�d:d;�Zdd-d%�d<d=�Zdd-d%�d>d?�Zd@d�dAdB�Zdd-d%�dCdD�ZdddE�dFdG�Z e dHddIdJ�dKdL��Z e ddd%�dMdL��Z ddd%�dNdL�Z e dHddIdJ�dOdP��Z e ddd%�dQdP��Z ddd%�dRdP�Z e dSddTdJ�dUdV��Z e ddd%�dWdV��Z ddd%�dXdV�Z d�ddYdZd[�d\d]�Z d�ddYdZd[�d^d_�Z!dd`d%�dadb�Z"dd`d%�dcdd�Z#dd`d%�dedf�Z$d@d�dgdh�Z%dd`d%�didj�Z&dd`d%�dkdl�Z'dmdZd%�dndo�Z(dmdZd%�dpdq�Z)dmdZd%�drds�Z*d�ddYdZd[�dtdu�Z+d�ddYdZd[�dvdw�Z,d�ddYdZd[�dxdy�Z-d�ddYdZd[�dzd{�Z.ddZd%�d|d}�Z/ddZd%�d~d�Z0ddZd%�d�d��Z1d�ddYdd-d��d�d��Z2d�ddYdd-d��d�d��Z3d�ddYdd-d��d�d��Z4d�ddYdd-d��d�d��Z5ddd-d��d�d��Z6ddd-d��d�d��Z7ddd-d��d�d��Z8d�ddYd-d��d�d��Z9d�dddYdTd��d�d��Z:d@d�d�d��Z;d@d�d�d��Z<d@d�d�d��Z=d@d�d�d��Z>d@d�d�d��Z?d@d�d�d��Z@dd�d��d�d��ZAd�ddddZd��d�d��ZBd�d@d��d�d��ZCd�d�d�d��ZDd�d�d�d��ZEe d�dd�dJ�d�d���ZFe dSddTdJ�d�d���ZFe ddd%�d�d���ZFddd%�d�d��ZFe d�dd�dJ�d�d���ZGe dSddTdJ�d�d���ZGddd%�d�d��ZGe d�dd�dJ�d�d���ZHe ddd%�d�d���ZHddd%�d�d��ZHe d�dd�dJ�d�dń�ZIe ddd%�d�dń�ZIddd%�d�dńZIe d�dd�dJ�d�dɄ�ZJe ddd%�d�dɄ�ZJddd%�d�dɄZJe d�dd�dJ�d�d̈́�ZKe ddd%�d�d̈́�ZKddd%�d�d̈́ZKe d�dd�dJ�d�dф�ZLe ddd%�d�dф�ZLddd%�d�dфZLe d�dd�dJ�d�dՄ�ZMe ddd%�d�dՄ�ZMddd%�d�dՄZMe dHdd�dJ�d�dڄ�ZNe d�dd�dJ�d�dڄ�ZNe ddd%�d�dڄ�ZNddd%�d�dڄZNe d�dd�dJ�d�d��ZOe ddd%�d�d��ZOddd%�d�d�ZOe d�dd�dJ�d�d��ZPe ddd%�d�d��ZPddd%�d�d�ZPe d�dd�dJ�d�d��ZQe ddd%�d�d��ZQddd%�d�d�ZQdS )��SQLCoreOperationsru rG r� c C s d S rt ru r� ru ru rw r� / s z"SQLCoreOperations._propagate_attrsrN r �ColumnElement[Any]��opr� r� rs c O s d S rt ru �r� r. r� r� ru ru rw �operate2 s zSQLCoreOperations.operatec K s d S rt ru r/ ru ru rw �reverse_operate6 s z!SQLCoreOperations.reverse_operate.N)� python_implr} �intrn �_TypeEngineArgument[_OPT]z Optional[Callable[..., Any]]z'Callable[[Any], BinaryExpression[_OPT]])�opstring� precedence� is_comparison� return_typer2 rs c C s d S rt ru �r� r5 r6 r7 r8 r2 ru ru rw r. : s zSQLCoreOperations.oprz z&Callable[[Any], BinaryExpression[Any]]c C s d S rt ru r9 ru ru rw r. E s r Fc C s d S rt ru r9 ru ru rw r. O s z'Callable[[Any], BinaryExpression[bool]])r5 r6 r2 rs c C s d S rt ru )r� r5 r6 r2 ru ru rw �bool_opX s zSQLCoreOperations.bool_op�BooleanClauseList�r� rs c C s d S rt ru �r� r� ru ru rw �__and___ � zSQLCoreOperations.__and__c C s d S rt ru r= ru ru rw �__or__a r? zSQLCoreOperations.__or__zColumnElement[_T_co]c C s d S rt ru r� ru ru rw r c r? z SQLCoreOperations.__invert__r� c C s d S rt ru r= ru ru rw �__lt__e r? zSQLCoreOperations.__lt__c C s d S rt ru r= ru ru rw �__le__g r? zSQLCoreOperations.__le__c C s d S rt ru r� ru ru rw �__hash__m r? zSQLCoreOperations.__hash__c C s d S rt ru r= ru ru rw �__eq__o s zSQLCoreOperations.__eq__c C s d S rt ru r= ru ru rw �__ne__r s zSQLCoreOperations.__ne__c C s d S rt ru r= ru ru rw �is_distinct_fromu r? z"SQLCoreOperations.is_distinct_fromc C s d S rt ru r= ru ru rw �is_not_distinct_fromw r? z&SQLCoreOperations.is_not_distinct_fromc C s d S rt ru r= ru ru rw �__gt__y r? zSQLCoreOperations.__gt__c C s d S rt ru r= ru ru rw �__ge__{ r? zSQLCoreOperations.__ge__zUnaryExpression[_T_co]c C s d S rt ru r� ru ru rw �__neg__} r? zSQLCoreOperations.__neg__c C s d S rt ru r= ru ru rw � __contains__ r? z SQLCoreOperations.__contains__)�indexrs c C s d S rt ru )r� rL ru ru rw � __getitem__� r? z SQLCoreOperations.__getitem__z _SQO[int]zColumnElement[int])r� r� rs c C s d S rt ru r= ru ru rw � __lshift__� s z SQLCoreOperations.__lshift__c C s d S rt ru r= ru ru rw rN � s c C s d S rt ru r= ru ru rw rN � r? c C s d S rt ru r= ru ru rw � __rshift__� s z SQLCoreOperations.__rshift__c C s d S rt ru r= ru ru rw rO � s c C s d S rt ru r= ru ru rw rO � r? z _SQO[str]zColumnElement[str]c C s d S rt ru r= ru ru rw �concat� s zSQLCoreOperations.concatc C s d S rt ru r= ru ru rw rP � s c C s d S rt ru r= ru ru rw rP � r? r� zBinaryExpression[bool])r� �escapers c C s d S rt ru �r� r� rQ ru ru rw �like� s zSQLCoreOperations.likec C s d S rt ru rR ru ru rw �ilike� s zSQLCoreOperations.ilikezBinaryExpression[Any]c C s d S rt ru r= ru ru rw � bitwise_xor� r? z SQLCoreOperations.bitwise_xorc C s d S rt ru r= ru ru rw � bitwise_or� r? z SQLCoreOperations.bitwise_orc C s d S rt ru r= ru ru rw � bitwise_and� r? z SQLCoreOperations.bitwise_andc C s d S rt ru r� ru ru rw � bitwise_not� r? z SQLCoreOperations.bitwise_notc C s d S rt ru r= ru ru rw �bitwise_lshift� r? z SQLCoreOperations.bitwise_lshiftc C s d S rt ru r= ru ru rw �bitwise_rshift� r? z SQLCoreOperations.bitwise_rshiftz=Union[Iterable[Any], BindParameter[Any], roles.InElementRole]c C s d S rt ru r= ru ru rw �in_� s zSQLCoreOperations.in_c C s d S rt ru r= ru ru rw �not_in� s zSQLCoreOperations.not_inc C s d S rt ru r= ru ru rw �notin_� s zSQLCoreOperations.notin_c C s d S rt ru rR ru ru rw �not_like� s zSQLCoreOperations.not_likec C s d S rt ru rR ru ru rw �notlike� s zSQLCoreOperations.notlikec C s d S rt ru rR ru ru rw � not_ilike� s zSQLCoreOperations.not_ilikec C s d S rt ru rR ru ru rw �notilike� s zSQLCoreOperations.notilikec C s d S rt ru r= ru ru rw �is_� r? zSQLCoreOperations.is_c C s d S rt ru r= ru ru rw �is_not� r? zSQLCoreOperations.is_notc C s d S rt ru r= ru ru rw �isnot� r? zSQLCoreOperations.isnot)r� rQ � autoescapers c C s d S rt ru �r� r� rQ re ru ru rw � startswith� s z SQLCoreOperations.startswithc C s d S rt ru rf ru ru rw � istartswith� s z SQLCoreOperations.istartswithc C s d S rt ru rf ru ru rw �endswith� s zSQLCoreOperations.endswithc C s d S rt ru rf ru ru rw � iendswith� s zSQLCoreOperations.iendswithr� c K s d S rt ru r� ru ru rw �contains� r? zSQLCoreOperations.containsc K s d S rt ru r� ru ru rw � icontains� r? zSQLCoreOperations.icontains)r� r� rs c K s d S rt ru )r� r� r� ru ru rw �match� r? zSQLCoreOperations.match)�pattern�flagsrs c C s d S rt ru )r� rn ro ru ru rw � regexp_match� s z SQLCoreOperations.regexp_match)rn � replacementro rs c C s d S rt ru )r� rn rq ro ru ru rw �regexp_replace s z SQLCoreOperations.regexp_replacec C s d S rt ru r� ru ru rw �desc r? zSQLCoreOperations.descc C s d S rt ru r� ru ru rw �asc r? zSQLCoreOperations.ascc C s d S rt ru r� ru ru rw � nulls_first r? z SQLCoreOperations.nulls_firstc C s d S rt ru r� ru ru rw � nullsfirst r? z SQLCoreOperations.nullsfirstc C s d S rt ru r� ru ru rw � nulls_last r? z SQLCoreOperations.nulls_lastc C s d S rt ru r� ru ru rw � nullslast r? zSQLCoreOperations.nullslast�CollationClause)� collationrs c C s d S rt ru �r� rz ru ru rw �collate r? zSQLCoreOperations.collate)�cleft�cright� symmetricrs c C s d S rt ru )r� r} r~ r ru ru rw �between s zSQLCoreOperations.betweenz _SQO[_T_co]�r� rs c C s d S rt ru r� ru ru rw �distinct r? zSQLCoreOperations.distinctzCollectionAggregate[Any]c C s d S rt ru r� ru ru rw �any_ r? zSQLCoreOperations.any_c C s d S rt ru r� ru ru rw �all_ r? zSQLCoreOperations.all_z _SQO[_NMT]zColumnElement[_NMT]c C s d S rt ru r= ru ru rw �__add__! s zSQLCoreOperations.__add__c C s d S rt ru r= ru ru rw r� ' s c C s d S rt ru r= ru ru rw r� - s c C s d S rt ru r= ru ru rw r� 0 r? c C s d S rt ru r= ru ru rw �__radd__2 s zSQLCoreOperations.__radd__c C s d S rt ru r= ru ru rw r� 5 s c C s d S rt ru r= ru ru rw r� 8 r? c C s d S rt ru r= ru ru rw �__sub__: s zSQLCoreOperations.__sub__c C s d S rt ru r= ru ru rw r� @ s c C s d S rt ru r= ru ru rw r� C r? c C s d S rt ru r= ru ru rw �__rsub__E s zSQLCoreOperations.__rsub__c C s d S rt ru r= ru ru rw r� K s c C s d S rt ru r= ru ru rw r� N r? c C s d S rt ru r= ru ru rw �__mul__P s zSQLCoreOperations.__mul__c C s d S rt ru r= ru ru rw r� V s c C s d S rt ru r= ru ru rw r� Y r? c C s d S rt ru r= ru ru rw �__rmul__[ s zSQLCoreOperations.__rmul__c C s d S rt ru r= ru ru rw r� a s c C s d S rt ru r= ru ru rw r� d r? c C s d S rt ru r= ru ru rw �__mod__f s zSQLCoreOperations.__mod__c C s d S rt ru r= ru ru rw r� i s c C s d S rt ru r= ru ru rw r� l r? c C s d S rt ru r= ru ru rw �__rmod__n s zSQLCoreOperations.__rmod__c C s d S rt ru r= ru ru rw r� q s c C s d S rt ru r= ru ru rw r� t r? zColumnElement[_NUMERIC]c C s d S rt ru r= ru ru rw � __truediv__v s z SQLCoreOperations.__truediv__z _SQO[_NT]zColumnElement[_NT]c C s d S rt ru r= ru ru rw r� { s c C s d S rt ru r= ru ru rw r� ~ s c C s d S rt ru r= ru ru rw r� � r? c C s d S rt ru r= ru ru rw � __rtruediv__� s z SQLCoreOperations.__rtruediv__c C s d S rt ru r= ru ru rw r� � s c C s d S rt ru r= ru ru rw r� � r? c C s d S rt ru r= ru ru rw � __floordiv__� s z SQLCoreOperations.__floordiv__c C s d S rt ru r= ru ru rw r� � s c C s d S rt ru r= ru ru rw r� � r? c C s d S rt ru r= ru ru rw � __rfloordiv__� s z SQLCoreOperations.__rfloordiv__c C s d S rt ru r= ru ru rw r� � s c C s d S rt ru r= ru ru rw r� � r? )..)....)r FNN)r N)N)N)N)N)N)N)NF)NF)NF)NF)N)N)F)Rr� r� r� r� r% r r< �non_memoized_propertyr� r0 r1 r r. r: r> r@ r rA rB rC rD rE rF rG rH rI rJ rK rM rN rO rP rS rT rU rV rW rX rY rZ r[ r\ r] r^ r_ r` ra rb rc rd rg rh ri rj rk rl rm rp rr rs rt ru rv rw rx r| r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� ru ru ru rw r+ ' s^ �� � � � � � � � � � � � � � � � �r+ c @ s e Zd ZdZdZdS )�SQLColumnExpressiona� A type that may be used to indicate any SQL column element or object that acts in place of one. :class:`.SQLColumnExpression` is a base of :class:`.ColumnElement`, as well as within the bases of ORM elements such as :class:`.InstrumentedAttribute`, and may be used in :pep:`484` typing to indicate arguments or return values that should behave as column expressions. .. versionadded:: 2.0.0b4 ru N�r� r� r� r� r� ru ru ru rw r� � s r� c @ s� e Zd ZU dZdZdZded< ded< dZdZded < dZ dZ e � Z d ed < e jd d �dd��Ze jdd �dd��ZdZded< ejdd �dd��Zedd �dd��Zedd �dd��Zedd �dd ��ZdZdZdZ d Z d ed < e d�d d!d"�d#d$��Z e d�d%d&d"�d'd$��Z d�d%d&d"�d(d$�Z e d)d)d*�d+d,��Z e d!d!d*�d-d,��Z d&d �d.d,�Z d/ed0< e!�sxe jd/d �d1d2��Z"ejd3d �d4d5��Z#d6d7� Z$d8d9d:�d;d<�Z%d=d9d9d&d>�d?d@�Z&d=d9d9d&d>�dAdB�Z'd�d=d9dCddDdE�dFdG�Z(ed&d �dHdI��Z)edJd �dKdL��Z*e jdMd �dNdO��Z+e jdMd �dPdQ��Z,e jdMd �dRdS��Z-d d �dTdU�Z.d&ddV�dWdX�Z/d&ddY�dZd[�Z0ejdd �d\d]��Z1ejdd �d^d_��Z2ddddd`�daddddbd9dcdd�dedf�Z3dgdhdi�djdk�Z4ddldm�dndo�Z5d�ddpdqdr�dsdt�Z6e jd8d �dudv��Z7e jdqd �dwdx��Z8ee �9dydz�d8d �d{d|���Z:ee �9dyd}�d8d �d~d���Z;d�d8d��d�d��Z<e jdqd �d�d���Z=e jdqd �d�d���Z>d�dqd��d�d��Z?dS )�r a Represent a column-oriented SQL expression suitable for usage in the "columns" clause, WHERE clause etc. of a statement. While the most familiar kind of :class:`_expression.ColumnElement` is the :class:`_schema.Column` object, :class:`_expression.ColumnElement` serves as the basis for any unit that may be present in a SQL expression, including the expressions themselves, SQL functions, bound parameters, literal expressions, keywords such as ``NULL``, etc. :class:`_expression.ColumnElement` is the ultimate base class for all such elements. A wide variety of SQLAlchemy Core functions work at the SQL expression level, and are intended to accept instances of :class:`_expression.ColumnElement` as arguments. These functions will typically document that they accept a "SQL expression" as an argument. What this means in terms of SQLAlchemy usually refers to an input which is either already in the form of a :class:`_expression.ColumnElement` object, or a value which can be **coerced** into one. The coercion rules followed by most, but not all, SQLAlchemy Core functions with regards to SQL expressions are as follows: * a literal Python value, such as a string, integer or floating point value, boolean, datetime, ``Decimal`` object, or virtually any other Python object, will be coerced into a "literal bound value". This generally means that a :func:`.bindparam` will be produced featuring the given value embedded into the construct; the resulting :class:`.BindParameter` object is an instance of :class:`_expression.ColumnElement`. The Python value will ultimately be sent to the DBAPI at execution time as a parameterized argument to the ``execute()`` or ``executemany()`` methods, after SQLAlchemy type-specific converters (e.g. those provided by any associated :class:`.TypeEngine` objects) are applied to the value. * any special object value, typically ORM-level constructs, which feature an accessor called ``__clause_element__()``. The Core expression system looks for this method when an object of otherwise unknown type is passed to a function that is looking to coerce the argument into a :class:`_expression.ColumnElement` and sometimes a :class:`_expression.SelectBase` expression. It is used within the ORM to convert from ORM-specific objects like mapped classes and mapped attributes into Core expression objects. * The Python ``None`` value is typically interpreted as ``NULL``, which in SQLAlchemy Core produces an instance of :func:`.null`. A :class:`_expression.ColumnElement` provides the ability to generate new :class:`_expression.ColumnElement` objects using Python expressions. This means that Python operators such as ``==``, ``!=`` and ``<`` are overloaded to mimic SQL operations, and allow the instantiation of further :class:`_expression.ColumnElement` instances which are composed from other, more fundamental :class:`_expression.ColumnElement` objects. For example, two :class:`.ColumnClause` objects can be added together with the addition operator ``+`` to produce a :class:`.BinaryExpression`. Both :class:`.ColumnClause` and :class:`.BinaryExpression` are subclasses of :class:`_expression.ColumnElement`: .. sourcecode:: pycon+sql >>> from sqlalchemy.sql import column >>> column('a') + column('b') <sqlalchemy.sql.expression.BinaryExpression object at 0x101029dd0> >>> print(column('a') + column('b')) {printsql}a + b .. seealso:: :class:`_schema.Column` :func:`_expression.column` Zcolumn_elementFrn � primary_key�Optional[ColumnElement[_T]]r� T�_insert_sentinelzAbstractSet[ForeignKey]� foreign_keys�List[ColumnElement[Any]]r� c C s g S rt ru r� ru ru rw �_proxies! s zColumnElement._proxiesr� c C s dS )a} The named label that can be used to target this column in a result set in a "table qualified" context. This label is almost always the label used when rendering <expr> AS <label> in a SELECT statement when using the LABEL_STYLE_TABLENAME_PLUS_COL label style, which is what the legacy ORM ``Query`` object uses as well. For a regular Column bound to a Table, this is typically the label <tablename>_<columnname>. For other constructs, different rules may apply, such as anonymized labels and others. .. versionchanged:: 1.4.21 renamed from ``._label`` Nru r� ru ru rw � _tq_label% s zColumnElement._tq_labelNr� c C s | j S )al A label-based version of 'key' that in some circumstances refers to this object in a Python namespace. _tq_key_label comes into play when a select() statement is constructed with apply_labels(); in this case, all Column objects in the ``.c`` collection are rendered as <tablename>_<columnname> in SQL; this is essentially the value of ._label. But to locate those columns in the ``.c`` collection, the name is along the lines of <tablename>_<key>; that's the typical value of .key_label. .. versionchanged:: 1.4.21 renamed from ``._key_label`` )� _proxy_keyr� ru ru rw � _tq_key_labelB s zColumnElement._tq_key_labelc C s | j S )z legacy; renamed to _tq_key_label)r� r� ru ru rw � _key_labelT s zColumnElement._key_labelc C s | j S )z legacy; renamed to _tq_label�r� r� ru ru rw �_labelY s zColumnElement._labelc C s t | dd�S )a: the 'name' that naturally applies this element when rendered in SQL. Concretely, this is the "name" of a column or a label in a SELECT statement; ``<columnname>`` and ``<labelname>`` below:: SELECT <columnmame> FROM table SELECT column AS <labelname> FROM table Above, the two names noted will be what's present in the DBAPI ``cursor.description`` as the names. If this attribute returns ``None``, it means that the SQL element as written does not have a 100% fully predictable "name" that would appear in the ``cursor.description``. Examples include SQL functions, CAST functions, etc. While such things do return names in ``cursor.description``, they are only predictable on a database-specific basis; e.g. an expression like ``MAX(table.col)`` may appear as the string ``max`` on one database (like PostgreSQL) or may appear as the whole expression ``max(table.col)`` on SQLite. The default implementation looks for a ``.name`` attribute on the object, as has been the precedent established in SQLAlchemy for many years. An exception is made on the ``FunctionElement`` subclass so that the return value is always ``None``. .. versionadded:: 1.4.21 �nameN)�getattrr� ru ru rw �_non_anon_label^ s "z ColumnElement._non_anon_labelru z Sequence[str]� _alt_namesry �ColumnElement[_T]r� c C s d S rt ru r� ru ru rw r� � s zColumnElement.self_groupr� r, c C s d S rt ru r� ru ru rw r� � s c C sT |t jt jt jfkr4| jjtjjkr4t| t j t j �S |t j t j fkrLt | �S | S d S rt )r �and_�or_�_asbool�type�_type_affinityr � BOOLEANTYPE� AsBoolean�is_true�is_false�any_op�all_op�Groupingr� ru ru rw r� � s ��r� r� c C s d S rt ru r� ru ru rw r � s zColumnElement._negatec C s d S rt ru r� ru ru rw r � s c C sP | j jtjjkr t| tjtj�S | jtj d�}t |t �s<t �t |tj dd�S d S �Nr T)r �wraps_column_expression)r� r� r r� r� r r� r� r� r r� r r� r r ru ru rw r � s ��TypeEngine[_T]r� c C s t jS rt �r �NULLTYPEr� ru ru rw r� � s zColumnElement.typezTypeEngine.Comparator[_T]c C sL z | j j}W n2 tk r> } ztd| j �|�W 5 d }~X Y n X || �S d S )NzOObject %r associated with '.type' attribute is not a TypeEngine class or object)r� �comparator_factoryr� r )r� r� �errru ru rw � comparator� s ���zColumnElement.comparatorc C s | j �|� d S rt )r� r� �r� �stateru ru rw � __setstate__� s zColumnElement.__setstate__r} r )r� rs c C sX zt | j|�W S tk rR } z&tdt| �jt| j�j|f �|�W 5 d }~X Y nX d S )Nz3Neither %r object nor %r object has an attribute %r)r� r� r� r� r� )r� r� r� ru ru rw � __getattr__� s ����zColumnElement.__getattr__zoperators.OperatorTyper- c O s || j f|�|�S rt �r� r/ ru ru rw r0 � s zColumnElement.operatec K s ||| j f|�S rt r� r/ ru ru rw r1 � s z ColumnElement.reverse_operate�Optional[TypeEngine[_T]]ro �r �objrq � expandingrs c C s t d |||| jd|d�S �NT)�_compared_to_operatorrq �_compared_to_typer� r� �� BindParameterr� �r� r r� rq r� ru ru rw � _bind_param� s �zColumnElement._bind_paramc C s | S )z^Return a column expression. Part of the inspection interface; returns self. ru r� ru ru rw � expression s zColumnElement.expressionrS c C s | fS rt ru r� ru ru rw �_select_iterable s z ColumnElement._select_iterablez FrozenSet[ColumnElement[Any]]c C s t dd� | jD ��S )Nc s s | ]}|j s|V qd S rt )r� �r� r� ru ru rw � <genexpr> s z-ColumnElement.base_columns.<locals>.<genexpr>)� frozenset� proxy_setr� ru ru rw � base_columns s zColumnElement.base_columnsc C s& t | �� g��tjdd� | jD �� �S )aF set of all columns we are proxying as of 2.0 this is explicitly deannotated columns. previously it was effectively deannotated columns but wasn't enforced. annotated columns should basically not go into sets if at all possible because their hashing behavior is very non-performant. c S s g | ] }|j �qS ru )r� r� ru ru rw � <listcomp> s z+ColumnElement.proxy_set.<locals>.<listcomp>)r� Z _deannotate�union� itertools�chainr� r� ru ru rw r� s �zColumnElement.proxy_setc C s t t| j��S rt )r� r& r� r� ru ru rw �_expanded_proxy_set s z!ColumnElement._expanded_proxy_setc C s | gt tjdd� | jD �� � S )z�An 'uncached' version of proxy set. This list includes annotated columns which perform very poorly in set operations. c S s g | ] }|� � �qS ru )�_uncached_proxy_listr� ru ru rw r� - s z6ColumnElement._uncached_proxy_list.<locals>.<listcomp>)�listr� r� r� r� ru ru rw r� $ s �z"ColumnElement._uncached_proxy_list)� othercolumnrs c C s t | j�|j��S )z�Return True if the given :class:`_expression.ColumnElement` has a common ancestor to this :class:`_expression.ColumnElement`.)rn r� � intersection)r� r� ru ru rw �shares_lineage0 s z ColumnElement.shares_lineager< c C s t |d�o t | d�o |j| jkS )zhReturn True if the given column element compares to this one when targeting within a result row.r� )r r� r= ru ru rw �_compare_name_for_result6 s � �z&ColumnElement._compare_name_for_resultc C sF | j r d| j kr tt| j d �S | j}|s0| j}t|t�r>d S |S d S )N� proxy_key)� _annotationsr r} r� r� r� �_anonymous_label�r� r� ru ru rw r� @ s zColumnElement._proxy_keyc C s< t | dd�dk rdS | jr4d| jkr4tt| jd �S dS dS )a\ a suggested label to use in the case that the column has no name, which should be used if possible as the explicit 'AS <label>' where this expression would normally have an anon label. this is essentially mostly what _proxy_key does except it returns None if the column has a normal name that can be used. r� Nr� )r� r� r r} r� ru ru rw �_expression_labelR s z ColumnElement._expression_label)r� r� �name_is_truncatable�compound_select_colsrT �&Optional[Sequence[ColumnElement[Any]]]�#typing_Tuple[str, ColumnClause[_T]])� selectabler� r� r� r� r� rs c K s� |dkr | j }|dkr"| j}n|}|dk s.t�t|rBt�tj|�n|t| dd�|d�}|j |_ |rnt |�|_ n| g|_ |j dk r�|j j �|�|_ ||fS )z�Create a new :class:`_expression.ColumnElement` representing this :class:`_expression.ColumnElement` as it appears in the select list of a descending selectable. Nr� )rq � _selectable)�_anon_name_labelr� r� r� r r| r �TruncatedLabelRoler� r� r� r� r� �columnsr )r� r� r� r� r� r� r� �coru ru rw � _make_proxyd s( � � zColumnElement._make_proxyr4 z Cast[_OPT])rq rs c C s t | |�S )a Produce a type cast, i.e. ``CAST(<expression> AS <type>)``. This is a shortcut to the :func:`_expression.cast` function. .. seealso:: :ref:`tutorial_casts` :func:`_expression.cast` :func:`_expression.type_coerce` )�Castr� ru ru rw r � s zColumnElement.cast� Label[_T])r� rs c C s t || | j�S )z�Produce a column label, i.e. ``<columnname> AS <name>``. This is a shortcut to the :func:`_expression.label` function. If 'name' is ``None``, an anonymous label name will be generated. )�Labelr� r� ru ru rw �label� s zColumnElement.labelz Optional[int]r� )�seed�add_hashrs c C sp | j d k r| j } q t| �}|rF|dk s*t�|s2t�|d> |B }|d }t|t�r`tj|d|d�S t�||pld�S )Ni � �_� )�enclosing_label�anon)r� �hashr� r� r� �safe_construct)r� r� r� � hash_valueru ru rw � _anon_label� s �zColumnElement._anon_labelc C s t | dd�}| �|�S )a� Provides a constant 'anonymous label' for this ColumnElement. This is a label() expression which will be named at compile time. The same label() is returned each time ``anon_label`` is called so that expressions can reference ``anon_label`` multiple times, producing the same label name at compile time. The compiler uses this function automatically at compile time for expressions that are known to be 'unnamed' like binary expressions and function calls. .. versionchanged:: 1.4.9 - this attribute was not intended to be public and is renamed to _anon_name_label. anon_name exists for backwards compat r� N�r� r� r� ru ru rw r� � s z ColumnElement._anon_name_labelc C s | � | j�S )a� Provides a constant 'anonymous key label' for this ColumnElement. Compare to ``anon_label``, except that the "key" of the column, if available, is used to generate the label. This is used when a deduplicating key is placed into the columns collection of a selectable. .. versionchanged:: 1.4.9 - this attribute was not intended to be public and is renamed to _anon_key_label. anon_key_label exists for backwards compat )r� r� r� ru ru rw �_anon_key_label� s z ColumnElement._anon_key_label�1.4zqThe :attr:`_expression.ColumnElement.anon_label` attribute is now private, and the public accessor is deprecated.c C s | j S rt )r� r� ru ru rw � anon_label� s zColumnElement.anon_labelzuThe :attr:`_expression.ColumnElement.anon_key_label` attribute is now private, and the public accessor is deprecated.c C s | j S rt )r� r� ru ru rw �anon_key_label� s z ColumnElement.anon_key_labelr3 ��idxrs c C s0 t | dd�}|dkr | �|�S | j||d�S dS )a) label to apply to a column that is anon labeled, but repeated in the SELECT, so that we have to make an "extra anon" label that disambiguates it from the previous appearance. these labels come out like "foo_bar_id__1" and have double underscores in them. r� N�r� )r� �_dedupe_anon_tq_label_idxr� �r� r r� ru ru rw �_dedupe_anon_label_idx s z$ColumnElement._dedupe_anon_label_idxc C s | � t| dd ��S �Nr� �r� r� r� ru ru rw �_anon_tq_label s z ColumnElement._anon_tq_labelc C s | � t| dd ��S )Nr� r r� ru ru rw �_anon_tq_key_label s z ColumnElement._anon_tq_key_labelc C s t | dd �pd}| j||d�S )Nr� r� r r� r ru ru rw r $ s z'ColumnElement._dedupe_anon_tq_label_idx)N)N)N)NF)N)@r� r� r� r� r� r� r r r� �_omit_from_statementsr* r� r� r< r r� r� r� r� r+ r' r� r$ r� r� r� � _render_label_in_columns_clause�_allow_label_resolve�_is_implicitly_booleanr� r r� r r r� r� r� r� r0 r1 r� r� r� r� r� r� r� r� r� r� r� r� r r� r� r� r� � deprecatedr� r� r r r r ru ru ru rw r � s� O # � � � � + �$��r c @ s e Zd ZU dZdZded< dS )�KeyedColumnElementz)ColumnElement where ``.key`` is non-None.Tr} r� N)r� r� r� r� r r ru ru ru rw r * s r c s� e Zd ZdZedd�dd��Zejdd�dd��Zedd�d d ��Z edd�d d ��Z ejd d�� fdd� �Z dd d�dd�Z e� fdd��Z � ZS )�WrapsColumnExpressionz�Mixin that defines a :class:`_expression.ColumnElement` as a wrapper with special labeling behavior for an expression that already has a name. .. versionadded:: 1.4 .. seealso:: :ref:`change_4449` r� r� c C s t � �d S rt ��NotImplementedErrorr� ru ru rw �wrapped_column_expression@ s z/WrapsColumnExpression.wrapped_column_expressionr� c C s | j }t|d�r|jS d S d S r )r r r� �r� �wceru ru rw r� D s z WrapsColumnExpression._tq_labelc C s | j S rt r� r� ru ru rw r� L s z WrapsColumnExpression._labelc C s d S rt ru r� ru ru rw r� P s z%WrapsColumnExpression._non_anon_labelr} c s2 | j }|js*|j}|r|S t|d�r*|jS t� jS )Nr� )r r r� r r� �super)r� r �nalr� ru rw r� T s z&WrapsColumnExpression._anon_name_labelr3 r� c C s, | j }|j}|r | �|d �S | �|�S d S )Nr� )r r� r� r )r� r r r ru ru rw r c s z,WrapsColumnExpression._dedupe_anon_label_idxc s | j }|js|jS t� jS rt )r r r� r r r� ru rw r� k s z WrapsColumnExpression._proxy_key)r� r� r� r� r$ r r< r� r� r� r� r� r r� � __classcell__ru ru r� rw r 2 s r c @ s0 e Zd ZU dZdZdejfdejfdejfdej fdej fgZ de d < d e d< d e d< d e d< d Z dZd ZdZejdd ejddd d d ddd f dddddddddddddd� dd�Zd efd d �Zed d �d d ��Zd!d �d"d#�Zd$d%� Zd&d'� Zd6ddd(d)�d*d+�Zd,d-� Zd.d/� Z d0d1� Z d2d3� Z d4d5� Z dS )7r� a� Represent a "bound expression". :class:`.BindParameter` is invoked explicitly using the :func:`.bindparam` function, as in:: from sqlalchemy import bindparam stmt = select(users_table).where( users_table.c.name == bindparam("username") ) Detailed discussion of how :class:`.BindParameter` is used is at :func:`.bindparam`. .. seealso:: :func:`.bindparam` r� r� r� �callablerp rr rZ �_traverse_internalsr} r� z Optional[_T]FTNr� r r~ rn z#Union[bool, Literal[_NoArg.NO_ARG]]�Optional[bool]zOptional[Callable[[], Any]]r� zOptional[TypeEngine[Any]]) r� rp rq r� r� �quote� callable_r� � isoutparamrr r� r� �_is_crudc C s� |t jkr |t jko|d k}|t jkr*d }|d k r>t�||�}|rvtjt| �|d k rbt|t�sb|nddd�| _d| _ n$|r�|| _nt�t| �d�| _d| _ | j| _ |p�d| _ || _ || _ || _| | _|| _|| _d | _| | _| r�d| _|d k�r:|�r|�r|d }ntj}n|}| d k �r,| �| |�| _n t�|�| _nbt|t��rP|� | _nLt|��r�|�r�|�rp|d }n|}|�|�t d| �_n |t d| �_n|| _d S )N�paramT�� sanitize_keyr z%BindParameter[typing_Tuple[Any, ...]]) r( r- � quoted_name� constructr� r� r r� r� � _key_is_anonZ_identifying_key� _orig_keyr� rp r r r� r� � expand_oprr r r Z_NO_VALUE_IN_LISTZcoerce_compared_valuer� �_resolve_value_to_typer" Z_resolve_values_to_typesr )r� r� rp rq r� r� r r r� r rr r� r� r � check_valueru ru rw �__init__� sr ��� � � � zBindParameter.__init__c C sH | j |d�}||_d|_|tk r$|n| j|_|jtjkrDt�|�|_|S )zXReturn a copy of this :class:`.BindParameter` with the given value set. )r� N) r% rp r r- r� r� r r� r' )r� rp r� r� Zclonedru ru rw � _with_value s zBindParameter._with_valuer� c C s | j r| � � S | jS dS )z�Return the value of this bound parameter, taking into account if the ``callable`` parameter was set. The ``callable`` value will be evaluated and returned if present, else ``value``. N)r rp r� ru ru rw �effective_value s z BindParameter.effective_valuero c C s t �| �}d|_|S )ah Produce a copy of this bound parameter that will enable the :paramref:`_sql.BindParameter.literal_execute` flag. The :paramref:`_sql.BindParameter.literal_execute` flag will have the effect of the parameter rendered in the compiled SQL string using ``[POSTCOMPILE]`` form, which is a special form that is converted to be a rendering of the literal value of the parameter at SQL execution time. The rationale is to support caching of SQL statement strings that can embed per-statement literal values, such as LIMIT and OFFSET parameters, in the final SQL string that is passed to the DBAPI. Dialects in particular may want to use this method within custom compilation schemes. .. versionadded:: 1.4.5 .. seealso:: :ref:`engine_thirdparty_caching` T)r� r% rr )r� r� ru ru rw �render_literal_execute" s z$BindParameter.render_literal_executec C s$ | j |kr | �� }||_ |S | S d S rt )r& r% )r� r� r� r� ru ru rw r� ; s z BindParameter._negate_in_binaryc C s t �| �}||_|S rt )r� r% r� )r� rq r� ru ru rw r� C s z'BindParameter._with_binary_element_typerA )r� r� rs c K sF t j| f|�}|j�| j� |sB| jrBtjt|�|jp8ddd�|_ |S )Nr Tr ) r� r% r� r� r� r� r� r r% r� )r� r� r� r� ru ru rw r% H s �zBindParameter._clonec C s~ | j j�dd�}|s(|d k r$d|t< d S |�| �\}}|rD|| j fS |d k rV|�| � || j | jj| jrr| j | n| j | j fS )N� inherit_cacheFT) r� r� r r0 Zget_anonr� r� Z_static_cache_keyr$ r� rr )r� r[ r� Z _gen_cache_okZid_�foundru ru rw �_gen_cache_keyY s �z BindParameter._gen_cache_keyc C s, | j s(d| _ tjt| �| jp ddd�| _d S )NTr r )r� r� r� r r% r� r� ru ru rw r� p s �z BindParameter._convert_to_uniquec C s2 | j �� }| j}| jr&| �� }d|d< ||d< |S )z4execute a deferred value for serialization purposes.Nr rp )r� r� rp r )r� r� r� ru ru rw r� w s zBindParameter.__getstate__c C s< |� dd�r,tjt| �|� dd�dd�|d< | j�|� d S )Nr� Fr% r Tr r� )r r� r� r r� r� r� ru ru rw r� � s � zBindParameter.__setstate__c C s d| j j| j| j| jf S )Nz%s(%r, %r, type_=%r))r� r� r� rp r� r� ru ru rw r � s �zBindParameter.__repr__)F) r� r� r� r� r� r6 � dp_anon_name�dp_type� dp_plain_dict� dp_plain_obj� dp_booleanr r r r r$ r- r( r- r) r* r$ r+ r, r� r� r% r/ r� r� r� r ru ru ru rw r� t sP � �(g r� c @ s2 e Zd ZU dZdZdejfgZded< dd� Z dS ) � TypeClausezTHandle a type keyword in a SQL statement. Used by the ``Case`` statement. � typeclauser� rZ r c C s || _ d S rt �r� r� ru ru rw r) � s zTypeClause.__init__N) r� r� r� r� r� r6 r1 r r r) ru ru ru rw r5 � s � r5 c @ s e Zd ZU dZdZdejfdejfgZde d< dZ dZ e � de j�Zd Zd Zd Zd Zed d �d d ��Zdd� Zedd �dd��ZdZde d< dZde d< d Zedd� �Zdd�dd �Z e d d d d �d!d"��Z e � d#�d$d%d&d'�d(d)��Z!ed%d �d*d+��Z"ed,d-� �Z#d3d.d/d0�d1d2�Z$dS )4� TextClausea� Represent a literal SQL text fragment. E.g.:: from sqlalchemy import text t = text("SELECT * FROM users") result = connection.execute(t) The :class:`_expression.TextClause` construct is produced using the :func:`_expression.text` function; see that function for full documentation. .. seealso:: :func:`_expression.text` Z textclause� _bindparamsr rZ r Tz(?<![:\w\x5c]):(\w+)(?!:)FzIterable[FromClause]r� c C s dS �Nru ru r� ru ru rw � _hide_froms� s zTextClause._hide_fromsc C s t | |�S rt )r� r= ru ru rw r> � s zTextClause.__and__rS c C s | fS rt ru r� ru ru rw r� � s zTextClause._select_iterableNr� r� r� c C s | j dkS �N�*�r r� ru ru rw r# � s zTextClause._is_starr} r> c s& i � _ � fdd�}� j�||�� _d S )Nc s( t | �d��� j| �d�< d| �d� S )Nr z:%s)r� �groupr9 )�mr� ru rw �repl� s z!TextClause.__init__.<locals>.repl)r9 �_bind_params_regex�subr )r� r rA ru r� rw r) � s zTextClause.__init__r{ r rA )�binds�names_to_valuesrs c O s� | j �� | _ }|D ]R}z||j }W n4 tk rZ } zt�d|j �|�W 5 d}~X Y qX |||j< q|�� D ]Z\}}z || }W n2 tk r� } zt�d| �|�W 5 d}~X Y qpX |j|dd�||< qp| S )a� Establish the values and/or types of bound parameters within this :class:`_expression.TextClause` construct. Given a text construct such as:: from sqlalchemy import text stmt = text("SELECT id, name FROM user WHERE name=:name " "AND timestamp=:timestamp") the :meth:`_expression.TextClause.bindparams` method can be used to establish the initial value of ``:name`` and ``:timestamp``, using simple keyword arguments:: stmt = stmt.bindparams(name='jack', timestamp=datetime.datetime(2012, 10, 8, 15, 12, 5)) Where above, new :class:`.BindParameter` objects will be generated with the names ``name`` and ``timestamp``, and values of ``jack`` and ``datetime.datetime(2012, 10, 8, 15, 12, 5)``, respectively. The types will be inferred from the values given, in this case :class:`.String` and :class:`.DateTime`. When specific typing behavior is needed, the positional ``*binds`` argument can be used in which to specify :func:`.bindparam` constructs directly. These constructs must include at least the ``key`` argument, then an optional value and type:: from sqlalchemy import bindparam stmt = stmt.bindparams( bindparam('name', value='jack', type_=String), bindparam('timestamp', type_=DateTime) ) Above, we specified the type of :class:`.DateTime` for the ``timestamp`` bind, and the type of :class:`.String` for the ``name`` bind. In the case of ``name`` we also set the default value of ``"jack"``. Additional bound parameters can be supplied at statement execution time, e.g.:: result = connection.execute(stmt, timestamp=datetime.datetime(2012, 10, 8, 15, 12, 5)) The :meth:`_expression.TextClause.bindparams` method can be called repeatedly, where it will re-use existing :class:`.BindParameter` objects to add new information. For example, we can call :meth:`_expression.TextClause.bindparams` first with typing information, and a second time with value information, and it will be combined:: stmt = text("SELECT id, name FROM user WHERE name=:name " "AND timestamp=:timestamp") stmt = stmt.bindparams( bindparam('name', type_=String), bindparam('timestamp', type_=DateTime) ) stmt = stmt.bindparams( name='jack', timestamp=datetime.datetime(2012, 10, 8, 15, 12, 5) ) The :meth:`_expression.TextClause.bindparams` method also supports the concept of **unique** bound parameters. These are parameters that are "uniquified" on name at statement compilation time, so that multiple :func:`_expression.text` constructs may be combined together without the names conflicting. To use this feature, specify the :paramref:`.BindParameter.unique` flag on each :func:`.bindparam` object:: stmt1 = text("select id from table where name=:name").bindparams( bindparam("name", value='name1', unique=True) ) stmt2 = text("select id from table where name=:name").bindparams( bindparam("name", value='name2', unique=True) ) union = union_all( stmt1.columns(column("id")), stmt2.columns(column("id")) ) The above statement will render as:: select id from table where name=:name_1 UNION ALL select id from table where name=:name_2 .. versionadded:: 1.3.11 Added support for the :paramref:`.BindParameter.unique` flag to work with :func:`_expression.text` constructs. z?This text() construct doesn't define a bound parameter named %rNF)r� )r9 r� r% �KeyErrorr: � ArgumentErrorr� r* ) r� rD rE � new_paramsr� �existingr� r� rp ru ru rw r� � s4 h��� ���zTextClause.bindparamszsqlalchemy.sql.selectable� _ColumnExpressionArgument[Any]zTypeEngine[Any]rV )�cols�typesrs c sj t jj}dd� |D �}� fdd�|D �}dd� � �� D �}|j�|j�}|j| || t|�o`| d� |S )a" Turn this :class:`_expression.TextClause` object into a :class:`_expression.TextualSelect` object that serves the same role as a SELECT statement. The :class:`_expression.TextualSelect` is part of the :class:`_expression.SelectBase` hierarchy and can be embedded into another statement by using the :meth:`_expression.TextualSelect.subquery` method to produce a :class:`.Subquery` object, which can then be SELECTed from. This function essentially bridges the gap between an entirely textual SELECT statement and the SQL expression language concept of a "selectable":: from sqlalchemy.sql import column, text stmt = text("SELECT id, name FROM some_table") stmt = stmt.columns(column('id'), column('name')).subquery('st') stmt = select(mytable).\ select_from( mytable.join(stmt, mytable.c.name == stmt.c.name) ).where(stmt.c.id > 5) Above, we pass a series of :func:`_expression.column` elements to the :meth:`_expression.TextClause.columns` method positionally. These :func:`_expression.column` elements now become first class elements upon the :attr:`_expression.TextualSelect.selected_columns` column collection, which then become part of the :attr:`.Subquery.c` collection after :meth:`_expression.TextualSelect.subquery` is invoked. The column expressions we pass to :meth:`_expression.TextClause.columns` may also be typed; when we do so, these :class:`.TypeEngine` objects become the effective return type of the column, so that SQLAlchemy's result-set-processing systems may be used on the return values. This is often needed for types such as date or boolean types, as well as for unicode processing on some dialect configurations:: stmt = text("SELECT id, name, timestamp FROM some_table") stmt = stmt.columns( column('id', Integer), column('name', Unicode), column('timestamp', DateTime) ) for id, name, timestamp in connection.execute(stmt): print(id, name, timestamp) As a shortcut to the above syntax, keyword arguments referring to types alone may be used, if only type conversion is needed:: stmt = text("SELECT id, name, timestamp FROM some_table") stmt = stmt.columns( id=Integer, name=Unicode, timestamp=DateTime ) for id, name, timestamp in connection.execute(stmt): print(id, name, timestamp) The positional form of :meth:`_expression.TextClause.columns` also provides the unique feature of **positional column targeting**, which is particularly useful when using the ORM with complex textual queries. If we specify the columns from our model to :meth:`_expression.TextClause.columns`, the result set will match to those columns positionally, meaning the name or origin of the column in the textual SQL doesn't matter:: stmt = text("SELECT users.id, addresses.id, users.id, " "users.name, addresses.email_address AS email " "FROM users JOIN addresses ON users.id=addresses.user_id " "WHERE users.id = 1").columns( User.id, Address.id, Address.user_id, User.name, Address.email_address ) query = session.query(User).from_statement(stmt).options( contains_eager(User.addresses)) The :meth:`_expression.TextClause.columns` method provides a direct route to calling :meth:`_expression.FromClause.subquery` as well as :meth:`_expression.SelectBase.cte` against a textual SELECT statement:: stmt = stmt.columns(id=Integer, name=String).cte('st') stmt = select(sometable).where(sometable.c.id == stmt.c.id) :param \*cols: A series of :class:`_expression.ColumnElement` objects, typically :class:`_schema.Column` objects from a :class:`_schema.Table` or ORM level column-mapped attributes, representing a set of columns that this textual string will SELECT from. :param \**types: A mapping of string names to :class:`.TypeEngine` type objects indicating the datatypes to use for names that are SELECTed from the textual string. Prefer to use the ``*cols`` argument as it also indicates positional ordering. c S s g | ]}t �tj|��qS ru )r r| r �LabeledColumnExprRole�r� �colru ru rw r� � s z&TextClause.columns.<locals>.<listcomp>c s. g | ]&}|j � kr&t|j � �|j ��n|�qS ru )r� r� r� rN �rL ru rw r� � s ��c S s g | ]\}}t ||��qS ru r� )r� r� rq ru ru rw r� s )� positional)r< r� Zsql_selectabler� rV r� �_initrn )r� rK rL r� Z input_colsZpositional_input_colsZkeyed_input_cols�elemru rP rw r� � s" s� �� �zTextClause.columnsc C s t jS rt r� r� ru ru rw r� s zTextClause.typec C s | j �| �S rt )r� r� r� ru ru rw r� s zTextClause.comparatorr� �Union[Self, Grouping[Any]]r� c C s |t jkrt| �S | S d S rt )r Zin_opr� r� ru ru rw r� s zTextClause.self_group)N)%r� r� r� r� r� r6 Z dp_string_clauseelement_dict� dp_stringr r r r �rer� �UNICODErB r r r r* r$ r; r> r� r� r� r r# r) r' r� r< r� r� r� r� r� ru ru ru rw r8 � sF � �r8 c @ sT e Zd ZU dZdZg Zded< d ed< es>ej dd�dd ��Z e d d�d d ��Z d S ) �Nullz�Represent the NULL keyword in a SQL statement. :class:`.Null` is accessed as a constant via the :func:`.null` function. �nullrZ r � _singletonr� r� c C s t jS rt r� r� ru ru rw r� / s z Null.typec C s t jS )z+Return a constant :class:`.Null` construct.)rX rZ ��clsru ru rw � _instance3 s zNull._instanceN) r� r� r� r� r� r r r r< r r� � classmethodr] ru ru ru rw rX s rX c @ sb e Zd ZU dZdZg Zded< d ed< es>ej dd�dd ��Z d d�d d �Z e d d�d d��Z dS )�False_z�Represent the ``false`` keyword, or equivalent, in a SQL statement. :class:`.False_` is accessed as a constant via the :func:`.false` function. �falserZ r rZ r� r� c C s t jS rt �r r� r� ru ru rw r� M s z False_.type�True_c C s t jS rt �rb rZ r� ru ru rw r Q s zFalse_._negatec C s t jS rt �r_ rZ r[ ru ru rw r] T s zFalse_._instanceN)r� r� r� r� r� r r r r< r r� r r^ r] ru ru ru rw r_ = s r_ c @ sv e Zd ZU dZdZg Zded< d ed< es>ej dd�dd ��Z d d�d d �Z e d dd�dd��Z e d d�dd��ZdS )rb z�Represent the ``true`` keyword, or equivalent, in a SQL statement. :class:`.True_` is accessed as a constant via the :func:`.true` function. �truerZ r rZ r� r� c C s t jS rt ra r� ru ru rw r� k s z True_.typer_ c C s t jS rt rd r� ru ru rw r o s z True_._negate� Optional[ColumnElement[Any]]r, r< c C s |d kr| � � S |S d S rt )r] )r\ r� ru ru rw �_ifnoner s z True_._ifnonec C s t jS rt rc r[ ru ru rw r] { s zTrue_._instanceN)r� r� r� r� r� r r r r< r r� r r^ rg r] ru ru ru rw rb \ s rb c @ s� e Zd ZU dZdZdZdejfdejfgZ de d< de d< e j dde jd �d d d d d d�dd�Zed*d dd d�dd��Zdd�dd�Zdd�dd �Zed d�d d ��Zd d!� Zejd"d�d#d$��Zd+d%d&d'�d(d)�ZdS ),� ClauseListzzDescribe a list of clauses, separated by an operator. By default, is comma-separated, such as a column listing. Z clauselistT�clausesr rZ r r� )r r? �group_contents�_literal_as_text_rolerJ rN rn zType[roles.SQLRole])ri r r? rj rk c sf |� _ |� _|� _|}|��� _� jr>� �fdd�|D �� _n� �fdd�|D �� _t�� j �� _d S )Nc s& g | ] }t j�|� d �j� jd��qS )��apply_propagate_attrsr )r r| r� r �r� r� �r� Ztext_converter_roleru rw r� � s � ��z'ClauseList.__init__.<locals>.<listcomp>c s g | ]}t j�|� d ��qS �rl )r r| rn ro ru rw r� � s � �)r r? rj �_text_converter_roleri r � is_booleanr )r� r r? rj rk ri Zclauses_iteratorru ro rw r) � s � �zClauseList.__init__Nr� �r ri rs c C s8 | � | �}|rt|�ng |_d|_||_d|_d|_|S )NTF)r� r� ri r? r rj r �r\ r ri r� ru ru rw �_construct_raw� s zClauseList._construct_raw� Iterator[ColumnElement[Any]]r� c C s t | j�S rt ��iterri r� ru ru rw �__iter__� s zClauseList.__iter__r3 c C s t | j�S rt ��lenri r� ru ru rw �__len__� s zClauseList.__len__rS c C s t j�dd� | jD ��S )Nc S s g | ] }|j �qS ru )r� )r� rS ru ru rw r� � s z/ClauseList._select_iterable.<locals>.<listcomp>)r� r� � from_iterableri r� ru ru rw r� � s �zClauseList._select_iterablec C sB | j r(| j�t�| j|�j| jd�� n| j�t�| j|�� d S �Nr )rj ri r� r r| rq r� r �r� r� ru ru rw r� � s �� �zClauseList.appendr� c C s t tjdd� | jD �� �S )Nc S s g | ] }|j �qS ru �r� r� ru ru rw r� � s z,ClauseList._from_objects.<locals>.<listcomp>�r� r� r� ri r� ru ru rw r� � s zClauseList._from_objectsr� rT r� c C s$ | j r t�| j|�r t| �S | S d S rt )r? r � is_precedentr r� r� ru ru rw r� � s zClauseList.self_group)N)N)r� r� r� r� r� r! r6 Zdp_clauseelement_list� dp_operatorr r r Zcomma_opr �WhereHavingRoler) r^ ru ry r| r$ r� r� r< r& r� r� ru ru ru rw rh � s0 � � � �rh c @ s� e Zd ZU dZded< ded< dZded< ed d � �Zd d d d�dd�Zedd�dd��Z e d d d�ddddd ddd�dd��Z d S ) �OperatorExpressionz[base for expressions that contain an operator and operands .. versionadded:: 2.0 rN r r� r� Trn r? c C s t �| j�S rt )r r7 r r� ru ru rw r7 � s z OperatorExpression.is_comparisonNr� �Union[Self, Grouping[_T]]r� c C s: | j rt�| j|�s*|tjkr2t�| j�s2t| �S | S d S rt )r? r r� r r rr r� r� ru ru rw r� � s � �� � z OperatorExpression.self_group�%typing_Tuple[ColumnElement[Any], ...]r� c C s t � �d S rt r r� ru ru rw �_flattened_operator_clauses s z.OperatorExpression._flattened_operator_clauses)�negate� modifiersr, r� zOperatorExpression[_T])�left�rightr. rq r� r� rs c C s� t �|�r�|d ks td|� ���d}t|dd �|krL|�|j�rLd}|j}n|f}t|dd �|krz|�|j�rzd}|j} n|f} |r�tj||f|| �� S |j r�d }t ||||||d�S )Nz.negate not supported for associative operator Fr T)rq r� r� ) r Zis_associativer� r� Z_compare_type_affinityr� r� �ExpressionClauseList�_construct_for_listr* �BinaryExpression) r\ r� r� r. rq r� r� �multiZleft_flattenedZright_flattenedru ru rw �_construct_for_op s^ �� �� � �� ��� �z$OperatorExpression._construct_for_op)N) r� r� r� r� r r? r$ r7 r� r� r^ r� ru ru ru rw r� � s ��r� c @ s� e Zd ZU dZdZdejfdejfgZde d< de d< de d < d d �d d dd�dd�Z e dd�dd��Z dd�dd�Z dd�dd�Ze dd�d d ��Zejd d�d d ��Zd!d"d#�d$d%�Zed&d'�d d(d!dd)d*�d+d,��Zd-d�d.d/�Zd S )0r� a9 Describe a list of clauses, separated by an operator, in a column expression context. :class:`.ExpressionClauseList` differs from :class:`.ClauseList` in that it represents a column-oriented DQL expression only, not an open ended list of anything comma separated. .. versionadded:: 2.0 �expression_clauselistri r rZ r r� rn r? N�rq rN rJ r~ )r ri rq c s< |� _ t� fdd�|D ��� _t�� j �� _t�|�� _d S )Nc 3 s | ]}t jtj|� d �V qdS )rl N�r r| r �ExpressionElementRolern r� ru rw r� f s � �z0ExpressionClauseList.__init__.<locals>.<genexpr>) r r ri r rr r r � to_instancer� )r� r rq ri ru r� rw r) ^ s � z ExpressionClauseList.__init__r� c C s | j S rt �ri r� ru ru rw r� o s z0ExpressionClauseList._flattened_operator_clausesrv c C s t | j�S rt rw r� ru ru rw ry u s z ExpressionClauseList.__iter__r3 c C s t | j�S rt rz r� ru ru rw r| x s z ExpressionClauseList.__len__rS c C s | fS rt ru r� ru ru rw r� { s z%ExpressionClauseList._select_iterabler� c C s t tjdd� | jD �� �S )Nc S s g | ] }|j �qS ru r� r� ru ru rw r� � s z6ExpressionClauseList._from_objects.<locals>.<listcomp>r� r� ru ru rw r� s z"ExpressionClauseList._from_objectsr, ry �r� rs c C s | j |f7 _ d S rt r� r ru ru rw �_append_inplace� s z$ExpressionClauseList._append_inplaceT)r? r� zExpressionClauseList[_T])r rq ri r? rs c sD | � | �}||_|r.t� fdd�|D ��|_n||_� |_||_|S )Nc 3 s | ]}|j � d �V qdS )r N�r� r� r ru rw r� � s z;ExpressionClauseList._construct_for_list.<locals>.<genexpr>)r� r? r ri r r� )r\ r rq r? ri r� ru r rw r� � s � z(ExpressionClauseList._construct_for_listr c C s, | j tjd�}t|t�s t�t|tjdd�S r� r r ru ru rw r � s �z ExpressionClauseList._negate)r� r� r� r� r� r6 Zdp_clauseelement_tupler� r r r) r$ r� ry r| r� r< r& r� r� r^ r� r ru ru ru rw r� G s, � �� r� c s� e Zd ZdZdZdd� Zedddddd �d d ��Zeej fddddddd d �dd��Z eddd�dd��Z ed+ddd d�dd��Z eej fdddd �d d ��Z eej fd ddd �d d!��Zed"d#�d$d%��Zd,d&d'd(�� fd)d*� Z� ZS )-r; r� Tc O s t d��d S )Nz+BooleanClauseList has a private constructorr )r� �argr� ru ru rw r) � s �zBooleanClauseList.__init__rN r z Iterable[ColumnElement[Any]]z+typing_Tuple[int, List[ColumnElement[Any]]])r � continue_on�skip_onri rs c s� d }g }t j� d}|D ]F}||kr(|}q||kr@|g}d} q^q|sJd}n|� d}|�|� q|st|d k rt|g}d}|� fdd�|D �fS )Nr r r9 c s g | ]}|j � d ��qS )r r� r� r ru rw r� � s zBBooleanClauseList._process_clauses_for_boolean.<locals>.<listcomp>)r r� r� ) r\ r r� r� ri Zhas_continue_on�convert_clauses�lccr� ru r rw � _process_clauses_for_boolean� s( z.BooleanClauseList._process_clauses_for_booleanr, )r r� r� �initial_clauseri r� rs c s� |t jkrj� j}tjd|� d|� d|� d|tjkr6dnd� d|� d|tjkrPdnd � d � d d � | �� �S | �� ||d d� t� |f| �D ��\}} |dkr�t j � � fdd�| D ��} | �� | �S |s�t �| d S d S )Nz Invoking z_() without arguments is deprecated, and will be disallowed in a future release. For an empty z() construct, use '�(ztrue()zfalse()z, *args)' or '�True�Falsez , *args)'.r� )�versionc S s g | ]}t �tj|��qS ru )r r| r r� rn ru ru rw r� � s �z0BooleanClauseList._construct.<locals>.<listcomp>r c 3 s4 | ],}t |d d�� kr&dd� |jD �n|fV qdS )r Nc s s | ] }|V qd S rt ru r� ru ru rw r� s z9BooleanClauseList._construct.<locals>.<genexpr>.<genexpr>)r� r� )r� Zto_flatr ru rw r� s ��z/BooleanClauseList._construct.<locals>.<genexpr>r )r( r- r� r< Zwarn_deprecatedrb rZ ru r� Zcoerce_generator_argr� r� r} r� ) r\ r r� r� r� ri r� r� r� r� Zflattened_clausesru r rw � _construct� s8 � �� ��� � z BooleanClauseList._construct� Optional[ColumnElement[bool]])ri rs c C sV t jtjtj }}}| �||||�\}}|dkr>| �||�S |dkrN|d S d S d S )Nr r )r r� rb rZ r_ r� ru )r\ ri r r� r� r� r� ru ru rw �_construct_for_whereclause s � � z,BooleanClauseList._construct_for_whereclauseNr� rs c C s: | � | �}|rt|�nd|_d|_||_tj|_d|_|S )Nru T) r� r ri r? r r r� r� r rt ru ru rw ru / s z BooleanClauseList._construct_rawz=Union[Literal[True], _ColumnExpressionArgument[bool], _NoArg]� _ColumnExpressionArgument[bool]r� )r� ri rs c G s | j tjtjtj|f|�� S )zwProduce a conjunction of expressions joined by ``AND``. See :func:`_sql.and_` for full documentation. )r� r r� rb rZ r_ �r\ r� ri ru ru rw r� = s ��zBooleanClauseList.and_z>Union[Literal[False], _ColumnExpressionArgument[bool], _NoArg]c G s | j tjtjtj|f|�� S )zuProduce a conjunction of expressions joined by ``OR``. See :func:`_sql.or_` for full documentation. )r� r r� r_ rZ rb r� ru ru rw r� Q s ��zBooleanClauseList.or_rS r� c C s | fS rt ru r� ru ru rw r� e s z"BooleanClauseList._select_iterabler� zUnion[Self, Grouping[bool]]r� c s | j s | S t� j|d�S d S r~ )ri r r� r� r� ru rw r� i s z BooleanClauseList.self_group)N)N)r� r� r� r� r- r) r^ r� r( r- r� r� ru r� r� r$ r� r� r ru ru r� rw r; � s. *� < � �� �r; c s� e Zd ZU dZdZejg Zded< ded< e� d�dd �d d d �� fd d��Z e dd�dd��Z ddd�Z d ddd�dd�Z� ZS ) r zRepresent a SQL tuple.r rZ r rW r� �sqlalchemy.sql.sqltypesNrP rJ z,Optional[Sequence[_TypeEngineArgument[Any]]])ri rL c s� t jj}|d kr dd� |D �}n:t|�t|�krFt�dt|�|f ��dd� t||�D �}|jdd� |D �� | _t � j |� d S )Nc S s g | ]}t �tj|��qS ru r� r� ru ru rw r� � s �z"Tuple.__init__.<locals>.<listcomp>z*Wrong number of elements for %d-tuple: %r c S s, g | ]$\}}t jtj||js |nd d��qS �Nr� )r r| r r� �_isnull)r� �typr� ru ru rw r� � s � �c S s g | ] }|j �qS ru r7 )r� r� ru ru rw r� � s ) r< r� � sql_sqltypesr{ r: rG �ziprW r� r r) )r� rL ri �sqltypesZ init_clausesr� ru rw r) � s � ��� zTuple.__init__rS r� c C s | fS rt ru r� ru ru rw r� � s zTuple._select_iterableFc sB |r t d |� dd�| jd�S t� �fdd�t|| jj�D �� S d S )NT)rp r� r� r� rq r� c s$ g | ] \}}t d |� |d�d��qS )NT)r� r� r� rq )r� )r� �oZcompared_to_type�r rq ru rw r� � s ��z%Tuple._bind_param.<locals>.<listcomp>)r� r� r r� rL r� ru r� rw r� � s � ��zTuple._bind_paramr� rA r� c C s | S rt ru r� ru ru rw r� � s zTuple.self_group)NF)N)r� r� r� r� r� rh r r r< r� r) r$ r� r� r� r ru ru r� rw r v s � � r .c @ s� e Zd ZU dZdZdejfdejfdejfgZde d< de d< d e d< d e d< d d d �d ddd�dd�Z e j dd�dd��Z d S )�Casea: Represent a ``CASE`` expression. :class:`.Case` is produced using the :func:`.case` factory function, as in:: from sqlalchemy import case stmt = select(users_table). where( case( (users_table.c.name == 'wendy', 'W'), (users_table.c.name == 'jack', 'J'), else_='E' ) ) Details on :class:`.Case` usage is at :func:`.case`. .. seealso:: :func:`.case` �caserp �whens�else_rZ r z:List[typing_Tuple[ColumnElement[bool], ColumnElement[_T]]]r� rf N)rp r� zLUnion[typing_Tuple[_ColumnExpressionArgument[bool], Any], Mapping[Any, Any]]z Optional[Any])r� rp r� c s� t �dd|�}zt�|�}W n tk r0 Y nX � fdd�|D �� _|d krVd � _nt �tj |�� _|d k r�t �tj |�� _ nd � _ t dd� t � j�D �� j d k r�� j j ntj�}tt|�� _ d S )Nr� r� c s4 g | ],\}}t jtj|� d ��� t �tj|�f�qS rp )r r| r r� r� )r� r� �rr� ru rw r� � s �� �z!Case.__init__.<locals>.<listcomp>c s s" | ]�^ }}|j js|j V qd S rt )r� r� )r� r� Zthenru ru rw r� s �z Case.__init__.<locals>.<genexpr>)r Z!_expression_collection_was_a_listr< Zdictlike_iteritemsr r� rp r| r r� r� �next�reversedr� r r� r rd )r� rp r� r� Z new_whensrq ru r� rw r) � s2 � � �� z Case.__init__r� r� c C s t tjdd� | �� D �� �S )Nc S s g | ] }|j �qS ru r� )r� �xru ru rw r� ! s z&Case._from_objects.<locals>.<listcomp>)r� r� r� r� r� ru ru rw r� s �zCase._from_objects)r� r� r� r� r� r6 �dp_clauseelementZdp_clauseelement_tuplesr r r) r< r& r� ru ru ru rw r� � s � �3r� c @ sz e Zd ZU dZdZdejfdejfgZde d< de d< de d< d e d < d d d �dd�Z e j dd�dd��Z edd� �ZdS )r� aO Represent a ``CAST`` expression. :class:`.Cast` is produced using the :func:`.cast` factory function, as in:: from sqlalchemy import cast, Numeric stmt = select(cast(product_table.c.unit_price, Numeric(10, 4))) Details on :class:`.Cast` usage is at :func:`.cast`. .. seealso:: :ref:`tutorial_casts` :func:`.cast` :func:`.try_cast` :func:`.type_coerce` - an alternative to CAST that coerces the type on the Python side only, which is often sufficient to generate the correct SQL and data coercion. r r� r� rZ r r, r� r5 r6 rJ rm �r� rq c C s4 t �|�| _tjtj|| j| d�| _t| j�| _ d S �N)rq rm ) r r� r� r r| r r� r� r5 r6 �r� r� rq ru ru rw r) J s �z Cast.__init__r� r� c C s | j jS rt �r� r� r� ru ru rw r� X s zCast._from_objectsc C s | j S rt �r� r� ru ru rw r \ s z Cast.wrapped_column_expressionN)r� r� r� r� r� r6 r� r1 r r r) r< r& r� r$ r ru ru ru rw r� % s � r� c @ s e Zd ZdZdZdZdS )�TryCastz�Represent a TRY_CAST expression. Details on :class:`.TryCast` usage is at :func:`.try_cast`. .. seealso:: :func:`.try_cast` :ref:`tutorial_casts` Ztry_castTN)r� r� r� r� r� r- ru ru ru rw r� a s r� c @ s� e Zd ZU dZdZdejfdejfgZde d< de d< de d< d d d �d d �Z e j dd�dd��Z ejdd� �Zedd� �Zd ddd�dd�ZdS ) � TypeCoercea Represent a Python-side type-coercion wrapper. :class:`.TypeCoerce` supplies the :func:`_expression.type_coerce` function; see that function for usage details. .. seealso:: :func:`_expression.type_coerce` :func:`.cast` Z type_coercer� r� rZ r r, r� rJ rm r� c C s( t �|�| _tjtj|| j| d�| _d S r� )r r� r� r r| r r� r� r� ru ru rw r) � s �zTypeCoerce.__init__r� r� c C s | j jS rt r� r� ru ru rw r� � s zTypeCoerce._from_objectsc C s, t | jt�r"| j�� }| j|_|S | jS d S rt )r� r� r� r% r� )r� �bpru ru rw �typed_expression� s zTypeCoerce.typed_expressionc C s | j S rt r� r� ru ru rw r � s z$TypeCoerce.wrapped_column_expressionNr� zTypeCoerce[_T]r� c C s, | j j|d�}|| j k r$t|| j�S | S d S r~ )r� r� r� r� )r� r� r ru ru rw r� � s zTypeCoerce.self_group)N)r� r� r� r� r� r6 r� r1 r r r) r< r& r� r+ r' r� r$ r r� ru ru ru rw r� q s � �r� c @ sf e Zd ZU dZdZdejfdejfgZde d< de d< de d< dd d �d d �Z e j d d�dd��Z dS )�Extractz=Represent a SQL EXTRACT clause, ``extract(field FROM expr)``.�extract�expr�fieldrZ r r, r} rJ )r� r� c C s" t j| _|| _t�tj|�| _d S rt ) r � INTEGERTYPEr� r� r r| r r� r� )r� r� r� ru ru rw r) � s zExtract.__init__r� r� c C s | j jS rt )r� r� r� ru ru rw r� � s zExtract._from_objectsN)r� r� r� r� r� r6 r� rU r r r) r< r& r� ru ru ru rw r� � s � r� c @ sT e Zd ZU dZdZdejfgZded< ded< dd�dd �Z e j d d �d d ��Z dS )�_label_referencea� Wrap a column expression as it appears in a 'reference' context. This expression is any that includes an _order_by_label_element, which is a Label, or a DESC / ASC construct wrapping a Label. The production of _label_reference() should occur when an expression is added to this context; this includes the ORDER BY or GROUP BY of a SELECT statement, as well as a few other places, such as the ORDER BY within an OVER clause. Zlabel_reference�elementrZ r r� �r� c C s || _ d S rt r� �r� r� ru ru rw r) � s z_label_reference.__init__r� r� c C s g S rt ru r� ru ru rw r� � s z _label_reference._from_objectsN) r� r� r� r� r� r6 r� r r r) r< r& r� ru ru ru rw r� � s � r� c @ sH e Zd ZU dZdejfgZded< dd�dd�Ze j d d �d d ��Z d S )�_textual_label_referenceZtextual_label_referencer� rZ r r} r� c C s || _ d S rt r� r� ru ru rw r) � s z!_textual_label_reference.__init__r8 r� c C s t | j�S rt )r8 r� r� ru ru rw � _text_clause� s z%_textual_label_reference._text_clauseN) r� r� r� r� r6 rU r r r) r< r r� ru ru ru rw r� � s � r� c @ s e Zd ZU dZdZdejfdejfdejfgZde d< de d< d0d d d d dd�dd�Z e ddd�dd��Z e ddd�dd��Z e ddd�dd��Ze ddd�d d ��Ze ddd �d d ��Ze ddd �d!d"��Zed#d$�d%d&��Zejd'd$�d(d)��Zd*d+� Zd1d d,d-�d.d/�Zd S )2r a� Define a 'unary' expression. A unary expression has a single column expression and an operator. The operator can be placed on the left (where it is called the 'operator') or right (where it is called the 'modifier') of the column expression. :class:`.UnaryExpression` is the basis for several unary operators including those used by :func:`.desc`, :func:`.asc`, :func:`.distinct`, :func:`.nulls_first` and :func:`.nulls_last`. Zunaryr� r �modifierrZ r r� NFr, r� r~ rn )r� r r� rq r� c C s@ || _ || _|j| _|j| j p"| jd�| _t�|�| _|| _d S r~ ) r r� r� r� r� r r� r� r� )r� r� r r� rq r� ru ru rw r) s � zUnaryExpression.__init__� _ColumnExpressionArgument[_T]zUnaryExpression[_T])�columnrs c C s t t�tj|�tjdd�S �NF)r� r� )r r r| r �ByOfRoler Znulls_first_op�r\ r� ru ru rw �_create_nulls_first! s �z#UnaryExpression._create_nulls_firstc C s t t�tj|�tjdd�S r� )r r r| r r� r Z nulls_last_opr� ru ru rw �_create_nulls_last, s �z"UnaryExpression._create_nulls_lastz'_ColumnExpressionOrStrLabelArgument[_T]c C s t t�tj|�tjdd�S r� )r r r| r r� r Zdesc_opr� ru ru rw � _create_desc7 s �z UnaryExpression._create_descc C s t t�tj|�tjdd�S r� )r r r| r r� r Zasc_opr� ru ru rw � _create_ascA s �zUnaryExpression._create_asc�r� rs c C s" t �tj|�}t|tj|jdd�S �NF�r rq r� )r r| r r� r r Z distinct_opr� �r\ r� Zcol_exprru ru rw �_create_distinctL s ��z UnaryExpression._create_distinctc C s" t �tj|�}t|tj|jdd�S r� )r r| r r� r r Zbitwise_not_opr� r� ru ru rw �_create_bitwise_not[ s ��z#UnaryExpression._create_bitwise_notr� r� c C s t �| j�r| jjS d S d S rt )r Zis_order_by_modifierr� r� r� r� ru ru rw r� j s z'UnaryExpression._order_by_label_elementr� c C s | j jS rt �r� r� r� ru ru rw r� q s z UnaryExpression._from_objectsc C s> | j jtjjkr0t| jtjd�tjtj| jd�S t � | �S d S )Nr r� ) r� r� r r� r r� r r r� r� r r� ru ru rw r u s �zUnaryExpression._negater� r� c C s$ | j r t�| j |�r t| �S | S d S rt )r r r� r� r� ru ru rw r� � s zUnaryExpression.self_group)NNNF)N)r� r� r� r� r� r6 r� r� r r r) r^ r� r� r� r� r� r� r$ r� r< r& r� r r� ru ru ru rw r � s> � � �r c @ sP e Zd ZdZdZdZeddd�dd��Zeddd�dd ��Zd d � Z d d � Z dS )�CollectionAggregatea Forms the basis for right-hand collection operator modifiers ANY and ALL. The ANY and ALL keywords are available in different ways on different backends. On PostgreSQL, they only work for an ARRAY type. On MySQL, they only work for subqueries. Tr� zCollectionAggregate[bool]r� c C s* t �tj|�}|�� }t|tjtj dd�S r� ) r r| r r� r� r� r r� r r� r� ru ru rw � _create_any� s ��z CollectionAggregate._create_anyc C s* t �tj|�}|�� }t|tjtj dd�S r� ) r r| r r� r� r� r r� r r� r� ru ru rw � _create_all� s ��z CollectionAggregate._create_allc O s6 t �|�st�d��d|d< | jjt �|�f|�|�S )N�2Only comparison operators may be used with ANY/ALLT�reverse)r r7 r: rG r� r0 Zmirrorr/ ru ru rw r0 � s �zCollectionAggregate.operatec K s t �|�rt�t�d��d S )Nr� )r r7 r� r: rG r/ ru ru rw r1 � s �z#CollectionAggregate.reverse_operateN) r� r� r� r� r- r* r^ r� r� r0 r1 ru ru ru rw r� � s r� c @ s> e Zd ZdZdd� Zedd� �Zdddd �d d �Zd d � ZdS )r� Tc C s2 || _ tj| _|| _|| _d | _d| _|j| _d S �NT) r� r r� r� r r� r� r� r )r� r� r r� ru ru rw r) � s zAsBoolean.__init__c C s | j S rt r� r� ru ru rw r � s z#AsBoolean.wrapped_column_expressionNr� rA r� c C s | S rt ru r� ru ru rw r� � s zAsBoolean.self_groupc C s0 t | jttf�r| j�� S t| j| j| j�S d S rt )r� r� rb r_ r r� r� r r� ru ru rw r � s zAsBoolean._negate)N) r� r� r� r- r) r$ r r� r ru ru ru rw r� � s r� c @ s e Zd ZU dZdZdejfdejfdejfdejfdejfdej fgZ d e d < dejfdejfdejfdejfdej fgZ d Z d e d< d e d< d e d< d$d d dddd d�dd�Zedd�dd��Zdd� Zejr�ddd �d d �Zejd d�d d!��Zd"d#� ZdS )%r� a� Represent an expression that is ``LEFT <operator> RIGHT``. A :class:`.BinaryExpression` is generated automatically whenever two column expressions are used in a Python binary expression: .. sourcecode:: pycon+sql >>> from sqlalchemy.sql import column >>> column('a') + column('b') <sqlalchemy.sql.expression.BinaryExpression object at 0x101029dd0> >>> print(column('a') + column('b')) {printsql}a + b �binaryr� r� r r� r� r� rZ r Tr� r, NrN r~ r� )r� r� r rq r� r� c C s� t |t�rt�|�}|�� |�� f| _|jp0|j| _|j|d�| _|j|d�| _ || _ t � |�| _ || _t�|�| _|d kr�i | _n|| _d S r~ )r� r} r Z custom_oprC �_origr� r� r� r� r r r� r� r� rr r r� )r� r� r� r rq r� r� ru ru rw r) s zBinaryExpression.__init__r� r� c C s | j | jfS rt )r� r� r� ru ru rw r� 8 s z,BinaryExpression._flattened_operator_clausesc C s* | j tjtjfkr | j | j� S td��dS )a Implement Python-side "bool" for BinaryExpression as a simple "identity" check for the left and right attributes, if the operator is "eq" or "ne". Otherwise the expression continues to not support "bool" like all other column expressions. The rationale here is so that ColumnElement objects can be hashable. What? Well, suppose you do this:: c1, c2 = column('x'), column('y') s1 = set([c1, c2]) We do that **a lot**, columns inside of sets is an extremely basic thing all over the ORM for example. So what happens if we do this? :: c1 in s1 Hashing means it will normally use ``__hash__()`` of the object, but in case of hash collision, it's going to also do ``c1 == c1`` and/or ``c1 == c2`` inside. Those operations need to return a True/False value. But because we override ``==`` and ``!=``, they're going to get a BinaryExpression. Hence we implement ``__bool__`` here so that these comparisons behave in this particular context mostly like regular object comparisons. Thankfully Python is OK with that! Otherwise we'd have to use special set classes for columns (which we used to do, decades ago). r N)r r �eq�ner� r r� ru ru rw r > s zBinaryExpression.__bool__zBinaryExpression[_T]r� c C s d S rt ru r� ru ru rw r f s zBinaryExpression.__invert__r� c C s | j j| jj S rt )r� r� r� r� ru ru rw r� j s z BinaryExpression._from_objectsc C sF | j d k r6t| j| j�| j | j�| j | j| j| jd�S | �� � � S d S )N)r� rq r� ) r� r� r� r� r� r r� r� r� r r� ru ru rw r n s � zBinaryExpression._negate)NNN)r� r� r� r� r� r6 r� r� r2 r1 r r r� r r) r$ r� r r% r r r< r& r� r ru ru ru rw r� � sF �� �� � &r� c @ sV e Zd ZU dZdZdejfdejfdejfgZded< dd d �Z dd d d �dd�Z dS )�Slicez�Represent SQL for a Python array-slice object. This is not a specific SQL construct at this level, but may be interpreted by specific dialects, e.g. PostgreSQL. �slice�start�stop�steprZ r Nc C sT t jtj||tjd�| _t jtj||tjd�| _t jtj||tjd�| _tj | _ d S )N)r� rq ) r r| r r� r r� r� r� r� r� r� )r� r� r� r� �_nameru ru rw r) � s& ���zSlice.__init__r� rA r� c C s |t jkst�| S rt )r �getitemr� r� ru ru rw r� � s zSlice.self_group)N)N) r� r� r� r� r� r6 r� r r r) r� ru ru ru rw r� | s � r� c @ s e Zd ZdZdZdS )�IndexExpressionzJRepresent the class of expressions that are like an "index" operation.TN)r� r� r� r� r- ru ru ru rw r� � s r� c @ s8 e Zd ZU dZdZded< d ddd�d d �Zd d � ZdS )�GroupedElementz&Represent any parenthesized expression�groupingr� r� Nr� rA r� c C s | S rt ru r� ru ru rw r� � s zGroupedElement.self_groupc C s | j �� S rt )r� r� r� ru ru rw r� � s zGroupedElement._ungroup)N)r� r� r� r� r� r r� r� ru ru ru rw r� � s r� c @ s� e Zd ZU dZdejfdejfgZded< dejfgZ ded< dd�dd �Z d d � Z e j d d � �Ze jdd�dd��Ze jdd�dd��Ze jdd�dd��Zdd� Zdd� Zd d � Zer�d$d d d!�d"d#�Zd S )%r� z/Represent a grouping within a column expressionr� r� rZ r z0Union[TextClause, ClauseList, ColumnElement[_T]]r� c C s" || _ t|dtj�| _|j| _d S )Nr� )r� r� r r� r� r� r� ru ru rw r) � s zGrouping.__init__c C s | � | j�|��S rt )r� r� r� r� ru ru rw r� � s z"Grouping._with_binary_element_typec C s | j jS rt �r� r r� ru ru rw r � s z Grouping._is_implicitly_booleanr� r� c C s t | jdd �p| jS r )r� r� r� r� ru ru rw r� � s �zGrouping._tq_labelr� c C s t | jt�r| jgS g S d S rt )r� r� r r� ru ru rw r� � s zGrouping._proxiesr� c C s | j jS rt r� r� ru ru rw r� � s zGrouping._from_objectsc C s t | j|�S rt )r� r� )r� �attrru ru rw r� � s zGrouping.__getattr__c C s | j | jd�S )N�r� r� r� r� ru ru rw r� � s zGrouping.__getstate__c C s |d | _ |d | _d S )Nr� r� r� r� ru ru rw r� � s zGrouping.__setstate__Nr� rA r� c C s d S rt ru r� ru ru rw r� � s zGrouping.self_group)N)r� r� r� r� r6 r� r1 r r r� r) r� r< r r r� r� r� r& r� r� r� r� r r� ru ru ru rw r� � s. � � �r� c @ s8 e Zd ZdZdZdddd�dd�Zdd d d �d d �ZdS )�_OverrideBindsa used by cache_key->_apply_params_to_element to allow compilation / execution of a SQL element that's been cached, using an alternate set of bound parameter values. This is used by the ORM to swap new parameter values into expressions that are embedded into loader options like with_expression(), selectinload(). Previously, this task was accomplished using the .params() method which would perform a deep-copy instead. This deep copy proved to be too expensive for more complex expressions. See #11085 Zoverride_bindsr� r� )r� r� �replaces_paramsc C s || _ dd� t||�D �| _d S )Nc S s i | ]\}}|j |j�qS ru )r� rp r� ru ru rw r� s z+_OverrideBinds.__init__.<locals>.<dictcomp>)r� r� � translate)r� r� r� r� ru ru rw r) s �z_OverrideBinds.__init__r[ zList[BindParameter[Any]]z Optional[typing_Tuple[Any, ...]])r[ r� rs c s. g }� j �||�}|�� fdd�|D �� |S )ztgenerate a cache key for the given element, substituting its bind values for the translation values present.c 3 s6 | ].}|j � jkr*|j� j|j d dd�n|V qdS )TF)r� r� N)r� r� r* )r� r� r� ru rw r� s � � �z0_OverrideBinds._gen_cache_key.<locals>.<genexpr>)r� r/ �extend)r� r[ r� Z existing_bpsZckru r� rw r/ s � z _OverrideBinds._gen_cache_keyN)r� r� r� r� r� r) r/ ru ru ru rw r� � s r� c @ s e Zd ZdZdZdS )� _OverRanger r N)r� r� r� �RANGE_UNBOUNDED� RANGE_CURRENTru ru ru rw r� . s r� c @ s� e Zd ZU dZdZdejfdejfdejfdejfdejfgZde d < d Z d e d< d Z d e d< d e d< d e d< d e d< d!d ddddd�dd�Z dd� Z ddd�dd�Zes�ejdd�d d ��Zejd d�d d ��Zd S )"�Overa Represent an OVER clause. This is a special operator against a so-called "window" function, as well as any aggregate function, which produces results relative to the result set itself. Most modern SQL backends now support window functions. �overr� �order_by� partition_by�range_�rowsrZ r N�Optional[ClauseList]r� z0Optional[typing_Tuple[_IntOrRange, _IntOrRange]]�Optional[_ByArgument]�4Optional[typing_Tuple[Optional[int], Optional[int]]])r� r r r r c C s� || _ |d k r&tt�|�dtji�| _|d k rFtt�|�dtji�| _|rn| �|�| _ |rft � d��q�d | _ n$|r�| �|�| _ d | _ n d | _ | _ d S )Nrk z*'range_' and 'rows' are mutually exclusive) r� rh r< �to_listr r� r r �_interpret_ranger r: rG r )r� r� r r r r ru ru rw r) W s0 ���� � z Over.__init__c C s | j | j| j| j| j| jffS rt )r� r� r r r r r� ru ru rw � __reduce__x s �zOver.__reduce__z:typing_Tuple[Optional[_IntOrRange], Optional[_IntOrRange]]z&typing_Tuple[_IntOrRange, _IntOrRange])r rs c C s� t |t�rt|�dkr t�d��|\}}|d kr6t}nXt |t�rF|}nHz t|�}W n. tk r� } zt�d�|�W 5 d }~X Y nX |dkr�t }|d kr�t}nXt |t�r�|}nHz t|�}W n. tk r� } zt�d�|�W 5 d }~X Y nX |dkr�t }||fS )Nr9 z 2-tuple expected for range/rowsz(Integer or None expected for range valuer ) r� r r{ r: rG r� r� r3 � ValueErrorr� )r� r Zr0�r1�lowerr� �upperru ru rw r � s@ �� ��zOver._interpret_ranger� r� c C s | j jS rt r� r� ru ru rw r� � s z Over.typer� c C s$ t tjdd� | j| j| jfD �� �S )Nc S s g | ]}|d k r|j �qS rt r� r� ru ru rw r� � s �z&Over._from_objects.<locals>.<listcomp>)r� r� r� r� r r r� ru ru rw r� � s ���zOver._from_objects)NNNN)r� r� r� r� r� r6 r� r3 r r r r r) r r r r< r r� r& r� ru ru ru rw r 9 s2 � �! ,r c @ s� e Zd ZU dZdZdejfdejfgZded< dZ ded< d d d �d d �Z dd� Z ddddd�dddddd�dd�Z e dd�dd��Ze ddd d �d d��Zdd d �d!d�Zes�ejd"d�d#d$��Zejd%d�d&d'��ZdS )(� WithinGroupa Represent a WITHIN GROUP (ORDER BY) clause. This is a special operator against so-called "ordered set aggregate" and "hypothetical set aggregate" functions, including ``percentile_cont()``, ``rank()``, ``dense_rank()``, etc. It's supported only by certain database backends, such as PostgreSQL, Oracle and MS SQL Server. The :class:`.WithinGroup` construct extracts its type from the method :meth:`.FunctionElement.within_group_type`. If this returns ``None``, the function's ``.type`` is used. Z withingroupr� r rZ r Nr z.Union[FunctionElement[_T], FunctionFilter[_T]]rJ )r� r c G s* || _ |d k r&tt�|�dtji�| _d S )Nrk )r� rh r< r r r� r )r� r� r ru ru rw r) � s ��zWithinGroup.__init__c C s& | j | jf| jd k r t| j�nd fS r: )r� r� r r r� ru ru rw r � s �zWithinGroup.__reduce__)r r r r r r �Over[_T])r r r r rs c C s t | ||||d�S )z�Produce an OVER clause against this :class:`.WithinGroup` construct. This function has the same signature as that of :meth:`.FunctionElement.over`. �r r r r �r )r� r r r r ru ru rw r � s �zWithinGroup.overrA r� c C s d S rt ru r� ru ru rw �filter s zWithinGroup.filterr� zFunctionFilter[_T])�_WithinGroup__criterion0� criterionrs c G s d S rt ru )r� r r ru ru rw r s z Union[Self, FunctionFilter[_T]]�r rs c G s |s| S t | f|�� S )z.Produce a FILTER clause against this function.)�FunctionFilter)r� r ru ru rw r s r� c C s$ | j �| �}|d k r|S | j jS d S rt )r� �within_group_typer� )r� Zwgtru ru rw r� s zWithinGroup.typer� c C s t tjdd� | j| jfD �� �S )Nc S s g | ]}|d k r|j �qS rt r� r� ru ru rw r� ! s �z-WithinGroup._from_objects.<locals>.<listcomp>)r� r� r� r� r r� ru ru rw r� s ���zWithinGroup._from_objects)r� r� r� r� r� r6 r� r r r r) r r r r r r< r r� r& r� ru ru ru rw r � s. � �r c @ s� e Zd ZU dZdZdejfdejfgZded< dZ ded< d d d �d d �Z e d dd�dd��Z d-dddddd�dd�Z ddd�dd �Zdd d �d d �Zd.d!d"d#�d$d%�Zes�ejd&d'�d(d)��Zejd*d'�d+d,��ZdS )/r a� Represent a function FILTER clause. This is a special operator against aggregate and window functions, which controls which rows are passed to it. It's supported only by certain database backends. Invocation of :class:`.FunctionFilter` is via :meth:`.FunctionElement.filter`:: func.count(1).filter(True) .. seealso:: :meth:`.FunctionElement.filter` Z funcfilter�funcr rZ r Nr� z+Union[FunctionElement[_T], WithinGroup[_T]]r� )r r c G s || _ | jj| f|�� d S rt )r r Znon_generative)r� r r ru ru rw r) E s zFunctionFilter.__init__rA r c G s> t |�D ]0}t�tj|�}| jdk r2| j|@ | _q|| _q| S )a Produce an additional FILTER against the function. This method adds additional criteria to the initial criteria set up by :meth:`.FunctionElement.filter`. Multiple criteria are joined together at SQL render time via ``AND``. N)r� r r| r r� r )r� r �critru ru rw r M s zFunctionFilter.filterzYOptional[Union[Iterable[_ColumnExpressionArgument[Any]], _ColumnExpressionArgument[Any]]]r r )r r r r rs c C s t | ||||d�S )a� Produce an OVER clause against this filtered function. Used against aggregate or so-called "window" functions, for database backends that support window functions. The expression:: func.rank().filter(MyClass.y > 5).over(order_by='x') is shorthand for:: from sqlalchemy import over, funcfilter over(funcfilter(func.rank(), MyClass.y > 5), order_by='x') See :func:`_expression.over` for a full description. r r )r� r r r r ru ru rw r d s "�zFunctionFilter.overrJ zWithinGroup[_T])r rs c G s t | f|�� S )zUProduce a WITHIN GROUP (ORDER BY expr) clause against this function. )r )r� r ru ru rw � within_group� s zFunctionFilter.within_groupr� )r rs c C s d S rt ru )r� r ru ru rw r � s z FunctionFilter.within_group_typer� r� r� c C s t �t j|�rt| �S | S d S rt )r r� Z filter_opr� r� ru ru rw r� � s zFunctionFilter.self_groupr� r� c C s | j jS rt )r r� r� ru ru rw r� � s zFunctionFilter.typer� c C s t tjdd� | j| jfD �� �S )Nc S s g | ]}|d k r|j �qS rt r� r� ru ru rw r� � s �z0FunctionFilter._from_objects.<locals>.<listcomp>)r� r� r� r r r� ru ru rw r� � s ���z FunctionFilter._from_objects)NNNN)N)r� r� r� r� r� r6 r� r r r r) r' r r r r r� r r< r r� r& r� ru ru ru rw r * s. � �* �r c @ s� e Zd ZU dZdZded< ded< ded< dd � Zejdd �d d ��Z e j d d� �Z e j dd �dd��Z e j dd� �Ze j dd� �Zd)dddd�dd�Zd*dd d dd d �d d!�Zdddddd"�d#dddd$dd d%d&�d'd(�ZdS )+� NamedColumnFN�Optional[FromClause]�tabler} r� r� c C s, t |d�r| j|jkp*t |d�o*| j|jkS )Nr� r� )r r� r� r= ru ru rw r� � s �z$NamedColumn._compare_name_for_resultr� c C s | j S rt �r� r� ru ru rw r� � s zNamedColumn.descriptionc C s( | j }|r || jkr | �|�S | jS dS )z�table qualified label based on column key. for table-bound columns this is <tablename>_<column key/proxy key>; all other expressions it resolves to key/proxy key. N)r� r� � _gen_tq_labelr� )r� r� ru ru rw r� � s zNamedColumn._tq_key_labelr� c C s | � | j�S )z�table qualified label based on column name. for table-bound columns this is <tablename>_<columnname>; all other expressions it resolves to .name. �r! r� r� ru ru rw r� � s zNamedColumn._tq_labelc C s dS r� ru r� ru ru rw r � s z+NamedColumn._render_label_in_columns_clausec C s | j S rt r r� ru ru rw r� � s zNamedColumn._non_anon_labelTrn �r� � dedupe_on_keyrs c C s |S rt ru )r� r� r$ ru ru rw r! � s zNamedColumn._gen_tq_labelrN r r� ro r� c C s t | j||| j|d|d�S )NT)r� r� rq r� r� )r� r� r� r� ru ru rw r� � s �zNamedColumn._bind_param�r� r� r� r� �disallow_is_literalrT r� r� �r� r� r� r� r� r& r� rs c K s� t |rt�tj|p| j�n|p"| j| j|dd�}|j|_|d krH| j|_|rXt |�|_ n| g|_ |j d k r||j j � |j�|_ |j|fS )NF�rq 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� ru ru rw r� � s" �� zNamedColumn._make_proxy)T)NF)r� r� r� r� r r r� r< r r� r+ r' r� r� r r� r! r� r� ru ru ru rw r � s4 � ��r �_PSc @ sb e Zd ZU dZdZdejfdejfdejfgZ de d< dejfdejfgZ de d< d e d< dDd d d d�dd�Z dd� Z ejdd� �ZdEdd�Zejdd� �Zejdd� �Zed d � �Zejdd �d d ��ZdFd!d"d#�d$d%�Zd&d'� Zd(d)d*d"d+�d,d-�Zed.d/� �Z ed0d1� �Z e dd2�d3d4d5d6d7�d8d9�Z ej d:d �d;d<��Z!d d d=�d>d d?d5d@dA�dBdC�Z"d S )Gr� z�Represents a column label (AS). Represent a label, as typically applied to any column-level element using the ``AS`` sql keyword. r� r� r� �_elementrZ r r� r} Nr� r� r~ )r� r� rq c C s� |}t jtj|| d�}t|t�r(|j}q|r4|| _n,t� t | �t |dd��| _t|t�r`|j | _ | j | _ | _| _|| _|d k r�t�|�n| jj| _|g| _d S )Nrl r� r� )r r| r r� r� r� r� r� r� r� r r� r� Z_resolve_labelr� r� r� r* r r� r� r� )r� r� r� rq Z orig_elementru ru rw r) : s. � � � �zLabel.__init__c C s | j | j| j| jffS rt )r� r� r* r� r� ru ru rw r a s zLabel.__reduce__c C s dS r� ru r� ru ru rw r d s z%Label._render_label_in_columns_clauseFc C s t d |||| jd|d�S r� r� r� ru ru rw r� h s �zLabel._bind_paramc C s | j jS rt r� r� ru ru rw r s s z Label._is_implicitly_booleanc C s | j jS rt )r� r r� ru ru rw r w s zLabel._allow_label_resolvec C s | S rt ru r� ru ru rw r� { s z Label._order_by_label_elementr� c C s | j jtjd�S r~ )r* r� r Zas_r� ru ru rw r� s z Label.elementr� r� r� c C s | j | jj|d�S r~ )�_apply_to_innerr* r� r� ru ru rw r� � s zLabel.self_groupc C s | � | jj�S rt )r+ r* r r� ru ru rw r � s z Label._negatez Callable[_PS, ColumnElement[_T]]z_PS.argsz _PS.kwargs)�fnr� r� rs c O s. |||�}|| j k r&t| j|| jd�S | S d S r� )r* r� r� r� )r� r, r� r� Z sub_elementru ru rw r+ � s zLabel._apply_to_innerc C s | j jS rt )r� r� r� ru ru rw r� � s zLabel.primary_keyc C s | j jS rt )r� r� r� ru ru rw r� � s zLabel.foreign_keys)�clone�anonymize_labelsrY rn r ry )r- r. r� rs c K sP | � � || jf|�| _|rLt�t| �t| jdd��| _| j | _ | _ | _ d S )Nr� r� ) Z_reset_memoizationsr* r� r� r r� r� r� r� r� r� )r� r- r. r� ru ru rw �_copy_internals� s �zLabel._copy_internalsr� c C s | j jS rt r� r� ru ru rw r� � s zLabel._from_objects)r� r� rT r� r� )r� r� r� r� rs c K s� |s | j n|}| jj||dt|t�|d�\}}|| j krTt| j t�sTt�d| j ��|j|_|j � | � | j d k rz| j |_ | j |fS )NT)r� r& r� r� z�Label name %s is being renamed to an anonymous label due to disambiguation which is not supported right now. Please use unique names for explicit labels.) r� r� r� r� �_truncated_labelr� r: �InvalidRequestErrorr� r� r� r� r� )r� r� r� r� r� r� �eru ru rw r� � s& � �� zLabel._make_proxy)N)NF)N)#r� r� r� r� r� r6 r0 r1 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� ru ru ru rw r� " sP � � �' ��r� c sJ e Zd ZU dZded< ded< dZdejfdejfdej fdej fgZ d ed < d Z d ed < d Z d ed< d Zded< d Zded< dZedd� �Zd8ddddd�dd�Zdd�dd �Ze� fd d ��Zd9� fd d � Zed!d"�d#d$��Zejd%d&� �Zed'd(� �Z d)d*� Z d:ddd,d-�d.d/�Z d d dd dd0�d1d,d,dd2dd3d4d5�d6d7�Z � Z S );r� a� Represents a column expression from any textual string. The :class:`.ColumnClause`, a lightweight analogue to the :class:`_schema.Column` class, is typically invoked using the :func:`_expression.column` function, as in:: from sqlalchemy import column id, name = column("id"), column("name") stmt = select(id, name).select_from("user") The above statement would produce SQL like:: SELECT id, name FROM user :class:`.ColumnClause` is the immediate superclass of the schema-specific :class:`_schema.Column` object. While the :class:`_schema.Column` class has all the same capabilities as :class:`.ColumnClause`, the :class:`.ColumnClause` class is usable by itself in those cases where behavioral requirements are limited to simple SQL expression generation. The object has none of the associations with schema-level metadata or with execution-time behavior that :class:`_schema.Column` does, so in that sense is a "lightweight" version of :class:`_schema.Column`. Full details on :class:`.ColumnClause` usage is at :func:`_expression.column`. .. seealso:: :func:`_expression.column` :class:`_schema.Column` r r rn r� r� r� r� rZ r NzOptional[DefaultGenerator]�onupdater� zOptional[FetchedValue]�server_default�server_onupdateFc C s | j o| jdkS r< )r� r� r� ru ru rw r# s zColumnClause._is_starr} r~ )r rq r� r� c C s( | | _ | _|| _t�|�| _|| _d S rt )r� r� r r r� r� r� )r� r rq r� r� ru ru rw r) s zColumnClause.__init__)� column_tablesc K s g S rt ru )r� r6 r� ru ru rw r� , s zColumnClause.get_childrenc s | j d k r| j jS t� jS d S rt )r r� r r� r� ru rw r� 2 s z ColumnClause.entity_namespacec sL |r>| j d k r>| j jr>|�d�}|| j f|�}|j�| �}|S t� jf |�S )Nr- )r Z _is_subqueryr� r� �corresponding_columnr r% )r� r� r� r- r �newr� ru rw r% 9 s ��� zColumnClause._cloner� r� c C s | j }|d k r|gS g S d S rt �r )r� �tru ru rw r� F s zColumnClause._from_objectsc C s | j d k S rt r9 r� ru ru rw r N s z,ColumnClause._render_label_in_columns_clausec C s | j | jdd�S )NF)r$ r" r� ru ru rw � _ddl_labelR s zColumnClause._ddl_labelc C s� | j sD| jd ksD| jjsDt|d�rDt|t�rp|j sD|jd ksD|jjrpt|d�rZ| j|jkpnt|d�on| j|jkS |j� | j�S d S )Nr� r� r� ) r� r r r r� r� r� r� r� r� r= ru ru rw r� V s* ������ � � �z%ColumnClause._compare_name_for_resultTr� r# c C s2 | j }| jrdS |dk �r*t|��r*t|�rT|jrT|j�dd�d |j d | }n trft|t �sft �|jd | }t |�r�|j dk r�t |�r�|j |_ q�t ||j �}n2t |j�r�|jj dk r�t|t �r�t �t ||jj �}|�r ||jk�r |}d}||jk�r|d t|� }|d7 }q�|}t�tj|�S |S dS )z�generate table-qualified label for a table-bound column this is <tablename>_<columnname>. used primarily for LABEL_STYLE_TABLENAME_PLUS_COL as well as the .columns collection on a Join object. N�.r� r )r r� r r �schema�replacer� r r� rU r� r! r r" r� r} r r| r r� )r� r� r$ r: r� r� �counterru ru rw r! l s2 " zColumnClause._gen_tq_labelr% rT r� r r� r' c K s� | o | j o |d kp || jk}| j|r:t�tj|p6| j�n|pB| j| j||d�} |j| _|d krh| j | _ |rxt |�| _ n| g| _ |j d k r�|j j �| j �| _ | j | fS )Nr( )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� ru ru rw r� � s. �� �� zColumnClause._make_proxy)NFN)F)T)!r� r� r� r� r r� r6 r0 r1 r� r4 r r3 r� r4 r5 Z_is_multiparam_columnr$ r# r) r� r� r% r= r� r+ r' r r; r� r! r� r ru ru r� rw r� � sN %� � �<�r� c @ sp e Zd ZU dZdejfdejfdejfgZde d< ddd �d d �Z e fd d dd�dd�Z e jdd�dd��ZdS )�TableValuedColumnZtable_valued_columnr� r� � scalar_aliasrZ r rU r� )rA rq c C s || _ |j | _| _|| _d S rt )rA r� r� r� )r� rA rq ru ru rw r) � s zTableValuedColumn.__init__rY r ry )r- r� rs c K s$ || j f|�| _ | j j | _| _d S rt )rA r� r� )r� r- r� ru ru rw r/ � s z!TableValuedColumn._copy_internalsr� r� c C s | j gS rt )rA r� ru ru rw r� � s z TableValuedColumn._from_objectsN)r� r� r� r� r6 r0 r1 r� r r r) r% r/ r< r& r� ru ru ru rw r@ � s � �r@ c @ sN e Zd ZU dZdejfgZded< ee � d�dddd�d d ���Z d d � Z d S )ry rz rZ r r� z _ColumnExpressionArgument[str]r} zBinaryExpression[str])r� rz rs c C sR t jj}t�tjt |�}|jj |j kr6|j� |�}n|j}t |t |�tj|d�S r� )r< r� r� r r| r r� r} r� r� �StringZ_with_collationr� ry r r| )r\ r� rz r� r� Z collate_typeru ru rw � _create_collation_expression� s �z,CollationClause._create_collation_expressionc C s || _ d S rt )rz r{ ru ru rw r) s zCollationClause.__init__N) r� r� r� r� r6 rU r r r^ r< r� rC r) ru ru ru rw ry � s � ry c @ s e Zd ZdZdd� ZdS )�_IdentifiedClauseZ identifiedc C s || _ d S rt )�ident)r� rE ru ru rw r) s z_IdentifiedClause.__init__N)r� r� r� r� r) ru ru ru rw rD s rD c @ s e Zd ZdZdZdS )�SavepointClauseZ savepointFN�r� r� r� r� r- ru ru ru rw rF s rF c @ s e Zd ZdZdZdS )�RollbackToSavepointClauseZrollback_to_savepointFNrG ru ru ru rw rH s rH c @ s e Zd ZdZdZdS )�ReleaseSavepointClauseZrelease_savepointFNrG ru ru ru rw rI ! s rI c s� e Zd ZU dZdZded< eeddd d�dd���Zeed dd d�d d���Zed dd d�d d��Zddd d�� fdd� Z dd� Z dd� Z dd� Z � Z S )r" a� Represent a SQL identifier combined with quoting preferences. :class:`.quoted_name` is a Python unicode/str subclass which represents a particular identifier name along with a ``quote`` flag. This ``quote`` flag, when set to ``True`` or ``False``, overrides automatic quoting behavior for this identifier in order to either unconditionally quote or to not quote the name. If left at its default of ``None``, quoting behavior is applied to the identifier on a per-backend basis based on an examination of the token itself. A :class:`.quoted_name` object with ``quote=True`` is also prevented from being modified in the case of a so-called "name normalize" option. Certain database backends, such as Oracle, Firebird, and DB2 "normalize" case-insensitive names as uppercase. The SQLAlchemy dialects for these backends convert from SQLAlchemy's lower-case-means-insensitive convention to the upper-case-means-insensitive conventions of those backends. The ``quote=True`` flag here will prevent this conversion from occurring to support an identifier that's quoted as all lower case against such a backend. The :class:`.quoted_name` object is normally created automatically when specifying the name for key schema constructs such as :class:`_schema.Table`, :class:`_schema.Column`, and others. The class can also be passed explicitly as the name to any function that receives a name which can be quoted. Such as to use the :meth:`_engine.Engine.has_table` method with an unconditionally quoted name:: from sqlalchemy import create_engine from sqlalchemy import inspect from sqlalchemy.sql import quoted_name engine = create_engine("oracle+cx_oracle://some_dsn") print(inspect(engine).has_table(quoted_name("some_table", True))) The above logic will run the "has table" logic against the Oracle backend, passing the name exactly as ``"some_table"`` without converting to upper case. .. versionchanged:: 1.2 The :class:`.quoted_name` construct is now importable from ``sqlalchemy.sql``, in addition to the previous location of ``sqlalchemy.sql.elements``. )r r r r r r} �rp r rs c C s d S rt ru �r\ rp r ru ru rw r# [ s zquoted_name.constructry c C s d S rt ru rK ru ru rw r# _ s r� zOptional[quoted_name]c C s |d kr d S t ||�S d S rt )r" rK ru ru rw r# c s c sH |d k st d��t|| �r0|d ks,|j|kr0|S t� �| |�}||_|S )Nz0use quoted_name.construct() for None passthrough)r� r� r r r� )r\ rp r r� r� ru rw r� l s �� zquoted_name.__new__c C s t t| �| jffS rt )r" r} r r� ru ru rw r w s zquoted_name.__reduce__c C s | j r | S t| ��� S d S rt )r r} r r� ru ru rw �_memoized_method_lowerz s z"quoted_name._memoized_method_lowerc C s | j r | S t| ��� S d S rt )r r} r r� ru ru rw �_memoized_method_upper� s z"quoted_name._memoized_method_upper)r� r� r� r� r� r r r^ r# r� r rL rM r ru ru r� rw r" & s 0 r" zSet[ColumnClause[Any]]r� c C s t � }t| i d|ji� |S )z2locate Column objects within the given expression.r� )�setr7 r� )r� rK ru ru rw � _find_columns� s rO zSequence[ColumnElement[_T]]r� )�argsrs c C s" | D ]}|j js|j S qtjS rt )r� r� r r� )rP �aru ru rw �_type_from_args� s rR c C s8 | j ||d�}|d kr4t�d|t|dd �| jf ��|S )N)�require_embeddedzbGiven column '%s', attached to table '%s', failed to locate a corresponding column from table '%s'r )r7 r: r1 r� r� )Z fromclauser� rS r� ru ru rw � _corresponding_column_or_error� s ���rT c @ s e Zd ZdZdd� ZdS )�#_memoized_property_but_not_nulltypez,memoized property, but dont memoize NullTypec C s, |d kr | S | � |�}|js(||j| j< |S rt )�fgetr� r� r� )r� r� r\ �resultru ru rw �__get__� s z+_memoized_property_but_not_nulltype.__get__N)r� r� r� r� rX ru ru ru rw rU � s rU c s� e Zd ZU ded< dd� Z� fdd�Zejdd� �Ze d d � �Z ejd d � �Z ejd d� �Z ejdd�dd��Z ejdd�dd��Z� ZS )�AnnotatedColumnElementr, �_Annotated__elementc C sR t �| ||� dD ]}| j�|d � qdD ]"}| j�|d�d kr*| j�|� q*d S )N)r� r� r� r� r� r� )r� r� r F)r# r) r� r� r )r� r� r� r� ru ru rw r) � s z AnnotatedColumnElement.__init__c s t � �|�}|j�dd � |S )Nr� )r �_with_annotationsr� r� )r� r� r- r� ru rw r[ � s z(AnnotatedColumnElement._with_annotationsc C s | j jS )z'pull 'name' from parent, if not present)rZ r� r� ru ru rw r� � s zAnnotatedColumnElement.namec C s | j jS )a� pull 'type' from parent and don't cache if null. type is routinely changed on existing columns within the mapped_column() initialization process, and "type" is also consulted during the creation of SQL expressions. Therefore it can change after it was already retrieved. At the same time we don't want annotated objects having overhead when expressions are produced, so continue to memoize, but only when we have a non-null type. )rZ r� r� ru ru rw r� � s zAnnotatedColumnElement.typec C s | j jS )z(pull 'table' from parent, if not present)rZ r r� ru ru rw r � s z AnnotatedColumnElement.tablec C s | j jS )z&pull 'key' from parent, if not present)rZ r� r� ru ru rw r� � s zAnnotatedColumnElement.keyrF r� c C s t rt| jt�st�| jjS rt )r r� rZ rO r� �infor� ru ru rw r\ � s zAnnotatedColumnElement.infor} c C s | j jS rt )rZ r� r� ru ru rw r� � s z'AnnotatedColumnElement._anon_name_label)r� r� r� r r) r[ r< r r� rU r� r r� r\ r� r ru ru r� rw rY � s rY c sN e Zd ZdZdZddddd�� fdd � Zdd �d d �Zd dd�dd�Z� ZS )r0 zVA unicode subclass used to identify symbolic " "names that may require truncation.ru Nr} r r rJ c s t |d|�}t� �| ||�S )Nr )r� r r� rK r� ru rw r� � s z_truncated_label.__new__r� c C s | j t| �| jffS rt )r� r} r r� ru ru rw r � s z_truncated_label.__reduce__r� )�map_rs c C s | S rt ru �r� r] ru ru rw � apply_map� s z_truncated_label.apply_map)N) r� r� r� r� r� r� r r_ r ru ru r� rw r0 � s r0 c @ s e Zd ZdZdZdS )�conva� Mark a string indicating that a name has already been converted by a naming convention. This is a string subclass that indicates a name that should not be subject to any further naming conventions. E.g. when we create a :class:`.Constraint` using a naming convention as follows:: m = MetaData(naming_convention={ "ck": "ck_%(table_name)s_%(constraint_name)s" }) t = Table('t', m, Column('x', Integer), CheckConstraint('x > 5', name='x5')) The name of the above constraint will be rendered as ``"ck_t_x5"``. That is, the existing name ``x5`` is used in the naming convention as the ``constraint_name`` token. In some situations, such as in migration scripts, we may be rendering the above :class:`.CheckConstraint` with a name that's already been converted. In order to make sure the name isn't double-modified, the new name is applied using the :func:`_schema.conv` marker. We can use this explicitly as follows:: m = MetaData(naming_convention={ "ck": "ck_%(table_name)s_%(constraint_name)s" }) t = Table('t', m, Column('x', Integer), CheckConstraint('x > 5', name=conv('ck_t_x5'))) Where above, the :func:`_schema.conv` marker indicates that the constraint name here is final, and the name will render as ``"ck_t_x5"`` and not ``"ck_t_ck_t_x5"`` .. seealso:: :ref:`constraint_naming_conventions` ru Nr� ru ru ru rw r` s *r` c @ sH e Zd ZdZdZedddddd d �d d ��Zd d � Zdd� Zdd� Z dS )r� zDA unicode subclass used to identify anonymously generated names.ru NFr3 r} r� rn )r� �bodyr� r! rs c C sH t �dd|�}|r |�d�}d||�dd�f }|r@d||f }t|�S )Nz [%\(\) \$]+r� z %%(%d %s)s�%�%%z%s%s)rV rC �stripr> r� )r\ r� ra r� r! r� ru ru rw r� > s z _anonymous_label.safe_constructc C sD d|kr$t |t�s$t|��dd�}nt|�}ttt�| |�| j��S �Nrb rc �r� r� r} r> r" r� r r= ru ru rw r� T s ��z_anonymous_label.__add__c C sD d|kr$t |t�s$t|��dd�}nt|�}ttt�|| �| j��S re rf r= ru ru rw r� a s ��z_anonymous_label.__radd__c C s& | j d k rt| | | j �S | | S d S rt )r r" r^ ru ru rw r_ n s z_anonymous_label.apply_map)NF) r� r� r� r� r� r^ r� r� r� r_ ru ru ru rw r� 8 s � r� )F)NF)NF)NF)N)F)�r� � __future__r �decimalr �enumr r� r rV r% r r r r r r r r r r r r r r r r Z typing_Tupler r r r r� r r r r r Z_typingr r r! r" � annotationr# r$ �baser% r& r' r( r) r* r+ r, r- r. r r/ r0 r1 r2 r3 Zvisitorsr4 r5 r6 r7 r8 r: r; r< r= r> Z util.typingr? r@ rA rB rC rD rE rF rG rH rI rJ �compilerrK rL Z functionsrM rN r= rO rP rQ rR r� rS rT rU rV r� rW rX rY rZ r[ Zenginer\ r] Zengine.interfacesr^ r_ r` ra rb Z engine.resultrc �floatrj r3 rl rd rf rh ri rk rx r� r� Z_self_inspectsr� r( Z DMLColumnRoleZDDLConstraintColumnRoleZColumnsClauseRoler) r+ r� r� Z_SQOZColumnArgumentOrKeyRoleZStatementOptionRoler� ZBinaryElementRoleZ OrderByRoleZLimitOffsetRoleZDDLExpressionRoler r r Z InElementRoler� r5 ZFromClauseRoleZSelectStatementRoleZ Inspectabler8 Z ConstExprRolerX Z_create_singletonrn r_ rb rh 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 _IntOrRanger r r r r) rM r� ZDDLReferredColumnRoleZStrAsPlainColumnRoler� r@ r} ry rD rF rH rI Z MemoizedSlotsr" rO rR rT r rU rY r0 r` Z_generated_labelr� ru ru ru rw �<module> s& � � � �&�&] � ; � } � � uB � � $ �lX[ Q Mb<@ @ *@3 j i 8 � ~!a �?2