o g 6@sddlmZddlZddlmZddlmZddlmZddlmZddlm Z dd lm Z d d l m Z d d l mZd d lmZd dlmZd dlmZededZejfddZejfddZGdddejeZGddde jZddZdS)) annotationsN)Any)Optional)TypeVar) CONTAINED_BY)CONTAINS)OVERLAP)types)util) expression) operators)_TypeEngineArgument_T)boundcC |||S)zjA synonym for the ARRAY-level :meth:`.ARRAY.Comparator.any` method. See that method for details. )anyotherarrexproperatorr`/var/www/html/flaskapp/venv/lib/python3.10/site-packages/sqlalchemy/dialects/postgresql/array.pyr rcCr)zjA synonym for the ARRAY-level :meth:`.ARRAY.Comparator.all` method. See that method for details. )allrrrrAll'rrcsLeZdZdZdZdZdZfddZeddZ dd d Z dd d Z Z S)arraya0A PostgreSQL ARRAY literal. This is used to produce ARRAY literals in SQL expressions, e.g.:: from sqlalchemy.dialects.postgresql import array from sqlalchemy.dialects import postgresql from sqlalchemy import select, func stmt = select(array([1, 2]) + array([3, 4, 5])) print(stmt.compile(dialect=postgresql.dialect())) Produces the SQL: .. sourcecode:: sql SELECT ARRAY[%(param_1)s, %(param_2)s] || ARRAY[%(param_3)s, %(param_4)s, %(param_5)s]) AS anon_1 An instance of :class:`.array` will always have the datatype :class:`_types.ARRAY`. The "inner" type of the array is inferred from the values present, unless the ``type_`` keyword argument is passed:: array(["foo", "bar"], type_=CHAR) Multidimensional arrays are produced by nesting :class:`.array` constructs. The dimensionality of the final :class:`_types.ARRAY` type is calculated by recursively adding the dimensions of the inner :class:`_types.ARRAY` type:: stmt = select( array( [array([1, 2]), array([3, 4]), array([column("q"), column("x")])] ) ) print(stmt.compile(dialect=postgresql.dialect())) Produces: .. sourcecode:: sql SELECT ARRAY[ ARRAY[%(param_1)s, %(param_2)s], ARRAY[%(param_3)s, %(param_4)s], ARRAY[q, x] ] AS anon_1 .. versionadded:: 1.3.6 added support for multidimensional array literals .. seealso:: :class:`_postgresql.ARRAY` postgresqlTc s|dd}tjtjg|Ri|dd|jD|_|dur#|n |jr+|jdntj}t |t rGt |j |j dur@|j dndd|_ dSt ||_ dS)Ntype_cSsg|]}|jqSr)type).0argrrr rsz"array.__init__..rr) dimensions)popsuper__init__rcomma_opclauses _type_tuplesqltypesNULLTYPE isinstanceARRAY item_typer%r )selfr*kwtype_arg main_type __class__rrr(ns      zarray.__init__cCs|fSNrr1rrr_select_iterablezarray._select_iterableFNcs@|stjurtjd|jddStfdd|DS)NT)_compared_to_operatorr_compared_to_typeuniquecsg|] }j|ddqS)T)_assume_scalarr) _bind_param)r!orr1rrrr#s z%array._bind_param..)rgetitemr BindParameterr r)r1robjr>rrrArr?s zarray._bind_paramcCs"|tjtjtjfvrt|S|Sr7)rany_opall_oprBr Grouping)r1againstrrr self_groups zarray.self_group)FNr7) __name__ __module__ __qualname____doc____visit_name__stringify_dialect inherit_cacher(propertyr9r?rI __classcell__rrr5rr0s8   rc@seZdZdZ   ddd d ZGd ddejjZeZe ddZ e ddZ ddZ e jddZddZddZddZdS)r/an PostgreSQL ARRAY type. The :class:`_postgresql.ARRAY` type is constructed in the same way as the core :class:`_types.ARRAY` type; a member type is required, and a number of dimensions is recommended if the type is to be used for more than one dimension:: from sqlalchemy.dialects import postgresql mytable = Table( "mytable", metadata, Column("data", postgresql.ARRAY(Integer, dimensions=2)), ) The :class:`_postgresql.ARRAY` type provides all operations defined on the core :class:`_types.ARRAY` type, including support for "dimensions", indexed access, and simple matching such as :meth:`.types.ARRAY.Comparator.any` and :meth:`.types.ARRAY.Comparator.all`. :class:`_postgresql.ARRAY` class also provides PostgreSQL-specific methods for containment operations, including :meth:`.postgresql.ARRAY.Comparator.contains` :meth:`.postgresql.ARRAY.Comparator.contained_by`, and :meth:`.postgresql.ARRAY.Comparator.overlap`, e.g.:: mytable.c.data.contains([1, 2]) Indexed access is one-based by default, to match that of PostgreSQL; for zero-based indexed access, set :paramref:`_postgresql.ARRAY.zero_indexes`. Additionally, the :class:`_postgresql.ARRAY` type does not work directly in conjunction with the :class:`.ENUM` type. For a workaround, see the special type at :ref:`postgresql_array_of_enum`. .. container:: topic **Detecting Changes in ARRAY columns when using the ORM** The :class:`_postgresql.ARRAY` type, when used with the SQLAlchemy ORM, does not detect in-place mutations to the array. In order to detect these, the :mod:`sqlalchemy.ext.mutable` extension must be used, using the :class:`.MutableList` class:: from sqlalchemy.dialects.postgresql import ARRAY from sqlalchemy.ext.mutable import MutableList class SomeOrmClass(Base): # ... data = Column(MutableList.as_mutable(ARRAY(Integer))) This extension will allow "in-place" changes such to the array such as ``.append()`` to produce events which will be detected by the unit of work. Note that changes to elements **inside** the array, including subarrays that are mutated in place, are **not** detected. Alternatively, assigning a new array value to an ORM element that replaces the old one will always trigger a change event. .. seealso:: :class:`_types.ARRAY` - base array type :class:`_postgresql.array` - produces a literal array value. FNr0_TypeEngineArgument[Any]as_tupleboolr% Optional[int] zero_indexescCs>t|tr tdt|tr|}||_||_||_||_dS)a-Construct an ARRAY. E.g.:: Column("myarray", ARRAY(Integer)) Arguments are: :param item_type: The data type of items of this array. Note that dimensionality is irrelevant here, so multi-dimensional arrays like ``INTEGER[][]``, are constructed as ``ARRAY(Integer)``, not as ``ARRAY(ARRAY(Integer))`` or such. :param as_tuple=False: Specify whether return results should be converted to tuples from lists. DBAPIs such as psycopg2 return lists by default. When tuples are returned, the results are hashable. :param dimensions: if non-None, the ARRAY will assume a fixed number of dimensions. This will cause the DDL emitted for this ARRAY to include the exact number of bracket clauses ``[]``, and will also optimize the performance of the type overall. Note that PG arrays are always implicitly "non-dimensioned", meaning they can store any number of dimensions no matter how they were declared. :param zero_indexes=False: when True, index values will be converted between Python zero-based and PostgreSQL one-based indexes, e.g. a value of one will be added to all index values before passing to the database. zUDo not nest ARRAY types; ARRAY(basetype) handles multi-dimensional arrays of basetypeN)r.r/ ValueErrorr r0rTr%rW)r1r0rTr%rWrrrr(s '  zARRAY.__init__c@s(eZdZdZddZddZddZdS) zARRAY.Comparatora*Define comparison operations for :class:`_types.ARRAY`. Note that these operations are in addition to those provided by the base :class:`.types.ARRAY.Comparator` class, including :meth:`.types.ARRAY.Comparator.any` and :meth:`.types.ARRAY.Comparator.all`. cK|jt|tjdS)zBoolean expression. Test if elements are a superset of the elements of the argument array expression. kwargs may be ignored by this operator but are required for API conformance.  result_type)operaterr,Boolean)r1rkwargsrrrcontains+szARRAY.Comparator.containscCrY)zBoolean expression. Test if elements are a proper subset of the elements of the argument array expression. rZ)r\rr,r]r1rrrr contained_by4szARRAY.Comparator.contained_bycCrY)zuBoolean expression. Test if array has elements in common with an argument array expression. rZ)r\r r,r]r`rrroverlap<szARRAY.Comparator.overlapN)rJrKrLrMr_rarbrrrr Comparator!s   rccCs|jSr7)rTr8rrrhashableDr:zARRAY.hashablecCstSr7)listr8rrr python_typeHszARRAY.python_typecCs||kSr7r)r1xyrrrcompare_valuesLszARRAY.compare_valuescCst|jtjo |jjSr7)r.r0r,Enum native_enumr8rrr_against_native_enumOszARRAY._against_native_enumcs:j||durdSddfdd}|S)NcSsdd|dS)NzARRAY[z, ])join)elementsrrrto_str]sz'ARRAY.literal_processor..to_strcs|j}|Sr7)_apply_item_processorr%valueinner item_procr1rprrprocess`s z(ARRAY.literal_processor..process)r0 dialect_implliteral_processorr1dialectrwrrurryVs zARRAY.literal_processorcs$j||fdd}|S)Ncs|dur|S|jtSr7)rqr%rersrvr1rrrwms  z%ARRAY.bind_processor..process)r0rxbind_processorrzrr}rr~hs zARRAY.bind_processorcsTj|||fdd}jr(|tdfddfdd}|S)Ncs*|dur|S|jjrtStSr7)rqr%rTtuplerer|r}rrrw|sz'ARRAY.result_processor..processz^{(.*)}$cs|d}t|S)Nr)matchgroup_split_enum_valuesrr)patternrrhandle_raw_stringsz1ARRAY.result_processor..handle_raw_stringcs(|dur|St|tr|S|Sr7)r.strr|)rsuper_rprrrws)r0rxresult_processorrlrecompile)r1r{coltyperwr)rrvrr1rrrws     zARRAY.result_processor)FNF)r0rSrTrUr%rVrWrU)rJrKrLrMr(r,r/rccomparator_factoryrQrdrfrir memoized_propertyrlryr~rrrrrr/s$J 3!    r/cCsd|vr |r |dSgS|dd}|dd}g}td|}d}|D]}|dkr/| }q%|r;||ddq%|td |q%|S) N",z\"z _$ESC_QUOTE$_z\\\z(")Fz ([^\s,]+),?)splitreplacerappendextendfindall) array_stringtextresult on_quotes in_quotestokrrrrs   r) __future__rrtypingrrrrrrr r r,r sqlr sql._typingrreqrExpressionClauseListrr/rrrrrs(               v y