+h+* ddlZddlZddlZddlmZddlmZddlmZddlmZddlm Z ddlm Z dd lm Z dd lm Z dd lm Z dd lmZdd lmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlm Z ddl!m"Z"ddlmZ#ddlm$Z$dd lm%Z%dd!lm&Z&dd"lm'Z'ddlm Z(dd#lm)Z)dd$l*m+Z+dd%l,m-Z-e.d&Z/Gd'd(e.Z0d)Z1 dKd*Z2d+Z3Gd,d-e(jhZ5Gd.d/e6Z7Gd0d1eee#jpe Z9Gd2d3e6Z:Gd4d5eZ;ejxe7d6ejxe9d7dLd8Z= dMd9Z>ej~Gd:d;ee+e#jpe Z@dNd<ZAd=ZBd>ZCGd?d@e%jZE dOdAZFdPdBZGdNdCZHdDZIdEZJdFZKdGZLdHZMdIZNdJZOy)QN) attributes)_class_to_mapper) _never_set) _none_set) attribute_str) class_mapper)InspectionAttr) instance_str) object_mapper) object_state)state_attribute_str)state_class_str) state_str)CriteriaOption)MapperProperty)ORMColumnsClauseRole)ORMEntityColumnsClauseRole)ORMFromClauseRole)PropComparator) PathRegistry)event)exc) inspection)sql)util result_tuple)base) coercions) expression)lambdas)roles)visitors)SupportsCloneAnnotations)ColumnCollection)delete delete-orphanallmergeexpunge save-updaterefresh-expirenonecbeZdZdZej gdZeZgdZdZ dZ dZ e dZ y) CascadeOptionszHKeeps track of the options sent to :paramref:`.relationship.cascade`)r*r/r))r,r*r/r.r+) save_updater(refresh_expirer+r, delete_orphanc t|tjs||j|St |}|j |j r`tjddjt|j |j Dcgc] }t|c}zd|vr|j|jd|vr|j|jdt j#t$|}d|v|_d|v|_d|v|_d|v|_d |v|_d |v|_|j0r!|j(stj2d |Scc}w) NzInvalid cascade option(s): %s, r*r/r-r(r.r+r,r)z5The 'delete-orphan' cascade option requires 'delete'.) isinstancer string_types from_stringset difference_allowed_cascadessa_exc ArgumentErrorjoinsortedreprupdate_add_w_all_cascadescleardiscard frozenset__new__r1r2r(r3r+r,r4warn)cls value_listvaluesxselfs F/var/www/html/venv/lib/python3.12/site-packages/sqlalchemy/orm/util.pyrGzCascadeOptions.__new__Ts^ j$"3"3 4 8J??:. .Z   S22 3&&/))"("--c.C.CD"Q   F? MM#11 2 V  LLNu  8(F2&( .&8&  F* ,6   dkk IIJ  7sE7cbddjt|Dcgc]}|c}zScc}w)NzCascadeOptions(%r),)r?r@)rMrLs rN__repr__zCascadeOptions.__repr__ys(#sxxF4L0Iq0I'JKK0Is , cptjd|xsdDcgc]}|s| }}||Scc}w)Nz\s*,\s*)resplit)rIargcrKs rNr9zCascadeOptions.from_string|s6XXj#)<B!BB6{Cs33N)__name__ __module__ __qualname____doc__ all_cascadesr;rCr<_viewonly_cascades __slots__rGrQ classmethodr9rNr1r1@sR)'11(%NI#JLrar1cd sfd |r! fd} fd} fd} fd}n fd} fd} fd}tj|d |d d tj|d |d tj|d|d d |rtj|dd d yy)zNRuns a validation method on an attribute value to be set or appended. cR|jj}|j|uSN)managerimpl)state initiatorrfkeys rNdetect_is_backrefz,_validator_events..detect_is_backrefs&==%**D>>- -rac|jtjur$s ||s|j|dS|SNFoprOP_BULK_REPLACEobjrgvaluerhrjinclude_backrefsri validators rNappendz!_validator_events..appends>||:#=#== (9%(K c5%@@ rac s ||s-|j}|Dcgc] }||dc}|ddyycc}wrlrp rgrKrhrprrrjrsrirts rNbulk_setz#_validator_events..bulk_setsJ'8 'JiikCI:?Ic3u5q (Ks;cPs ||s|j|dS|Srlrwrgrroldvaluerhrjrsrirts rNset_z_validator_events..set_s,'8 'J c5%@@ racPs ||s|j|dyy)NTrwrqs rNremovez!_validator_events..removes*'8 'J%))+sE48(Krac|jtjur#s ||s|j|S|Srdrmrqs rNruz!_validator_events..appends<||:#=#== (9%(K c599 rac~s ||s,|j}|Dcgc] }||c}|ddyycc}wrdrwrxs rNryz#_validator_events..bulk_setsA'8 'JiikEKLEYsC7Lq (KLs:cNs ||s|j|S|Srdrwr{s rNr}z_validator_events..set_s*'8 'J c599 raruT)rawretval bulk_replace)rr:rN)rlisten) descrirtinclude_removesrsruryr}rrjs `` ` @rN_validator_eventsrs  .     9 9   M    LLxT$? LL~xT: LLudT: T8VdCrac  tj}i i|D]}||}tjtj |d}|||<i}|j D]p}|j|k(rtjd|d|d|j|j|||j<|j|j<r| |< fd} g} |jD]\} }|| jtj|D cgc] } | | | c} tj t#j$| j'|gzj)|| jtj|D cgc] } | | | c} j)|tj*| j-|Scc} wcc} w)a0Create a ``UNION`` statement used by a polymorphic mapper. See :ref:`concrete_inheritance` for an example of how this is used. :param table_map: mapping of polymorphic identities to :class:`_schema.Table` objects. :param typecolname: string name of a "discriminator" column, which will be derived from the query, producing the polymorphic identity for each row. If ``None``, no polymorphic discriminator is generated. :param aliasname: name of the :func:`~sqlalchemy.sql.expression.alias()` construct generated. :param cast_nulls: if True, non-existent columns, which are represented as labeled NULLs, will be passed into CAST. This is a legacy behavior that is problematic on some backends such as Oracle - in which case it can be set to False. T) allow_selectzPolymorphic union can't use 'z3' as the discriminator column due to mapped column zn; please apply the 'typecolname' argument; this is available on ConcreteBase as '_concrete_discriminator_name'c$ ||S#t$r{r.colsy Lu%d+ + Lxx E$K8>>tDDsxxz5;?EEdKK  Ls AB:BB)r OrderedSetr!expectr$StrictFromClauseRolerWrir=InvalidRequestErroraddtypeitemsrurselectliteral_columnsql_util_quote_ddl_exprr select_from union_allalias) table_map typecolname aliasnamercolnamesrirmrWrresulttype_rrrs ` @@rNpolymorphic_unionrs, HK E#   & &D  #  "Auu #00 #A ' LL AaeeH66E!%%L " E-0LF!) u  " MM 6>?dT5)?.. ( 8 8 ?#eK0 +e$  MM 3;<4c$&<+e$ ( ==& ! ' ' 22@=s G!G&c|rd}t|}|dk(r|d} |jd}n"|dvr|\}}ntjd|z|jdd}|r'tjd d j |zt |}|&|jtj| S|j|| S|jd }|r1tjd d j |jzt|}|j|S#t$r|jd}YwxYw) a9Generate "identity key" tuples, as are used as keys in the :attr:`.Session.identity_map` dictionary. This function has several call styles: * ``identity_key(class, ident, identity_token=token)`` This form receives a mapped class and a primary key scalar or tuple as an argument. E.g.:: >>> identity_key(MyClass, (1, 2)) (, (1, 2), None) :param class: mapped class (must be a positional argument) :param ident: primary key, may be a scalar or tuple argument. :param identity_token: optional identity token .. versionadded:: 1.2 added identity_token * ``identity_key(instance=instance)`` This form will produce the identity key for a given instance. The instance need not be persistent, only that its primary key attributes are populated (else the key will contain ``None`` for those missing values). E.g.:: >>> instance = MyClass(1, 2) >>> identity_key(instance=instance) (, (1, 2), None) In this form, the given instance is ultimately run though :meth:`_orm.Mapper.identity_key_from_instance`, which will have the effect of performing a database check for the corresponding row if the object is expired. :param instance: object instance (must be given as a keyword arg) * ``identity_key(class, row=row, identity_token=token)`` This form is similar to the class/tuple form, except is passed a database result row as a :class:`.Row` object. E.g.:: >>> row = engine.execute(\ text("select * from table where a=1 and b=2")\ ).first() >>> identity_key(MyClass, row=row) (, (1, 2), None) :param class: mapped class (must be a positional argument) :param row: :class:`.Row` row returned by a :class:`_engine.CursorResult` (must be given as a keyword arg) :param identity_token: optional identity token .. versionadded:: 1.2 added identity_token Nrrrowident)rz1expected up to three positional arguments, got %sidentity_tokenzunknown keyword arguments: %sr6)rinstance)lenpoprr=r>r?r identity_key_from_primary_keyrto_listidentity_key_from_rowkeysr identity_key_from_instance) argskwargsrlargsclass_rrmapperrs rN identity_keyrsm@ D  A:!WF ,jj'f_ MFE&&FN  $4d; &&/$))F2CC f% ;77 U#N8 //N0 ::j) &&/$))FKK2HH x(00::= , 7+ ,sD00E  E c&eZdZdZ ddZdZy) ORMAdapterzaColumnAdapter subclass which excludes adaptation of entities from non-matching mappers. Nc tj|}|j|_|j}|j}|r||_nd|_t jj|||||||jy)N)adapt_requiredallow_label_resolveanonymize_labels include_fn) rinspectr selectableis_aliased_class aliased_classr ColumnAdapter__init__ _include_fn) rMentity equivalentsrrrinforrs rNrzORMAdapter.__init__s{!!&)kk __ 00 !'D !%D ''   ) 3-'' ( rac|jjdd}| xs8|j|jxs|jj|S)N parentmapper) _annotationsgetisar)rMelemrs rNrzORMAdapter._include_fnsF""&&~t<zOVZZ 4O 8OOra)NFTF)rXrYrZr[rrr`rarNrr~s    8PrarcReZdZdZ d dZedZdZdZdZ dZ y) AliasedClassaRepresents an "aliased" form of a mapped class for usage with Query. The ORM equivalent of a :func:`~sqlalchemy.sql.expression.alias` construct, this object mimics the mapped class using a ``__getattr__`` scheme and maintains a reference to a real :class:`~sqlalchemy.sql.expression.Alias` object. A primary purpose of :class:`.AliasedClass` is to serve as an alternate within a SQL statement generated by the ORM, such that an existing mapped entity can be used in multiple contexts. A simple example:: # find all pairs of users with the same name user_alias = aliased(User) session.query(User, user_alias).\ join((user_alias, User.id > user_alias.id)).\ filter(User.name == user_alias.name) :class:`.AliasedClass` is also capable of mapping an existing mapped class to an entirely new selectable, provided this selectable is column- compatible with the existing mapped selectable, and it can also be configured in a mapping as the target of a :func:`_orm.relationship`. See the links below for examples. The :class:`.AliasedClass` object is constructed typically using the :func:`_orm.aliased` function. It also is produced with additional configuration when using the :func:`_orm.with_polymorphic` function. The resulting object is an instance of :class:`.AliasedClass`. This object implements an attribute scheme which produces the same attribute and method interface as the original mapped class, allowing :class:`.AliasedClass` to be compatible with any attribute technique which works on the original class, including hybrid attributes (see :ref:`hybrids_toplevel`). The :class:`.AliasedClass` can be inspected for its underlying :class:`_orm.Mapper`, aliased selectable, and other information using :func:`_sa.inspect`:: from sqlalchemy import inspect my_alias = aliased(MyClass) insp = inspect(my_alias) The resulting inspection object is an instance of :class:`.AliasedInsp`. .. seealso:: :func:`.aliased` :func:`.with_polymorphic` :ref:`relationship_aliased_class` :ref:`relationship_to_window_function` Nc tj|} | j} d} |[| jr1| jj r| jj }n,| jj||}n| jrd} t|| |||r|n | j||n | j|| || | |_ d| jjz|_y)NFrflatTAliasedClass_%s)rrrrr _is_subqueryr_with_polymorphic_selectable_anonymous_fromclause AliasedInspwith_polymorphic_mapperspolymorphic_on _aliased_insprrX)rMmapped_class_or_acrrradapt_on_namesrwith_polymorphic_discriminator base_aliasuse_mapper_pathrepresents_outer_joininspr nest_adapterss rNrzAliasedClass.__init__s!!"45 =$$)E)E--/77MM!!N  " " M(    ' %00-9 +&&    !  $*FMM,B,BB rac6|j|}d|jjjz|_||_|j rL|j D]=}||ustj|}t||jj|?|S)Nr) rGrrrXr_is_with_polymorphic_with_polymorphic_entitiesr_reconstitute_from_aliased_inspsetattr)rI aliased_insprpsub_aliased_inspents rNrz,AliasedClass._reconstitute_from_aliased_inspskk#(<+>+>+E+E+N+NN (  , ,$0$K$K H #<7&FF(CC!1!8!8!A!A3G  H rac |jd}|j}t||}t |dr,t |dr t j|j|St |dr|jd|}t |dr|j|}t||||S#t$r t wxYw)Nr__call____self____get__adapt_to_entity) __dict___targetgetattrrAttributeErrorhasattrr MethodType__func__rrr)rMrirtargetattrs rN __getattr__zAliasedClass.__getattr__%s ( MM/:M#**F63'D 4 $z)B##DMM48 8 4 #<<d+D 4* +'' 6D D#t $ 1 # " " #s B++B?cRt||}t|dr,t|dr tj|j|St|dr|j d|}t|dr8t j||_|j|}t||||S)Nrrrr) rrrrrrweakrefref _weak_entityrr)rMri mapped_classrrs rN_get_from_serializedz!AliasedClass._get_from_serializedBs|S) 4 $z)B##DMM48 8 4 #<<d+D 4* +(/ D(9L %'' 5D D#t $ rac^dt||jjjfzS)Nz)idrrrXrMs rNrQzAliasedClass.__repr__Ws0+ tH    & & / //   rac,t|jSrd)strrr s rN__str__zAliasedClass.__str__]s4%%&&ra) NNFFr`NNFF) rXrYrZr[rr_rrr rQrr`rarNrrsT8z  !#'+#2Ch  :* 'rarc^eZdZdZdej j fdej jfdej jfdej jfdej jfdejjfdejjfgZ d Z ed Zd Z ej$d Zed ZedZedZdZdZddZdZej6dZej6dZej6dZdZdZ dZ!y)raProvide an inspection interface for an :class:`.AliasedClass` object. The :class:`.AliasedInsp` object is returned given an :class:`.AliasedClass` using the :func:`_sa.inspect` function:: from sqlalchemy import inspect from sqlalchemy.orm import aliased my_alias = aliased(MyMappedClass) insp = inspect(my_alias) Attributes on :class:`.AliasedInsp` include: * ``entity`` - the :class:`.AliasedClass` represented. * ``mapper`` - the :class:`_orm.Mapper` mapping the underlying class. * ``selectable`` - the :class:`_expression.Alias` construct which ultimately represents an aliased :class:`_schema.Table` or :class:`_expression.Select` construct. * ``name`` - the name of the alias. Also is used as the attribute name when returned in a result tuple from :class:`_query.Query`. * ``with_polymorphic_mappers`` - collection of :class:`_orm.Mapper` objects indicating all those mappers expressed in the select construct for the :class:`.AliasedClass`. * ``polymorphic_on`` - an alternate column or SQL expression which will be used as the "discriminator" for a polymorphic load. .. seealso:: :ref:`inspection_toplevel` r_adapt_on_names_use_mapper_pathrrrrc |j} |j} tj||_| |_|x|_x|_|_||_||_ tj|xs||_ ||_ | |_ | |_ |rd|_||_g|_|jD]q}|| ust#|j$||| |}t'|j|j$j(||j j+|j,snd|_| g|_t/j0|| j2| d|jDchc]}| s |j c}|_| r*|j4j7|j4|_| |_| |_ycc}w)NT)rrrF)rrradapt_from_selectables)rrrrrrpersist_selectable local_tablerr _base_aliasrr_nest_adaptersrrrrrrrXrurrr_equivalent_columns_adapterwraprr)rMr inspectedrrrrrrrrrrrpolyrrs rNrzAliasedInsp.__init__s'--!!#KK/  * * *  #   ,";;{':d; 0%:"+ #(,D %,DD ).0D +55 Nv%& "#''5(8 CDKK)=)=sC33::3;L;LM N).D %-3HD ) .. 22)! 66$% $    %..33DMMBDM-) $s"F?c|j}|/tj|}tj||_|Srd)rrrrr)rMrs rNrzAliasedInsp.entitys=! ;>>tDC ' C 0D  raTcx|jj|j||djd|dS)N)r parententityentity_namespaceormcompile_state_pluginplugin_subject)r _annotater_set_propagate_attrsr s rN__clause_element__zAliasedInsp.__clause_element__s@(( $ $$(   %*d C  rac|jSrd)rr s rNr!zAliasedInsp.entity_namespaces {{rac.|jjS)zUReturn the mapped class ultimately represented by this :class:`.AliasedInsp`.)rrr s rNrzAliasedInsp.class_s{{!!!racp|jr|jjStj|Srd)rr_path_registryr per_mapperr s rNr,zAliasedInsp._path_registry s,  ;;-- -**40 0rac |j|j|j|j|j|j |j |j|j|j|jd S)N) rrrrrrrrrrr) rrrrrrrrrrrr s rN __getstate__zAliasedInsp.__getstate__sjkkkk__II"22(,(E(E.2.A.A**,#44%)%?%?!00  rac||j|d|d|d|d|d|d|d|d|d |d |d  y) Nrrrrrrrrrrr)r)rMrgs rN __setstate__zAliasedInsp.__setstate__ sg (O (O 'N &M , - 2 3 ,  # $ " # ) * / " raNc||jd}|r||d<|jj|j|j d|dS)N)r r proxy_keyr"r#)rrtraverser&r')rMrrids rN_adapt_elementzAliasedInsp._adapt_element/sT  KK   AkN MM " "4 ( Yq\ ! !).$G rac|j}||vrD||jur|St|j|jj j S|j|jr|SJd|d|)Nzmapper z doesn't correspond to )rrrrrrXrr)rMr self_polys rN_entity_for_mapperzAliasedInsp._entity_for_mapper>sq11 Y $ KK!7!7- ZZ $K O&$O O5rac|jj\}}|jj||j Dcic]!\}}|jj||#c}}fScc}}wrd)r _get_clauserr4r)rMonclause replacemaprparams rNr;zAliasedInsp._get_clauseLsp#{{66* MM " "8 ,#-"2"2"4 C &&s+U2    s&A2ciSrdr`r s rN_memoized_valueszAliasedInsp._memoized_valuesWs rac@|jr>|jj|jDcgc]}|jc}}n|jj}|Dcgc]\}}||j |f}}}t |Scc}wcc}}wrd)rr_columns_plus_keysrr6r')rMrcols_plus_keysrirs rN_all_column_expressionsz#AliasedInsp._all_column_expressions[s  $ $![[;;'+'F'FGGN"[[;;=N=K 08SS$%%c* +   //H  s B*Bcn||jvr|j|S||i|x|j|<}|Srd)r@)rMri callable_rkwrrs rN_memozAliasedInsp._memojsE $'' '((- -1:D1GB1G GD ! !# &Lrac|jr&ddjd|jDz}nd}dt||jj|fzS)Nz(%s)r6c3HK|]}|jjywrd)rrX).0mps rN z'AliasedInsp.__repr__..ss+') ""+s "rSz)rr?r rrX)rM with_polys rNrQzAliasedInsp.__repr__qsc  ( (+-1-J-J+"II, tH KK 0   racjr?djjddjfdjDdSdjjdS)Nzwith_polymorphic(z, [r6c3fK|](}|jur|jj*ywrd)rrrX)rKrLrMs rNrMz&AliasedInsp.__str__..s/,II&&s.1z])zaliased())rrrXr?rr s`rNrzAliasedInsp.__str__~s\  $ $ %% ";;  %%)LL$9$9; ;rard)"rXrYrZr[r%ExtendedInternalTraversal dp_string dp_booleandp_inspectabledp_clauseelementInternalTraversaldp_has_cache_key_list_cache_key_traversalrpropertyrrrmemoized_instancemethodr(r!rr,r/r1r6r9memoized_propertyr;r@rDrHrQrr`rarNrras $N 33==> H>>IIJ X??JJK H66EEF x99JJK &  & & < <  855FFG F*R   !!  "  "" 11       P      0 0   >%%..))$ : 7## #   T "H$:$:) ##D)..w7 77D) )raN) rXrYrZr[r^rrpreload_modulerfr`rarNr^r^s5IT23 *4 *rar^cDeZdZdZdej j fdej jfdejjfdejjfdejjfgZ ddZ e dZd Zd Zd Zd Zd ZdZdZy)LoaderCriteriaOptiona Add additional WHERE criteria to the load for all occurrences of a particular entity. :class:`_orm.LoaderCriteriaOption` is invoked using the :func:`_orm.with_loader_criteria` function; see that function for details. .. versionadded:: 1.4 root_entityrwhere_criteriainclude_aliasespropagate_to_loadersc tj|d}|||_d|_nd|_||_||_t |r~d|_tj|tjt|j |jn|jjftj||_ n0d|_tjtj||_ ||_||_y)aV Add additional WHERE criteria to the load for all occurrences of a particular entity. .. versionadded:: 1.4 The :func:`_orm.with_loader_criteria` option is intended to add limiting criteria to a particular kind of entity in a query, **globally**, meaning it will apply to the entity as it appears in the SELECT query as well as within any subqueries, join conditions, and relationship loads, including both eager and lazy loaders, without the need for it to be specified in any particular part of the query. The rendering logic uses the same system used by single table inheritance to ensure a certain discriminator is applied to a table. E.g., using :term:`2.0-style` queries, we can limit the way the ``User.addresses`` collection is loaded, regardless of the kind of loading used:: from sqlalchemy.orm import with_loader_criteria stmt = select(User).options( selectinload(User.addresses), with_loader_criteria(Address, Address.email_address != 'foo')) ) Above, the "selectinload" for ``User.addresses`` will apply the given filtering criteria to the WHERE clause. Another example, where the filtering will be applied to the ON clause of the join, in this example using :term:`1.x style` queries:: q = session.query(User).outerjoin(User.addresses).options( with_loader_criteria(Address, Address.email_address != 'foo')) ) The primary purpose of :func:`_orm.with_loader_criteria` is to use it in the :meth:`_orm.SessionEvents.do_orm_execute` event handler to ensure that all occurrences of a particular entity are filtered in a certain way, such as filtering for access control roles. It also can be used to apply criteria to relationship loads. In the example below, we can apply a certain set of rules to all queries emitted by a particular :class:`_orm.Session`:: session = Session(bind=engine) @event.listens_for("do_orm_execute", session) def _add_filtering_criteria(execute_state): if ( execute_state.is_select and not execute_state.is_column_load and not execute_state.is_relationship_load ): execute_state.statement = execute_state.statement.options( with_loader_criteria( SecurityRole, lambda cls: cls.role.in_(['some_role']), include_aliases=True ) ) In the above example, the :meth:`_orm.SessionEvents.do_orm_execute` event will intercept all queries emitted using the :class:`_orm.Session`. For those queries which are SELECT statements and are not attribute or relationship loads a custom :func:`_orm.with_loader_criteria` option is added to the query. The :func:`_orm.with_loader_criteria` option will be used in the given statement and will also be automatically propagated to all relationship loads that descend from this query. The criteria argument given is a ``lambda`` that accepts a ``cls`` argument. The given class will expand to include all mapped subclass and need not itself be a mapped class. .. tip:: When using :func:`_orm.with_loader_criteria` option in conjunction with the :func:`_orm.contains_eager` loader option, it's important to note that :func:`_orm.with_loader_criteria` only affects the part of the query that determines what SQL is rendered in terms of the WHERE and FROM clauses. The :func:`_orm.contains_eager` option does not affect the rendering of the SELECT statement outside of the columns clause, so does not have any interaction with the :func:`_orm.with_loader_criteria` option. However, the way things "work" is that :func:`_orm.contains_eager` is meant to be used with a query that is already selecting from the additional entities in some way, where :func:`_orm.with_loader_criteria` can apply it's additional criteria. In the example below, assuming a mapping relationship as ``A -> A.bs -> B``, the given :func:`_orm.with_loader_criteria` option will affect the way in which the JOIN is rendered:: stmt = select(A).join(A.bs).options( contains_eager(A.bs), with_loader_criteria(B, B.flag == 1) ) Above, the given :func:`_orm.with_loader_criteria` option will affect the ON clause of the JOIN that is specified by ``.join(A.bs)``, so is applied as expected. The :func:`_orm.contains_eager` option has the effect that columns from ``B`` are added to the columns clause:: SELECT b.id, b.a_id, b.data, b.flag, a.id AS id_1, a.data AS data_1 FROM a JOIN b ON a.id = b.a_id AND b.flag = :flag_1 The use of the :func:`_orm.contains_eager` option within the above statement has no effect on the behavior of the :func:`_orm.with_loader_criteria` option. If the :func:`_orm.contains_eager` option were omitted, the SQL would be the same as regards the FROM and WHERE clauses, where :func:`_orm.with_loader_criteria` continues to add its criteria to the ON clause of the JOIN. The addition of :func:`_orm.contains_eager` only affects the columns clause, in that additional columns against ``b`` are added which are then consumed by the ORM to produce ``B`` instances. .. warning:: The use of a lambda inside of the call to :func:`_orm.with_loader_criteria` is only invoked **once per unique class**. Custom functions should not be invoked within this lambda. See :ref:`engine_lambda_caching` for an overview of the "lambda SQL" feature, which is for advanced use only. :param entity_or_base: a mapped class, or a class that is a super class of a particular set of mapped classes, to which the rule will apply. :param where_criteria: a Core SQL expression that applies limiting criteria. This may also be a "lambda:" or Python function that accepts a target class as an argument, when the given class is a base with many different mapped subclasses. .. note:: To support pickling, use a module-level Python function to produce the SQL expression instead of a lambda or a fixed SQL expression, which tend to not be picklable. :param include_aliases: if True, apply the rule to :func:`_orm.aliased` constructs as well. :param propagate_to_loaders: defaults to True, apply to relationship loaders such as lazy loaders. This indicates that the option object itself including SQL expression is carried along with each loaded instance. Set to ``False`` to prevent the object from being assigned to individual instances. .. seealso:: :ref:`examples_session_orm_events` - includes examples of using :func:`_orm.with_loader_criteria`. :ref:`do_orm_execute_global_criteria` - basic example on how to combine :func:`_orm.with_loader_criteria` with the :meth:`_orm.SessionEvents.do_orm_execute` event. :param track_closure_variables: when False, closure variables inside of a lambda expression will not be used as part of any cache key. This allows more complex expressions to be used inside of a lambda expression but requires that the lambda ensures it returns the identical SQL every time given a particular class. .. versionadded:: 1.4.0b2 FNT)track_closure_variables) lambda_argsopts)rrrlr_where_crit_origcallabledeferred_where_criteriar#DeferredLambdaElementr$WhereHavingRoler^ LambdaOptionsrmr!rrnro)rMentity_or_baserm loader_onlyrnrorqrs rNrzLoaderCriteriaOption.__init__sh##NE: >-D DK#D  DK . N #+/D (")"?"?%%#++7((![[//**,C #D ,1D ("+"2"2%%~#D  /$8!rac t||||S)N)rnro)rk)rIrrmrnros rN _unreducezLoaderCriteriaOption._unreduces$  +!5   ractj|jr|jjn |j|j |j |jffSrd)rkr}rrrlrtrnror s rN __reduce__zLoaderCriteriaOption.__reduce__sP * *&*kk ""t7G7G%%$$))    rac#K|jr*|jjjD]}|yt|jj }|rm|j d}tj|d}|r |jjD]}|n|j|j |rlyyw)NrF)raiseerr) rrself_and_descendantslistrl__subclasses__rrrextend)rMrstacksubclassrLs rN _all_mappersz!LoaderCriteriaOption._all_mapperss ;;{{))>>   ))88:;E 99Q< ((EB!jj==! !LL!8!8!:;s CC  C cV|jjjdd|uryy)Nfor_loader_criteriaFT)select_statementrrrM compile_states rN_should_includez$LoaderCriteriaOption._should_includes3  * * 7 7 ; ;%t   rac|jr&|jj|j}n |j}t j |d|idS)NrT)detect_subquery_cols)rvrm_resolve_with_argsrr_deep_annotate)rMext_infocrits rN_resolve_where_criteriaz,LoaderCriteriaOption._resolve_where_criteriasP  ' '&&99(//JD&&D&& ($/d  rac$|j|Srd)process_compile_state)rMrmapper_entitiess rN'process_compile_state_replaced_entitieszrs &2F2Frac|Srdr`rs rNrrsract|tjrR|rtjd|r|j ||St jtj||St|||||S)aProduce an alias of the given element, usually an :class:`.AliasedClass` instance. E.g.:: my_alias = aliased(MyClass) session.query(MyClass, my_alias).filter(MyClass.id > my_alias.id) The :func:`.aliased` function is used to create an ad-hoc mapping of a mapped class to a new selectable. By default, a selectable is generated from the normally mapped selectable (typically a :class:`_schema.Table` ) using the :meth:`_expression.FromClause.alias` method. However, :func:`.aliased` can also be used to link the class to a new :func:`_expression.select` statement. Also, the :func:`.with_polymorphic` function is a variant of :func:`.aliased` that is intended to specify a so-called "polymorphic selectable", that corresponds to the union of several joined-inheritance subclasses at once. For convenience, the :func:`.aliased` function also accepts plain :class:`_expression.FromClause` constructs, such as a :class:`_schema.Table` or :func:`_expression.select` construct. In those cases, the :meth:`_expression.FromClause.alias` method is called on the object and the new :class:`_expression.Alias` object returned. The returned :class:`_expression.Alias` is not ORM-mapped in this case. .. seealso:: :ref:`tutorial_orm_entity_aliases` - in the :ref:`unified_tutorial` :ref:`orm_queryguide_orm_aliases` - in the :ref:`queryguide_toplevel` :param element: element to be aliased. Is normally a mapped class, but for convenience can also be a :class:`_expression.FromClause` element. :param alias: Optional selectable unit to map the element to. This is usually used to link the object to a subquery, and should be an aliased select construct as one would produce from the :meth:`_query.Query.subquery` method or the :meth:`_expression.Select.subquery` or :meth:`_expression.Select.alias` methods of the :func:`_expression.select` construct. :param name: optional string name to use for the alias, if not specified by the ``alias`` parameter. The name, among other things, forms the attribute name that will be accessible via tuples returned by a :class:`_query.Query` object. Not supported when creating aliases of :class:`_sql.Join` objects. :param flat: Boolean, will be passed through to the :meth:`_expression.FromClause.alias` call so that aliases of :class:`_expression.Join` objects will alias the individual tables inside the join, rather than creating a subquery. This is generally supported by all modern databases with regards to right-nested joins and generally produces more efficient queries. :param adapt_on_names: if True, more liberal "matching" will be used when mapping the mapped columns of the ORM entity to those of the given selectable - a name-based match will be performed if the given selectable doesn't otherwise have a column that corresponds to one on the entity. The use case for this is when associating an entity with some derived selectable such as one that uses aggregate functions:: class UnitPrice(Base): __tablename__ = 'unit_price' ... unit_id = Column(Integer) price = Column(Numeric) aggregated_unit_price = Session.query( func.sum(UnitPrice.price).label('price') ).group_by(UnitPrice.unit_id).subquery() aggregated_unit_price = aliased(UnitPrice, alias=aggregated_unit_price, adapt_on_names=True) Above, functions on ``aggregated_unit_price`` which refer to ``.price`` will return the ``func.sum(UnitPrice.price).label('price')`` column, as it is matched on the name "price". Ordinarily, the "price" function wouldn't have any "column correspondence" to the actual ``UnitPrice.price`` column as it is not a proxy of the original. z+adapt_on_names only applies to ORM elementsrr)rrrr) r7r" FromClauser=r>rr!rr$AnonymizedFromClauseRoler)elementrrrrs rNaliasedrsx':001 &&=  ==d=6 6##..d  )   rac t|} |dvr|rtjd| rj| j| usJt j |}t | jD cgc]} | jc} } || k(r| S|j| }| j|||\} }|s|r|j|}t|||| ||| Scc} w)ab Produce an :class:`.AliasedClass` construct which specifies columns for descendant mappers of the given base. Using this method will ensure that each descendant mapper's tables are included in the FROM clause, and will allow filter() criterion to be used against those tables. The resulting instances will also have those columns already loaded so that no "post fetch" of those columns will be required. .. seealso:: :ref:`with_polymorphic` - full discussion of :func:`_orm.with_polymorphic`. :param base: Base class to be aliased. :param classes: a single class or mapper, or list of class/mappers, which inherit from the base class. Alternatively, it may also be the string ``'*'``, in which case all descending mapped classes will be added to the FROM clause. :param aliased: when True, the selectable will be aliased. For a JOIN, this means the JOIN will be SELECTed from inside of a subquery unless the :paramref:`_orm.with_polymorphic.flat` flag is set to True, which is recommended for simpler use cases. :param flat: Boolean, will be passed through to the :meth:`_expression.FromClause.alias` call so that aliases of :class:`_expression.Join` objects will alias the individual tables inside the join, rather than creating a subquery. This is generally supported by all modern databases with regards to right-nested joins and generally produces more efficient queries. Setting this flag is recommended as long as the resulting SQL is functional. :param selectable: a table or subquery that will be used in place of the generated FROM clause. This argument is required if any of the desired classes use concrete table inheritance, since SQLAlchemy currently cannot generate UNIONs among tables automatically. If used, the ``selectable`` argument must represent the full set of tables and columns mapped by every mapped class. Otherwise, the unaccounted mapped columns will result in their table being appended directly to the FROM clause which will usually lead to incorrect results. When left at its default value of ``False``, the polymorphic selectable assigned to the base mapper is used for selecting rows. However, it may also be passed as ``None``, which will bypass the configured polymorphic selectable and instead construct an ad-hoc selectable for the target classes given; for joined table inheritance this will be a join that includes all target mappers and their subclasses. :param polymorphic_on: a column to be used as the "discriminator" column for the given selectable. If not given, the polymorphic_on attribute of the base classes' mapper will be used, if any. This is useful for mappings that don't have polymorphic loading behavior by default. :param innerjoin: if True, an INNER JOIN will be used. This should only be specified if querying for one specific subtype only :param adapt_on_names: Passes through the :paramref:`_orm.aliased.adapt_on_names` parameter to the aliased object. This may be useful in situations where the given selectable is not directly related to the existing mapped selectable. .. versionadded:: 1.4.33 rlz[the 'flat' and 'selectable' arguments cannot be passed simultaneously to with_polymorphic()) innerjoinr)rrrrr) rr=r>rrto_setr:rrunion_with_polymorphic_argsrr)r classesrrrrrrr_existing_aliasprimary_mapperrL new_classesmapperss rNwith_polymorphicr]sd&d+N&4"" 3  %%777++g&!0!I!I J2RYY J  k !" "mmK0G(??y@GZ$5545@  %!('5("+m  Ks!CceZdZdZdZ dZdZdZdZe jZ dZ dZ edZedZedZd Z d Z d Zd Zed Zd ZdZy )BundleaHA grouping of SQL expressions that are returned by a :class:`.Query` under one namespace. The :class:`.Bundle` essentially allows nesting of the tuple-based results returned by a column-oriented :class:`_query.Query` object. It also is extensible via simple subclassing, where the primary capability to override is that of how the set of expressions should be returned, allowing post-processing as well as custom return types, without involving ORM identity-mapped classes. .. versionadded:: 0.9.0 .. seealso:: :ref:`bundles` FTc x|x|_|_|Dcgc](}tjtj ||*c}x|_}td|Dcgc]}|jjd| c}Dx|_ |_ |jd|j|_ ycc}wcc}w)aQConstruct a new :class:`.Bundle`. e.g.:: bn = Bundle("mybundle", MyClass.x, MyClass.y) for row in session.query(bn).filter( bn.c.x == 5).filter(bn.c.y == 4): print(row.mybundle.x, row.mybundle.y) :param name: name of the bundle. :param \*exprs: columns or SQL expressions comprising the bundle. :param single_entity=False: if True, rows for this :class:`.Bundle` can be returned as a "single entity" outside of any enclosing tuple in the same manner as a mapped entity. )apply_propagate_attrsc3NK|]}t|d|j|fyw)riN)r_label)rKrs rNrMz"Bundle.__init__..s*1 S% ,c 21 s#%bundle single_entityN)rrr!rr$ColumnsClauseRoleexprsr'rrrWcolumnsrr)rMrrrGexpres rNrzBundle.__init__s$#'& DK      ''T    U!11 AFGA**8Q7G1 !   VVOT5G5GH Hs -B2#B7 c |j|j|jft|jDcgc]}|j ||c}zScc}wrd) __class__rrtupler_gen_cache_key)rManon_map bindparamsrs rNrzBundle._gen_cache_keysN 4+=+=>CG:: N4T : 6 NB   NsA cT|jdjjddS)Nrrrrrr s rNrz Bundle.mapper#zz!}))--ndCCracT|jdjjddS)Nrr rr s rNrz Bundle.entity#rrac|jSrd)rWr s rNr!zBundle.entity_namespace's vv raNc|jj|j}|jj|j|Srd)rrGrrB)rMcloneds rN_clonez Bundle._cloneGs5''7t}}- rac ||d}|j|j|jdjj d|j }t j|jDcgc]}|jj d| c}tjddj|jd|dScc}w) N)rr!rr%rF)_literal_as_text_rolegroupr"r#) rBrr_propagate_attrsrrr" ClauseListr$rr&r')rM annotationsr%rs rNr(zBundle.__clause_element__Ls!%4@ 4,,-A77;; dkk   ! !<@::Fa!..$$Xq1F',&=&=  Y{ # ! !-2&4 Gs1#C c6|jjSrd)r(clausesr s rNrzBundle.clauseses&&(000rac4|j}||_|S)z.proc|s e ,@s % )rXrYrZr[ris_clause_element is_mapperr is_bundler immutabledictrrrrZrrr!rrWrr(rrrr`rarNrrs(M<II)t))+I@ DDDDG0 A/  211rarc4tj|ddi|S)zDeep copy the given ClauseElement, annotating each element with the "_orm_adapt" flag. Elements within the exclude collection will be cloned but not annotated. _orm_adaptT)rr)rexcludes rN _orm_annotaters  " "7\4,@' JJrac0tj|dS)zRemove annotations that link a column to a particular mapping. Note this doesn't affect "remote" and "foreign" annotations passed by the :func:`_orm.foreign` and :func:`_orm.remote` annotators. )rr )rKr_deep_deannotaters rN_orm_deannotaters  $ $6 rac,tj|Srdrrs rN_orm_full_deannotaters  $ $W --racreZdZdZej j ZdZ ddZdZ d dZ d dZ y) _ORMJoinz/Extend Join to support ORM constructs as input.TNc tj|} tj|} | j} ||_||_t |d| } | |_t|tjrt | j|}t|tjr6|jj} |j}||j z }n+t|t"r|}|j$j} nd}|r| j}t'j( |r| }n|}|j+|| d| d|\}}}}}}|7|rt-j.|||}|}nt-j.||||}|}n|}||_| j2r|j4j7dd}n| j8s | j:r| }nd}|"|j4j=d|i|_|duxr|}t>j@jC|||||||r%|xjDt-jF|zc_"|szt | ddrl| jHjJrU| jHjL}|<| j:r| jNjQ|}|jD|z|_"yyyyy)N_joined_from_infoT)source_selectabledest_selectablesource_polymorphicof_type_entityalias_secondaryextra_criteriar r))rrr _left_memo _right_memorrr7rr8rrQueryableAttribute comparator_source_selectablerZ_extra_criteriarparentrclause_is_present _create_joinsrr?_target_adapter is_selectablerrrrrr"Joinrr<and_rsingle_single_table_criterionrr4)rMleftrightr<isouterfullrrr left_info right_infoadapt_to left_orm_info on_selectablepropleft_selectable adapt_frompjsjsourcedest secondarytarget_adapterr augment_onclause single_crits rNrz_ORMJoin.__init__s&&t, ''. ((%& &99E !+ h 1 1 2}33X>H h = = >$//BBDM$$D x77 7O . 1D KK22MD '22O))-I* , """, (#') $. # ~HHYr:E!H88D)RAD!H#1D &&.;;??"D  $$ (B(B( # '$($5$5$;$;#\2%!$t+?  tUHgtL  MMSXX7 7M Hd3!!(( %++CCK&..","5"5">">{"KK $ ; ' )4rac|}t|tjr'|j}t|tjr'|j|usJt |j|j|j |j|j|j}t ||j|j |j|jS)zlSplice a join into the center. Given join(a, b) and join(b, c), return join(a, b).join(c) )rrr)rr) r7rr rrrr<rrr)rMotherleftmostrs rN_splice_into_centerz_ORMJoin._splice_into_centers 388,}}H388,zzX%%% II JJ MMLL((    KK NNMM))   rac"t|||||S)N)rrr)rMrr<rr join_to_lefts rNr?z _ORMJoin.join4seXD'JJrac"t|||d|S)NT)rrr))rMrr<rr*s rN outerjoinz_ORMJoin.outerjoin>seXt$GGra)NFFNNr`NFFNNFN) rXrYrZr[r"r __visit_name__ inherit_cacherr'r?r,r`rarNrrsT9__33NM  pt|tjr$|jr |j}|j}|j||S)aCreate filtering criterion that relates this query's primary entity to the given related instance, using established :func:`_orm.relationship()` configuration. E.g.:: stmt = select(Address).where(with_parent(some_user, User.addresses)) The SQL rendered is the same as that rendered when a lazy loader would fire off from the given parent on that attribute, meaning that the appropriate state is taken from the parent object in Python without the need to render joins to the parent table in the rendered statement. The given property may also make use of :meth:`_orm.PropComparator.of_type` to indicate the left side of the criteria:: a1 = aliased(Address) a2 = aliased(Address) stmt = select(a1, a2).where( with_parent(u1, User.addresses.of_type(a2)) ) The above use is equivalent to using the :func:`_orm.with_parent.from_entity` argument:: a1 = aliased(Address) a2 = aliased(Address) stmt = select(a1, a2).where( with_parent(u1, User.addresses, from_entity=a2) ) :param instance: An instance which has some :func:`_orm.relationship`. :param property: String property name, or class-bound attribute, which indicates what relationship from the instance should be used to reconcile the parent/child relationship. .. deprecated:: 1.4 Using strings is deprecated and will be removed in SQLAlchemy 2.0. Please use the class-bound attribute directly. :param from_entity: Entity in which to consider as the left side. This defaults to the "zero" entity of the :class:`_query.Query` itself. .. versionadded:: 1.2 zUsing strings to indicate relationship names in the ORM with_parent() function is deprecated and will be removed SQLAlchemy 2.0. Please use the class-bound attribute directly.) from_entity) r7rr8warn_deprecated_20r rrrZrr_of_type _with_parent)rrr4rs rN with_parentr8sl$))*  N x(v}}d+44 D*77 8 ==--K}}   X;  ??racDtj|}|jS)zReturn True if the given object has a database identity. This typically corresponds to the object being in either the persistent or detached state. .. seealso:: :func:`.was_deleted` )rinstance_state has_identityobject_rgs rNr;r;s   % %g .E   racDtj|}|jS)zReturn True if the given object was deleted within a session flush. This is regardless of whether or not the object is persistent or detached. .. seealso:: :attr:`.InstanceState.was_deleted` )rr: was_deletedr<s rNr?r?s   % %g .E   rac|jr.|jr!|j|juryy|jr|jr||jvS||uS|j |S)zdetermine if 'given' corresponds to 'entity', in terms of an entity passed to Query that would match the same entity being referred to elsewhere in the query. TF)rrrr common_parentgivenrs rN_entity_corresponds_torDst   ! !!!#u'8'8'::     ! !U;;; ;U? "    &&rac|jr1|jxr#|j xr||uxs||jvS|js|j|jS|jxr||j vS)adetermine if 'given' corresponds to 'entity', in terms of a path of loader options where a mapped attribute is taken to be a member of a parent entity. e.g.:: someoption(A).someoption(A.b) # -> fn(A, A) -> True someoption(A).someoption(C.d) # -> fn(A, C) -> False a1 = aliased(A) someoption(a1).someoption(A.b) # -> fn(a1, A) -> False someoption(a1).someoption(a1.b) # -> fn(a1, a1) -> True wp = with_polymorphic(A, [A1, A2]) someoption(wp).someoption(A1.foo) # -> fn(wp, A1) -> False someoption(wp).someoption(wp.A1.foo) # -> fn(wp, wp.A1) -> True )rrrrArrrBs rN$_entity_corresponds_to_use_path_implrFs(   # # P+++ P&NEV-N-N$N  $ $""6==11  # # 9888 rac|jr+||jvxs|jj|S|jr||jvS|j|S)zedetermine if 'given' "is a" mapper, in terms of the given would load rows of type 'mapper'. )rrrr)rCrs rN _entity_isarH sd  777 5<<;K;K <    ' '7777yy  raczddlm}m}m}m}ddlm}ddlm}|x|_ x|_ x|_ x|_ |_ y)aZUse random-ordering sets within the unit of work in order to detect unit of work sorting issues. This is a utility function that can be used to help reproduce inconsistent unit of work sorting issues. For example, if two kinds of objects A and B are being inserted, and B has a foreign key reference to A - the A must be inserted first. However, if there is no relationship between A and B, the unit of work won't know to perform this sorting, and an operation may or may not fail, depending on how the ordering works out. Since Python sets and dictionaries have non-deterministic ordering, such an issue may occur on some runs and not on others, and in practice it tends to have a great dependence on the state of the interpreter. This leads to so-called "heisenbugs" where changing entirely irrelevant aspects of the test program still cause the failure behavior to change. By calling ``randomize_unitofwork()`` when a script first runs, the ordering of a key series of sets within the unit of work implementation are randomized, so that the script can be minimized down to the fundamental mapping and operation that's failing, while still reproducing the issue on at least some runs. This utility is also available when running the test suite via the ``--reversetop`` flag. r) unitofworksessionr dependency) topological) RandomSetN) sqlalchemy.ormrJrKrrLsqlalchemy.utilrMsqlalchemy.testing.utilrNr:)rJrKrrLrMrNs rNrandomize_unitofworkrR/sA6GF+15>>KO>> >j:>racfd}t|trtj|\}}}t|trt|tr ||z dkrgSt|tr|dkst|tr|dkr|t ||S|j||}|t |dd|j St |S|dk(r|t |dSt |||dzdS)zdcalculate __getitem__ in terms of an iterable query object that also has a slice() method. cJs tdtjdy)Nz@negative indexes are not accepted by SQL index / slice operatorszSupport for negative indexes for SQL index / slice operators will be removed in 2.0; these operators fetch the complete result and do not work efficiently.) IndexErrorrr5)allow_negativesrN_no_negative_indexesz&_getitem.._no_negative_indexesYs-*   # #/ rarNr)r7slicer decode_sliceintrstep)iterable_queryitemrVrWstartstopr\ress ` rN_getitemrbSs $ --d3tT tS !5#&u !I$ tS !dQh "'- -""5$/  9TD49945 59  2: "'+ +tdQh78; ;ra)p_unionT)NNFF)FFNFFFFNrdr-r.)PrTrrrSrr rrrrr r r r r rrr interfacesrrrrrr path_registryrrrr=rrr engine.resultrsql_baser!r"r#r$rr%sql.annotationr&sql.baser'rFr\r1rrrrrrerMemoizedHasCacheKeyrr^rk _inspectsrr_self_inspectsrrrrr rr?r,r8r;r?rDrFrHrRrbr`rarNrms " %!&&,2)&'(""5'   ?Y?D?DF=AO3de;P%P''%PPx'6x'vh<    h}'@ # \"#FG! [!"78n h  qh m    mm`K .aHzaHJIM2:j7C@L  "'(  F !!>H.