File: //opt/alt/python37/lib64/python3.7/site-packages/sqlalchemy/sql/__pycache__/elements.cpython-37.pyc
B
��4]`Y � @ s d Z ddlmZ ddlZddlZddlZddlZddlmZ ddlm Z ddl
m Z ddl m
Z
dd l mZ dd
l mZ dd l mZ dd l mZ dd
lmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ dd� Zdd� Zdd� Zd�dd �Z d�d d �Z d�d d �Z d!d"� Z ej G d#d$� d$e��Z!G d%d&� d&ej"e!�Z#G d'd(� d(e#�Z$G d)d*� d*e!�Z%G d+d,� d,ee!�Z&G d-d.� d.e#�Z'G d/d0� d0e#�Z(G d1d2� d2e#�Z)G d3d4� d4e!�Z*G d5d6� d6e*e#�Z+e+j,Z,e+j-Z-G d7d8� d8e*e#�Z.G d9d:� d:e#�Z/d�d;d<�Z0G d=d>� d>e#�Z1G d?d@� d@e#�Z2G dAdB� dBe#�Z3G dCdD� dDe#�Z4G dEdF� dFe#�Z5G dGdH� dHe#�Z6G dIdJ� dJe6�Z7G dKdL� dLe6�Z8G dMdN� dNe#�Z9G dOdP� dPe#�Z:G dQdR� dRe9�Z;G dSdT� dTe#�Z<e�=dU�Z>e�=dV�Z?G dWdX� dXe#�Z@G dYdZ� dZe#�ZAG d[d\� d\e#�ZBG d]d^� d^e#�ZCG d_d`� d`ee#�ZDG dadb� dbe#�ZEG dcdd� ddee!�ZFG dedf� dfeF�ZGG dgdh� dheF�ZHG didj� djeF�ZIG dkdl� dlejJejK�ZLG dmdn� dneL�ZMG dodp� dpeM�ZNG dqdr� dreM�ZOG dsdt� dteO�ZPePdu�ZQeMZRG dvdw� dweM�ZSdxdy� ZTdzd{� ZUd|d}� ZVd~d� ZWd�d�� ZXd�d�� ZYe�Zd��d�d�� �Z[d�d�� Z\d�d�� Z]d�d�� Z^d�d�� Z_d�d�� Z`d�d�� Zad�d�� Zbd�d�� Zcd�d�d��Zdd�d�� Zed�d�� Zfejgdfd�d��Zhd�d�� Zid�d�� Zjd�d�� Zkd�d�� Zld�d�d��Zme�nd�ejo�Zpd�d�� Zqd�d�� Zrd�d�� Zsd�d�d��ZtG d�d�� d�e �ZudS )�zpCore SQL expression elements, including :class:`.ClauseElement`,
:class:`.ColumnElement`, and derived classes.
� )�unicode_literalsN� )� operators)�type_api)� Annotated)� _generative)�
Executable)� Immutable)�NO_ARG)�PARSE_AUTOCOMMIT)�cloned_traverse)�traverse)� Visitable� )�exc)�
inspection)�utilc K s | � � S )N)�_clone)�element�kw� r �J/opt/alt/python37/lib64/python3.7/site-packages/sqlalchemy/sql/elements.pyr $ s r c C s t �| d||f �S )Nz�.. warning:: The %s argument to %s can be passed as a Python string argument, which will be treated as **trusted SQL text** and rendered as given. **DO NOT PASS UNTRUSTED INPUT TO THIS PARAMETER**.)r Zadd_parameter_text)Z paramnameZmeth_rstZ param_rstr r r �_document_text_coercion( s r c C s t | �}t|t|�tj|jd�S )a� Return the clause ``expression COLLATE collation``.
e.g.::
collate(mycolumn, 'utf8_bin')
produces::
mycolumn COLLATE utf8_bin
The collation expression is also quoted if it is a case sensitive
identifier, e.g. contains uppercase characters.
.. versionchanged:: 1.2 quoting is automatically applied to COLLATE
expressions if they are case sensitive.
)�type_)�_literal_as_binds�BinaryExpression�CollationClauser �collate�type)�
expression� collation�exprr r r r 6 s r Fc C s t | �} | j|||d�S )aE Produce a ``BETWEEN`` predicate clause.
E.g.::
from sqlalchemy import between
stmt = select([users_table]).where(between(users_table.c.id, 5, 7))
Would produce SQL resembling::
SELECT id, name FROM user WHERE id BETWEEN :id_1 AND :id_2
The :func:`.between` function is a standalone version of the
:meth:`.ColumnElement.between` method available on all
SQL expressions, as in::
stmt = select([users_table]).where(users_table.c.id.between(5, 7))
All arguments passed to :func:`.between`, including the left side
column expression, are coerced from Python scalar values if a
the value is not a :class:`.ColumnElement` subclass. For example,
three fixed values can be compared as in::
print(between(5, 3, 7))
Which would produce::
:param_1 BETWEEN :param_2 AND :param_3
:param expr: a column expression, typically a :class:`.ColumnElement`
instance or alternatively a Python scalar expression to be coerced
into a column expression, serving as the left side of the ``BETWEEN``
expression.
:param lower_bound: a column or Python scalar expression serving as the
lower bound of the right side of the ``BETWEEN`` expression.
:param upper_bound: a column or Python scalar expression serving as the
upper bound of the right side of the ``BETWEEN`` expression.
:param symmetric: if True, will render " BETWEEN SYMMETRIC ". Note
that not all databases support this syntax.
.. versionadded:: 0.9.5
.. seealso::
:meth:`.ColumnElement.between`
)� symmetric)r �between)r! Z lower_boundZ upper_boundr" r r r r# O s 2r# c C s t d| |dd�S )a� Return a literal clause, bound to a bind parameter.
Literal clauses are created automatically when non-
:class:`.ClauseElement` objects (such as strings, ints, dates, etc.) are
used in a comparison operation with a :class:`.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.
NT)r �unique)�
BindParameter)�valuer r r r �literal� s r' c C s t | d|ddd�S )aw Create an 'OUT' parameter for usage in functions (stored procedures),
for databases which support them.
The ``outparam`` can be used like a regular function parameter.
The "output" value will be available from the
:class:`~sqlalchemy.engine.ResultProxy` object via its ``out_parameters``
attribute, which returns a dictionary containing the values.
NFT)r r$ �
isoutparam)r% )�keyr r r r �outparam� s
r* c C s t �t| ��S )z�Return a negation of the given clause, i.e. ``NOT(clause)``.
The ``~`` operator is also overloaded on all
:class:`.ColumnElement` subclasses to produce the
same result.
)r �invr )�clauser r r �not_� s r- c @ s6 e Zd ZdZdZi ZdZg ZdZdZ dZ
dZ dZ dZ
dZdd� Zedd � �Zejd
d � �Zd d
� Zdd� Zdd� Zd:dd�Zdd� Zdd� Zdd� Zdd� Z d d � Z efd d �Z d d!� Z d;d"d#�Z e�!d$�d<d%d&��Z"d'd(� Z#d)d*� Z$e�%d+d,�d-d.� �Z&e�%d+d/�d0d1� �Z'd2d3� Z(d4d5� Z)d6d7� Z*e*Z+d8d9� Z,dS )=�
ClauseElementzSBase class for elements of a programmatically constructed SQL
expression.
r, FNTc C s< | j �| j �}| j�� |_tj�|� tj�|� | |_ |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.
)
� __class__�__new__�__dict__�copyr. � _cloned_set�_reset�
ColumnElement�
comparator� _is_clone_of)�self�cr r r r � s zClauseElement._clonec 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/ )r8 r r r � _constructor� s
zClauseElement._constructorc C s. t �� }| }x |dk r(|�|� |j}qW |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 �
column_set�addr7 )r8 �s�fr r r r3 � s
zClauseElement._cloned_setc C s | j �� }|�dd � |S )Nr7 )r1 r2 �pop)r8 �dr r r � __getstate__� s
zClauseElement.__getstate__c C s
t | |�S )zgreturn a copy of this ClauseElement with annotations
updated by the given dictionary.
)r )r8 �valuesr r r � _annotate� s zClauseElement._annotatec C s
t | |�S )zhreturn a copy of this ClauseElement with annotations
replaced by the given dictionary.
)r )r8 rB r r r �_with_annotations s z ClauseElement._with_annotationsc C s |r | � � S | S dS )z�return a copy of this :class:`.ClauseElement` with annotations
removed.
:param values: optional tuple of individual values
to remove.
N)r )r8 rB �cloner r r � _deannotate s zClauseElement._deannotatec C s" | j r|�| ||�S t�| ��d S )N)�supports_executionZ_execute_clauseelementr ZObjectNotExecutableError)r8 Z
connectionZ multiparams�paramsr r r �_execute_on_connection s z$ClauseElement._execute_on_connectionc O s | � d||�S )z�Return a copy with :func:`bindparam()` elements replaced.
Same functionality as ``params()``, except adds `unique=True`
to affected bind parameters so that multiple statements can be
used.
T)�_params)r8 � optionaldict�kwargsr r r �
unique_params# s zClauseElement.unique_paramsc O s | � d||�S )a� Return a copy with :func:`bindparam()` elements replaced.
Returns a copy of this ClauseElement with :func:`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}
F)rJ )r8 rK rL r r r rH - s
zClauseElement.paramsc sP t |�dkr � �|d � nt |�dkr2t�d��� �fdd�}t| i d|i�S )Nr r z9params() takes zero or one positional dictionary argumentc s, | j � kr � | j | _d| _�r(| �� d S )NF)r) r& �required�_convert_to_unique)�bind)rL r$ r r �visit_bindparamD s
z.ClauseElement._params.<locals>.visit_bindparam� bindparam)�len�updater �
ArgumentErrorr )r8 r$ rK rL rQ r )rL r$ r rJ < s zClauseElement._paramsc K s | |kS )aT Compare this ClauseElement to the given 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:`.ColumnElement`)
r )r8 �otherr r r r �compareM s zClauseElement.comparec K s dS )at Reassign internal elements to be clones of themselves.
Called during a copy-and-traverse operation on newly
shallow-copied elements to create a deep copy.
The given clone function should be used, which may be applying
additional transformations to the element (i.e. replacement
traversal, cloned traversal, annotations).
Nr )r8 rE r r r r �_copy_internalsZ s z ClauseElement._copy_internalsc K s g S )a� Return immediate child elements of this :class:`.ClauseElement`.
This is used for visit traversal.
\**kwargs may contain flags that change the collection that is
returned, for example to return a subset of items in order to
cut down on larger traversals, or to return child items from a
different context (such as schema-level collections instead of
clause-level).
r )r8 rL r r r � get_childreng s zClauseElement.get_childrenc C s | S )aa Apply a 'grouping' to this :class:`.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:`.select` constructs when placed into
the FROM clause of another :func:`.select`. (Note that
subqueries should be normally created using the
:meth:`.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:`.ClauseElement`
just returns self.
r )r8 �againstr r r �
self_groupu s zClauseElement.self_groupzsqlalchemy.engine.defaultc K sD |s.|r|j }n | jr&| jj }| j}n|�� }| j|fd|i|��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 ``Engine`` or ``Connection`` from which a
``Compiled`` will be acquired. This argument takes precedence over
this :class:`.ClauseElement`'s bound engine, if any.
: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 ``Dialect`` instance from which a ``Compiled``
will be acquired. This argument takes precedence over the `bind`
argument as well as this :class:`.ClauseElement`'s bound engine,
if any.
:param inline: Used for INSERT statements, for a dialect which does
not support inline retrieval of newly generated primary key
columns, will force the expression used to create the new primary
key value to be rendered inline within the INSERT statement's
VALUES clause. This typically refers to Sequence execution but may
also refer to any server-side default generation function
associated with a primary key `Column`.
: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})
.. versionadded:: 0.9.0
.. seealso::
:ref:`faq_sql_expression_string`
rP )�dialectrP ZStrCompileDialect� _compiler)r8 �defaultrP r\ r r r r �compile� s 7zClauseElement.compilec K s |j || f|�S )zNReturn a compiler appropriate for this ClauseElement, given a
Dialect.)Zstatement_compiler)r8 r\ r r r r r] � s zClauseElement._compilerc C s* t jrt| �� �S t| �� ��dd�S d S )N�ascii�backslashreplace)r �py3k�strr_ Zunicode�encode)r8 r r r �__str__� s zClauseElement.__str__z0.9z�The :meth:`.ClauseElement.__and__` method is deprecated and will be removed in a future release. Conjunctions should only be used from a :class:`.ColumnElement` subclass, e.g. :meth:`.ColumnElement.__and__`.c C s
t | |�S )z*'and' at the ClauseElement level.
)�and_)r8 rV r r r �__and__� s
zClauseElement.__and__z�The :meth:`.ClauseElement.__or__` method is deprecated and will be removed in a future release. Conjunctions should only be used from a :class:`.ColumnElement` subclass, e.g. :meth:`.ColumnElement.__or__`.c C s
t | |�S )z)'or' at the ClauseElement level.
)�or_)r8 rV r r r �__or__� s
zClauseElement.__or__c C s t | d�r| jS | �� S d S )N�negation_clause)�hasattrrj �_negate)r8 r r r �
__invert__� s
zClauseElement.__invert__c C s t | jtjd�tjd d�S )N)rZ )�operator�negate)�UnaryExpressionr[ r r+ )r8 r r r rl � s zClauseElement._negatec C s t d��d S )Nz+Boolean value of this clause is not defined)� TypeError)r8 r r r �__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>)� description�object�__repr__�
__module__r/ �__name__�id)r8 Zfriendlyr r r ru s
zClauseElement.__repr__)NF)N)NN)-rw rv � __qualname__�__doc__�__visit_name__Z _annotationsrG �
_from_objectsrP r7 �
is_selectableZis_clause_elementrs �_order_by_label_elementZ_is_from_containerr �propertyr: r �memoized_propertyr3 rA rC rD rF rI rM rH rJ rW rX rY r[ � dependenciesr_ r] re �
deprecatedrg ri rm rl rr � __nonzero__ru r r r r r. � sT
@
r. c s e Zd ZdZdZdZg ZdZdZdZ dZ
dZ dZ dZ
dZdZd/dd�Z� fd d
�Zejd d � �Zejd
d� �Zdd� Zdd� Zdd� Zd0dd�Zedd� �Zedd� �Z ejdd � �Z ejd d � �Z d d � Z d!d"� Z d#d$� Z!d1d%d&�Z"d2d'd(�Z#d)d*� Z$d+d,� Z%ejd-d.� �Z&� Z'S )3r5 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:`.ColumnElement` is the
:class:`.Column` object, :class:`.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:`.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:`.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:`.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:`.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 a method 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:`.ColumnElement` expression. The
``__clause_element__()`` method, if present, should return a
:class:`.ColumnElement` instance. The primary use of
``__clause_element__()`` within SQLAlchemy is that of class-bound
attributes on ORM-mapped classes; a ``User`` class which contains a
mapped attribute named ``.name`` will have a method
``User.name.__clause_element__()`` which when invoked returns the
:class:`.Column` called ``name`` associated with the mapped table.
* The Python ``None`` value is typically interpreted as ``NULL``,
which in SQLAlchemy Core produces an instance of :func:`.null`.
A :class:`.ColumnElement` provides the ability to generate new
:class:`.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:`.ColumnElement` instances
which are composed from other, more fundamental :class:`.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:`.ColumnElement`::
>>> from sqlalchemy.sql import column
>>> column('a') + column('b')
<sqlalchemy.sql.expression.BinaryExpression object at 0x101029dd0>
>>> print column('a') + column('b')
a + b
.. seealso::
:class:`.Column`
:func:`.expression.column`
Zcolumn_elementFr NTc C sT |t jt jt jfkr4| jjtjjkr4t| t j t j
�S |t j t j fkrLt
| �S | S d S )N)r rf rh �_asboolr �_type_affinityr � BOOLEANTYPE� AsBoolean�istrue�isfalse�any_op�all_op�Grouping)r8 rZ r r r r[ � s zColumnElement.self_groupc s2 | j jtjjkr t| tjtj�S tt | ��
� S d S )N) r r� r r� r� r r� r� �superr5 rl )r8 )r/ r r rl � s zColumnElement._negatec C s t jS )N)r �NULLTYPE)r8 r r r r � s zColumnElement.typec C s< y | j j}W n" tk
r. td| j ��Y n
X || �S d S )NzOObject %r associated with '.type' attribute is not a TypeEngine class or object)r �comparator_factory�AttributeErrorrq )r8 r� r r r r6 � s zColumnElement.comparatorc C sF y t | j|�S tk
r@ tdt| �jt| j�j|f ��Y nX d S )Nz3Neither %r object nor %r object has an attribute %r)�getattrr6 r� r rw )r8 r) r r r � __getattr__� s zColumnElement.__getattr__c O s || j f|�|�S )N)r6 )r8 �oprV rL r r r �operate� s zColumnElement.operatec K s ||| j f|�S )N)r6 )r8 r� rV rL r r r �reverse_operate� s z ColumnElement.reverse_operatec C s t d |||| jdd�S )NT)�_compared_to_operatorr �_compared_to_typer$ )r% r )r8 rn �objr r r r � _bind_param� s zColumnElement._bind_paramc C s | S )z^Return a column expression.
Part of the inspection interface; returns self.
r )r8 r r r r � s zColumnElement.expressionc C s | fS )Nr )r8 r r r �_select_iterable� s z ColumnElement._select_iterablec C s t �dd� | jD ��S )Nc s s | ]}|j s|V qd S )N)�_proxies)�.0r9 r r r � <genexpr>� s z-ColumnElement.base_columns.<locals>.<genexpr>)r r; � proxy_set)r8 r r r � base_columns� s zColumnElement.base_columnsc C s, t �| g�}x| jD ]}|�|j� qW |S )N)r r; r� rT r� )r8 r= r9 r r r r� � s zColumnElement.proxy_setc C s. t �| g�}x | jD ]}|�|�� � qW |S )z�An 'uncached' version of proxy set.
This is so that we can read annotations from the list of columns
without breaking the caching of the above proxy_set.
)r r; r� rT �_uncached_proxy_set)r8 r= r9 r r r r� � s z!ColumnElement._uncached_proxy_setc C s t | j�|j��S )zoReturn True if the given :class:`.ColumnElement`
has a common ancestor to this :class:`.ColumnElement`.)�boolr� � intersection)r8 Z othercolumnr r r �shares_lineage s z ColumnElement.shares_lineagec 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.�name)rk r� )r8 rV r r r �_compare_name_for_result s
z&ColumnElement._compare_name_for_resultc K s� |dkrH| j }| jr | j}qLy t| �}W qL tjk
rD | j }Y qLX n|}t|rZt|�n|t| dd�|d�}| g|_|j dk r�|j j
� |�|_ ||j |< |S )z�Create a new :class:`.ColumnElement` representing this
:class:`.ColumnElement` as it appears in the select list of a
descending selectable.
Nr )r � _selectable)
�
anon_labelr) rc r ZUnsupportedCompilationError� ColumnClause�
_as_truncatedr� r� r7 �columns�get�_columns)r8 �
selectabler� �name_is_truncatabler r) �cor r r � _make_proxy s$
zColumnElement._make_proxyc K s\ |f}|r ||kr || � |�}x6|D ]*}|r<| �|�r<dS t|�t| �kr&dS q&W dS dS )a� Compare this ColumnElement to another.
Special arguments understood:
:param use_proxies: when True, consider two columns that
share a common base column as equivalent (i.e. shares_lineage())
:param equivalents: a dictionary of columns as keys mapped to sets
of columns. If the given "other" column is present in this
dictionary, if any of the columns in the corresponding set() pass
the comparison test, the result is True. This is used to expand the
comparison to other columns that may be known to be equivalent to
this one via foreign key or other criterion.
TFN)�unionr� �hash)r8 rV Z use_proxiesZ equivalentsr Z
to_compareZothr r r rW 7 s
zColumnElement.comparec 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:`coretutorial_casts`
:func:`~.expression.cast`
:func:`~.expression.type_coerce`
.. versionadded:: 1.0.7
)�Cast)r8 r r r r �castS s zColumnElement.castc 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 )r8 r� r r r �labele s zColumnElement.labelc C s2 x| j dk r| j } qW tdt| �t| dd�f �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.
Nz
%%(%d %s)sr� �anon)r7 �_anonymous_labelrx r� )r8 r r r r� o s
zColumnElement.anon_label)N)N)NF)FN)(rw rv ry rz r{ � primary_key� foreign_keysr� �_labelr) �
_key_label� _render_label_in_columns_clause�_resolve_label�_allow_label_resolve�_is_implicitly_booleanZ
_alt_namesr[ rl r r� r r6 r� r� r� r� r r r� r� r� r� r� r� r� rW r� r� r� �
__classcell__r r )r/ r r5 sB H
r5 c
@ s~ e Zd ZdZdZdZdZeddeddddddf
dd�Zdd � Z d
d � Z
e d d
� �Z dd� Z
dd� Zdd� Zdd� Zdd� ZdS )r% 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`
rR Fr Nc C s t |t�r|j}|j}|tkr.|tko,|dk}|tkr:d}|dk rLt||�}|rltdt| �|p`df �| _n|p~tdt| � �| _| j| _|p�d| _ || _
|| _ || _ | | _
|| _|| _|dkr�| dk r�| �|
|�| _n t�|�| _nt |t�r�|� | _n|| _dS )a<$ Produce a "bound expression".
The return value is an instance of :class:`.BindParameter`; this
is a :class:`.ColumnElement` subclass which represents a so-called
"placeholder" value in a SQL expression, the value of which is
supplied at the point at which the statement in executed against a
database connection.
In SQLAlchemy, the :func:`.bindparam` construct has
the ability to carry along the actual value that will be ultimately
used at expression time. In this way, it serves not just as
a "placeholder" for eventual population, but also as a means of
representing so-called "unsafe" values which should not be rendered
directly in a SQL statement, but rather should be passed along
to the :term:`DBAPI` as values which need to be correctly escaped
and potentially handled for type-safety.
When using :func:`.bindparam` explicitly, the use case is typically
one of traditional deferment of parameters; the :func:`.bindparam`
construct accepts a name which can then be referred to at execution
time::
from sqlalchemy import bindparam
stmt = select([users_table]).\
where(users_table.c.name == bindparam('username'))
The above statement, when rendered, will produce SQL similar to::
SELECT id, name FROM user WHERE name = :username
In order to populate the value of ``:username`` above, the value
would typically be applied at execution time to a method
like :meth:`.Connection.execute`::
result = connection.execute(stmt, username='wendy')
Explicit use of :func:`.bindparam` is also common when producing
UPDATE or DELETE statements that are to be invoked multiple times,
where the WHERE criterion of the statement is to change on each
invocation, such as::
stmt = (users_table.update().
where(user_table.c.name == bindparam('username')).
values(fullname=bindparam('fullname'))
)
connection.execute(
stmt, [{"username": "wendy", "fullname": "Wendy Smith"},
{"username": "jack", "fullname": "Jack Jones"},
]
)
SQLAlchemy's Core expression system makes wide use of
:func:`.bindparam` in an implicit sense. It is typical that Python
literal values passed to virtually all SQL expression functions are
coerced into fixed :func:`.bindparam` constructs. For example, given
a comparison operation such as::
expr = users_table.c.name == 'Wendy'
The above expression will produce a :class:`.BinaryExpression`
construct, where the left side is the :class:`.Column` object
representing the ``name`` column, and the right side is a
:class:`.BindParameter` representing the literal value::
print(repr(expr.right))
BindParameter('%(4327771088 name)s', 'Wendy', type_=String())
The expression above will render SQL such as::
user.name = :name_1
Where the ``:name_1`` parameter name is an anonymous name. The
actual string ``Wendy`` is not in the rendered string, but is carried
along where it is later used within statement execution. If we
invoke a statement like the following::
stmt = select([users_table]).where(users_table.c.name == 'Wendy')
result = connection.execute(stmt)
We would see SQL logging output as::
SELECT "user".id, "user".name
FROM "user"
WHERE "user".name = %(name_1)s
{'name_1': 'Wendy'}
Above, we see that ``Wendy`` is passed as a parameter to the database,
while the placeholder ``:name_1`` is rendered in the appropriate form
for the target database, in this case the PostgreSQL database.
Similarly, :func:`.bindparam` is invoked automatically
when working with :term:`CRUD` statements as far as the "VALUES"
portion is concerned. The :func:`.insert` construct produces an
``INSERT`` expression which will, at statement execution time,
generate bound placeholders based on the arguments passed, as in::
stmt = users_table.insert()
result = connection.execute(stmt, name='Wendy')
The above will produce SQL output as::
INSERT INTO "user" (name) VALUES (%(name)s)
{'name': 'Wendy'}
The :class:`.Insert` construct, at compilation/execution time,
rendered a single :func:`.bindparam` mirroring the column
name ``name`` as a result of the single ``name`` parameter
we passed to the :meth:`.Connection.execute` method.
:param key:
the key (e.g. the name) for this bind param.
Will be used in the generated
SQL statement for dialects that use named parameters. This
value may be modified when part of a compilation operation,
if other :class:`BindParameter` objects exist with the same
key, or if its length is too long and truncation is
required.
:param value:
Initial value for this bind param. Will be used at statement
execution time as the value for this parameter passed to the
DBAPI, if no other value is indicated to the statement execution
method for this particular parameter name. Defaults to ``None``.
:param callable\_:
A callable function that takes the place of "value". The function
will be called at statement execution time to determine the
ultimate value. Used for scenarios where the actual bind
value cannot be determined at the point at which the clause
construct is created, but embedded bind values are still desirable.
:param type\_:
A :class:`.TypeEngine` class or instance representing an optional
datatype for this :func:`.bindparam`. If not passed, a type
may be determined automatically for the bind, based on the given
value; for example, trivial Python types such as ``str``,
``int``, ``bool``
may result in the :class:`.String`, :class:`.Integer` or
:class:`.Boolean` types being automatically selected.
The type of a :func:`.bindparam` is significant especially in that
the type will apply pre-processing to the value before it is
passed to the database. For example, a :func:`.bindparam` which
refers to a datetime value, and is specified as holding the
:class:`.DateTime` type, may apply conversion needed to the
value (such as stringification on SQLite) before passing the value
to the database.
:param unique:
if True, the key name of this :class:`.BindParameter` will be
modified if another :class:`.BindParameter` of the same name
already has been located within the containing
expression. This flag is used generally by the internals
when producing so-called "anonymous" bound expressions, it
isn't generally applicable to explicitly-named :func:`.bindparam`
constructs.
:param required:
If ``True``, a value is required at execution time. If not passed,
it defaults to ``True`` if neither :paramref:`.bindparam.value`
or :paramref:`.bindparam.callable` were passed. If either of these
parameters are present, then :paramref:`.bindparam.required`
defaults to ``False``.
:param quote:
True if this parameter name requires quoting and is not
currently known as a SQLAlchemy reserved word; this currently
only applies to the Oracle backend, where bound names must
sometimes be quoted.
:param isoutparam:
if True, the parameter should be treated like a stored procedure
"OUT" parameter. This applies to backends such as Oracle which
support OUT parameters.
:param expanding:
if True, this parameter will be treated as an "expanding" parameter
at execution time; the parameter value is expected to be a sequence,
rather than a scalar value, and the string SQL statement will
be transformed on a per-execution basis to accommodate the sequence
with a variable number of parameter slots passed to the DBAPI.
This is to allow statement caching to be used in conjunction with
an IN clause.
.. seealso::
:meth:`.ColumnOperators.in_`
:ref:`baked_in` - with baked queries
.. note:: The "expanding" feature does not support "executemany"-
style parameter sets.
.. versionadded:: 1.2
.. versionchanged:: 1.3 the "expanding" bound parameter feature now
supports empty lists.
.. seealso::
:ref:`coretutorial_bind_param`
:ref:`coretutorial_insert_expressions`
:func:`.outparam`
Nz
%%(%d %s)s�paramz
%%(%d param)s)�
isinstancer� r r) r
� quoted_namer� rx Z_identifying_key� _orig_keyr$ r& �callabler( rN � expandingZcoerce_compared_valuer �_resolve_value_to_type) r8 r) r& r r$ rN �quoteZ callable_r� r( r� r� r r r �__init__� s< a
zBindParameter.__init__c C s | � � }||_|S )zrReturn a copy of this :class:`.BindParameter` in
the context of an expanding IN against a tuple.
)r �_expanding_in_types)r8 �types�clonedr r r �_with_expanding_in_types� s z&BindParameter._with_expanding_in_typesc C s6 | � � }||_d|_d|_|jtjkr2t�|�|_|S )zXReturn a copy of this :class:`.BindParameter` with the given value
set.
NF)r r& r� rN r r r� r� )r8 r& r� r r r � _with_value� s zBindParameter._with_valuec 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� r& )r8 r r r �effective_value� s
z BindParameter.effective_valuec C s0 t �| �}| jr,tdt|�|jp"df �|_|S )Nz
%%(%d %s)sr� )r. r r$ r� rx r� r) )r8 r9 r r r r � s
zBindParameter._clonec C s, | j s(d| _ tdt| �| jp df �| _d S )NTz
%%(%d %s)sr� )r$ r� rx r� r) )r8 r r r rO � s z BindParameter._convert_to_uniquec K s0 t |t�o.| j�|j�o.| j|jko.| j|jkS )z@Compare this :class:`BindParameter` to the given
clause.)r� r% r Z_compare_type_affinityr& r� )r8 rV r r r r rW � s
zBindParameter.comparec C s2 | j �� }| j}| jr&| �� }d|d< ||d< |S )z4execute a deferred value for serialization purposes.Nr� r& )r1 r2 r& r� )r8 r@ �vr r r rA � s
zBindParameter.__getstate__c C s d| j | j| jf S )Nz BindParameter(%r, %r, type_=%r))r) r& r )r8 r r r ru � s zBindParameter.__repr__)rw rv ry rz r{ Z_is_crudr� r
r� r� r� r r� r rO rW rA ru r r r r r% � s0 r% c @ s e Zd ZdZdZdd� ZdS )�
TypeClausezTHandle a type keyword in a SQL statement.
Used by the ``Case`` statement.
�
typeclausec C s
|| _ d S )N)r )r8 r r r r r� s zTypeClause.__init__N)rw rv ry rz r{ r� r r r r r� � s r� c @ s� e Zd ZdZdZe�dej�Ze j
� de i�Z
dZ
dd� Zedd � �Zed
d � �Zg Zd Z ZZdZd)d
d�Zeejdddd�eddd�d*dd����Z e dd� �Z e� d�dd � �Z ed d � �Z!ed d � �Z"d+d!d"�Z#e$fd#d$�Z%d%d&� Z&d'd(� Z'd S ),�
TextClauseaU Represent a literal SQL text fragment.
E.g.::
from sqlalchemy import text
t = text("SELECT * FROM users")
result = connection.execute(t)
The :class:`.Text` construct is produced using the :func:`.text`
function; see that function for full documentation.
.. seealso::
:func:`.text`
Z
textclausez(?<![:\w\x5c]):(\w+)(?!:)�
autocommitFc C s
t | |�S )N)rf )r8 rV r r r rg & s zTextClause.__and__c C s | fS )Nr )r8 r r r r� * s zTextClause._select_iterablec C s | S )Nr )r8 r r r r� . s zTextClause.selectableNc s, |� _ i � _� fdd�}� j�||�� _d S )Nc s( t | �d��� j| �d�< d| �d� S )Nr z:%s)r% �group� _bindparams)�m)r8 r r �repl@ s z!TextClause.__init__.<locals>.repl)Z_bindr� �_bind_params_regex�sub�text)r8 r� rP r� r )r8 r r� < s zTextClause.__init__)z0.6z�The :paramref:`.text.autocommit` parameter is deprecated and will be removed in a future release. Please use the :paramref:`.Connection.execution_options.autocommit` parameter in conjunction with the :meth:`.Executable.execution_options` method.)z0.9z�The :paramref:`.text.bindparams` parameter is deprecated and will be removed in a future release. Please refer to the :meth:`.TextClause.bindparams` method.)z0.9z�The :paramref:`.text.typemap` parameter is deprecated and will be removed in a future release. Please refer to the :meth:`.TextClause.columns` method.)r� �
bindparams�typemapr� z
:func:`.text`z:paramref:`.text.text`c C sB t ||d�}|r|j|� }|r*|jf |�}|dk r>|j|d�}|S )aD Construct a new :class:`.TextClause` clause, representing
a textual SQL string directly.
E.g.::
from sqlalchemy import text
t = text("SELECT * FROM users")
result = connection.execute(t)
The advantages :func:`.text` provides over a plain string are
backend-neutral support for bind parameters, per-statement
execution options, as well as
bind parameter and result-column typing behavior, allowing
SQLAlchemy type constructs to play a role when executing
a statement that is specified literally. The construct can also
be provided with a ``.c`` collection of column elements, allowing
it to be embedded in other SQL expression constructs as a subquery.
Bind parameters are specified by name, using the format ``:name``.
E.g.::
t = text("SELECT * FROM users WHERE id=:user_id")
result = connection.execute(t, user_id=12)
For SQL statements where a colon is required verbatim, as within
an inline string, use a backslash to escape::
t = text("SELECT * FROM users WHERE name='\:username'")
The :class:`.TextClause` construct includes methods which can
provide information about the bound parameters as well as the column
values which would be returned from the textual statement, assuming
it's an executable SELECT type of statement. The
:meth:`.TextClause.bindparams` method is used to provide bound
parameter detail, and :meth:`.TextClause.columns` method allows
specification of return columns including names and types::
t = text("SELECT * FROM users WHERE id=:user_id").\
bindparams(user_id=7).\
columns(id=Integer, name=String)
for id, name in connection.execute(t):
print(id, name)
The :func:`.text` construct is used in cases when
a literal string SQL fragment is specified as part of a larger query,
such as for the WHERE clause of a SELECT statement::
s = select([users.c.id, users.c.name]).where(text("id=:user_id"))
result = connection.execute(s, user_id=12)
:func:`.text` is also used for the construction
of a full, standalone statement using plain text.
As such, SQLAlchemy refers
to it as an :class:`.Executable` object, and it supports
the :meth:`Executable.execution_options` method. For example,
a :func:`.text` construct that should be subject to "autocommit"
can be set explicitly so using the
:paramref:`.Connection.execution_options.autocommit` option::
t = text("EXEC my_procedural_thing()").\
execution_options(autocommit=True)
Note that SQLAlchemy's usual "autocommit" behavior applies to
:func:`.text` constructs implicitly - that is, statements which begin
with a phrase such as ``INSERT``, ``UPDATE``, ``DELETE``,
or a variety of other phrases specific to certain backends, will
be eligible for autocommit if no transaction is in progress.
:param text:
the text of the SQL statement to be created. use ``:<param>``
to specify bind parameters; they will be compiled to their
engine-specific format.
:param autocommit: whether or not to set the "autocommit" execution
option for this :class:`.TextClause` object.
:param bind:
an optional connection or engine to be used for this text query.
:param bindparams:
A list of :func:`.bindparam` instances used to
provide information about parameters embedded in the statement.
E.g.::
stmt = text("SELECT * FROM table WHERE id=:id",
bindparams=[bindparam('id', value=5, type_=Integer)])
:param typemap:
A dictionary mapping the names of columns represented in the columns
clause of a ``SELECT`` statement to type objects.
E.g.::
stmt = text("SELECT * FROM table",
typemap={'id': Integer, 'name': String},
)
.. seealso::
:ref:`sqlexpression_text` - in the Core tutorial
:ref:`orm_tutorial_literal_sql` - in the ORM tutorial
)rP N)r� )r� r� r� Zexecution_options)r8 r� rP r� r� r� Zstmtr r r � _create_textH s
zTextClause._create_textc O s� | j �� | _ }xJ|D ]B}y||j }W n$ tk
rL t�d|j ��Y qX |||j< qW xR|�� D ]F\}}y || }W n" tk
r� t�d| ��Y qfX |�|�||< qfW dS )a�
Establish the values and/or types of bound parameters within
this :class:`.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:`.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:`.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:`.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)
)
z?This text() construct doesn't define a bound parameter named %rN)r� r2 r) �KeyErrorr rU �itemsr� )r8 ZbindsZnames_to_valuesZ
new_paramsrP Zexistingr) r& r r r r� � s" A
zTextClause.bindparamszsqlalchemy.sql.selectablec sB � fdd�|D �}dd� � � � D �}|j| || t|�o<| d�S )a� Turn this :class:`.TextClause` object into a :class:`.TextAsFrom`
object that can be embedded into another statement.
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')).alias('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:`.column` elements to the
:meth:`.TextClause.columns` method positionally. These :func:`.column`
elements now become first class elements upon the :attr:`.TextAsFrom.c`
column collection, just like any other selectable.
The column expressions we pass to :meth:`.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:`.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:`.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))
.. versionadded:: 1.1 the :meth:`.TextClause.columns` method now
offers positional column targeting in the result set when
the column expressions are passed purely positionally.
The :meth:`.TextClause.columns` method provides a direct
route to calling :meth:`.FromClause.alias` as well as
:meth:`.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)
.. versionadded:: 0.9.0 :func:`.text` can now be converted into a
fully featured "selectable" construct using the
:meth:`.TextClause.columns` method.
c s. g | ]&}|j � kr&t|j � �|j ��n|�qS r )r) r� r? )r� �col)r� r r �
<listcomp>� s z&TextClause.columns.<locals>.<listcomp>c S s g | ]\}}t ||��qS r )r� )r� r) r r r r r� � s )Z
positional)r� Z
TextAsFromr� )r8 r� �colsr� Zpositional_input_colsZkeyed_input_colsr )r� r r� 1 s _
zTextClause.columnsc C s t jS )N)r r� )r8 r r r r � s zTextClause.typec C s | j �| �S )N)r r� )r8 r r r r6 � s zTextClause.comparatorc C s |t jkrt| �S | S d S )N)r Zin_opr� )r8 rZ r r r r[ � s
zTextClause.self_groupc s$ t � �fdd�| j�� D ��| _d S )Nc 3 s | ]}|j � |f��fV qd S )N)r) )r� �b)rE r r r r� � s z-TextClause._copy_internals.<locals>.<genexpr>)�dictr� rB )r8 rE r r )rE r r rX � s zTextClause._copy_internalsc K s t | j�� �S )N)�listr� rB )r8 rL r r r rY � s zTextClause.get_childrenc C s t |t�o|j| jkS )N)r� r� r� )r8 rV r r r rW � s zTextClause.compare)N)NNNN)N)(rw rv ry rz r{ �rer_ �UNICODEr� r �_execution_optionsr� r r� rg r r� r� Z _hide_fromsr) r� r� r� r� � classmethodr Zdeprecated_paramsr r� r r� r� r� r r6 r[ r rX rY rW r r r r r�
s8
w Yn
r� c @ s6 e Zd ZdZdZejdd� �Zedd� �Z dd� Z
d S )
�Nullz�Represent the NULL keyword in a SQL statement.
:class:`.Null` is accessed as a constant via the
:func:`.null` function.
Znullc C s t jS )N)r r� )r8 r r r r � s z Null.typec C s t � S )z+Return a constant :class:`.Null` construct.)r� )�clsr r r � _instance� s zNull._instancec C s
t |t�S )N)r� r� )r8 rV r r r rW � s z Null.compareN) rw rv ry rz r{ r r� r r� r� rW r r r r r� � s
r� c @ s> e Zd ZdZdZejdd� �Zdd� Ze dd� �Z
d d
� Z d S ) �False_z�Represent the ``false`` keyword, or equivalent, in a SQL statement.
:class:`.False_` is accessed as a constant via the
:func:`.false` function.
Zfalsec C s t jS )N)r r� )r8 r r r r � s z False_.typec C s t � S )N)�True_)r8 r r r rl � s zFalse_._negatec C s t � S )a Return a :class:`.False_` construct.
E.g.::
>>> from sqlalchemy import false
>>> print select([t.c.x]).where(false())
SELECT x FROM t WHERE false
A backend which does not support true/false constants will render as
an expression against 1 or 0::
>>> print select([t.c.x]).where(false())
SELECT x FROM t WHERE 0 = 1
The :func:`.true` and :func:`.false` constants also feature
"short circuit" operation within an :func:`.and_` or :func:`.or_`
conjunction::
>>> print select([t.c.x]).where(or_(t.c.x > 5, true()))
SELECT x FROM t WHERE true
>>> print select([t.c.x]).where(and_(t.c.x > 5, false()))
SELECT x FROM t WHERE false
.. versionchanged:: 0.9 :func:`.true` and :func:`.false` feature
better integrated behavior within conjunctions and on dialects
that don't support true/false constants.
.. seealso::
:func:`.true`
)r� )r� r r r r� � s $zFalse_._instancec C s
t |t�S )N)r� r� )r8 rV r r r rW s zFalse_.compareN) rw rv ry rz r{ r r� r rl r� r� rW r r r r r� � s &r� c @ sJ e Zd ZdZdZejdd� �Zdd� Ze dd� �Z
e d d
� �Z d d � Z d
S )r� z�Represent the ``true`` keyword, or equivalent, in a SQL statement.
:class:`.True_` is accessed as a constant via the
:func:`.true` function.
�truec C s t jS )N)r r� )r8 r r r r s z
True_.typec C s t � S )N)r� )r8 r r r rl s z
True_._negatec C s |d kr| � � S |S d S )N)r� )r� rV r r r �_ifnone s z
True_._ifnonec C s t � S )a Return a constant :class:`.True_` construct.
E.g.::
>>> from sqlalchemy import true
>>> print select([t.c.x]).where(true())
SELECT x FROM t WHERE true
A backend which does not support true/false constants will render as
an expression against 1 or 0::
>>> print select([t.c.x]).where(true())
SELECT x FROM t WHERE 1 = 1
The :func:`.true` and :func:`.false` constants also feature
"short circuit" operation within an :func:`.and_` or :func:`.or_`
conjunction::
>>> print select([t.c.x]).where(or_(t.c.x > 5, true()))
SELECT x FROM t WHERE true
>>> print select([t.c.x]).where(and_(t.c.x > 5, false()))
SELECT x FROM t WHERE false
.. versionchanged:: 0.9 :func:`.true` and :func:`.false` feature
better integrated behavior within conjunctions and on dialects
that don't support true/false constants.
.. seealso::
:func:`.false`
)r� )r� r r r r� $ s $zTrue_._instancec C s
t |t�S )N)r� r� )r8 rV r r r rW J s z
True_.compareN)
rw rv ry rz r{ r r� r rl r� r� r� rW r r r r r� s &r� c @ sr e Zd ZdZdZdd� Zdd� Zdd� Zed d
� �Z d d � Z
e fd
d�Z dd� Z
edd� �Zddd�Zdd� ZdS )�
ClauseListzzDescribe a list of clauses, separated by an operator.
By default, is comma-separated, such as a column listing.
�
clauselistc s� |� dtj�� _|� dd�� _|� dd�� _|� dd�� _|� dt��� jrd� �fdd �|D �� _n�fd
d �|D �� _t� � j�� _
d S ) Nrn r� T�group_contents�
_tuple_valuesF�_literal_as_textc s g | ]}�|�j � jd ��qS ))rZ )r[ rn )r� r, )r8 �text_converterr r r� a s z'ClauseList.__init__.<locals>.<listcomp>c s g | ] }� |��qS r r )r� r, )r� r r r� e s ) r? r Zcomma_oprn r� r� r� �_expression_literal_as_text�clauses�
is_booleanr� )r8 r� rL r )r8 r� r r� W s zClauseList.__init__c C s
t | j�S )N)�iterr� )r8 r r r �__iter__h s zClauseList.__iter__c C s
t | j�S )N)rS r� )r8 r r r �__len__k s zClauseList.__len__c C s t | �S )N)r� )r8 r r r r� n s zClauseList._select_iterablec C s6 | j r"| j�t|�j| jd�� n| j�t|�� d S )N)rZ )r� r� �appendr� r[ rn )r8 r, r r r r� r s zClauseList.appendc s � �fdd�| j D �| _ d S )Nc s g | ]}� |f���qS r r )r� r, )rE r r r r� { s z.ClauseList._copy_internals.<locals>.<listcomp>)r� )r8 rE r r )rE r r rX z s zClauseList._copy_internalsc K s | j S )N)r� )r8 rL r r r rY } s zClauseList.get_childrenc C s t tjdd� | jD �� �S )Nc S s g | ]
}|j �qS r )r| )r� r9 r r r r� � s z,ClauseList._from_objects.<locals>.<listcomp>)r� � itertools�chainr� )r8 r r r r| � s zClauseList._from_objectsNc C s$ | j r t�| j|�r t| �S | S d S )N)r� r � is_precedentrn r� )r8 rZ r r r r[ � s zClauseList.self_groupc K s t |t�s,t| j�dkr,| jd j|f|�S t |t��rt| j�t|j�k�r| j|jk�r| jtjtjfkr�t � }xB| jD ]8}x2t |j��
|�D ] }|j|f|�r�|� |� P q�W q|W t|�t|j�kS x@t dt| j��D ]"}| j| j|j| f|�s�dS q�W dS ndS dS )z�Compare this :class:`.ClauseList` to the given :class:`.ClauseList`,
including a comparison of all the clause items.
r r FTN)
r� r� rS r� rW rn r rf rh �set�
differencer< �range)r8 rV r Z completedr, Z other_clause�ir r r rW � s&
zClauseList.compare)N)rw rv ry rz r{ r� r� r� r r� r� r rX rY r| r[ rW r r r r r� N s
r� c sf e Zd ZdZdZdd� Zedd� �Zedd� �Zed d
� �Z e
d d � �Z d� fdd� Z dd� Z
� ZS )�BooleanClauseListr� Fc O s t d��d S )Nz+BooleanClauseList has a private constructor)�NotImplementedError)r8 �argr r r r r� � s zBooleanClauseList.__init__c s� g }dd� t �|�D �}x<|D ]4}t||�r0q nt||�rH|jtjd�S |�|� q W t|�dkrt|d jtjd�S |s�|r�|d jtjd�S � fdd�|D �}| �| �}||_ d|_
� |_ d|_ t
j|_d|_|S )Nc S s g | ] }t |��qS r )r� )r� r, r r r r� � s z0BooleanClauseList._construct.<locals>.<listcomp>)rZ r r c s g | ]}|j � d ��qS ))rZ )r[ )r� r9 )rn r r r� � s T)r Zcoerce_generator_argr� r[ r r� r� rS r0 r� r� rn r� r r� r r� ) r� rn Z continue_onZskip_onr� r Zconvert_clausesr, r8 r )rn r �
_construct� s,
z BooleanClauseList._constructc G s | j tjttf|�� S )a Produce a conjunction of expressions joined by ``AND``.
E.g.::
from sqlalchemy import and_
stmt = select([users_table]).where(
and_(
users_table.c.name == 'wendy',
users_table.c.enrolled == True
)
)
The :func:`.and_` conjunction is also available using the
Python ``&`` operator (though note that compound expressions
need to be parenthesized in order to function with Python
operator precedence behavior)::
stmt = select([users_table]).where(
(users_table.c.name == 'wendy') &
(users_table.c.enrolled == True)
)
The :func:`.and_` operation is also implicit in some cases;
the :meth:`.Select.where` method for example can be invoked multiple
times against a statement, which will have the effect of each
clause being combined using :func:`.and_`::
stmt = select([users_table]). where(users_table.c.name == 'wendy'). where(users_table.c.enrolled == True)
.. seealso::
:func:`.or_`
)r
r rf r� r� )r� r� r r r rf � s 'zBooleanClauseList.and_c G s | j tjttf|�� S )ad Produce a conjunction of expressions joined by ``OR``.
E.g.::
from sqlalchemy import or_
stmt = select([users_table]).where(
or_(
users_table.c.name == 'wendy',
users_table.c.name == 'jack'
)
)
The :func:`.or_` conjunction is also available using the
Python ``|`` operator (though note that compound expressions
need to be parenthesized in order to function with Python
operator precedence behavior)::
stmt = select([users_table]).where(
(users_table.c.name == 'wendy') |
(users_table.c.name == 'jack')
)
.. seealso::
:func:`.and_`
)r
r rh r� r� )r� r� r r r rh s zBooleanClauseList.or_c C s | fS )Nr )r8 r r r r� ! s z"BooleanClauseList._select_iterableNc s | j s
| S tt| �j|d�S d S )N)rZ )r� r� r r[ )r8 rZ )r/ r r r[ % s z BooleanClauseList.self_groupc C s
t �| �S )N)r� rl )r8 r r r rl + s zBooleanClauseList._negate)N)rw rv ry r{ r� r� r� r
rf rh r r� r[ rl r� r r )r/ r r � s # ) r c s6 e Zd ZdZ� fdd�Zedd� �Zd dd�Z� ZS )
�TuplezRepresent a SQL tuple.c sT dd� |D �}dd� |D �| _ |�d| j r4| j d ntj�| _tt| �j||� dS )a� Return a :class:`.Tuple`.
Main usage is to produce a composite IN construct::
from sqlalchemy import tuple_
tuple_(table.c.col1, table.c.col2).in_(
[(1, 2), (5, 12), (10, 19)]
)
.. versionchanged:: 1.3.6 Added support for SQLite IN tuples.
.. warning::
The composite IN construct is not supported by all backends, and is
currently known to work on PostgreSQL, MySQL, and SQLite.
Unsupported backends will raise a subclass of
:class:`~sqlalchemy.exc.DBAPIError` when such an expression is
invoked.
c S s g | ] }t |��qS r )r )r� r9 r r r r� M s z"Tuple.__init__.<locals>.<listcomp>c S s g | ]
}|j �qS r )r )r� r r r r r� N s r r N)� _type_tupler? r r� r r� r r� )r8 r� r )r/ r r r� 6 s zTuple.__init__c C s | fS )Nr )r8 r r r r� V s zTuple._select_iterableNc s$ t � �fdd�t|| j�D �� �� S )Nc
s$ g | ] \}}t d |� |d�d��qS )NT)r� r� r$ r )r% )r� �oZcompared_to_type)rn r r r r� ] s z%Tuple._bind_param.<locals>.<listcomp>)r �zipr r[ )r8 rn r� r r )rn r r r� Z s zTuple._bind_param)N) rw rv ry rz r� r r� r� r� r r )r/ r r 3 s r c @ s> e Zd ZdZdZd dd�Zefdd�Zdd � Ze d
d � �Z
dS )
�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`
ZcaseNc C s� yt �|�}W n tk
r" Y nX |dk r<dd� |D �}ndd� |D �}|rbt|d �d j}nd}|dkrvd| _n
t|�| _|| _|| _|dk r�t|�| _nd| _dS )a Produce a ``CASE`` expression.
The ``CASE`` construct in SQL is a conditional object that
acts somewhat analogously to an "if/then" construct in other
languages. It returns an instance of :class:`.Case`.
:func:`.case` in its usual form is passed a list of "when"
constructs, that is, a list of conditions and results as tuples::
from sqlalchemy import case
stmt = select([users_table]).\
where(
case(
[
(users_table.c.name == 'wendy', 'W'),
(users_table.c.name == 'jack', 'J')
],
else_='E'
)
)
The above statement will produce SQL resembling::
SELECT id, name FROM user
WHERE CASE
WHEN (name = :name_1) THEN :param_1
WHEN (name = :name_2) THEN :param_2
ELSE :param_3
END
When simple equality expressions of several values against a single
parent column are needed, :func:`.case` also has a "shorthand" format
used via the
:paramref:`.case.value` parameter, which is passed a column
expression to be compared. In this form, the :paramref:`.case.whens`
parameter is passed as a dictionary containing expressions to be
compared against keyed to result expressions. The statement below is
equivalent to the preceding statement::
stmt = select([users_table]).\
where(
case(
{"wendy": "W", "jack": "J"},
value=users_table.c.name,
else_='E'
)
)
The values which are accepted as result values in
:paramref:`.case.whens` as well as with :paramref:`.case.else_` are
coerced from Python literals into :func:`.bindparam` constructs.
SQL expressions, e.g. :class:`.ColumnElement` constructs, are accepted
as well. To coerce a literal string expression into a constant
expression rendered inline, use the :func:`.literal_column` construct,
as in::
from sqlalchemy import case, literal_column
case(
[
(
orderline.c.qty > 100,
literal_column("'greaterthan100'")
),
(
orderline.c.qty > 10,
literal_column("'greaterthan10'")
)
],
else_=literal_column("'lessthan10'")
)
The above will render the given constants without using bound
parameters for the result values (but still for the comparison
values), as in::
CASE
WHEN (orderline.qty > :qty_1) THEN 'greaterthan100'
WHEN (orderline.qty > :qty_2) THEN 'greaterthan10'
ELSE 'lessthan10'
END
:param whens: The criteria to be compared against,
:paramref:`.case.whens` accepts two different forms, based on
whether or not :paramref:`.case.value` is used.
In the first form, it accepts a list of 2-tuples; each 2-tuple
consists of ``(<sql expression>, <value>)``, where the SQL
expression is a boolean expression and "value" is a resulting value,
e.g.::
case([
(users_table.c.name == 'wendy', 'W'),
(users_table.c.name == 'jack', 'J')
])
In the second form, it accepts a Python dictionary of comparison
values mapped to a resulting value; this form requires
:paramref:`.case.value` to be present, and values will be compared
using the ``==`` operator, e.g.::
case(
{"wendy": "W", "jack": "J"},
value=users_table.c.name
)
:param value: An optional SQL expression which will be used as a
fixed "comparison point" for candidate values within a dictionary
passed to :paramref:`.case.whens`.
:param else\_: An optional SQL expression which will be the evaluated
result of the ``CASE`` construct if all expressions within
:paramref:`.case.whens` evaluate to false. When omitted, most
databases will produce a result of NULL if none of the "when"
expressions evaluate to true.
Nc S s$ g | ] \}}t |��� t |�f�qS r )r r[ )r� r9 �rr r r r� s z!Case.__init__.<locals>.<listcomp>c S s$ g | ] \}}t |��� t|�f�qS r )� _no_literalsr[ r )r� r9 r r r r r� s ���) r Zdictlike_iteritemsrq r� r r& r �whens�else_)r8 r r& r Zwhenlistr r r r r� � s( y
z
Case.__init__c sP | j d k r� | j f��| _ � �fdd�| jD �| _| jd k rL� | jf��| _d S )Nc s( g | ] \}}� |f��� |f��f�qS r r )r� �x�y)rE r r r r� $ s z(Case._copy_internals.<locals>.<listcomp>)r& r r )r8 rE r r )rE r r rX ! s
zCase._copy_internalsc k sH | j d k r| j V x | jD ]\}}|V |V qW | jd k rD| jV d S )N)r& r r )r8 rL r r r r r rY ( s
zCase.get_childrenc C s t tjdd� | �� D �� �S )Nc S s g | ]
}|j �qS r )r| )r� r r r r r� 4 s z&Case._from_objects.<locals>.<listcomp>)r� r r rY )r8 r r r r| 1 s zCase._from_objects)NN) rw rv ry rz r{ r� r rX rY r r| r r r r r j s
r c C s t | |dd�S )a3 Produce a :class:`.ColumnClause` object that has the
:paramref:`.column.is_literal` flag set to True.
:func:`.literal_column` is similar to :func:`.column`, except that
it is more often used as a "standalone" column expression that renders
exactly as stated; while :func:`.column` stores a string name that
will be assumed to be part of a table and may be quoted as such,
:func:`.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 NullType.
.. seealso::
:func:`.column`
:func:`.text`
:ref:`sqlexpression_literal_column`
T)r �
is_literal)r� )r� r r r r �literal_column8 s r c @ s< e Zd ZdZdZdd� Zefdd�Zdd� Ze d d
� �Z
d S ) r� a` 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:`coretutorial_casts`
:func:`.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� c C s, t �|�| _t|| jd�| _t| j�| _dS )a Produce a ``CAST`` expression.
:func:`.cast` returns an instance of :class:`.Cast`.
E.g.::
from sqlalchemy import cast, Numeric
stmt = select([
cast(product_table.c.unit_price, Numeric(10, 4))
])
The above statement will produce SQL resembling::
SELECT CAST(unit_price AS NUMERIC(10, 4)) FROM product
The :func:`.cast` function performs two distinct functions when
used. The first is that it renders the ``CAST`` expression within
the resulting SQL string. The second is that it associates the given
type (e.g. :class:`.TypeEngine` class or instance) with the column
expression on the Python side, which means the expression will take
on the expression operator behavior associated with that type,
as well as the bound-value handling and result-row-handling behavior
of the type.
.. versionchanged:: 0.9.0 :func:`.cast` now applies the given type
to the expression such that it takes effect on the bound-value,
e.g. the Python-to-database direction, in addition to the
result handling, e.g. database-to-Python, direction.
An alternative to :func:`.cast` is the :func:`.type_coerce` function.
This function performs the second task of associating an expression
with a specific type, but does not render the ``CAST`` expression
in SQL.
:param expression: A SQL expression, such as a :class:`.ColumnElement`
expression or a Python string which will be coerced into a bound
literal value.
:param type\_: A :class:`.TypeEngine` class or instance indicating
the type to which the ``CAST`` should apply.
.. seealso::
:ref:`coretutorial_casts`
: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 N)r � to_instancer r r, r� r� )r8 r r r r r r� u s 5 z
Cast.__init__c K s$ || j f|�| _ || jf|�| _d S )N)r, r� )r8 rE r r r r rX � s zCast._copy_internalsc K s | j | jfS )N)r, r� )r8 rL r r r rY � s zCast.get_childrenc C s | j jS )N)r, r| )r8 r r r r| � s zCast._from_objectsN) rw rv ry rz r{ r� r rX rY r r| r r r r r� Y s 9 r� c @ sJ e Zd ZdZdZdd� Zefdd�Zdd� Ze d d
� �Z
e j d d � �Z
d
S )�
TypeCoercea� Represent a Python-side type-coercion wrapper.
:class:`.TypeCoerce` supplies the :func:`.expression.type_coerce`
function; see that function for usage details.
.. versionchanged:: 1.1 The :func:`.type_coerce` function now produces
a persistent :class:`.TypeCoerce` wrapper object rather than
translating the given object in place.
.. seealso::
:func:`.expression.type_coerce`
:func:`.cast`
Z type_coercec C s t �|�| _t|| jd�| _dS )aL Associate a SQL expression with a particular type, without rendering
``CAST``.
E.g.::
from sqlalchemy import type_coerce
stmt = select([
type_coerce(log_table.date_string, StringDateTime())
])
The above construct will produce a :class:`.TypeCoerce` object, which
renders SQL that labels the expression, but otherwise does not
modify its value on the SQL side::
SELECT date_string AS anon_1 FROM log
When result rows are fetched, the ``StringDateTime`` type
will be applied to result rows on behalf of the ``date_string`` column.
The rationale for the "anon_1" label is so that the type-coerced
column remains separate in the list of result columns vs. other
type-coerced or direct values of the target column. In order to
provide a named label for the expression, use
:meth:`.ColumnElement.label`::
stmt = select([
type_coerce(
log_table.date_string, StringDateTime()).label('date')
])
A type that features bound-value handling will also have that behavior
take effect when literal values or :func:`.bindparam` constructs are
passed to :func:`.type_coerce` as targets.
For example, if a type implements the
:meth:`.TypeEngine.bind_expression`
method or :meth:`.TypeEngine.bind_processor` method or equivalent,
these functions will take effect at statement compilation/execution
time when a literal value is passed, as in::
# bound-value handling of MyStringType will be applied to the
# literal value "some string"
stmt = select([type_coerce("some string", MyStringType)])
:func:`.type_coerce` is similar to the :func:`.cast` function,
except that it does not render the ``CAST`` expression in the resulting
statement.
:param expression: A SQL expression, such as a :class:`.ColumnElement`
expression or a Python string which will be coerced into a bound
literal value.
:param type\_: A :class:`.TypeEngine` class or instance indicating
the type to which the expression is coerced.
.. seealso::
:ref:`coretutorial_casts`
:func:`.cast`
)r N)r r r r r, )r8 r r r r r r� � s ? zTypeCoerce.__init__c K s" || j f|�| _ | j�dd � d S )N�typed_expression)r, r1 r? )r8 rE r r r r rX
s zTypeCoerce._copy_internalsc K s | j fS )N)r, )r8 rL r r r rY
s zTypeCoerce.get_childrenc C s | j jS )N)r, r| )r8 r r r r|
s zTypeCoerce._from_objectsc C s, t | jt�r"| j�� }| j|_|S | jS d S )N)r� r, r% r r )r8 Zbpr r r r
s
zTypeCoerce.typed_expressionN)rw rv ry rz r{ r� r rX rY r r| r r� r r r r r r � s B r c @ s< e Zd ZdZdZdd� Zefdd�Zdd� Ze d d
� �Z
d S ) �Extractz=Represent a SQL EXTRACT clause, ``extract(field FROM expr)``.�extractc K s t j| _|| _t|d�| _dS )z�Return a :class:`.Extract` construct.
This is typically available as :func:`.extract`
as well as ``func.extract`` from the
:data:`.func` namespace.
N)r Z INTEGERTYPEr �fieldr r! )r8 r r! rL r r r r� *
s zExtract.__init__c K s || j f|�| _ d S )N)r! )r8 rE r r r r rX 6
s zExtract._copy_internalsc K s | j fS )N)r! )r8 rL r r r rY 9
s zExtract.get_childrenc C s | j jS )N)r! r| )r8 r r r r| <
s zExtract._from_objectsN) rw rv ry rz r{ r� r rX rY r r| r r r r r %
s r c @ s4 e Zd ZdZdZdd� Zefdd�Zedd� �Z d S )
�_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_referencec C s
|| _ d S )N)r )r8 r r r r r� P
s z_label_reference.__init__c K s || j f|�| _ d S )N)r )r8 rE r r r r rX S
s z _label_reference._copy_internalsc C s dS )Nr r )r8 r r r r| V
s z _label_reference._from_objectsN)
rw rv ry rz r{ r� r rX r r| r r r r r A
s
r c @ s& e Zd ZdZdd� Zejdd� �ZdS )�_textual_label_referenceZtextual_label_referencec C s
|| _ d S )N)r )r8 r r r r r� ^
s z!_textual_label_reference.__init__c C s t �| j�S )N)r� r� r )r8 r r r � _text_clausea
s z%_textual_label_reference._text_clauseN)rw rv ry r{ r� r r� r! r r r r r [
s r c @ s� e Zd ZdZdZd dd�Zedd� �Zed d
� �Zed d � �Z ed
d� �Z
edd� �Z e dd� �Z
e dd� �Zefdd�Zdd� Zdd� Zdd � Zd d d �ZdS )!rp 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:`.nullsfirst` and :func:`.nullslast`.
ZunaryNFc C s> || _ || _|j| j p| jd�| _t�|�| _|| _|| _d S )N)rZ ) rn �modifierr[ r r r r ro �wraps_column_expression)r8 r rn r" r ro r# r r r r� v
s zUnaryExpression.__init__c C s t t|�tjdd�S )aZ Produce the ``NULLS FIRST`` modifier for an ``ORDER BY`` expression.
:func:`.nullsfirst` is intended to modify the expression produced
by :func:`.asc` or :func:`.desc`, and indicates how NULL values
should be handled when they are encountered during ordering::
from sqlalchemy import desc, nullsfirst
stmt = select([users_table]). order_by(nullsfirst(desc(users_table.c.name)))
The SQL expression from the above would resemble::
SELECT id, name FROM user ORDER BY name DESC NULLS FIRST
Like :func:`.asc` and :func:`.desc`, :func:`.nullsfirst` is typically
invoked from the column expression itself using
:meth:`.ColumnElement.nullsfirst`, rather than as its standalone
function version, as in::
stmt = (select([users_table]).
order_by(users_table.c.name.desc().nullsfirst())
)
.. seealso::
:func:`.asc`
:func:`.desc`
:func:`.nullslast`
:meth:`.Select.order_by`
F)r" r# )rp �_literal_as_label_referencer Z
nullsfirst_op)r� �columnr r r �_create_nullsfirst�
s &z"UnaryExpression._create_nullsfirstc C s t t|�tjdd�S )a? Produce the ``NULLS LAST`` modifier for an ``ORDER BY`` expression.
:func:`.nullslast` is intended to modify the expression produced
by :func:`.asc` or :func:`.desc`, and indicates how NULL values
should be handled when they are encountered during ordering::
from sqlalchemy import desc, nullslast
stmt = select([users_table]). order_by(nullslast(desc(users_table.c.name)))
The SQL expression from the above would resemble::
SELECT id, name FROM user ORDER BY name DESC NULLS LAST
Like :func:`.asc` and :func:`.desc`, :func:`.nullslast` is typically
invoked from the column expression itself using
:meth:`.ColumnElement.nullslast`, rather than as its standalone
function version, as in::
stmt = select([users_table]). order_by(users_table.c.name.desc().nullslast())
.. seealso::
:func:`.asc`
:func:`.desc`
:func:`.nullsfirst`
:meth:`.Select.order_by`
F)r" r# )rp r$ r Z nullslast_op)r� r% r r r �_create_nullslast�
s %z!UnaryExpression._create_nullslastc C s t t|�tjdd�S )a( Produce a descending ``ORDER BY`` clause element.
e.g.::
from sqlalchemy import desc
stmt = select([users_table]).order_by(desc(users_table.c.name))
will produce SQL as::
SELECT id, name FROM user ORDER BY name DESC
The :func:`.desc` function is a standalone version of the
:meth:`.ColumnElement.desc` method available on all SQL expressions,
e.g.::
stmt = select([users_table]).order_by(users_table.c.name.desc())
:param column: A :class:`.ColumnElement` (e.g. scalar SQL expression)
with which to apply the :func:`.desc` operation.
.. seealso::
:func:`.asc`
:func:`.nullsfirst`
:func:`.nullslast`
:meth:`.Select.order_by`
F)r" r# )rp r$ r �desc_op)r� r% r r r � _create_desc�
s #z UnaryExpression._create_descc C s t t|�tjdd�S )a! Produce an ascending ``ORDER BY`` clause element.
e.g.::
from sqlalchemy import asc
stmt = select([users_table]).order_by(asc(users_table.c.name))
will produce SQL as::
SELECT id, name FROM user ORDER BY name ASC
The :func:`.asc` function is a standalone version of the
:meth:`.ColumnElement.asc` method available on all SQL expressions,
e.g.::
stmt = select([users_table]).order_by(users_table.c.name.asc())
:param column: A :class:`.ColumnElement` (e.g. scalar SQL expression)
with which to apply the :func:`.asc` operation.
.. seealso::
:func:`.desc`
:func:`.nullsfirst`
:func:`.nullslast`
:meth:`.Select.order_by`
F)r" r# )rp r$ r �asc_op)r� r% r r r � _create_asc s "zUnaryExpression._create_ascc C s t |�}t|tj|jdd�S )as Produce an column-expression-level unary ``DISTINCT`` clause.
This applies the ``DISTINCT`` keyword to an individual column
expression, and is typically contained within an aggregate function,
as in::
from sqlalchemy import distinct, func
stmt = select([func.count(distinct(users_table.c.name))])
The above would produce an expression resembling::
SELECT COUNT(DISTINCT name) FROM user
The :func:`.distinct` function is also available as a column-level
method, e.g. :meth:`.ColumnElement.distinct`, as in::
stmt = select([func.count(users_table.c.name.distinct())])
The :func:`.distinct` operator is different from the
:meth:`.Select.distinct` method of :class:`.Select`,
which produces a ``SELECT`` statement
with ``DISTINCT`` applied to the result set as a whole,
e.g. a ``SELECT DISTINCT`` expression. See that method for further
information.
.. seealso::
:meth:`.ColumnElement.distinct`
:meth:`.Select.distinct`
:data:`.func`
F)rn r r# )r rp r Z distinct_opr )r� r! r r r �_create_distinct0 s $z UnaryExpression._create_distinctc C s" | j tjtjfkr| jjS d S d S )N)r" r r( r* r r~ )r8 r r r r~ \ s z'UnaryExpression._order_by_label_elementc C s | j jS )N)r r| )r8 r r r r| c s z UnaryExpression._from_objectsc K s || j f|�| _ d S )N)r )r8 rE r r r r rX g s z UnaryExpression._copy_internalsc K s | j fS )N)r )r8 rL r r r rY j s z UnaryExpression.get_childrenc K s4 t |t�o2| j|jko2| j|jko2| jj|jf|�S )zXCompare this :class:`UnaryExpression` against the given
:class:`.ClauseElement`.)r� rp rn r" r rW )r8 rV r r r r rW m s
zUnaryExpression.comparec C sj | j d k r*t| j| j | j| j| j| jd�S | jjtj jkr\t| j
t j d�t j tj | jd d�S t
�| �S d S )N)rn ro r" r r# )rZ )rn r r# ro )ro rp r rn r" r r# r� r r� r[ r r+ r. rl )r8 r r r rl x s
zUnaryExpression._negatec C s$ | j r t�| j |�r t| �S | S d S )N)rn r r r� )r8 rZ r r r r[ � s zUnaryExpression.self_group)NNNNF)N)rw rv ry rz r{ r� r� r& r' r) r+ r, r r~ r| r rX rY rW rl r[ r r r r rp f
s&
, + ) ( , rp c @ s8 e Zd ZdZedd� �Zedd� �Zdd� Zdd � Zd
S ) �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.
c C s< t |�}|jr t|d�r |�� }|�� }t|tjtj dd�S )a� Produce an ANY expression.
This may apply to an array type for some dialects (e.g. postgresql),
or to a subquery for others (e.g. mysql). e.g.::
# postgresql '5 = ANY (somearray)'
expr = 5 == any_(mytable.c.somearray)
# mysql '5 = ANY (SELECT value FROM table)'
expr = 5 == any_(select([table.c.value]))
.. versionadded:: 1.1
.. seealso::
:func:`.expression.all_`
� as_scalarF)rn r r# )
r r} rk r. r[ r- r r� r r� )r� r! r r r � _create_any� s z CollectionAggregate._create_anyc C s< t |�}|jr t|d�r |�� }|�� }t|tjtj dd�S )a� Produce an ALL expression.
This may apply to an array type for some dialects (e.g. postgresql),
or to a subquery for others (e.g. mysql). e.g.::
# postgresql '5 = ALL (somearray)'
expr = 5 == all_(mytable.c.somearray)
# mysql '5 = ALL (SELECT value FROM table)'
expr = 5 == all_(select([table.c.value]))
.. versionadded:: 1.1
.. seealso::
:func:`.expression.any_`
r. F)rn r r# )
r r} rk r. r[ r- r r� r r� )r� r! r r r � _create_all� s z CollectionAggregate._create_allc O s6 t �|�st�d��d|d< | jjt �|�f|�|�S )Nz2Only comparison operators may be used with ANY/ALLT�reverse)r �
is_comparisonr rU r6 r� Zmirror)r8 r� rV rL r r r r� � s
zCollectionAggregate.operatec K s t �|�rt�t�d��d S )Nz2Only comparison operators may be used with ANY/ALL)r r2 �AssertionErrorr rU )r8 r� rV rL r r r r� � s z#CollectionAggregate.reverse_operateN) rw rv ry rz r� r/ r0 r� r� r r r r r- � s
! #r- c @ s& e Zd Zdd� Zddd�Zdd� ZdS ) r� c C s2 || _ tj| _|| _|| _d | _d| _|j| _d S )NT) r r r� r rn ro r" r# r� )r8 r rn ro r r r r� � s zAsBoolean.__init__Nc C s | S )Nr )r8 rZ r r r r[ � s zAsBoolean.self_groupc C s0 t | jttf�r| j�� S t| j| j| j�S d S )N)r� r r� r� rl r� ro rn )r8 r r r rl � s
zAsBoolean._negate)N)rw rv ry r� r[ rl r r r r r� � s
r� c s| e Zd ZdZdZdZddd�Zdd� ZeZe d d
� �Z
e d d � �Z e fd
d�Z
dd� Zdd� Zddd�Z� fdd�Z� ZS )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::
>>> from sqlalchemy.sql import column
>>> column('a') + column('b')
<sqlalchemy.sql.expression.BinaryExpression object at 0x101029dd0>
>>> print column('a') + column('b')
a + b
ZbinaryTNc C sz t |tj�rt�|�}||f| _|j|d�| _|j|d�| _|| _ t
� |�| _ || _
t�|�| _|d krpi | _n|| _d S )N)rZ )r� r � string_typesr Z custom_op�_origr[ �left�rightrn r r r ro r� r� � modifiers)r8 r6 r7 rn r ro r8 r r r r� s
zBinaryExpression.__init__c C s> | j t jt jfkr2| � t| jd �t| jd ��S td��d S )Nr r z+Boolean value of this clause is not defined)rn �eq�ner� r5 rq )r8 r r r rr 0 s zBinaryExpression.__bool__c C s t �| j�S )N)r r2 rn )r8 r r r r2 8 s z BinaryExpression.is_comparisonc C s | j j| jj S )N)r6 r| r7 )r8 r r r r| < s z BinaryExpression._from_objectsc K s$ || j f|�| _ || jf|�| _d S )N)r6 r7 )r8 rE r r r r rX @ s z BinaryExpression._copy_internalsc K s | j | jfS )N)r6 r7 )r8 rL r r r rY D s z BinaryExpression.get_childrenc K sj t |t�oh| j|jkoh| jj|jf|�r:| jj|jf|�pht�| j�oh| jj|jf|�oh| jj|jf|�S )z[Compare this :class:`BinaryExpression` against the
given :class:`BinaryExpression`.)r� r rn r6 rW r7 r Zis_commutative)r8 rV r r r r rW G s
zBinaryExpression.comparec C s t �| j|�rt| �S | S d S )N)r r rn r� )r8 rZ r r r r[ Y s zBinaryExpression.self_groupc s< | j d k r*t| j| j| j | j| j| jd�S tt| ��� S d S )N)ro r r8 ) ro r r6 r7 rn r r8 r� rl )r8 )r/ r r rl _ s
zBinaryExpression._negate)NNN)N)rw rv ry rz r{ r� r� rr r� r r2 r| r rX rY rW r[ rl r� r r )r/ r r s
r c @ s& e Zd ZdZdZdd� Zddd�ZdS ) �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.
�slicec C s || _ || _|| _tj| _d S )N)�start�stop�stepr r� r )r8 r= r> r? r r r r� w s zSlice.__init__Nc C s |t jkst�| S )N)rn �getitemr3 )r8 rZ r r r r[ } s zSlice.self_group)N)rw rv ry rz r{ r� r[ r r r r r; m s r; c @ s e Zd ZdZdS )�IndexExpressionzKRepresent the class of expressions that are like an "index" operation.
N)rw rv ry rz r r r r rA � s rA c @ s� e Zd ZdZdZdd� Zd dd�Zejdd � �Z e
d
d � �Z e
d d
� �Z e
fdd�Zdd� Ze
dd� �Zdd� Zdd� Zdd� Zdd� ZdS ) r� z/Represent a grouping within a column expressionZgroupingc C s || _ t|dtj�| _d S )Nr )r r� r r� r )r8 r r r r r� � s zGrouping.__init__Nc C s | S )Nr )r8 rZ r r r r[ � s zGrouping.self_groupc C s | j jS )N)r r� )r8 r r r r� � s z Grouping._is_implicitly_booleanc C s | j S )N)r� )r8 r r r r� � s zGrouping._key_labelc C s t | jdd �p| jS )Nr� )r� r r� )r8 r r r r� � s zGrouping._labelc K s || j f|�| _ d S )N)r )r8 rE r r r r rX � s zGrouping._copy_internalsc K s | j fS )N)r )r8 rL r r r rY � s zGrouping.get_childrenc C s | j jS )N)r r| )r8 r r r r| � s zGrouping._from_objectsc C s t | j|�S )N)r� r )r8 �attrr r r r� � s zGrouping.__getattr__c C s | j | jd�S )N)r r )r r )r8 r r r rA � s zGrouping.__getstate__c C s |d | _ |d | _d S )Nr r )r r )r8 �stater r r � __setstate__� s
zGrouping.__setstate__c K s t |t�o| j�|j�S )N)r� r� r rW )r8 rV r r r r rW � s zGrouping.compare)N)rw rv ry rz r{ r� r[ r r� r� r r� r� r rX rY r| r� rA rD rW r r r r r� � s
r� �RANGE_UNBOUNDED�
RANGE_CURRENTc @ sx e Zd ZdZdZdZdZdZddd�Zdd� Z e
e � dd �d
d � ��Z
e jd d
� �Zdd� Zefdd�Ze
dd� �ZdS )�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. It's supported only by certain database
backends.
�overNc C s� || _ |dk r$tt�|�dti�| _|dk rBtt�|�dti�| _|rj| �|�| _|rbt �
d��q�d| _ n$|r�| �|�| _ d| _n d | _ | _dS )aA Produce an :class:`.Over` object against a function.
Used against aggregate or so-called "window" functions,
for database backends that support window functions.
:func:`~.expression.over` is usually called using
the :meth:`.FunctionElement.over` method, e.g.::
func.row_number().over(order_by=mytable.c.some_column)
Would produce::
ROW_NUMBER() OVER(ORDER BY some_column)
Ranges are also possible using the :paramref:`.expression.over.range_`
and :paramref:`.expression.over.rows` parameters. These
mutually-exclusive parameters each accept a 2-tuple, which contains
a combination of integers and None::
func.row_number().over(
order_by=my_table.c.some_column, range_=(None, 0))
The above would produce::
ROW_NUMBER() OVER(ORDER BY some_column
RANGE BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW)
A value of None indicates "unbounded", a
value of zero indicates "current row", and negative / positive
integers indicate "preceding" and "following":
* RANGE BETWEEN 5 PRECEDING AND 10 FOLLOWING::
func.row_number().over(order_by='x', range_=(-5, 10))
* ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW::
func.row_number().over(order_by='x', rows=(None, 0))
* RANGE BETWEEN 2 PRECEDING AND UNBOUNDED FOLLOWING::
func.row_number().over(order_by='x', range_=(-2, None))
* RANGE BETWEEN 1 FOLLOWING AND 3 FOLLOWING::
func.row_number().over(order_by='x', range_=(1, 3))
.. versionadded:: 1.1 support for RANGE / ROWS within a window
:param element: a :class:`.FunctionElement`, :class:`.WithinGroup`,
or other compatible construct.
:param partition_by: a column element or string, or a list
of such, that will be used as the PARTITION BY clause
of the OVER construct.
:param order_by: a column element or string, or a list
of such, that will be used as the ORDER BY clause
of the OVER construct.
:param range\_: optional range clause for the window. This is a
tuple value which can contain integer values or None, and will
render a RANGE BETWEEN PRECEDING / FOLLOWING clause
.. versionadded:: 1.1
:param rows: optional rows clause for the window. This is a tuple
value which can contain integer values or None, and will render
a ROWS BETWEEN PRECEDING / FOLLOWING clause.
.. versionadded:: 1.1
This function is also available from the :data:`~.expression.func`
construct itself via the :meth:`.FunctionElement.over` method.
.. seealso::
:data:`.expression.func`
:func:`.expression.within_group`
Nr� z*'range_' and 'rows' are mutually exclusive) r r� r �to_listr$ �order_by� partition_by�_interpret_range�range_r rU �rows)r8 r rK rJ rM rN r r r r� � s& S
z
Over.__init__c C s� t |t�rt|�dkr t�d��|d d kr2t}n<yt|d �}W n tk
r` t�d��Y nX |dkrnt}|d d kr�t}n<yt|d �}W n tk
r� t�d��Y nX |dkr�t}||fS )Nr z 2-tuple expected for range/rowsr z(Integer or None expected for range valuer ) r� �tuplerS r rU rE �int�
ValueErrorrF )r8 rM �lower�upperr r r rL @
s*
zOver._interpret_rangez1.1z�the :attr:`.Over.func` member of the :class:`.Over` class is deprecated and will be removed in a future release. Please refer to the :attr:`.Over.element` attribute.c C s | j S )zIthe element referred to by this :class:`.Over`
clause.
)r )r8 r r r �func`
s
z Over.funcc C s | j jS )N)r r )r8 r r r r o
s z Over.typec K s dd� | j | j| jfD �S )Nc S s g | ]}|d k r|�qS )Nr )r� r9 r r r r� u
s z%Over.get_children.<locals>.<listcomp>)r rK rJ )r8 rL r r r rY s
s zOver.get_childrenc K sH || j f|�| _ | jd k r*|| jf|�| _| jd k rD|| jf|�| _d S )N)r rK rJ )r8 rE r r r r rX z
s
zOver._copy_internalsc C s$ t tjdd� | j| j| jfD �� �S )Nc S s g | ]}|d k r|j �qS )N)r| )r� r9 r r r r� �
s z&Over._from_objects.<locals>.<listcomp>)r� r r r rK rJ )r8 r r r r| �
s zOver._from_objects)NNNN)rw rv ry rz r{ rJ rK r r� rL r r r� rT r� r rY r rX r| r r r r rG � s
l rG c @ sX e Zd ZdZdZdZdd� Zddd�Zej dd � �Z
d
d � Z e fd d
�Z
edd� �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 withingroupNc G s( || _ |dk r$tt�|�dti�| _dS )a� Produce a :class:`.WithinGroup` object against a function.
Used against so-called "ordered set aggregate" and "hypothetical
set aggregate" functions, including :class:`.percentile_cont`,
:class:`.rank`, :class:`.dense_rank`, etc.
:func:`~.expression.within_group` is usually called using
the :meth:`.FunctionElement.within_group` method, e.g.::
from sqlalchemy import within_group
stmt = select([
department.c.id,
func.percentile_cont(0.5).within_group(
department.c.salary.desc()
)
])
The above statement would produce SQL similar to
``SELECT department.id, percentile_cont(0.5)
WITHIN GROUP (ORDER BY department.salary DESC)``.
:param element: a :class:`.FunctionElement` construct, typically
generated by :data:`~.expression.func`.
:param \*order_by: one or more column elements that will be used
as the ORDER BY clause of the WITHIN GROUP construct.
.. versionadded:: 1.1
.. seealso::
:data:`.expression.func`
:func:`.expression.over`
Nr� )r r� r rI r$ rJ )r8 r rJ r r r r� �
s
$
zWithinGroup.__init__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`.
)rK rJ rM rN )rG )r8 rK rJ rM rN r r r rH �
s zWithinGroup.overc C s$ | j �| �}|d k r|S | j jS d S )N)r Zwithin_group_typer )r8 Zwgtr r r r �
s zWithinGroup.typec K s dd� | j | jfD �S )Nc S s g | ]}|d k r|�qS )Nr )r� r9 r r r r� �
s z,WithinGroup.get_children.<locals>.<listcomp>)r rJ )r8 rL r r r rY �
s zWithinGroup.get_childrenc K s. || j f|�| _ | jd k r*|| jf|�| _d S )N)r rJ )r8 rE r r r r rX �
s
zWithinGroup._copy_internalsc C s t tjdd� | j| jfD �� �S )Nc S s g | ]}|d k r|j �qS )N)r| )r� r9 r r r r� �
s z-WithinGroup._from_objects.<locals>.<listcomp>)r� r r r rJ )r8 r r r r| �
s zWithinGroup._from_objects)NNNN)rw rv ry rz r{ rJ r� rH r r� r rY r rX r r| r r r r rU �
s +
rU c @ sj e Zd ZdZdZdZdd� Zdd� Zddd �Zdd
d �Z e
j d d
� �Z dd� Z
efdd�Zedd� �ZdS )�FunctionFiltera� 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)
.. versionadded:: 1.0.0
.. seealso::
:meth:`.FunctionElement.filter`
Z
funcfilterNc G s || _ | j|� dS )a� Produce a :class:`.FunctionFilter` object against a function.
Used against aggregate and window functions,
for database backends that support the "FILTER" clause.
E.g.::
from sqlalchemy import funcfilter
funcfilter(func.count(1), MyClass.name == 'some name')
Would produce "COUNT(1) FILTER (WHERE myclass.name = 'some name')".
This function is also available from the :data:`~.expression.func`
construct itself via the :meth:`.FunctionElement.filter` method.
.. versionadded:: 1.0.0
.. seealso::
:meth:`.FunctionElement.filter`
N)rT �filter)r8 rT � criterionr r r r� s zFunctionFilter.__init__c G s< x6t |�D ]*}t|�}| jdk r.| j|@ | _q
|| _q
W | 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� rX )r8 rX r r r rW . s
zFunctionFilter.filterc 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.
)rK rJ rM rN )rG )r8 rK rJ rM rN r r r rH D s zFunctionFilter.overc C s t �t j|�rt| �S | S d S )N)r r Z filter_opr� )r8 rZ r r r r[ ^ s zFunctionFilter.self_groupc C s | j jS )N)rT r )r8 r r r r d s zFunctionFilter.typec K s dd� | j | jfD �S )Nc S s g | ]}|d k r|�qS )Nr )r� r9 r r r r� i s z/FunctionFilter.get_children.<locals>.<listcomp>)rT rX )r8 rL r r r rY h s zFunctionFilter.get_childrenc K s. || j f|�| _ | jd k r*|| jf|�| _d S )N)rT rX )r8 rE r r r r rX k s
z FunctionFilter._copy_internalsc C s t tjdd� | j| jfD �� �S )Nc S s g | ]}|d k r|j �qS )N)r| )r� r9 r r r r� u s z0FunctionFilter._from_objects.<locals>.<listcomp>)r� r r rT rX )r8 r r r r| p s z FunctionFilter._from_objects)NNNN)N)rw rv ry rz r{ rX r� rW rH r[ r r� r rY r rX r r| r r r r rV �
s
rV c @ s� e Zd ZdZdZd%dd�Zdd� Zejdd � �Z ejd
d � �Z
e d d
� �Z ejdd� �Z
ejdd� �Zd&dd�Zdd� Zdd� Ze dd� �Ze dd� �Zd d � Zed fd d �Ze d!d"� �Zd'd#d$�ZdS )(r� z�Represents a column label (AS).
Represent a label, as typically applied to any column-level
element using the ``AS`` sql keyword.
r� Nc C s� t |t�r|j| _xt |t�r&|j}qW |r<|| _| j| _n tdt| �t|dd�f �| _| j | _ | _| _
|| _ || _ |g| _
dS )a� Return a :class:`Label` object for the
given :class:`.ColumnElement`.
A label changes the name of an element in the columns clause of a
``SELECT`` statement, typically via the ``AS`` SQL keyword.
This functionality is more conveniently available via the
:meth:`.ColumnElement.label` method on :class:`.ColumnElement`.
:param name: label name
:param obj: a :class:`.ColumnElement`.
z
%%(%d %s)sr� r� N)r� r� r� r� r r� r� rx r� r) r� �_element�_typer� )r8 r� r r r r r r� � s
zLabel.__init__c C s | j | j| j| jffS )N)r/ r� rY rZ )r8 r r r �
__reduce__� s zLabel.__reduce__c C s | j jS )N)r r� )r8 r r r r� � s z Label._is_implicitly_booleanc C s | j jS )N)r r� )r8 r r r r� � s zLabel._allow_label_resolvec C s | S )Nr )r8 r r r r~ � s z Label._order_by_label_elementc C s t �| jpt| jdd ��S )Nr )r r rZ r� rY )r8 r r r r � s z
Label.typec C s | j jtjd�S )N)rZ )rY r[ r Zas_)r8 r r r r � s z
Label.elementc C s | j | jj|d�S )N)rZ )�_apply_to_innerrY r[ )r8 rZ r r r r[ � s zLabel.self_groupc C s | � | jj�S )N)r\ rY rl )r8 r r r rl � s z
Label._negatec O s. |||�}|| j k r&t| j|| jd�S | S d S )N)r )rY r� r� rZ )r8 �fnr r Z sub_elementr r r r\ � s
zLabel._apply_to_innerc C s | j jS )N)r r� )r8 r r r r� � s zLabel.primary_keyc C s | j jS )N)r r� )r8 r r r r� � s zLabel.foreign_keysc K s | j fS )N)r )r8 rL r r r rY � s zLabel.get_childrenFc K sn || j f|�| _ | j�dd � | j�dd � |rjtdt| �t| jdd�f � | _| _| j | _ | _
| _ d S )Nr r� z
%%(%d %s)sr� r� ) rY r1 r? r� rx r� r r� r� r) r� r� )r8 rE Zanonymize_labelsr r r r rX � s "zLabel._copy_internalsc C s | j jS )N)r r| )r8 r r r r| � s zLabel._from_objectsc K s> | j j||r|n| jdd�}|j�| � | jd k r:| j|_|S )NT)r� �disallow_is_literal)r r� r� r� r� rZ r )r8 r� r� r �er r r r� � s
zLabel._make_proxy)N)N)N)rw rv ry rz r{ r� r[ r r� r� r� r r~ r r r[ rl r\ r� r� rY r rX r| r� r r r r r� } s$
#
r� c @ s� e Zd ZdZdZd Z Z ZZdZ e
� � Z d dd�Z
dd� Zd d
� Zd d � Zeee�Ze d
d� �Ze
jdd� �Ze dd� �Ze dd� �Ze dd� �Zdd� Zd dd�Zd d d �ZdS )!r� a� Represents a column expression from any textual string.
The :class:`.ColumnClause`, a lightweight analogue to the
:class:`.Column` class, is typically invoked using the
:func:`.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:`.Column` object. While the :class:`.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:`.Column` does, so in that sense is a "lightweight"
version of :class:`.Column`.
Full details on :class:`.ColumnClause` usage is at :func:`.column`.
.. seealso::
:func:`.column`
:class:`.Column`
r% NFc C s( | | _ | _|| _t�|�| _|| _dS )aC Produce a :class:`.ColumnClause` object.
The :class:`.ColumnClause` is a lightweight analogue to the
:class:`.Column` class. The :func:`.column` function can
be invoked with just a name alone, 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
Once constructed, :func:`.column` may be used like any other SQL
expression element such as within :func:`.select` constructs::
from sqlalchemy.sql import column
id, name = column("id"), column("name")
stmt = select([id, name]).select_from("user")
The text handled by :func:`.column` is assumed to be handled
like the name of a database column; if the string contains mixed case,
special characters, or matches a known reserved word on the target
backend, the column expression will render using the quoting
behavior determined by the backend. To produce a textual SQL
expression that is rendered exactly without any quoting,
use :func:`.literal_column` instead, or pass ``True`` as the
value of :paramref:`.column.is_literal`. Additionally, full SQL
statements are best handled using the :func:`.text` construct.
:func:`.column` can be used in a table-like
fashion by combining it with the :func:`.table` function
(which is the lightweight analogue to :class:`.Table`) to produce
a working table construct with minimal boilerplate::
from sqlalchemy import table, column, select
user = table("user",
column("id"),
column("name"),
column("description"),
)
stmt = select([user.c.description]).where(user.c.name == 'wendy')
A :func:`.column` / :func:`.table` construct like that illustrated
above can be created in an
ad-hoc fashion and is not associated with any
:class:`.schema.MetaData`, DDL, or events, unlike its
:class:`.Table` counterpart.
.. versionchanged:: 1.0.0 :func:`.expression.column` can now
be imported from the plain ``sqlalchemy`` namespace like any
other SQL element.
:param text: the text of the element.
:param type: :class:`.types.TypeEngine` object which can associate
this :class:`.ColumnClause` with a type.
:param is_literal: if True, the :class:`.ColumnClause` is assumed to
be an exact expression that will be delivered to the output with no
quoting rules applied regardless of case sensitive settings. the
:func:`.literal_column()` function essentially invokes
:func:`.column` while passing ``is_literal=True``.
.. seealso::
:class:`.Column`
:func:`.literal_column`
:func:`.table`
:func:`.text`
:ref:`sqlexpression_literal_column`
N)r) r� �tabler r r r )r8 r� r r r� r r r r� ! s S zColumnClause.__init__c 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` Z_textualrk r� r� r� r� r� r� )r8 rV r r r r� y s
z%ColumnClause._compare_name_for_resultc C s
| j d S )Nr` )r1 )r8 r r r �
_get_table� s zColumnClause._get_tablec C s | j �| � || jd< d S )Nr` )�_memoized_propertyZexpire_instancer1 )r8 r` r r r �
_set_table� s zColumnClause._set_tablec C s | j }|d k r|gS g S d S )N)r` )r8 �tr r r r| � s zColumnClause._from_objectsc C s t jr | jS | j�dd�S d S )Nr` ra )r rb r� rd )r8 r r r rs � s zColumnClause.descriptionc C s" | j | jkr| �| j �S | jS d S )N)r) r� �
_gen_labelr� )r8 r r r r� � s zColumnClause._key_labelc C s | � | j�S )N)re r� )r8 r r r r� � s zColumnClause._labelc C s
| j d k S )N)r` )r8 r r r r� � s z,ColumnClause._render_label_in_columns_clausec C s | j }| jrd S |d k �r|j�rt|dd �rP|j�dd�d |j d | }n|jd | }t|dd �d k r�t|t�r�|j |_ q�t||j �}n.t|jdd �d k r�t|t�r�t
�t||jj �}||j kr�|}d}x&||j kr�|d t |� }|d7 }q�W |}t
|�S |S d S )N�schema�.�_r� r )r` r Znamed_with_columnr� rf �replacer� r� r� r� r3 r9 rc r� )r8 r� rd r� r� Zcounterr r r re � s. "
zColumnClause._gen_labelc C s t | j||| j|dd�S )NT)r� r� r r$ )r% r) r )r8 rn r� r r r r r� � s zColumnClause._bind_paramTc K s� | o | j o |d kp || jk}| j|r4t|p0| j�n|p<| j| j||d�}|d krZ| j|_| g|_|jd k r~|jj� |j�|_|r�||j
|j< |S )N)r r� r ) r r� r: r� r r) r� r7 r� r� r� ) r8 r� r� Zattachr� r^ r r r9 r r r r� � s$
zColumnClause._make_proxy)NFN)N)NTFF) rw rv ry rz r{ Zonupdater^ Zserver_defaultZserver_onupdateZ_is_multiparam_columnr Z!group_expirable_memoized_propertyrb r� r� ra rc r r` r| r� rs r� r� r� re r� r� r r r r r� � s* !
X
'
r� c @ s e Zd ZdZdd� ZdS )r r c C s
|| _ d S )N)r )r8 r r r r r� s zCollationClause.__init__N)rw rv ry r{ r� r r r r r s r c @ s( e Zd ZdZej�ddi�Zdd� ZdS )�_IdentifiedClauseZ
identifiedr� Fc C s
|| _ d S )N)�ident)r8 rk r r r r� s z_IdentifiedClause.__init__N)rw rv ry r{ r r� r� r� r r r r rj s
rj c @ s e Zd ZdZdS )�SavepointClauseZ savepointN)rw rv ry r{ r r r r rl $ s rl c @ s e Zd ZdZdS )�RollbackToSavepointClauseZrollback_to_savepointN)rw rv ry r{ r r r r rm ( s rm c @ s e Zd ZdZdS )�ReleaseSavepointClauseZrelease_savepointN)rw rv ry r{ r r r r rn , s rn c sD e Zd ZdZdZ� fdd�Zdd� Zdd� Zd d
� Zd d � 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:`.Table`, :class:`.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.has_table` method with
an unconditionally quoted name::
from sqlalchemy import create_engine
from sqlalchemy.sql import quoted_name
engine = create_engine("oracle+cx_oracle://some_dsn")
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.
.. versionadded:: 0.9.0
.. 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� rR rS c sH |d kr d S t || �r,|d ks(|j|kr,|S tt| ��| |�}||_|S )N)r� r� r� r� r0 )r� r& r� r8 )r/ r r r0 b s
zquoted_name.__new__c C s t t�| �| jffS )N)r� r � text_typer� )r8 r r r r[ s s zquoted_name.__reduce__c C s | j r
| S t�| ��� S d S )N)r� r ro rR )r8 r r r �_memoized_method_lowerv s z"quoted_name._memoized_method_lowerc C s | j r
| S t�| ��� S d S )N)r� r ro rS )r8 r r r �_memoized_method_upper| s z"quoted_name._memoized_method_upperc C s$ | � dd�}tjs |�d�}d| S )Nr` ra z'%s')rd r Zpy2k�decode)r8 Z backslashedr r r ru � s
zquoted_name.__repr__) rw rv ry rz � __slots__r0 r[ rp rq ru r� r r )r/ r r� 0 s . r� c s6 e Zd ZdZdZd
� fdd� Zdd� Zdd � Z� ZS ) �_truncated_labelzVA unicode subclass used to identify symbolic "
"names that may require truncation.r Nc s t |d|�}tt| ��| ||�S )Nr� )r� r� rt r0 )r� r& r� )r/ r r r0 � s z_truncated_label.__new__c C s | j t�| �| jffS )N)r/ r ro r� )r8 r r r r[ � s z_truncated_label.__reduce__c C s | S )Nr )r8 �map_r r r � apply_map� s z_truncated_label.apply_map)N) rw rv ry rz rs r0 r[ rv r� r r )r/ r rt � s
rt 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"``
.. versionadded:: 0.9.4
.. seealso::
:ref:`constraint_naming_conventions`
r N)rw rv ry rz rs r r r r rw � s +rw c s, e Zd ZdZdZ� fdd�Zdd� Z� ZS )� _defer_namezRmark a name as 'deferred' for the purposes of automated name
generation.
r c s0 |d kr t S t|t�r|S tt| ��| |�S d S )N)�
_NONE_NAMEr� rw r� rx r0 )r� r& )r/ r r r0 � s
z_defer_name.__new__c C s | j t�| �ffS )N)r/ r ro )r8 r r r r[ � s z_defer_name.__reduce__)rw rv ry rz rs r0 r[ r� r r )r/ r rx � s rx c @ s e Zd ZdZdZdS )�_defer_none_namez>indicate a 'deferred' name that was ultimately the value None.r N)rw rv ry rz rs r r r r rz � s rz Z _unnamed_c @ s, e Zd ZdZdZdd� Zdd� Zdd� Zd S )
r� zDA unicode subclass used to identify anonymously
generated names.r c C s t ttj�| t�|��| j��S )N)r� r� r ro �__add__r� )r8 rV r r r r{ � s z_anonymous_label.__add__c C s t ttj�t�|�| �| j��S )N)r� r� r ro r{ r� )r8 rV r r r �__radd__� s z_anonymous_label.__radd__c C s& | j d k rt| | | j �S | | S d S )N)r� r� )r8 ru r r r rv s
z_anonymous_label.apply_mapN)rw rv ry rz rs r{ r| rv r r r r r� � s
r� c C s t | t�r| S t| �S dS )z�coerce the given value to :class:`._truncated_label`.
Existing :class:`._truncated_label` and
:class:`._anonymous_label` objects are passed
unchanged.
N)r� rt )r& r r r r� s
r� c C s6 t | tj�r| S yt| �S tk
r0 d| S X d S )Nzunprintable element %r)r� r r4 rc � Exception)r r r r �_string_or_unprintable s r~ c C s t jdd� | D �� S )z\expand the given set of ClauseElements to be the set of all 'cloned'
predecessors.
c S s g | ]
}|j �qS r )r3 )r� r r r r r� ( s z"_expand_cloned.<locals>.<listcomp>)r r )�elementsr r r �_expand_cloned# s r� c C s t jdd� | D �� S )zXexpand tables into individual columns in the
given list of column expressions.
c S s g | ]
}|j �qS r )r� )r� r9 r r r r� 0 s z%_select_iterables.<locals>.<listcomp>)r r )r r r r �_select_iterables+ s r� c s, t t| ���t|��� t � fdd�| D ��S )z�return the intersection of sets a and b, counting
any overlap between 'cloned' predecessors.
The returned set is in terms of the entities present within 'a'.
c 3 s | ]}� � |j�r|V qd S )N)r� r3 )r� �elem)� all_overlapr r r� < s z'_cloned_intersection.<locals>.<genexpr>)r r� r� )�ar� r )r� r �_cloned_intersection3 s r� c s, t t| ���t|��� t � fdd�| D ��S )Nc 3 s | ]}� � |j�s|V qd S )N)r� r3 )r� r� )r� r r r� C s z%_cloned_difference.<locals>.<genexpr>)r r� r� )r� r� r )r� r �_cloned_difference@ s r� zsqlalchemy.sql.functionsc C s( t |d�rt|| j�r |�d �S |S d S )Nr� )rk r� ZFunctionElementr� )Z functionsr r r r �_labeledG s
r� c C s
t | t�S )z:True if ``col`` is an instance of :class:`.ColumnElement`.)r� r5 )r� r r r �
_is_columnQ s r� c C s t �� }t| i d|ji� |S )z2locate Column objects within the given expression.r% )r r; r
r< )r, r� r r r �
_find_columnsW s r� c C sB t | tj�r| S t| d�r"| �� } y| jS tk
r< d S X d S )N�__clause_element__)r� r r4 rk r� r) r� )r r r r �_column_as_keyj s
r� c C s t | d�r| �� S | S d S )Nr� )rk r� )r r r r �_clause_element_as_expru s
r� c C s. t | tj�rt| �S t| d�r&| �� } t| �S )Nr� )r� r r4 r rk r� r� )r r r r r$ | s
r$ c C sN t | tj�rt| �S t| d�r&| �� } t | t�rB| jd k rBt| �S t | �S d S )Nr� )
r� r r4 r rk r� r5 r~ r r� )r r r r �&_literal_and_labels_as_label_reference� s
r� c C s t | �S )N)r� )r r r r r� � s r� c C sb t | t�r| S t| d�r | �� S t | tj�r4|| �S t | tjtf�rLt| �S t �
dt | � ��d S )Nr� z=SQL expression object expected, got object of type %r instead) r� r rk r� r r4 �NoneTyper� � _const_exprr rU r )r Z
text_fallbackr r r � _literal_as� s
r� c C s |rt | t�S t | t�S d S )N)r� r� �_no_text_coercion)r Zallow_coercion_to_textr r r r� � s
r� c C s
t | t�S )N)r� r� )r r r r �_literal_as_column� s r� c C s: t | �} t�| � }t�dt�| �|r*dndd� ��d S )Nz�Textual column expression %(column)r should be explicitly declared with text(%(column)r), or use %(literal_column)s(%(column)r) for more specificityr r% )r% r )rc �_guess_straight_column�matchr rU r �ellipses_string)r �guess_is_literalr r r �_no_column_coercion� s r� c C s( |dt �| �|rd| ndd� ��d S )NzX%(extra)sTextual SQL expression %(expr)r should be explicitly declared as text(%(expr)r)z%s � )r! �extra)r r� )r Zexc_clsr� r r r r� � s r� c C s6 t | d�r| �� S t| t�s.t�d| f ��n| S d S )Nr� z�Ambiguous literal: %r. Use the 'text()' function to indicate a SQL expression literal, or 'literal()' to indicate a bound value.)rk r� r� r r rU )r r r r r � s
r c C s t | t� ot| d� S )Nr� )r� r rk )r r r r � _is_literal� s r� c C s | d kr d S t | |�S d S )N)�_only_column_elements)r r� r r r � _only_column_elements_or_none� s r� c C s8 t | d�r| �� } t| t�s4t�d|| t| �f ��| S )Nr� zMColumn-based expression object expected for argument '%s'; got: '%s', type %s)rk r� r� r5 r rU r )r r� r r r r� � s
r� c C sD t | d�r| �� S t| t�s<| d kr*t� S t|| |dd�S n| S d S )Nr� T)r r$ )rk r� r� r r� r% )r r� r r r r r � s
r z^\w\S*$c C s� t | t�r| S t| d�r | �� S tj| dd�}|d krPt | tjtf�r`t | �S nt|d�r`|j
S | dkrnd}n$t | t j �r�t
t| �dd�S t| � t
| |d�S )Nr� F)Zraiseerrr� �*T)r )r� r rk r� r �inspectr r� r� r� r� �numbers�Numberr� rc r� )r Zinspr� r r r � _interpret_as_column_or_from s
r� c C sL t | tttf�r| S | d kr"t� S | dkr0t� S | dkr>t� S t�d��d S )NFTz Expected None, False, or True)r� r� r� r� r rU )r r r r r� s r� c C s& x | D ]}|j js|j S qW tjS d S )N)r Z_isnullr r� )�argsr� r r r �_type_from_args+ s
r� 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` )Zcorresponding_columnr ZInvalidRequestErrorr� rs )Z
fromclauser% r� r9 r r r � _corresponding_column_or_error3 s
r� c sj e Zd Zdd� Z� fdd�Zejdd� �Zejdd� �Zejd d
� �Z ejd d � �Z
ejd
d� �Z � Z S )�AnnotatedColumnElementc C sJ t �| ||� tj�| � x*dD ]"}| j�|d�d kr | j�|� q W d S )N)r� r) r` F)r r� r5 r6 r4 r1 r� r? )r8 r rB rB r r r r� A s
z AnnotatedColumnElement.__init__c s t t| ��|�}tj�|� |S )N)r� r� rD r5 r6 r4 )r8 rB rE )r/ r r rD H s z(AnnotatedColumnElement._with_annotationsc C s | j jS )z'pull 'name' from parent, if not present)�_Annotated__elementr� )r8 r r r r� M s zAnnotatedColumnElement.namec C s | j jS )z(pull 'table' from parent, if not present)r� r` )r8 r r r r` R s z AnnotatedColumnElement.tablec C s | j jS )z&pull 'key' from parent, if not present)r� r) )r8 r r r r) W s zAnnotatedColumnElement.keyc C s | j jS )N)r� �info)r8 r r r r� \ s zAnnotatedColumnElement.infoc C s | j jS )N)r� r� )r8 r r r r� ` s z!AnnotatedColumnElement.anon_label)
rw rv ry r� rD r r� r� r` r) r� r� r� r r )r/ r r� @ s r� )F)N)N)N)F)NN)F)vrz Z
__future__r r r� rn r� r� r r Z
annotationr �baser r r r
r Zvisitorsr r
r r r r r r r r# r' r* r- Z_self_inspectsr. ZColumnOperatorsr5 r% r� r� r� r� r� r� r rf rh r r r r� r r r r rp r- r� r r; rA r� ZsymbolrE rF rG rU rV r� r� r rj rl rm rn Z
MemoizedSlotsro r� rt rw rx rz ry Z_generated_labelr� r� r~ r� r� r� r� r� r� r� r� r� r� r$ r� r� r� r� r� r� rU r� r r� r� r� r r_ �Ir� r� r� r� r� r� r r r r �<module> s�
6
e r z
2;B] 7 O
!ak 0^g2
Pm y Y0