+h[dZddlZddlZddlZddlmZddlmZddlmZddlm Z ddlm Z dd lm Z dd lm Z dd lm Z d d lmZd dlmZd dlmZd dlmZdZdZdZej*dZej*dZGddeZGddeZdZdZdZdZdZdZ dZ!dZ"Gdd ejFjHZ%Gd!d"ejFjHZ&ejNd#d$Z(Gd%d&eZ)Gd'd(eZ*Gd)d*eZ+Gd+d,eZ,Gd-d.e+Z-Gd/d0e.Z/Gd1d2ej`e/Z1Gd3d4e1eZ2Gd5d6e Z3Gd7d8ejhe+Z5Gd9d:e6Z7Gd;de Z9Gd?d@eZ:GdAdBe:Z;GdCdDejxe:Z=GdEdFej|Z?dJdGZ@dHZAefdIZBy)Kz4Foundational utilities common to many sql modules. N)roles)visitors) HasCacheKey)HasCopyInternals)MemoizedHasCacheKey) ClauseVisitor)ExtendedInternalTraversal)InternalTraversal)exc)util) HasMemoized) hybridmethodPARSE_AUTOCOMMITNO_ARGc,eZdZdZdZdZdZdZdZy) Immutablez@mark a ClauseElement as 'immutable' when expressions are cloned.TctdNz(Immutable objects do not support copyingNotImplementedErrorself optionaldictkwargss F/var/www/html/venv/lib/python3.12/site-packages/sqlalchemy/sql/base.py unique_paramszImmutable.unique_params,!"LMMctdrrrs rparamszImmutable.params/rr c |SNrkws r_clonezImmutable._clone2s r c yr$r%r&s r_copy_internalszImmutable._copy_internals5s r N) __name__ __module__ __qualname____doc__ _is_immutablerr"r(r*r%r rrr's JMNN r rc*eZdZdZdZdZedZy)SingletonConstantz.Represent SQL constants like NULL, TRUE, FALSETc|jSr$) _singleton)clsargr's r__new__zSingletonConstant.__new__>s ~~r c~tj|}|jt|g|_||_yr$)objectr6__init__ frozenset proxy_setr3)r4objs r_create_singletonz#SingletonConstant._create_singletonAs0nnS! "3%( r N)r+r,r-r._is_singleton_constantr6 classmethodr=r%r rr1r19s$8!  r r1cztjj|Dcgc]}|jc}Scc}wr$) itertoolschain from_iterable _from_objects)elementselements rrDrDQs0 ?? ( (.677  7 78cztjj|Dcgc]}|jc}Scc}w)zXexpand tables into individual columns in the given list of column expressions. )rArBrC_select_iterable)rEcs r_select_iterablesrKWs2 ?? ( (%-.  . .rGcPtjd}||}||_|S)znon-caching _generative() decorator. This is basically the legacy decorator that copies the object and runs a method on the new copy. cP|j}||g|i|}|Jd|S)zMark a method as generative.z,generative methods must have no return value) _generate)fnrargsr'xs r _generativez _generative.._generativeis9~~ t !d !b !yHHHy r )r decoratornon_generative)rOrR decorateds rrRrRas3 ^^BI!I r c |jdi|jdi}|Dcgc]*}|tj||j|df,c}tj fd}|Scc}w)Nmsgsdefaultsc |d}|dd}D]R\}}}|||us j|d|jd|jd}tj|||g|i|S)NrrzMethod z$() has already been invoked on this z construct)getr+ __class__r InvalidRequestError) rOrPr'rnamegetterdefault_msggettersrWs rcheckz!_exclusive_against..checksAwABx&- 3 "D&(d|8+hh{{DNN4 --c22 3$$$$$r )popoperator attrgetterrZrrS)namesr'rXr]rbrarWs @@r_exclusive_againstrgws~ 66&" Dvvj"%H  x""4((,,tT*BCG  ^^ % % L+s/A8c &|jdi|SNr%)r()rFr's rr(r(s 7>> B r c`tj|Dcgc]}|jc}Scc}w)z\expand the given set of ClauseElements to be the set of all 'cloned' predecessors. )rArB _cloned_set)rErQs r_expand_clonedrls% ??H=qQ]]= >>=s+ctt|jt|tfd|DS)zreturn 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'. c3ZK|]"}j|js|$ywr$ intersectionrk.0elem all_overlaps r z'_cloned_intersection..s)k66t7G7GH ++setrlrpabrts @r_cloned_intersectionr|s>nQ'(55nQ6GHK  r ctt|jt|tfd|DS)Nc3ZK|]"}j|jr|$ywr$rorqs rruz%_cloned_difference..s)+":":4;K;K"Lrvrwrys @r_cloned_differencers<nQ'(55nQ6GHK  r c:eZdZdZdZdZdZdZdZdZ dZ y ) _DialectArgViewzaA dictionary view of dialect-level arguments in the form _. c||_yr$)r<)rr<s rr9z_DialectArgView.__init__s r c |jdd\}}||fS#t$r*}tjt ||Yd}~yd}~wwxYw)N_rreplace_context)split ValueErrorrraise_KeyError)rkeydialect value_keyerrs r_keyz_DialectArgView._keysP &!$3!2 GYI% % < KK s ; ; !$$ < KK s ; ; _r)rr<rrrrr ArgumentError)rrvaluerrrs r __setitem__z_DialectArgView.__setitem__so A!%3 GY.s#  "" # s!)sumr<rvaluesrs r__len__z_DialectArgView.__len__s/ 00779   r cBfdjjDS)Nc3|K|]3}jj|jD] }|d| 5yw)rN)r<rr)rr dialect_name value_namers rruz+_DialectArgView.__iter__..sJ "hh66m  $Z 0 0 s9<)r<rrs`r__iter__z_DialectArgView.__iter__s $ 8 8  r N) r+r,r-r.r9rrrrrrr%r rrrs+ &" A9  r rc4eZdZdZdZdZdZdZdZdZ y) _DialectArgDictzA dictionary view of dialect-level arguments for a specific dialect. Maintains a separate collection of user-specified arguments and dialect-specified default arguments. c i|_i|_yr$r _defaultsrs rr9z_DialectArgDict.__init__sr cptt|jj|jSr$)rrxrunionrrs rrz_DialectArgDict.__len__s'3t))*00@AAr cptt|jj|jSr$)iterrxrrrrs rrz_DialectArgDict.__iter__s'C**+11$..ABBr cZ||jvr|j|S|j|Sr$rrrs rrz_DialectArgDict.__getitem__s0 $$$ $%%c* *>>#& &r c"||j|<yr$rrrrs rrz_DialectArgDict.__setitem__ s"'3r c|j|=yr$rrs rrz_DialectArgDict.__delitem__ s   s #r N) r+r,r-r.r9rrrrrr%r rrrs'BC' ($r rzsqlalchemy.dialectsctjjjj |}|j yt |j Sr$)r preloadeddialectsregistryloadconstruct_argumentsdict)r dialect_clss r_kw_reg_for_dialectrsB..))2277 EK&&.  // 00r ceZdZdZdej fgZedZe jdZ e dZ e jeZdZe jdZdZy ) DialectKWArgsa9Establish the ability for a class to have dialect-specific arguments with defaults and constructor validation. The :class:`.DialectKWArgs` interacts with the :attr:`.DefaultDialect.construct_arguments` present on a dialect. .. seealso:: :attr:`.DefaultDialect.construct_arguments` rctj|}|tjd|z||vri||<||||<y)aAdd a new kind of dialect-specific keyword argument for this class. E.g.:: Index.argument_for("mydialect", "length", None) some_index = Index('a', 'b', mydialect_length=5) The :meth:`.DialectKWArgs.argument_for` method is a per-argument way adding extra arguments to the :attr:`.DefaultDialect.construct_arguments` dictionary. This dictionary provides a list of argument names accepted by various schema-level constructs on behalf of a dialect. New dialects should typically specify this dictionary all at once as a data member of the dialect class. The use case for ad-hoc addition of argument names is typically for end-user code that is also using a custom compilation scheme which consumes the additional arguments. :param dialect_name: name of a dialect. The dialect must be locatable, else a :class:`.NoSuchModuleError` is raised. The dialect must also include an existing :attr:`.DefaultDialect.construct_arguments` collection, indicating that it participates in the keyword-argument validation and default system, else :class:`.ArgumentError` is raised. If the dialect does not include this collection, then any keyword argument can be specified on behalf of this dialect already. All dialects packaged within SQLAlchemy include this collection, however for third party dialects, support may vary. :param argument_name: name of the parameter. :param default: default value of the parameter. .. versionadded:: 0.9.4 NzRDialect '%s' does have keyword-argument validation and defaults enabled configured)r _kw_registryr r)r4r argument_namedefaultconstruct_arg_dictionarys r argument_forzDialectKWArgs.argument_for)scP$1#=#=l#K # +##=?KL  . .,. $S )7> %m4r ct|S)a9A collection of keyword arguments specified as dialect-specific options to this construct. The arguments are present here in their original ``_`` format. Only arguments that were actually passed are included; unlike the :attr:`.DialectKWArgs.dialect_options` collection, which contains all options known by this dialect including defaults. The collection is also writable; keys are accepted of the form ``_`` where the value will be assembled into the list of options. .. versionadded:: 0.9.2 .. versionchanged:: 0.9.4 The :attr:`.DialectKWArgs.dialect_kwargs` collection is now writable. .. seealso:: :attr:`.DialectKWArgs.dialect_options` - nested dictionary form )rrs rdialect_kwargszDialectKWArgs.dialect_kwargs[s0t$$r c|jS)z4A synonym for :attr:`.DialectKWArgs.dialect_kwargs`.)rrs rrzDialectKWArgs.kwargsus"""r ctj|}t}||jj ddi|St |j jD]%}||vs|jj ||'|S)N*)rrrrupdatereversedr[__mro__)rrrdr4s r_kw_reg_for_dialect_clsz%DialectKWArgs._kw_reg_for_dialect_cls|s#0#=#=l#K   # + KK  T{ +   6 67 F22KK&&'?'DE Fr cftjtj|jS)aA collection of keyword arguments specified as dialect-specific options to this construct. This is a two-level nested registry, keyed to ```` and ````. For example, the ``postgresql_where`` argument would be locatable as:: arg = my_object.dialect_options['postgresql']['where'] .. versionadded:: 0.9.2 .. seealso:: :attr:`.DialectKWArgs.dialect_kwargs` - flat dictionary form )r PopulateDictportable_instancemethodrrs rrzDialectKWArgs.dialect_optionss+&   ( ()E)E F  r c |sy|D]}tjd|}|std|z|jdd\}} |j|}d|vr,||vr(t j d|d|d|j||||<y#t j$rgtjd |d |tx|j|<}|jjddi|||j|<YwxYw) Nz ^(.+?)_(.+)$zGAdditional arguments should be named _, got '%s'rr rz Argument z is not accepted by dialect z on behalf of zCan't validate argument z,; can't locate any SQLAlchemy dialect named )rematch TypeErrorgrouprr rr[rrwarnrrrr)rrkmrarg_namerrs r_validate_dialect_kwargsz&DialectKWArgs._validate_dialect_kwargss3  CA+A?ABC&'WWQ] "L( C+/+?+? +M(77 (@@++lDNN< :@,X6? C(( 6 ,( :I9JJ$$\2Q ""C;/,21I) 6sBA6D D N)r+r,r-r.r dp_dialect_options"_dialect_kwargs_traverse_internalsr?rrmemoized_propertyrpropertyrrrrrrrr%r rrrs  -@@A*&/?/?b %%2##%4$$%89L    ,%Cr rc^eZdZdZdZiZedZdZedZ edZ edZ y) CompileStateaProduces additional object state necessary for a statement to be compiled. the :class:`.CompileState` class is at the base of classes that assemble state for a particular statement object that is then used by the compiler. This process is essentially an extension of the process that the SQLCompiler.visit_XYZ() method takes, however there is an emphasis on converting raw user intent into more organized structures rather than producing string output. The top-level :class:`.CompileState` for the statement being executed is also accessible when the execution context works with invoking the statement and collecting results. The production of :class:`.CompileState` is specific to the compiler, such as within the :meth:`.SQLCompiler.visit_insert`, :meth:`.SQLCompiler.visit_select` etc. methods. These methods are also responsible for associating the :class:`.CompileState` with the :class:`.SQLCompiler` itself, if the statement is the "toplevel" statement, i.e. the outermost SQL statement that's actually being executed. There can be other :class:`.CompileState` objects that are not the toplevel, such as when a SELECT subquery or CTE-nested INSERT/UPDATE/DELETE is generated. .. versionadded:: 1.4  statementc X|jrb|jjdd}|jj||jfd}|7|jd|jf}n|jd|jf}||ur |||fi|S|j||fi|SNcompile_state_pluginr)_propagate_attrsrZplugins_effective_plugin_targetcreate_for_statement)r4rcompilerr' plugin_nameklasss rrz!CompileState.create_for_statements  % %#4488& KKKOOi@@A4E}  B BC KKI>>?E C<y(1b1 1-5--iHRH Hr c ||_yr$r)rrrr's rr9zCompileState.__init__s "r c|jjdd}|r+||jf}||jvr|j|S |jd|jfS#t$rYywxYwr)rrZrrr)r4rrrs rget_plugin_classzCompileState.get_plugin_classs~0044 "D   B BCCckk!{{3''  ;; 9+M+MNO O  s A&& A21A2cX |j||jfS#t$rYywxYwr$)rrr)r4rrs r_get_plugin_class_for_pluginz)CompileState._get_plugin_class_for_plugins: ;;i@@A   s  ))cfd}|S)Nc*|jf<|Sr$)r)cls_to_decorater4r visit_names rdecoratez)CompileState.plugin_for..decorate"s5DCKKj1 2" "r r%)r4rrrs``` r plugin_forzCompileState.plugin_for s #r N) r+r,r-r. __slots__rr?rr9rrrr%r rrrsh4IGII2#&r rceZdZdZdZy) GenerativezUProvide a method-chaining pattern in conjunction with the @_generative decorator.c6|j}|j}|j|}|rH|jj j Dcic] \}}||vs ||c}}|_|S|jj |_|Scc}}wr$)_memoized_keysr[r6__dict__copyitems)rskipr4srvs rrNzGenerative._generate-s""nn KK  "&!3!3!5!;!;!=A$1AJ ++-AJ s  B$BNr+r,r-r.rNr%r rrr)s  r rceZdZdZdZy)InPlaceGenerativezkProvide a method-chaining pattern in conjunction with the @_generative decorator that mutates in place.cd|j}|D]}|jj|d |Sr$)rrrc)rrrs rrNzInPlaceGenerative._generate?s5"" 'A MM  a & ' r Nrr%r rr r ;s 5r r cNeZdZdZdZej ZejZ y)HasCompileStatez=A class that has a :class:`.CompileState` associated with it.N) r+r,r-r._compile_state_pluginr immutabledict _attributesrr_compile_state_factoryr%r rr r Fs'G $$$$&K)>>r r ceZdZdZdZdZy) _MetaOptionsz metaclass for the Options class.ctttd|D|_tj ||||y)Nc3JK|]}|jds|dvr|yw)__)_cache_key_traversalN) startswith)rrrs rruz(_MetaOptions.__init__..Us-||D)66s!#)tuplesorted _cache_attrstyper9)r4 classnamebasesdict_s rr9z_MetaOptions.__init__Ss8    c9eU3r c|}t|j|jr3td|dt|j|j|jj ||SNz.s3 %dmmA./s,/))r[r+joinrrs`r__repr__zOptions.__repr__s; NN # # II**   r ct||Sr$) issubclass)r4rs r isinstancezOptions.isinstances#u%%r c*||t|||zizSr$)r.)rr]rs radd_to_elementzOptions.add_to_elementstWT4058999r c|jSr$r5rs r _state_dictzOptions._state_dicts }}r c|jSr$)_state_dict_const)r4s rr?zOptions._state_dicts$$$r c <|j}||jurz|jrnt|jj |jr@t d|d|dt|jj |j||zS)Nzother element z is not empty, is not of type z+, and contains attributes not covered here )r?r[rrxr"r)r4r$rs r safe_mergezOptions.safe_merges     u &""E&&'2233C3CD**+66s7G7GH  Qwr c2|jt|j|}|j||}|rWi}|D]!}d|z} ||vr |||| <||vs|||| <#||z} t j j ||| i}| |fS||fS)a{process Options argument in terms of execution options. e.g.:: ( load_options, execution_options, ) = QueryContext.default_load_options.from_execution_options( "_sa_orm_load_options", { "populate_existing", "autoflush", "yield_per" }, execution_options, statement._execution_options, ) get back the Options and refresh "_sa_orm_load_options" in the exec options dict w/ the Options as well r)rprxrrZrr merge_with) r4rattrs exec_optionsstatement_exec_optionscheck_argnamesexisting_optionsresultargnamelocal new_optionss rfrom_execution_optionszOptions.from_execution_optionss<++   # #$: ; (++C5 F) Dg l*$0$9F5M 66$:7$CF5M  D+V3K--/::sK0L , ,$\1 1r N)r+r,r-r.r9r&r/r8r?r;rr=r?rrrA classlevelrCrOr%r rr(r(ls6!   &&::+**,%%03232r r(cPeZdZedZej dZedZy)CacheableOptionsc0tj|||Sr$)r_gen_cache_key)ranon_map bindparamss rrTzCacheableOptions._gen_cache_keys))$*EEr c |dfSrir%)r4rUrVs rrTzCacheableOptions._gen_cache_keys Ryr c,tj|Sr$)r_generate_cache_key_for_objectrs r_generate_cache_keyz$CacheableOptions._generate_cache_keys99$??r N)r+r,r-rrTrPrZr%r rrRrRsFFF@@r rRc2eZdZejZdZdZdZy)ExecutableOptionexecutable_optionFc |jj|j}t|j|_|S)z/Create a shallow copy of this ExecutableOption.)r[r6rr)rr'rJs rr(zExecutableOption._clone s/ NN " "4>> 2$--( r N) r+r,r-r EMPTY_DICT _annotations__visit_name___is_has_cache_keyr(r%r rr\r\s??L(Nr r\ceZdZdZdZej ZdZdZ dZ de jfde jfde jfgZdZdZdZdZdZdZed Zed Zed Zed Zed ZedZdZej@dddZ!ej@dddZ"eej@ddddZ#y) ExecutablezMark a :class:`_expression.ClauseElement` as supporting execution. :class:`.Executable` is a superclass for all "statement" types of objects, including :func:`select`, :func:`delete`, :func:`update`, :func:`insert`, :func:`text`. TNr% _with_options_with_context_optionsrFc|jSr$)rars rrz#Executable._effective_plugin_target1s"""r cN|xjtd|Dz c_y)aKApply options to this statement. In the general sense, options are any kind of Python object that can be interpreted by the SQL compiler for the statement. These options can be consumed by specific dialects or specific kinds of compilers. The most commonly known kind of option are the ORM level options that apply "eager load" and other loading behaviors to an ORM query. However, options can theoretically be used for many other purposes. For background on specific kinds of options for specific kinds of statements, refer to the documentation for those option objects. .. versionchanged:: 1.4 - added :meth:`.Generative.options` to Core statement objects towards the goal of allowing unified Core / ORM querying capabilities. .. seealso:: :ref:`deferred_options` - refers to options specific to the usage of ORM queries :ref:`relationship_loader_options` - refers to options specific to the usage of ORM queries c3dK|](}tjtj|*ywr$) coercionsexpectrExecutableOptionRole)rrrs rruz%Executable.options..Ss+$    U77 =$ s.0N)rerroptionss rrnzExecutable.options5s)< e$ $   r c||_y)z|Assign the compile options to a new value. :param compile_options: appropriate CacheableOptions structure N_compile_options)rcompile_optionss r_set_compile_optionszExecutable._set_compile_optionsXs !0r c.|xj|z c_y)z*update the _compile_options with new keys.Nrprms r_update_compile_optionsz"Executable._update_compile_optionsbs (r c4|xj||ffz c_y)aMAdd a context option to this statement. These are callable functions that will be given the CompileState object upon compilation. A second argument cache_args is required, which will be combined with the ``__code__`` identity of the function itself in order to produce a cache key. N)rf)r callable_ cache_argss r_add_context_optionzExecutable._add_context_optionhs "" :'>&@@"r c d|vrtjdd|vrtjd|jj||_y)aSet non-SQL options for the statement which take effect during execution. Execution options can be set on a per-statement or per :class:`_engine.Connection` basis. Additionally, the :class:`_engine.Engine` and ORM :class:`~.orm.query.Query` objects provide access to execution options which they in turn configure upon connections. The :meth:`execution_options` method is generative. A new instance of this statement is returned that contains the options:: statement = select(table.c.x, table.c.y) statement = statement.execution_options(autocommit=True) Note that only a subset of possible execution options can be applied to a statement - these include "autocommit" and "stream_results", but not "isolation_level" or "compiled_cache". See :meth:`_engine.Connection.execution_options` for a full list of possible options. .. seealso:: :meth:`_engine.Connection.execution_options` :meth:`_query.Query.execution_options` :meth:`.Executable.get_execution_options` isolation_levelz'isolation_level' execution option may only be specified on Connection.execution_options(), or per-engine using the isolation_level argument to create_engine().compiled_cachezm'compiled_cache' execution option may only be specified on Connection.execution_options(), not per statement.N)r r_execution_optionsrr&s rexecution_optionszExecutable.execution_optionsvscB  "##/  r !##H #'"9"9"?"?"Cr c|jS)zGet the non-SQL options which will take effect during execution. .. versionadded:: 1.3 .. seealso:: :meth:`.Executable.execution_options` )r}rs rget_execution_optionsz Executable.get_execution_optionss&&&r z:meth:`.Executable.execute`zAll 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`.) alternativec|j}|?t|ddxs|jj}d|z}t j ||j |||tjS)z.Compile and execute this :class:`.Executable`.N descriptionzThis %s is not directly bound to a Connection or Engine. Use the .execute() method of a Connection or Engine to execute this construct.) bindr.r[r+r UnboundExecutionError_execute_clauseelementrr)r multiparamsr"elabelr`s rexecutezExecutable.executes| II 9mT2Mdnn6M6M -/45  ++C0 0'' +vt'9'9';  r z:meth:`.Executable.scalar`zScalar 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`.cB|j|i|jS)znCompile and execute this :class:`.Executable`, returning the result's scalar representation. )rscalar)rrr"s rrzExecutable.scalars#t||[3F3::< " to produce new symbols "_", where "index" is an incrementing integer corresponding to . Inlines the approach taken by :class:`sqlalchemy.util.PopulateDict` which is otherwise usually used for this type of operation. c|jdd\}}|j|d}|dz||<|dzt|z}|||<|S)N rr)rrZstr)rridentderivedanonymous_counterrs r __missing__zprefix_anon_map.__missing__sX99S!, HHWa0)A-W # $5 66S  r N)r+r,r-r.rr%r rrrs  r rceZdZdZdZdZy)SchemaEventTargetzBase class for elements that are the targets of :class:`.DDLEvents` events. This includes :class:`.SchemaItem` as well as :class:`.SchemaType`. c y)z0Associate with this SchemaEvent's parent object.Nr%rparentr's r _set_parentzSchemaEventTarget._set_parentsr c |jj|||j|fi||jj||yr$)dispatchbefore_parent_attachrafter_parent_attachrs r_set_parent_with_dispatchz+SchemaEventTarget._set_parent_with_dispatchs? **48&2& ))$7r N)r+r,r-r.rrr%r rrr s?8r rceZdZdZddiZy) SchemaVisitorz/Define the visiting for ``SchemaItem`` objects.schema_visitorTN)r+r,r-r.__traverse_options__r%r rrrs9,d3r rceZdZdZdZd!dZdZedZdZ dZ d Z d Z d Z d Zd ZdZdZdZdZd!dZdZdZdZdZdZdZdZdZdZd!dZdZdZ dZ!dZ"d"d Z#y)#ColumnCollectionaCollection of :class:`_expression.ColumnElement` instances, typically for :class:`_sql.FromClause` objects. The :class:`_sql.ColumnCollection` object is most commonly available as the :attr:`_schema.Table.c` or :attr:`_schema.Table.columns` collection on the :class:`_schema.Table` object, introduced at :ref:`metadata_tables_and_columns`. The :class:`_expression.ColumnCollection` has both mapping- and sequence- like behaviors. A :class:`_expression.ColumnCollection` usually stores :class:`_schema.Column` objects, which are then accessible both via mapping style access as well as attribute access style. To access :class:`_schema.Column` objects using ordinary attribute-style access, specify the name like any other object attribute, such as below a column named ``employee_name`` is accessed:: >>> employee_table.c.employee_name To access columns that have names with special characters or spaces, index-style access is used, such as below which illustrates a column named ``employee ' payment`` is accessed:: >>> employee_table.c["employee ' payment"] As the :class:`_sql.ColumnCollection` object provides a Python dictionary interface, common dictionary method names like :meth:`_sql.ColumnCollection.keys`, :meth:`_sql.ColumnCollection.values`, and :meth:`_sql.ColumnCollection.items` are available, which means that database columns that are keyed under these names also need to use indexed access:: >>> employee_table.c["values"] The name for which a :class:`_schema.Column` would be present is normally that of the :paramref:`_schema.Column.key` parameter. In some contexts, such as a :class:`_sql.Select` object that uses a label style set using the :meth:`_sql.Select.set_label_style` method, a column of a certain key may instead be represented under a particular label name such as ``tablename_columnname``:: >>> from sqlalchemy import select, column, table >>> from sqlalchemy import LABEL_STYLE_TABLENAME_PLUS_COL >>> t = table("t", column("c")) >>> stmt = select(t).set_label_style(LABEL_STYLE_TABLENAME_PLUS_COL) >>> subq = stmt.subquery() >>> subq.c.t_c :class:`.ColumnCollection` also indexes the columns in order and allows them to be accessible by their integer position:: >>> cc[0] Column('x', Integer(), table=None) >>> cc[1] Column('y', Integer(), table=None) .. versionadded:: 1.4 :class:`_expression.ColumnCollection` allows integer-based index access to the collection. Iterating the collection yields the column expressions in order:: >>> list(cc) [Column('x', Integer(), table=None), Column('y', Integer(), table=None)] The base :class:`_expression.ColumnCollection` object can store duplicates, which can mean either two columns with the same key, in which case the column returned by key access is **arbitrary**:: >>> x1, x2 = Column('x', Integer), Column('x', Integer) >>> cc = ColumnCollection(columns=[(x1.name, x1), (x2.name, x2)]) >>> list(cc) [Column('x', Integer(), table=None), Column('x', Integer(), table=None)] >>> cc['x'] is x1 False >>> cc['x'] is x2 True Or it can also mean the same column multiple times. These cases are supported as :class:`_expression.ColumnCollection` is used to represent the columns in a SELECT statement which may include duplicates. A special subclass :class:`.DedupeColumnCollection` exists which instead maintains SQLAlchemy's older behavior of not allowing duplicates; this collection is used for schema level objects like :class:`_schema.Table` and :class:`.PrimaryKeyConstraint` where this deduping is helpful. The :class:`.DedupeColumnCollection` class also has additional mutation methods as the schema constructs have more use cases that require removal and replacement of columns. .. versionchanged:: 1.4 :class:`_expression.ColumnCollection` now stores duplicate column keys as well as the same column in multiple positions. The :class:`.DedupeColumnCollection` class is added to maintain the former behavior in those cases where deduplication as well as additional replace/remove operations are needed. ) _collection_index_colsetNctj|dttj|ditj|dg|r|j|yy)Nrrr)r8 __setattr__rx_initial_populate)rcolumnss rr9zColumnCollection.__init__sP4CE242.43   " "7 + r c&|j|yr$_populate_separate_keysriter_s rrz"ColumnCollection._initial_populates $$U+r cL|jDcgc]\}}| c}}Scc}}wr$rrrcols r _all_columnszColumnCollection._all_columnss $($4$45C555 cL|jDcgc]\}}| c}}Scc}}w)zQReturn a sequence of string key names for all columns in this collection.rrs rkeyszColumnCollection.keyss"#'"2"23hq#333rcL|jDcgc]\}}| c}}Scc}}w)zReturn a sequence of :class:`_sql.ColumnClause` or :class:`_schema.Column` objects for all columns in this collection.rrs rrzColumnCollection.valuess"%)$4$45C555rc,t|jS)zReturn a sequence of (key, column) tuples for all columns in this collection each consisting of a string key name and a :class:`_sql.ColumnClause` or :class:`_schema.Column` object. )listrrs rrzColumnCollection.itemssD$$%%r c,t|jSr$)boolrrs r__bool__zColumnCollection.__bool__sD$$%%r c,t|jSr$)rrrs rrzColumnCollection.__len__s4##$$r c^t|jDcgc]\}}| c}}Scc}}wr$)rrrs rrzColumnCollection.__iter__s%t'7'78VQS8998s ) c |j|S#t$rF}t|tjr!tj t ||nYd}~yd}~wwxYwr)rrr;r int_typesr IndexErrorrrrs rrzColumnCollection.__getitem__sO ;;s# # #t~~. JsOSAB s A .s+c!f+sr6)r[r+r7rs r__str__zColumnCollection.__str__s+ NN # # II+d+ +  r ctr$rrs rrzColumnCollection.__setitem__ !##r ctr$rrs rrzColumnCollection.__delitem__rr ctr$r)rrr<s rrzColumnCollection.__setattr__rr ct)zQDictionary clear() is not implemented for :class:`_sql.ColumnCollection`.rrs rclearzColumnCollection.clear "##r ct)zRDictionary remove() is not implemented for :class:`_sql.ColumnCollection`.r)rcolumns rremovezColumnCollection.removerr ct)zRDictionary update() is not implemented for :class:`_sql.ColumnCollection`.rrs rrzColumnCollection.updaterr ct|}||jdd|jjd|jD|jjdt |jD|jjt |jDcic]\}}|| c}}ycc}}w)*populate from an iterator of (key, column)Nc3&K|] \}}| ywr$r%rrrrJs rruz;ColumnCollection._populate_separate_keys..s;$!QA;c30K|]\}\}}||fywr$r%rridxrrJs rruz;ColumnCollection._populate_separate_keys..! $fq!S!H )rrrrr enumerater)rrcolsrrs rrz(ColumnCollection._populate_separate_keys sE{" ;$*:*:;;  (1$2B2B(C   $:J:J1KLvq#AsFLMLs) B? c| |j}t|j}|jj||f|jj |||j |<||j vr||j |<yy)aAdd a column to this :class:`_sql.ColumnCollection`. .. note:: This method is **not normally used by user-facing code**, as the :class:`_sql.ColumnCollection` is usually part of an existing object such as a :class:`_schema.Table`. To add a :class:`_schema.Column` to an existing :class:`_schema.Table` object, use the :meth:`_schema.Table.append_column` method. N)rrrappendraddr)rrrrs rrzColumnCollection.addsx ;**C   ! f .   A dkk !%DKK  "r c4|j|jdS)Nrrrrs r __getstate__zColumnCollection.__getstate__,s#//4;;GGr c tj|d|dtj|d|dtj|d|jDchc]\}}| c}}ycc}}w)Nrrr)r8rr)rstaterrs r __setstate__zColumnCollection.__setstate__/s\45?;4m0DE )0@0@AfacA As A*c||jvr0t|tjrt j dyy)z3Checks if a column object exists in this collectionzZcontains_column cannot be used with string arguments. Use ``col_name in table.c`` instead.FT)rr;rrr rrrs rcontains_columnz ColumnCollection.contains_column6s> dll "#t001'';r ct|S)zJReturn an "immutable" form of this :class:`_sql.ColumnCollection`.)ImmutableColumnCollectionrs r as_immutablezColumnCollection.as_immutableBs)..r c Ld}||jvr|Sd\}}|j}|jDcgc]\}}| } }}| D]K}tt |j} |j | } | s6|r || |sB||| }}It | t |kDr|| }}e| |k(sktjtj|jD cgc]/} | j|r| jjdd1c} } tjtj|jD cgc]/} | j|r| jjdd1c} }|| ksH|| }}N|Scc}}wcc} wcc} w)aGiven a :class:`_expression.ColumnElement`, return the exported :class:`_expression.ColumnElement` object from this :class:`_expression.ColumnCollection` which corresponds to that original :class:`_expression.ColumnElement` via a common ancestor column. :param column: the target :class:`_expression.ColumnElement` to be matched. :param require_embedded: only return corresponding columns for the given :class:`_expression.ColumnElement`, if the given :class:`_expression.ColumnElement` is actually present within a sub-element of this :class:`_expression.Selectable`. Normally the column will match if it merely shares a common ancestor with one of the exported columns of this :class:`_expression.Selectable`. .. seealso:: :meth:`_expression.Selectable.corresponding_column` - invokes this method against the collection returned by :attr:`_expression.Selectable.exported_columns`. .. versionchanged:: 1.4 the implementation for ``corresponding_column`` was moved onto the :class:`_expression.ColumnCollection` itself. c||j|D](}tt|gj|r(yyr,)r"rxrlrp)expanded_proxy_set target_setts rembeddedz7ColumnCollection.corresponding_column..embeddedhsD**+=> !>1#./<<&!  ! r )NNweightr)rr;rrxrlrprrreducerdr_uncached_proxy_listshares_lineager`rZ)rrrequire_embeddedrr intersectrrrJrrisc col_distance c_distances rcorresponding_columnz%ColumnCollection.corresponding_columnHs@  T\\ !M#Y%% $ 0 01fq!110 .A!$^AKK%@!A ''(:;A$. ;;&'CVc)n,&'C)^$(;; '*&>&>&@ "!008OO//!<$L"& '(&<&<&> "!008OO//!<"J"L0)*AYa0 .b e2Ds F 4F 4F! r$)F)$r+r,r-r.rr9rrrrrrrrrrrrrr/rZrrrrrrr__hash__rrrrr r rr%r rrr!sjX3I,,664 6 &&%:B # $$$$ $ $ HN&,H  / _r rc0eZdZdZddZdZdZdZdZy) DedupeColumnCollectionauA :class:`_expression.ColumnCollection` that maintains deduplicating behavior. This is useful by schema level objects such as :class:`_schema.Table` and :class:`.PrimaryKeyConstraint`. The collection includes more sophisticated mutator methods as well to suit schema objects which require mutable column collections. .. versionadded:: 1.4 Nc|$|j|k7rtjd|j}|tjd||jvrF|j|}||ury|j |t j j|dyt|j}|jj||f|jj|||j|<||j|<y)NKDedupeColumnCollection requires columns be under the same key as their .keyz-Can't add unnamed column to column collectionr;) rr rrreplacerrresetrrrrr)rrrexistingrs rrzDedupeColumnCollection.adds ?vzzS0##- jj ;##?  $++ {{3'H6! LL  " " ( ( =D$$%A    # #S&M 2 LL  V $#DKKN%DKK r ct|}g}|D]\}}|j|k7rtjd|j|j vr+|j|jk7r|j |m|j|j vr|j |||j |<|jj ||f|jjd|jD|j jdt|jD|D]}|j|y)rr#c3&K|] \}}| ywr$r%rs rruzADedupeColumnCollection._populate_separate_keys..s=&1aA=rc30K|]\}\}}||fywr$r%rs rruzADedupeColumnCollection._populate_separate_keys..rrN) rrr rr]rrrrrrr$)rrr replace_colrrs rrz.DedupeColumnCollection._populate_separate_keyssE{  2FAsww!|''1xx4;;&377chh+>""3'DKK'""3'!$ A  ''C1 2 =D,<,<==  (1$2B2B(C   C LL  r c4|jd|Dy)Nc38K|]}|j|fywr$)r)rrrs rruz0DedupeColumnCollection.extend..s$Ecggs^$Esrrs rextendzDedupeColumnCollection.extends $$$Eu$EEr c ||jvrtd|z|j|j=|jj ||j Dcgc]\}}||us ||fc}}|j dd|jj t|j Dcic] \}\}}|| c}}}|jt|j =ycc}}wcc}}}w)Nz8Can't remove column %r; column is not in this collection) rrrrrrrrr)rrrrJrrs rrzDedupeColumnCollection.removes  %J  KK # F#!%!1!1 1Qf_QF  +4T5E5E+F G G-#x3S#X G  KKD,,- .  Hs C*+C*0C0 c  t}|j|jvr\|j|jk7rC|j|j}|j|jk(r|j ||j|jvr(|j |j|jg}d}|j D]?\}}||vr#|r d}|j |j|f-|j ||fA|r|jj||s|j |j|f|jj |||j dd|jj|jjt|j Dcic] \}\}}|| c}}}|jj|j ycc}}}w)aadd the given column to this collection, removing unaliased versions of this column as well as existing columns with the same key. e.g.:: t = Table('sometable', metadata, Column('col1', Integer)) t.columns.replace(Column('col1', Integer, key='columnone')) will remove the original 'col1' from the collection, and add the new column under the name 'columnname'. Used by schema.Column to override columns during table reflection. FTN) rxr]rrrrrrdifference_updaterrr) rr remove_colr$new_colsreplacedrrrs rr$zDedupeColumnCollection.replaces"U ;;$++ %&** *CKK ,EzzUYY&u% :: $ NN4;;vzz2 3&& *FAsj #HOOVZZ$89C)  *  LL * *: 6 OOVZZ0 1  &  +4T5E5E+F G G-#x3S#X G  4++, Hs?G> r$) r+r,r-r.rrr-rr$r%r rr!r!s"  &D2F/"2-r r!cVeZdZdZdZdZdZejjxZ xZ Z y)r _parentctj|d|tj|d|jtj|d|jtj|d|jy)Nr6rrr)r8rrrr)r collections rr9z"ImmutableColumnCollection.__init__>s\4J74J,>,>?4:+<+<=4 0F0FGr cd|jiSNr6r5rs rrz&ImmutableColumnCollection.__getstate__Ds4<<((r c0|d}|j|yr:)r9)rrrs rrz&ImmutableColumnCollection.__setstate__Gsy! fr N) r+r,r-rr9rrrImmutableContainer _immutablerr-rr%r rr r ;s4IH )!33>>>C>&6r r c*eZdZdZdZdZdZdZy) ColumnSetc ||vSr$r%r s rr zColumnSet.contains_columnOs d{r c4|D]}|j|yr$)r)rrrs rr-zColumnSet.extendRs C HHSM r c0t|t|zSr$)rrs rr&zColumnSet.__add__VsDzDK''r cg}|D]/}|D](}|j|s|j||k(*1tj|Sr$)rrrEand_)rr$rrJrMs rr/zColumnSet.__eq__YsT  )A )##E*HHQ%Z( ) )}}a  r c8ttd|DS)Nc3 K|]}|ywr$r%)rrrQs rruz%ColumnSet.__hash__..bs*!*s )hashrrs rrzColumnSet.__hash__asE*T**++r N)r+r,r-r r-r&r/rr%r rr?r?Ns(!,r r?c tjd|j}|sY|jj}t |dt |dd}|r|d|}nd|z}|d|z}t j||S)Nz|The ``bind`` argument for schema methods that invoke SQL against an engine or connection will be required in SQLAlchemy 2.0.fullnamer]z object z %s objectzm%s is not bound to an Engine or Connection. Execution can not proceed without a database to execute against.)rwarn_deprecated_20rr[r+r.r r) schemaitemr`rr]ritems r_bind_or_errorrMes N ??D ##,,  GJ$E  %)51D%D ;!"  '',, Kr c |jS#t$r8tj|D]}t |ds|jccYSwxYw)zReturn the nearest .entity_namespace for the given entity. If not immediately available, does an iterate to find a sub-element that has one, if any. entity_namespace)rOrriteratehasattr)entityrss r_entity_namespacerSsX&&& $$V, Dt/0,,,   s -AA Ac  t|}|tur t|||St||S#t$r;}t j t jd|d|d|Yd}~yd}~wwxYw)zReturn an entry from an entity_namespace. Raises :class:`_exc.InvalidRequestError` rather than attribute error on not found. zEntity namespace for "z" has no property ""rN)rSrr.rrrr r\)rRrrnsrs r_entity_namespace_keyrWss  v & & 2sG, ,2s# #    # #3      s. . A21A--A2r$)Cr.rArdrrr traversalsrrrr r r r rrrrjrEtype_apisymbolrrr8rr1rDrKrRrgr(rlr|rcollections_abcMutableMappingrrpreload_modulerrrrr r rrwith_metaclassr(rRr\ StatementRolerdrrrrrr!r<r ordered_column_setr?rMrSrWr%r rrbs  #(+#/'   4;;12 X   $ 0 ,: ? 9 d**999 x$d**99$@*+1,1lCFlC^_6_D$ ?j?48G2!d!!,/G2T @w @ ' `$$j`Fd*88"4M4 FvFR N--N-b? 7 79I?&,'',.4"06 r