JezK
Edit File: functions.pyc
� xR�dc @ s� d Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m! Z! d d l" m# Z# d d l" m$ Z$ d d l m Z e j% e& � Z' d! d" � Z( d# e e e e f d$ � � YZ) d% e f d& � � YZ* d' e f d( � � YZ+ d) e, f d* � � YZ- e- � Z. e- j e. _ e- d+ e/ � Z0 d, e) f d- � � YZ1 d. e$ f d/ � � YZ2 d0 e j3 e2 e1 � f d1 � � YZ4 e( d2 e � e( d3 e � d4 e4 f d5 � � YZ5 d6 e4 f d7 � � YZ6 d8 e4 f d9 � � YZ7 d: e7 f d; � � YZ8 d< e7 f d= � � YZ9 d> e7 f d? � � YZ: d@ e7 f dA � � YZ; dB e4 f dC � � YZ< dD e4 f dE � � YZ= dF e4 f dG � � YZ> dH e4 f dI � � YZ? dJ e4 f dK � � YZ@ dL e6 f dM � � YZA dN e6 f dO � � YZB dP e6 f dQ � � YZC dR e6 f dS � � YZD dT e6 f dU � � YZE dV e6 f dW � � YZF dX e6 f dY � � YZG dZ e6 f d[ � � YZH d\ e6 f d] � � YZI d^ e4 f d_ � � YZJ d` e4 f da � � YZK db eK f dc � � YZL dd eK f de � � YZM df eK f dg � � YZN dh e4 f di � � YZO dj e4 f dk � � YZP dl e4 f dm � � YZQ dn e4 f do � � YZR dp e4 f dq � � YZS dr e4 f ds � � YZT dt e4 f du � � YZU dv S(w s6 SQL function API, factories, and built-in functions. i ( t annotation( t coercions( t operators( t roles( t schema( t sqltypes( t util( t _entity_namespace( t ColumnCollection( t Executable( t Generative( t HasMemoized( t _type_from_args( t BinaryExpression( t BindParameter( t Cast( t ClauseList( t ColumnElement( t Extract( t FunctionFilter( t Grouping( t literal_column( t NamedColumn( t Over( t WithinGroup( t FromClause( t Select( t TableValuedAlias( t InternalTraversal( t TraversibleTypei t _defaultc C sR t | } t j | � j � } | | k rD t j d j | � � n | | | <d S( s� Associate a callable with a particular func. name. This is normally called by _GenericMeta, but is also available by itself so that a non-Function construct can be associated with the :data:`.func` accessor (i.e. CAST, EXTRACT). sM The GenericFunction '{}' is already registered and is going to be overridden.N( t _registryR t text_typet lowert warnt format( t identifiert fnt packaget reg( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt register_function/ s t FunctionElementc B s� e Z d Z d e j f d e j f d e j f g Z d Z e Z e Z d! Z d � Z d! Z e d � � Z d � Z d! d � Z d � Z d! e d � Z e d � � Z e d � � Z e d � � Z e j d � � Z d! d! d! d! d � Z d � Z d � Z d � Z e d � � Z d � Z! d! e d � Z" d � Z# e$ j% d d d �d � � Z& e$ j% d d d �d � � Z' d! d � Z( d! d � Z) e d � � Z* RS(" s� Base for SQL function-oriented constructs. .. seealso:: :ref:`tutorial_functions` - in the :ref:`unified_tutorial` :class:`.Function` - named SQL function. :data:`.func` - namespace which produces registered or ad-hoc :class:`.Function` instances. :class:`.GenericFunction` - allows creation of registered function types. t clause_exprt _with_ordinalityt _table_value_typec O s� g | D]3 } t j t j | d t | d d � d | �^ q } | j pR t | � | _ t d t j d t | � j � | _ d S( sO Construct a :class:`.FunctionElement`. :param \*clauses: list of column expressions that form the arguments of the SQL function call. :param \**kwargs: additional kwargs are typically consumed by subclasses. .. seealso:: :data:`.func` :class:`.Function` t namet apply_propagate_attrst operatort group_contentsN( R t expectR t ExpressionElementRolet getattrt Nonet _has_argst boolR R t comma_opt Truet self_groupR* ( t selft clausest kwargst ct args( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt __init__b s =c C s" t t | � j p! t | d d � S( NR- ( t superR) t _proxy_keyR3 R4 ( R: ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyRA � s c C s | j | | | | � S( N( t _execute_function( R: t connectiont multiparamst paramst execution_options( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt _execute_on_connection� s c C s t | | | � S( s~ Return a column expression that's against this :class:`_functions.FunctionElement` as a scalar table-valued expression. The returned expression is similar to that returned by a single column accessed off of a :meth:`_functions.FunctionElement.table_valued` construct, except no FROM clause is generated; the function is rendered in the similar way as a scalar subquery. E.g.:: >>> from sqlalchemy import func, select >>> fn = func.jsonb_each("{'k', 'v'}").scalar_table_valued("key") >>> print(select(fn)) SELECT (jsonb_each(:jsonb_each_1)).key .. versionadded:: 1.4.0b2 .. seealso:: :meth:`_functions.FunctionElement.table_valued` :meth:`_functions.FunctionElement.alias` :meth:`_functions.FunctionElement.column_valued` ( t ScalarFunctionColumn( R: R- t type_( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt scalar_table_valued� s c O s� | j � } | j d d � } | j d d � } | j d d � } | ra | | f 7} t | _ n t j | � | _ | _ | j d | d | � S( sS Return a :class:`_sql.TableValuedAlias` representation of this :class:`_functions.FunctionElement` with table-valued expressions added. e.g.:: >>> fn = ( ... func.generate_series(1, 5). ... table_valued("value", "start", "stop", "step") ... ) >>> print(select(fn)) SELECT anon_1.value, anon_1.start, anon_1.stop, anon_1.step FROM generate_series(:generate_series_1, :generate_series_2) AS anon_1 >>> print(select(fn.c.value, fn.c.stop).where(fn.c.value > 2)) SELECT anon_1.value, anon_1.stop FROM generate_series(:generate_series_1, :generate_series_2) AS anon_1 WHERE anon_1.value > :value_1 A WITH ORDINALITY expression may be generated by passing the keyword argument "with_ordinality":: >>> fn = func.generate_series(4, 1, -1).table_valued("gen", with_ordinality="ordinality") >>> print(select(fn)) SELECT anon_1.gen, anon_1.ordinality FROM generate_series(:generate_series_1, :generate_series_2, :generate_series_3) WITH ORDINALITY AS anon_1 :param \*expr: A series of string column names that will be added to the ``.c`` collection of the resulting :class:`_sql.TableValuedAlias` construct as columns. :func:`_sql.column` objects with or without datatypes may also be used. :param name: optional name to assign to the alias name that's generated. If omitted, a unique anonymizing name is used. :param with_ordinality: string name that when present results in the ``WITH ORDINALITY`` clause being added to the alias, and the given string name will be added as a column to the .c collection of the resulting :class:`_sql.TableValuedAlias`. :param joins_implicitly: when True, the table valued function may be used in the FROM clause without any explicit JOIN to other tables in the SQL query, and no "cartesian product" warning will be generated. May be useful for SQL functions such as ``func.json_each()``. .. versionadded:: 1.4.33 .. versionadded:: 1.4.0b2 .. seealso:: :ref:`tutorial_functions_table_valued` - in the :ref:`unified_tutorial` :ref:`postgresql_table_valued` - in the :ref:`postgresql_toplevel` documentation :meth:`_functions.FunctionElement.scalar_table_valued` - variant of :meth:`_functions.FunctionElement.table_valued` which delivers the complete table valued expression as a scalar column expression :meth:`_functions.FunctionElement.column_valued` :meth:`_sql.TableValuedAlias.render_derived` - renders the alias using a derived column clause, e.g. ``AS name(col1, col2, ...)`` t with_ordinalityt joins_implicitlyR- N( t _generatet popR4 R8 R+ R t TableValueTypet typeR, t alias( R: t exprt kwt new_funcRK RL R- ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt table_valued� s D c C s | j d | d | � j S( s% Return this :class:`_functions.FunctionElement` as a column expression that selects from itself as a FROM clause. E.g.:: >>> from sqlalchemy import select, func >>> gs = func.generate_series(1, 5, -1).column_valued() >>> print(select(gs)) SELECT anon_1 FROM generate_series(:generate_series_1, :generate_series_2, :generate_series_3) AS anon_1 This is shorthand for:: gs = func.generate_series(1, 5, -1).alias().column :param name: optional name to assign to the alias name that's generated. If omitted, a unique anonymizing name is used. :param joins_implicitly: when True, the "table" portion of the column valued function may be a member of the FROM clause without any explicit JOIN to other tables in the SQL query, and no "cartesian product" warning will be generated. May be useful for SQL functions such as ``func.json_array_elements()``. .. versionadded:: 1.4.46 .. seealso:: :ref:`tutorial_functions_column_valued` - in the :ref:`unified_tutorial` :ref:`postgresql_column_valued` - in the :ref:`postgresql_toplevel` documentation :meth:`_functions.FunctionElement.table_valued` R- RL ( RQ t column( R: R- RL ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt column_valued s %c C s, t d g | j D] } | j | f ^ q � S( s� The set of columns exported by this :class:`.FunctionElement`. This is a placeholder collection that allows the function to be placed in the FROM clause of a statement:: >>> from sqlalchemy import column, select, func >>> stmt = select(column('x'), column('y')).select_from(func.myfunction()) >>> print(stmt) SELECT x, y FROM myfunction() The above form is a legacy feature that is now superseded by the fully capable :meth:`_functions.FunctionElement.table_valued` method; see that method for details. .. seealso:: :meth:`_functions.FunctionElement.table_valued` - generates table-valued SQL function expressions. t columns( R t _all_selected_columnst key( R: t col( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyRX ) s c C s1 | j j r | j j } n | j d � g } | S( N( RP t _is_table_valuet _elementst labelR4 ( R: t cols( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyRY D s c C s | j S( N( RX ( R: ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt exported_columnsM s c C s | j j S( s} Return the underlying :class:`.ClauseList` which contains the arguments for this :class:`.FunctionElement`. ( R* t element( R: ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR; Q s c C s" t | d | d | d | d | �S( sA Produce an OVER clause against this function. Used against aggregate or so-called "window" functions, for database backends that support window functions. The expression:: func.row_number().over(order_by='x') is shorthand for:: from sqlalchemy import over over(func.row_number(), order_by='x') See :func:`_expression.over` for a full description. .. seealso:: :func:`_expression.over` :ref:`tutorial_window_functions` - in the :ref:`unified_tutorial` t partition_byt order_byt rowst range_( R ( R: Rb Rc Rd Re ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt overY s c G s t | | � S( s� Produce a WITHIN GROUP (ORDER BY expr) clause against this function. Used against so-called "ordered set aggregate" and "hypothetical set aggregate" functions, including :class:`.percentile_cont`, :class:`.rank`, :class:`.dense_rank`, etc. See :func:`_expression.within_group` for a full description. .. versionadded:: 1.1 .. seealso:: :ref:`tutorial_functions_within_group` - in the :ref:`unified_tutorial` ( R ( R: Rc ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt within_groupy s c G s | s | St | | � S( sG Produce a FILTER clause against this function. Used against aggregate and window functions, for database backends that support the "FILTER" clause. The expression:: func.count(1).filter(True) is shorthand for:: from sqlalchemy import funcfilter funcfilter(func.count(1), True) .. versionadded:: 1.0.0 .. seealso:: :ref:`tutorial_functions_within_group` - in the :ref:`unified_tutorial` :class:`.FunctionFilter` :func:`.funcfilter` ( R ( R: t criterion( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt filter� s c C s t | | | � S( s^ Interpret this expression as a boolean comparison between two values. This method is used for an ORM use case described at :ref:`relationship_custom_operator_sql_function`. A hypothetical SQL function "is_equal()" which compares to values for equality would be written in the Core expression language as:: expr = func.is_equal("a", "b") If "is_equal()" above is comparing "a" and "b" for equality, the :meth:`.FunctionElement.as_comparison` method would be invoked as:: expr = func.is_equal("a", "b").as_comparison(1, 2) Where above, the integer value "1" refers to the first argument of the "is_equal()" function and the integer value "2" refers to the second. This would create a :class:`.BinaryExpression` that is equivalent to:: BinaryExpression("a", "b", operator=op.eq) However, at the SQL level it would still render as "is_equal('a', 'b')". The ORM, when it loads a related object or collection, needs to be able to manipulate the "left" and "right" sides of the ON clause of a JOIN expression. The purpose of this method is to provide a SQL function construct that can also supply this information to the ORM, when used with the :paramref:`_orm.relationship.primaryjoin` parameter. The return value is a containment object called :class:`.FunctionAsBinary`. An ORM example is as follows:: class Venue(Base): __tablename__ = 'venue' id = Column(Integer, primary_key=True) name = Column(String) descendants = relationship( "Venue", primaryjoin=func.instr( remote(foreign(name)), name + "/" ).as_comparison(1, 2) == 1, viewonly=True, order_by=name ) Above, the "Venue" class can load descendant "Venue" objects by determining if the name of the parent Venue is contained within the start of the hypothetical descendant value's name, e.g. "parent1" would match up to "parent1/child1", but not to "parent2/child1". Possible use cases include the "materialized path" example given above, as well as making use of special SQL functions such as geometric functions to create join conditions. :param left_index: the integer 1-based index of the function argument that serves as the "left" side of the expression. :param right_index: the integer 1-based index of the function argument that serves as the "right" side of the expression. .. versionadded:: 1.3 .. seealso:: :ref:`relationship_custom_operator_sql_function` - example use within the ORM ( t FunctionAsBinary( R: t left_indext right_index( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt as_comparison� s Hc C s | j j S( N( R; t _from_objects( R: ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyRn � s c C s d S( s For types that define their return type as based on the criteria within a WITHIN GROUP (ORDER BY) expression, called by the :class:`.WithinGroup` construct. Returns None by default, in which case the function's normal ``.type`` is used. N( R4 ( R: Rg ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt within_group_type� s c C s t j | | d | j d | �S( s� Produce a :class:`_expression.Alias` construct against this :class:`.FunctionElement`. .. tip:: The :meth:`_functions.FunctionElement.alias` method is part of the mechanism by which "table valued" SQL functions are created. However, most use cases are covered by higher level methods on :class:`_functions.FunctionElement` including :meth:`_functions.FunctionElement.table_valued`, and :meth:`_functions.FunctionElement.column_valued`. This construct wraps the function in a named alias which is suitable for the FROM clause, in the style accepted for example by PostgreSQL. A column expression is also provided using the special ``.column`` attribute, which may be used to refer to the output of the function as a scalar value in the columns or where clause, for a backend such as PostgreSQL. For a full table-valued expression, use the :meth:`_functions.FunctionElement.table_valued` method first to establish named columns. e.g.:: >>> from sqlalchemy import func, select, column >>> data_view = func.unnest([1, 2, 3]).alias("data_view") >>> print(select(data_view.column)) SELECT data_view FROM unnest(:unnest_1) AS data_view The :meth:`_functions.FunctionElement.column_valued` method provides a shortcut for the above pattern:: >>> data_view = func.unnest([1, 2, 3]).column_valued("data_view") >>> print(select(data_view)) SELECT data_view FROM unnest(:unnest_1) AS data_view .. versionadded:: 1.4.0b2 Added the ``.column`` accessor :param name: alias name, will be rendered as ``AS <name>`` in the FROM clause :param joins_implicitly: when True, the table valued function may be used in the FROM clause without any explicit JOIN to other tables in the SQL query, and no "cartesian product" warning will be generated. May be useful for SQL functions such as ``func.json_each()``. .. versionadded:: 1.4.33 .. seealso:: :ref:`tutorial_functions_table_valued` - in the :ref:`unified_tutorial` :meth:`_functions.FunctionElement.table_valued` :meth:`_functions.FunctionElement.scalar_table_valued` :meth:`_functions.FunctionElement.column_valued` t table_value_typeRL ( R t _constructRP ( R: R- RL ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyRQ s C c C s1 t j | � } | j r- | j | j � } n | S( s� Produce a :func:`_expression.select` construct against this :class:`.FunctionElement`. This is shorthand for:: s = select(function_element) ( R t _create_selectt _execution_optionsRF ( R: t s( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt selectR s s :meth:`.FunctionElement.scalar`t alternatives� Scalar execution in SQLAlchemy 2.0 is performed by the :meth:`_engine.Connection.scalar` method of :class:`_engine.Connection`, or in the ORM by the :meth:`.Session.scalar` method of :class:`.Session`.c C s | j � j � j � S( s� Execute this :class:`.FunctionElement` against an embedded 'bind' and return a scalar value. This first calls :meth:`~.FunctionElement.select` to produce a SELECT construct. Note that :class:`.FunctionElement` can be passed to the :meth:`.Connectable.scalar` method of :class:`_engine.Connection` or :class:`_engine.Engine`. ( Ru t executet scalar( R: ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyRx ` s s :meth:`.FunctionElement.execute`s� All statement execution in SQLAlchemy 2.0 is performed by the :meth:`_engine.Connection.execute` method of :class:`_engine.Connection`, or in the ORM by the :meth:`.Session.execute` method of :class:`.Session`.c C s | j � j � S( sg Execute this :class:`.FunctionElement` against an embedded 'bind'. This first calls :meth:`~.FunctionElement.select` to produce a SELECT construct. Note that :class:`.FunctionElement` can be passed to the :meth:`.Connectable.execute` method of :class:`_engine.Connection` or :class:`_engine.Engine`. ( Ru Rw ( R: ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyRw v s c K s+ t d | d | d | j d t d | | �S( Nt _compared_to_operatort _compared_to_typet uniqueRI ( R R4 RP R8 ( R: R/ t objRI RS ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt _bind_param� s c C sK | t j k r. t | j t j � r. t | � St t | � j d | � Sd S( Nt against( R t getitemt isinstanceRP R t ARRAYR R@ R) R9 ( R: R~ ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR9 � s c C s t | j � S( sz overrides FromClause.entity_namespace as functions are generally column expressions and not FromClauses. ( R R* ( R: ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt entity_namespace� s ( N(+ t __name__t __module__t __doc__R t dp_clauseelementt dp_booleant dp_has_cache_keyt _traverse_internalst packagenamest FalseR5 R+ R4 R, R? t _non_anon_labelt propertyRA RG RJ RU RW RX RY R` R t memoized_attributeR; Rf Rg Ri Rm Rn Ro RQ Ru R t deprecated_20Rx Rw R} R9 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR) E sH T' J J Rj c B s� e Z d e j f d e j f d e j f d e j f g Z d � Z d � Z e d � � Z e j d � � Z e d � � Z e j d � � Z RS( t sql_functionRk Rl t modifiersc C s t j | | | � S( N( R t _gen_cache_key( R: t anon_mapt bindparams( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� � s c C sR | | _ | | _ | | _ t j | _ t j | _ d | _ t | _ i | _ d S( N( R� Rk Rl R t function_as_comparison_opR/ R t BOOLEANTYPERP R4 t negateR8 t _is_implicitly_booleanR� ( R: R% Rk Rl ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR? � s c C s | j j j | j d S( Ni ( R� R; Rk ( R: ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt left� s c C s | | j j j | j d <d S( Ni ( R� R; Rk ( R: t value( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� � s c C s | j j j | j d S( Ni ( R� R; Rl ( R: ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt right� s c C s | | j j j | j d <d S( Ni ( R� R; Rl ( R: R� ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� � s ( R� R� R R� t dp_plain_objt dp_plain_dictR� R� R? R� R� t setterR� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyRj � s RH c B sP e Z d Z d e j f d e j f d e j f g Z e Z d Z d d � Z RS( t scalar_function_columnR- RP R% c C s( | | _ | | _ t j | � | _ d S( N( R% R- R t to_instanceRP ( R: R% R- RI ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR? � s N( R� R� t __visit_name__R t dp_anon_namet dp_typeR� R� R� t is_literalR4 t tableR? ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyRH � s t _FunctionGeneratorc B s) e Z d Z d � Z d � Z d � Z RS( s� Generate SQL function expressions. :data:`.func` is a special object instance which generates SQL functions based on name-based attributes, e.g.:: >>> print(func.count(1)) count(:param_1) The returned object is an instance of :class:`.Function`, and is a column-oriented SQL element like any other, and is used in that way:: >>> print(select(func.count(table.c.id))) SELECT count(sometable.id) FROM sometable Any name can be given to :data:`.func`. If the function name is unknown to SQLAlchemy, it will be rendered exactly as is. For common SQL functions which SQLAlchemy is aware of, the name may be interpreted as a *generic function* which will be compiled appropriately to the target database:: >>> print(func.current_timestamp()) CURRENT_TIMESTAMP To call functions which are present in dot-separated packages, specify them in the same manner:: >>> print(func.stats.yield_curve(5, 10)) stats.yield_curve(:yield_curve_1, :yield_curve_2) SQLAlchemy can be made aware of the return type of functions to enable type-specific lexical and result-based behavior. For example, to ensure that a string-based function returns a Unicode value and is similarly treated as a string in expressions, specify :class:`~sqlalchemy.types.Unicode` as the type: >>> print(func.my_string(u'hi', type_=Unicode) + ' ' + ... func.my_string(u'there', type_=Unicode)) my_string(:my_string_1) || :my_string_2 || my_string(:my_string_3) The object returned by a :data:`.func` call is usually an instance of :class:`.Function`. This object meets the "column" interface, including comparison and labeling functions. The object can also be passed the :meth:`~.Connectable.execute` method of a :class:`_engine.Connection` or :class:`_engine.Engine`, where it will be wrapped inside of a SELECT statement first:: print(connection.execute(func.current_timestamp()).scalar()) In a few exception cases, the :data:`.func` accessor will redirect a name to a built-in expression such as :func:`.cast` or :func:`.extract`, as these names have well-known meaning but are not exactly the same as "functions" from a SQLAlchemy perspective. Functions which are interpreted as "generic" functions know how to calculate their return type automatically. For a listing of known generic functions, see :ref:`generic_functions`. .. note:: The :data:`.func` construct has only limited support for calling standalone "stored procedures", especially those with special parameterization concerns. See the section :ref:`stored_procedures` for details on how to use the DBAPI-level ``callproc()`` method for fully traditional stored procedures. .. seealso:: :ref:`tutorial_functions` - in the :ref:`unified_tutorial` :class:`.Function` c K s g | _ | | _ d S( N( t _FunctionGenerator__namest opts( R: R� ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR? 4 s c C s� | j d � rA y | j | SWq` t k r= t | � � q` Xn | j d � r` | d d !} n t | j � } t | j � | g | _ | S( Nt __t _i i����( t startswitht __dict__t KeyErrort AttributeErrort endswithR� R� t listR� ( R: R- t f( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt __getattr__8 s c O s� | j j � } | j | � t | j � } | d k rI | j \ } } n) | d k rl d | j d } } n d } | d k r� t | j | j � � } | d k r� | | | � Sn t | j d d t | j d d !� | | �S( Ni i R i i����R� ( R� t copyt updatet lenR� R4 R t getR! t Functiont tuple( R: R= R< t ot tokensR& t fnamet func( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt __call__F s ( R� R� R� R? R� R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� � s K t groupR� c B s~ e Z d Z d Z e j d e j f d e j f d e j f g Z e j Z e j d d � d � � Z d � Z d d � Z RS( s� Describe a named SQL function. The :class:`.Function` object is typically generated from the :data:`.func` generation object. :param \*clauses: list of column expressions that form the arguments of the SQL function call. :param type\_: optional :class:`.TypeEngine` datatype object that will be used as the return value of the column expression generated by this function call. :param packagenames: a string which indicates package prefix names to be prepended to the function name when the SQL is generated. The :data:`.func` generator creates these when it is called using dotted format, e.g.:: func.mypackage.some_function(col1, col2) .. seealso:: :ref:`tutorial_functions` - in the :ref:`unified_tutorial` :data:`.func` - namespace which produces registered or ad-hoc :class:`.Function` instances. :class:`.GenericFunction` - allows creation of registered function types. t functionR� R- RP t binds 2.0s\ The :paramref:`_sql.text.bind` argument is deprecated and will be removed in SQLAlchemy 2.0.c O sk | j d d � p d | _ | | _ | j | � | _ t j | j d d � � | _ t j | | | � d S( s� Construct a :class:`.Function`. The :data:`.func` construct is normally used to construct new :class:`.Function` instances. R� RI N( ( RN R4 R� R- t _get_bindt _bindR R� R� RP R) R? ( R: R- R; RS ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR? � s c C s% d | k r! t j d � | d Sd S( NR� sO The Function.bind argument is deprecated and will be removed in SQLAlchemy 2.0.( R t warn_deprecated_20( R: RS ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� � s c K s. t | j | d | d | j d | d t | �S( NRy Rz RI R{ ( R R- RP R8 ( R: R/ R| RI RS ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR} � s ( s 2.0s\ The :paramref:`_sql.text.bind` argument is deprecated and will be removed in SQLAlchemy 2.0.N( R� R� R� R� R) R� R R� t dp_stringR� R t NULLTYPERP R t deprecated_paramsR? R� R4 R} ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� c s t _GenericMetac B s e Z d � Z RS( c C s� t j | j k r� | j d | � | _ } | j d | � | _ } | j d d � } d | k rr | d | _ n t | d t � | _ | j r� t | | | � q� t | _ n t t | � j | | | � d S( NR- R$ R& R t __return_type__t _register( R t Annotatedt __mro__R� R- R$ RN RP R3 R8 R� R( R@ R� R? ( t clst clsnamet basest clsdictR- R$ R& ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR? � s ( R� R� R? ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� � s t GenericFunctionc B s) e Z d Z e Z e Z e Z d � Z RS( sK Define a 'generic' function. A generic function is a pre-established :class:`.Function` class that is instantiated automatically when called by name from the :data:`.func` attribute. Note that calling any name from :data:`.func` has the effect that a new :class:`.Function` instance is created automatically, given that name. The primary use case for defining a :class:`.GenericFunction` class is so that a function of a particular name may be given a fixed return type. It can also include custom argument parsing schemes as well as additional methods. Subclasses of :class:`.GenericFunction` are automatically registered under the name of the class. For example, a user-defined function ``as_utc()`` would be available immediately:: from sqlalchemy.sql.functions import GenericFunction from sqlalchemy.types import DateTime class as_utc(GenericFunction): type = DateTime inherit_cache = True print(select(func.as_utc())) User-defined generic functions can be organized into packages by specifying the "package" attribute when defining :class:`.GenericFunction`. Third party libraries containing many functions may want to use this in order to avoid name conflicts with other systems. For example, if our ``as_utc()`` function were part of a package "time":: class as_utc(GenericFunction): type = DateTime package = "time" inherit_cache = True The above function would be available from :data:`.func` using the package name ``time``:: print(select(func.time.as_utc())) A final option is to allow the function to be accessed from one name in :data:`.func` but to render as a different name. The ``identifier`` attribute will override the name used to access the function as loaded from :data:`.func`, but will retain the usage of ``name`` as the rendered name:: class GeoBuffer(GenericFunction): type = Geometry package = "geo" name = "ST_Buffer" identifier = "buffer" inherit_cache = True The above function will render as follows:: >>> print(func.geo.buffer()) ST_Buffer() The name will be rendered as is, however without quoting unless the name contains special characters that require quoting. To force quoting on or off for the name, use the :class:`.sqlalchemy.sql.quoted_name` construct:: from sqlalchemy.sql import quoted_name class GeoBuffer(GenericFunction): type = Geometry package = "geo" name = quoted_name("ST_Buffer", True) identifier = "buffer" inherit_cache = True The above function will render as:: >>> print(func.geo.buffer()) "ST_Buffer"() .. versionadded:: 1.3.13 The :class:`.quoted_name` construct is now recognized for quoting when used with the "name" attribute of the object, so that quoting can be forced on or off for the function name. c O s� | j d d � } | d k rX g | D]* } t j t j | d | j d | �^ q% } n | j pj t | � | _ d | _ | j | � | _ t d t j d t | � j � | _ t j | j d d � p� t | d d � � | _ d S( Nt _parsed_argsR- R. R/ R0 RI RP ( ( RN R4 R R1 R R2 R- R5 R6 R� R� R� R R R7 R8 R9 R* R R� R3 RP ( R: R> R< t parsed_argsR= ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR? = s 7 ( R� R� R� R8 t coerce_argumentsR� R� t inherit_cacheR? ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� � s Yt castt extractt next_valuec B sS e Z d Z e j � Z d Z d e j f g Z d � Z d � Z e d � � Z RS( s Represent the 'next value', given a :class:`.Sequence` as its single argument. Compiles into the appropriate function on each backend, or will raise NotImplementedError if used on a backend that does not provide support for sequences. R� t sequencec K sd t | t j � s t d � � | j | � | _ | | _ t j | j pW t | d d � � | _ d S( Ns0 next_value() accepts a Sequence object as input.RP ( R� R t Sequencet AssertionErrorR� R� R� R R� t data_typeR3 R4 RP ( R: t seqRS ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR? i s c K s% t | t � o$ | j j | j j k S( N( R� R� R� R- ( R: t otherRS ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt compares s c C s g S( N( ( R: ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyRn y s ( R� R� R� R t IntegerRP R- R t dp_named_ddl_elementR� R? R� R� Rn ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� X s t AnsiFunctionc B s e Z d Z e Z d � Z RS( sE Define a function in "ansi" format, which doesn't render parenthesis.c O s t j | | | � d S( N( R� R? ( R: R> R< ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR? � s ( R� R� R� R8 R� R? ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� ~ s t ReturnTypeFromArgsc B s e Z d Z e Z d � Z RS( sA Define a function whose return type is the same as its arguments.c O st g | D]* } t j t j | d | j d | �^ q } | j d t | � � | | d <t t | � j | | � d S( NR- R. RI R� ( R R1 R R2 R- t setdefaultR R@ R� R? ( R: R> R< R= ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR? � s 4 ( R� R� R� R8 R� R? ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� � s t coalescec B s e Z e Z e Z RS( ( R� R� R8 R5 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� � s t maxc B s e Z d Z e Z RS( s! The SQL MAX() aggregate function.( R� R� R� R8 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� � s t minc B s e Z d Z e Z RS( s! The SQL MIN() aggregate function.( R� R� R� R8 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� � s t sumc B s e Z d Z e Z RS( s! The SQL SUM() aggregate function.( R� R� R� R8 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� � s t nowc B s e Z d Z e j Z e Z RS( s� The SQL now() datetime function. SQLAlchemy dialects will usually render this particular function in a backend-specific way, such as rendering it as ``CURRENT_TIMESTAMP``. ( R� R� R� R t DateTimeRP R8 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� � s t concatc B s e Z d Z e j Z e Z RS( s� The SQL CONCAT() function, which concatenates strings. E.g.:: >>> print(select(func.concat('a', 'b'))) SELECT concat(:concat_2, :concat_3) AS concat_1 String concatenation in SQLAlchemy is more commonly available using the Python ``+`` operator with string datatypes, which will render a backend-specific concatenation operator, such as :: >>> print(select(literal("a") + "b")) SELECT :param_1 || :param_2 AS anon_1 ( R� R� R� R t StringRP R8 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� � s t char_lengthc B s& e Z d Z e j Z e Z d � Z RS( s The CHAR_LENGTH() SQL function.c K s t j | | | � d S( N( R� R? ( R: t argR< ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR? � s ( R� R� R� R R� RP R8 R� R? ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� � s t randomc B s e Z d Z e Z e Z RS( s The RANDOM() SQL function.( R� R� R� R8 R5 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� � s t countc B s) e Z d Z e j Z e Z d d � Z RS( s� The ANSI COUNT aggregate function. With no arguments, emits COUNT \*. E.g.:: from sqlalchemy import func from sqlalchemy import select from sqlalchemy import table, column my_table = table('some_table', column('id')) stmt = select(func.count()).select_from(my_table) Executing ``stmt`` would emit:: SELECT count(*) AS count_1 FROM some_table c K s8 | d k r t d � } n t t | � j | | � d S( Nt *( R4 R R@ R� R? ( R: t expressionR< ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR? � s N( R� R� R� R R� RP R8 R� R4 R? ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� � s t current_datec B s e Z d Z e j Z e Z RS( s The CURRENT_DATE() SQL function.( R� R� R� R t DateRP R8 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� s t current_timec B s e Z d Z e j Z e Z RS( s The CURRENT_TIME() SQL function.( R� R� R� R t TimeRP R8 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� s t current_timestampc B s e Z d Z e j Z e Z RS( s% The CURRENT_TIMESTAMP() SQL function.( R� R� R� R R� RP R8 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� s t current_userc B s e Z d Z e j Z e Z RS( s The CURRENT_USER() SQL function.( R� R� R� R R� RP R8 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� s t localtimec B s e Z d Z e j Z e Z RS( s The localtime() SQL function.( R� R� R� R R� RP R8 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� s t localtimestampc B s e Z d Z e j Z e Z RS( s" The localtimestamp() SQL function.( R� R� R� R R� RP R8 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� & s t session_userc B s e Z d Z e j Z e Z RS( s The SESSION_USER() SQL function.( R� R� R� R R� RP R8 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� - s t sysdatec B s e Z d Z e j Z e Z RS( s The SYSDATE() SQL function.( R� R� R� R R� RP R8 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� 4 s t userc B s e Z d Z e j Z e Z RS( s The USER() SQL function.( R� R� R� R R� RP R8 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� ; s t array_aggc B s& e Z d Z e j Z e Z d � Z RS( s� Support for the ARRAY_AGG function. The ``func.array_agg(expr)`` construct returns an expression of type :class:`_types.ARRAY`. e.g.:: stmt = select(func.array_agg(table.c.values)[2:5]) .. versionadded:: 1.1 .. seealso:: :func:`_postgresql.array_agg` - PostgreSQL-specific version that returns :class:`_postgresql.ARRAY`, which has PG-specific operators added. c O s� g | D]! } t j t j | d | �^ q } | j d t j � } d | k r� t | � } t | t j � rz | | d <q� | | � | d <n | | d <t t | � j | | � d S( NR. t _default_array_typeRI R� ( R R1 R R2 RN R R� R R� R@ R� R? ( R: R> R< R= t default_array_typet type_from_args( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR? Y s + ( R� R� R� R R� RP R8 R� R? ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR� B s t OrderedSetAggc B s# e Z d Z e Z e Z d � Z RS( s� Define a function where the return type is based on the sort expression type as defined by the expression passed to the :meth:`.FunctionElement.within_group` method.c C s_ | j j } t j | j � } | j rP t | j � d k rP t j | d j � S| d j Sd S( Ni i ( R* Ra t sqlutilt unwrap_order_byRc t array_for_multi_clauseR� R; R R� RP ( R: Rg t func_clausesRc ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyRo u s ( R� R� R� R� R R8 R� Ro ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR m s t modec B s e Z d Z e Z RS( s* Implement the ``mode`` ordered-set aggregate function. This function must be used with the :meth:`.FunctionElement.within_group` modifier to supply a sort expression to operate upon. The return type of this function is the same as the sort expression. .. versionadded:: 1.1 ( R� R� R� R8 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR ~ s t percentile_contc B s e Z d Z e Z e Z RS( s� Implement the ``percentile_cont`` ordered-set aggregate function. This function must be used with the :meth:`.FunctionElement.within_group` modifier to supply a sort expression to operate upon. The return type of this function is the same as the sort expression, or if the arguments are an array, an :class:`_types.ARRAY` of the sort expression's type. .. versionadded:: 1.1 ( R� R� R� R8 R R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR � s t percentile_discc B s e Z d Z e Z e Z RS( s� Implement the ``percentile_disc`` ordered-set aggregate function. This function must be used with the :meth:`.FunctionElement.within_group` modifier to supply a sort expression to operate upon. The return type of this function is the same as the sort expression, or if the arguments are an array, an :class:`_types.ARRAY` of the sort expression's type. .. versionadded:: 1.1 ( R� R� R� R8 R R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR � s t rankc B s e Z d Z e j � Z e Z RS( s! Implement the ``rank`` hypothetical-set aggregate function. This function must be used with the :meth:`.FunctionElement.within_group` modifier to supply a sort expression to operate upon. The return type of this function is :class:`.Integer`. .. versionadded:: 1.1 ( R� R� R� R R� RP R8 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR � s t dense_rankc B s e Z d Z e j � Z e Z RS( s' Implement the ``dense_rank`` hypothetical-set aggregate function. This function must be used with the :meth:`.FunctionElement.within_group` modifier to supply a sort expression to operate upon. The return type of this function is :class:`.Integer`. .. versionadded:: 1.1 ( R� R� R� R R� RP R8 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR � s t percent_rankc B s e Z d Z e j � Z e Z RS( s) Implement the ``percent_rank`` hypothetical-set aggregate function. This function must be used with the :meth:`.FunctionElement.within_group` modifier to supply a sort expression to operate upon. The return type of this function is :class:`.Numeric`. .. versionadded:: 1.1 ( R� R� R� R t NumericRP R8 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR � s t cume_distc B s e Z d Z e j � Z e Z RS( s& Implement the ``cume_dist`` hypothetical-set aggregate function. This function must be used with the :meth:`.FunctionElement.within_group` modifier to supply a sort expression to operate upon. The return type of this function is :class:`.Numeric`. .. versionadded:: 1.1 ( R� R� R� R R RP R8 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR � s t cubec B s e Z d Z e Z e Z RS( sS Implement the ``CUBE`` grouping operation. This function is used as part of the GROUP BY of a statement, e.g. :meth:`_expression.Select.group_by`:: stmt = select( func.sum(table.c.value), table.c.col_1, table.c.col_2 ).group_by(func.cube(table.c.col_1, table.c.col_2)) .. versionadded:: 1.2 ( R� R� R� R8 R5 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR � s t rollupc B s e Z d Z e Z e Z RS( sW Implement the ``ROLLUP`` grouping operation. This function is used as part of the GROUP BY of a statement, e.g. :meth:`_expression.Select.group_by`:: stmt = select( func.sum(table.c.value), table.c.col_1, table.c.col_2 ).group_by(func.rollup(table.c.col_1, table.c.col_2)) .. versionadded:: 1.2 ( R� R� R� R8 R5 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR s t grouping_setsc B s e Z d Z e Z e Z RS( s Implement the ``GROUPING SETS`` grouping operation. This function is used as part of the GROUP BY of a statement, e.g. :meth:`_expression.Select.group_by`:: stmt = select( func.sum(table.c.value), table.c.col_1, table.c.col_2 ).group_by(func.grouping_sets(table.c.col_1, table.c.col_2)) In order to group by multiple sets, use the :func:`.tuple_` construct:: from sqlalchemy import tuple_ stmt = select( func.sum(table.c.value), table.c.col_1, table.c.col_2, table.c.col_3 ).group_by( func.grouping_sets( tuple_(table.c.col_1, table.c.col_2), tuple_(table.c.value, table.c.col_3), ) ) .. versionadded:: 1.2 ( R� R� R� R8 R5 R� ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyR s N(V R� t R R R R R R R R t baseR R R R R t elementsR R R R R R R R R R R R R t selectableR R R t visitorsR R t defaultdictt dictR R( R) Rj RH t objectR� R� R� t modifierR� R� t with_metaclassR� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R R R R R R R R R R R ( ( ( sK /opt/alt/python27/lib64/python2.7/site-packages/sqlalchemy/sql/functions.pyt <module> s� � � k'v d"v & +