+h dZddlmZddlmZddlmZddlmZddlm Z ddlm Z ddl m Z dd l m Z dd l mZdd lmZdd lmZdd lmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlm Z Gdde e Z!Gdde!Z"Gdde#Z$e$d?d!Z%e%jLd"Z%e$d#Z'e'jLd$Z'e$d?d%Z(e(jLd&Z(e$d'Z)e)jLd(Z)e$d)Z*e*jLd*Z*e$d+Z+e+jLd,Z+e$d-Z,e,jLd.Z,e$d/Z-e-jLd0Z-e$d@d1Z.e.jLd2Z.e$d3Z/e/jLd4Z/e$d@d5Z0e0jLd6Z0e$d7Z1e1jLd8Z1e$d9Z2e2jLd:Z2e$d;Z3e3jLd<Z3e$d=Z4e4jLd>Z4y )Az )util)QueryableAttribute)_class_to_mapper)_is_aliased_class)_is_mapped_class)InspectionAttr) LoaderOption)MapperProperty)PropComparator)_DEFAULT_TOKEN)_WILDCARD_TOKEN) PathRegistry) TokenRegistry)_orm_full_deannotate)excinspect)and_) coercions)roles) traversals)visitors) _generative) GenerativecDeZdZdZdZdej jfdej jfdej jfdejjfdej jfdej jfgZd Zed Zd Zd Zd ZdZedZfdZdZdZdZdZdZdZdZdZ dZ! d&dZ"dZ#dZ$dZ%e&dZ'e& d'dZ(e&d(dZ)e&dZ*e&dZ+ d)d Z,d*d!Z-d"Z.d#Z/d$Z0d%Z1xZ2S)+LoadaRepresents loader options which modify the state of a :class:`_query.Query` in order to affect how various mapped attributes are loaded. The :class:`_orm.Load` object is in most cases used implicitly behind the scenes when one makes use of a query option like :func:`_orm.joinedload`, :func:`.defer`, or similar. However, the :class:`_orm.Load` object can also be used directly, and in some cases can be useful. To use :class:`_orm.Load` directly, instantiate it with the target mapped class as the argument. This style of usage is useful when dealing with a :class:`_query.Query` that has multiple entities:: myopt = Load(MyClass).joinedload("widgets") The above ``myopt`` can now be used with :meth:`_query.Query.options`, where it will only take effect for the ``MyClass`` entity:: session.query(MyClass, MyOtherClass).options(myopt) One case where :class:`_orm.Load` is useful as public API is when specifying "wildcard" options that only take effect for a certain class:: session.query(Order).options(Load(Order).lazyload('*')) Above, all relationships on ``Order`` will be lazy-loaded, but other attributes on those descendant objects will load using their normal loader strategy. .. seealso:: :ref:`deferred_options` :ref:`deferred_loading_w_multiple` :ref:`relationship_loader_options` Tpathstrategy_of_type_extra_criteria_context_cache_key local_optsct|}|j|j|_t j |_i|_d|_yNF) r _post_inspect_path_registryrr OrderedDictcontextr#is_class_strategy)selfentityinsps R/var/www/html/venv/lib/python3.12/site-packages/sqlalchemy/orm/strategy_options.py__init__z Load.__init__asBv '' '') !&cn|j|}||_i|_i|_d|_d|_|SN)__new__rr)r#r r!)clsrloads r.for_existing_pathzLoad.for_existing_pathls9{{3   ! r0c$|j|SN)_adjust_for_extra_criteria)r+r) uncached_opts r.'_adapt_cached_option_to_uncached_optionz,Load._adapt_cached_option_to_uncached_optionvs..w77r0c|jsJd|jj}|j}|j }|j }|j |t |jS)aApply the current bound parameters in a QueryContext to the immediate "extra_criteria" stored with this Load object. Load objects are typically pulled from the cached version of the statement from a QueryContext. The statement currently being executed will have new values (and keys) for bound parameters in the extra criteria which need to be applied by loader strategies when they handle this criteria for a result set. z8this should only be called if _extra_criteria is present)r! compile_stateselect_statementquery_generate_cache_key_apply_params_to_elementr)r+r) orig_query current_queryk1k2s r._generate_extra_criteriazLoad._generate_extra_criteriaysw   F E F **;;   + + -  . . 0**2tT5I5I/JKKr0crjji}ddgfd}|j||S)zApply the current bound parameters in a QueryContext to all occurrences "extra_criteria" stored within al this Load object; copying in place. Nc|jsyd-jjjfdd\tfd|jD|_y)Nc3BK|]}j|ywr9)rB).0critrErFs r. zCLoad._adjust_for_extra_criteria..process..s&(++B5()r!rAr@tuple)optrErFckr)rCs @@r.processz0Load._adjust_for_extra_criteria..processsj&&!u}224MM5571FB"'(//(#C r0)r>r? _deep_clone)r+r)appliedrSrRrCs ` @@r.r:zLoad._adjust_for_extra_criterias> **;; D\  11r0c V||vr||S|j}|||<|j|_|j|jk(sJ|j|jk(sJ|j|jk(sJ|j rit j|j jDcgc]+\}}|t|tr|j||n|f-c}}|_|jj|j|||Scc}}wr9) _generaterpropagate_to_loadersr* is_opts_onlyr)rr(items isinstancerrTr#update)r+rUrSclonedkeyvalues r.rTzLoad._deep_clones 7?4= ! --**d.G.GGGG''4+A+AAAA""d&7&7777 <<!--'+ll&8&8&:#U %eT2))'7;"  FN   1 s90D% cg}|jgS|jjD]#\\}}}|dk7r|j||fz%|SNloader)r)rZappend)r+ serializedr^ loader_pathobjs r.r"zLoad._context_cache_keysc << I'+||'9'9'; 4 # S+h   kSF2 3 4r0c:tt| }i|_|Sr9)superrrWr#)r+r] __class__s r.rWzLoad._generatestT,. r0FNr3c|jjsy|j||t|j yr9)compile_options_enable_eagerloads_processbool current_path)r+r>mapper_entitiess r.'process_compile_state_replaced_entitiesz,Load.process_compile_state_replaced_entitiess;,,??   ]//0 0 r0c|jjsy|j||jt |j  xr|jj yr9)rkrlrm_lead_mapper_entitiesrnro_for_refresh_state)r+r>s r.process_compile_statezLoad.process_compile_statesU,,??    / /]//0 0 E!11DDD  r0cL|jj}|j}|r[|jj D]=\\}}}|r |j s|j ||} | -||j|| f<?y|jj|jyr9) rkrtror)rZrX _chop_path attributesr\) r+r>rpraiseerr is_refreshrotoken start_pathrbchopped_start_paths r.rmz Load._processs"22EE $11 /3||/A/A/C +# Vf&A&A%)__Z%N"%1",, 23    $ $ + +DLL 9r0c < |j}d|_|rT|jsHt|trt j dt j d|j dt|tjr|jt}|} |jts|rI|rd|_ |r|d|}|r|js|j|}|j|}||_|S|r t#|} n |j$} tj&d t)| j*|} |j,x}} ||}n]t#|}|j6s |jrMt9j:|j|ds|r&t j d|d|j$dy|j<r |x}} ||}n|j>r|j,x}} t9j:|j|ds|rt j d|d|j$dtA|dkDrR|j$j6r<|jjr&d|dd|j*jBddy|jDr|jDs|jD|_"t)|ddr|j}t#|x}}| |jF}|jH|jK|d}|jsPt9jL|jNjP|jNdd| t#|nd}t#|}|jH|jS|d||||}||_n||}| jU||jr |jH}||_|S#t.$rZ} t|t0s>tj2t j d| d| d t5|d | nYd} ~ d} ~ wwxYw#t.$rD} |r2tj2t j d |d| d | nYd} ~ yYd} ~ Fd} ~ wwxYw)Nz3Wildcard token cannot be followed by another entityzMapped attribute 'z#' does not refer to a mapped entityF:zUsing strings to indicate column or relationship paths in loader options is deprecated and will be removed in SQLAlchemy 2.0. Please use the class-bound attribute directly.zExpected attribute "z" on z' to be a mapped attribute; instead got z object.)replace_contextzCan't find property named "z in this Query.z Attribute 'z' does not link from element ''z Attribute "z" does not link from element "".rz Did you mean to use z .of_type(z)?r path_with_polymorphicT)aliased_use_mapper_path_existing_alias)+r has_entityr[rsa_exc ArgumentErrorpropr string_typesendswithr r rXis_aliased_classparentr{rrr,warn_deprecated_20getattrclass_propertyAttributeErrorr raise_type is_mapperorm_util$_entity_corresponds_to_use_path_impl is_property is_attributelen__name__r!r) entity_pathgetwith_polymorphicmapper base_mapperset _get_strategy)r+rattr for_strategy wildcard_keyrypolymorphic_entity_contextexisting_of_type default_token attr_str_nameentfound_propertyaeerrr-racext_info of_type_infoexistings r._generate_pathzLoad._generate_pathsZ == DOO$ .**I**26))> dD-- . MM.9M M}}_- 05D-&2D9D $,<,M,M;;'78Dzz$'   ./kk  # #6   szz40,0MM9D>:D4=D~~!6!6 DDKKb $228),   s1+QO(( Q 1AQQ  R4RRc"d|jdS)NzLoad(strategy=))rr+s r.__str__z Load.__str__s&*mm55r0cN|"tt|j}|Sr9)rPsortedrZ)r+rs r. _coerce_stratzLoad._coerce_strats#  VHNN$456Hr0ctd)NzHOnly 'unbound' loader options may be used with the Load.options() method)NotImplementedError)r+rrUbounds r._apply_to_parentzLoad._apply_to_parents! $  r0c &i}t|t }|r td|D]} |j|||y#t$rJ}t|t s/t jtjd|d|nYd}~hd}~wwxYw)aApply a series of options as sub-options to this :class:`_orm.Load` object. E.g.:: query = session.query(Author) query = query.options( joinedload(Author.book).options( load_only(Book.summary, Book.excerpt), joinedload(Book.citations).options( joinedload(Citation.author) ) ) ) :param \*opts: A series of loader option objects (ultimately :class:`_orm.Load` objects) which should be applied to the path specified by this :class:`_orm.Load` object. .. versionadded:: 1.3.6 .. seealso:: :func:`.defaultload` :ref:`relationship_loader_options` :ref:`deferred_loading_w_multiple` zMThe options() method is currently only supported for 'unbound' loader optionszLoader option z2 is not compatible with the Load.options() method.)from_N) r[ _UnboundLoadrrrrrrrr)r+opts apply_cacherrQrs r.optionsz Load.optionssB t\22 %/  C $$T;> " !#t,KK,,8;>!  s= BAB  Bc|j|}||_|j||d}|j|_|j|_|j |_dx|_|_|j|_y)N relationshipF)rrX_clone_for_bind_strategyrr r!r*)r+rrrXr]s r.set_relationship_strategyzLoad.set_relationship_strategysr%%h/$8!..tX~NKK  %55*>!YY--N!YYN  " "&@@B ""LL #00 # "     ,,   r0c|jj}d|d<|dtj|dd|d<|jj |d<|S)Nr3r!r))rbr)__dict__copyrserialize_context_dictr serializer+ds r. __getstate__zLoad.__getstate__~se MM    "  Y< #'>>) kAiLII'')& r0c|jj|tj|j|_|j %tj |j |_yyr9)rr\r deserializerr)deserialize_context_dict)r+states r. __setstate__zLoad.__setstate__sO U# ,,TYY7 << #'@@NDL $r0cd}tt||jD]\}\}}t|tj r>|dk(r|j dtzr|cS|dtk7r||jk7ry||urft|tr*|jr|jr|j|ry||dzdSNrrJrz relationship:r) enumerateziprr[rrrr r r^rrisa)r+to_chopric_tokenp_tokens r.rwzLoad._chop_paths %.s7DII/F%G  !A!'4#4#456g..s^/CD"NOEE7;;.'!7N3%%%%KK(/ 0q1uwr0)TN)Tr%)FN)TF)3r __module__ __qualname____doc___is_strategy_optionrExtendedInternalTraversaldp_has_cache_key dp_plain_objdp_multiInternalTraversaldp_clauseelement_listdp_has_cache_key_tuplesdp_string_multi_dict_cache_key_traversalr/ classmethodr7r<rGr:rTrr"rWrYr*rrXr r!rqrurmrrrrrrrrrrrrrrrrw __classcell__)ris@r.rr%s(T 33DDE X77DDE X77@@A H66LLM  . . F F   . . C C   '8#LJ2<B LH HO     :*#'sj6  44l37 @ @//// ''CG.A 4 O  r0rc~eZdZdZdZddZdZdZdZddZ d Z d Z d Z d Z ed ZdZddZdZdZdZy)ra<Represent a loader option that isn't tied to a root entity. The loader option will produce an entity-linked :class:`_orm.Load` object when it is passed :meth:`_query.Query.options`. This provides compatibility with the traditional system of freestanding options, e.g. ``joinedload('x.y.z')``. c<d|_g|_i|_d|_yr2)r_to_bindr#r!rs r.r/z_UnboundLoad.__init__s  !r0Nct|}|j}|vr||fS|}tj}| t ||f|j d|j |zd|jfz|jr"dtfd|jDfndz|jr!dtfd|jDfndz|jr!|jd|j|zSdzS) aXInlined gen_cache_key Original traversal is:: _cache_key_traversal = [ ("path", visitors.ExtendedInternalTraversal.dp_multi_list), ("strategy", visitors.ExtendedInternalTraversal.dp_plain_obj), ( "_to_bind", visitors.ExtendedInternalTraversal.dp_has_cache_key_list, ), ( "_extra_criteria", visitors.InternalTraversal.dp_clauseelement_list), ( "local_opts", visitors.ExtendedInternalTraversal.dp_string_multi_dict, ), ] The inlining is so that the "_to_bind" list can be flattened to not repeat the same UnboundLoad options over and over again. See #6869 rrrc3pK|]-}|vr'j|s|j/yw))_unbound_option_seenN)add_gen_cache_key)rLelemanon_map bindparamsseens r.rNz._UnboundLoad._gen_cache_key..sD!t+DHHTN ++$jt,s36r3r!c3BK|]}|jywr9)r )rLrrrs r.rNz._UnboundLoad._gen_cache_key..s& ++HjArOr#) idrir_cache_key_traversal_visitorrvisit_multi_listrrrrPr!r#visit_string_multi_dict) r+rrr idselfr5id_visrs `` @r.r z_UnboundLoad._gen_cache_keysI:Dnn X V$c* *6"C55# <5D#J"" 4: 4==)  * ==%)MM  # 6'' &$($8$89 D??++ $//4:?$ & HG$ & r0FcH|jj|d|_yr9)rrcrs r.rz_UnboundLoad._set_path_strategys T" r0c||vr||S|j}|||<|j|_|j|jk(sJ|j|jk(sJ|j|jk(sJ|j xsdDcgc]}|j ||c}|_|jj|j|||Scc}wr2) rWrrXr*rYrrTr#r\)r+rUrSr]rs r.rTz_UnboundLoad._deep_clones 7?4= ! --**d.G.GGGG''4+A+AAAA""d&7&7777<@==;NB 37D  Wg .    1  sC#c ||vr||S| |j}|j}|||<|j|_|jr|jd}t |t j r3|jtr|jdddztz}|j|j|jddz||jd|j|jk(sJ|j|jk(sJ|j|jk(sJt}|j|_|jDcgc]}||vr|j!|s|c}|Dcgc]+}||vr%|j!|s|j#||||-c}z|jdd|j$j'|j$|Scc}wcc}w)NrrrJ)rrWrrr[rrrr splitr rrXr*rYrr rr#r\) r+rrUrto_bindr]runiqrs r.rz_UnboundLoad._apply_to_parent4s 7?4= ?mmG! -- 9999R=D$ 1 12t}}8zz#q)C//A  ! ! dii"o-tT]]D  **d.G.GGGG''4+A+AAAA""d&7&7777u // 4    4  ! !&'5' B     1   s G%<0G*c |r?t|tjr%|ttfvr|tk(rd|_|d|}|rt |dr|js|dd}|r||fz}||_t|dd|_ |S)NFrrrJr!r3) r[rrr r rXrr*rrr!)r+rrrrs r.rz_UnboundLoad._generate_pathbs 4!2!23.99~%,1)*D1D $T"X.t7M7M":D 4'>D &t->C r0c|jj}d|d<|j|jd|d<|S)Nr3r!T)filter_aliased_classr)rr_serialize_pathrrs r.rz_UnboundLoad.__getstate__tsC MM    " (((N& r0c"g}|dD]p}t|trMt|dk(r|\}}d}n|\}}}t||}|r|j |}|j |`|j |rt||d<||_y)Nrr)r[rPrrof_typercr)r+rretr^r5propkeyr%rs r.rz_UnboundLoad.__setstate__}s= C#u%s8q=#&LC"G,/)C'sG,<<0D 4  3 c f  r0cD|jd}|jj}|jD]g}||vs|j ||r |j s(|j |Dcgc]}|jc}|j|j|iycc}w)N_unbound_load_dedupes) rxrkrtrr rX _bind_loader entity_zeroro)r+r>rprydedupesrzvalrs r.rmz_UnboundLoad._processs**+BC"22EE == C'! C c&>&>  0?@S__@!..!,,   As)B ct}d}|Dcgc]}||D]}|} }}| ddD]'}d|_|r |||fi|}|j|})||| dfi|}d|_|Scc}}w)Nct|tjrU|tk(rtfS|j dtzrtj dd|dd}|jdS|fS)N.zThe undocumented `.{WILDCARD}` format is deprecated and will be removed in a future version as it is believed to be unused. If you have been using this functionality, please comment on Issue #4390 on the SQLAlchemy project tracker.1.4versionr)r[rrr r startswithwarn_deprecatedrr^s r. _split_keyz+_UnboundLoad._from_keys.._split_keysn#t001/)*,,^^C/$9:((# !&ab'Cyy~%v r0rJrTF)r_is_chain_link defaultload) r5methkeyschainedkwrQr7r^r{ all_tokenss r. _from_keysz_UnboundLoad._from_keyssn *(,ICIeIeI I"% -E"&C 3,,ooe, -3 2-"-" JsA1cd}tt||jD]\}\}\}}t|tj r@|dk(r|j dtzr|cS|dtk7sT||jk7sdyt|tsw|j|usA|j|us|jjr|jj|ry|dz }||dSr)rrpairsr[rrrr r r^r r _parententityrr)r+rrrrp_entityp_props r.rwz_UnboundLoad._chop_paths 09  &1   ,A,+(F'4#4#456g..s^/CD"NOEE6::-G^4##61))9#11;;&4488B ' * FAqr{r0cPg}|D]}t|tr|r^|jrRt|jjr3|j |j j|jdft|j |j j|j|jr|jjndft|tr4|j |j j|jdf |j | |Sr9) r[rr rrrc _parentmapperrr^r,r )r+rr"r&r{s r.r#z_UnboundLoad._serialize_paths "E%!34(/@@JJ 3 3 : :EIItLMJJ!//66!II5:^^ENN11E>2 E//66 4HI 5!' "( r0c .|j}|jr |r ||dfz }|r|j||}|sy|d}t|tj r|j |||}nyt|tr+|j}|j|||j|}n>|jrt|rt|}||vrd}ntjd|sy|} t| } | | j }|j"| _|j$| _|j| _|j&| _| j} | jsSt)|D]E\} }| j+| j|| t-|dz k(r |j"ndd||rEy| j.j1|j.| js-| jj2r| jj4} n | j} | j6rA| j9D],} | j;|| |j< |j$.| S| j;|| |j< |j$| S)a]Convert from an _UnboundLoad() object into a Load() object. The _UnboundLoad() uses an informal "path" and does not necessarily refer to a lead entity as it may use string tokens. The Load() OTOH refers to a complete path. This method reconciles from a given Query into a Load. Example:: query = session.query(User).options( joinedload("orders").joinedload("items")) The above options will be an _UnboundLoad object along the lines of (note this is not the exact API of _UnboundLoad):: _UnboundLoad( _to_bind=[ _UnboundLoad(["orders"], {"lazy": "joined"}), _UnboundLoad(["orders", "items"], {"lazy": "joined"}), ] ) After this method, we get something more like this (again this is not exact API):: Load( User, (User, User.orders.property)) Load( User, (User, User.orders.property, Order, Order.items.property)) rJNz6mapper option expects string key or list of attributesr)rr)rr*rwr[rr_find_entity_basestringr r_find_entity_prop_comparatorrBrrrrrr)rrYr!rrrr#r\rrrrrr8)r+entitiesror)ryr|r{r,r path_elementrbridxrs r.r*z_UnboundLoad._bind_loadersHYY  ! !l 8A;. (J \BJ1  eT.. /11(E8LF ~ .>>D66$ 3 3XF # #(8(?U^FX%&&K   l# ?nnG--"//#'#9#9 !%!5!5{{''' 3  U,,KK%(C Oa,?%?DMMT/6 -    1''FKK,B,B#[[//N#[[N  " "&@@B $$ $ 3 33#00 %     ///,, !  r0c ft|r|}n t|}|D]}tj||s|cS|rut |s8t j dtjt|d|dt j d|ddjd|Ddy) Nz@Query has only expression-based entities, which do not apply to z ""zMapped attribute "zA" does not apply to any of the root entities in this query, e.g. , c32K|]}t|ywr9str)rLxs r.rNz<_UnboundLoad._find_entity_prop_comparator..s*Da3q6*DzV. Please specify the full path from one of the root entities to the target attribute. ) rrr_entity_corresponds_tolistrrrclsname_as_plain_namerjoin)r+rJrrry searchforrs r.rIz)_UnboundLoad._find_entity_prop_comparator~s V $I(0I C..sI>  H~ .. 55d4jA4I !..  *D8*D!D Fr0c n|jdtzratt|dk7ra|r_t j ddj d|Dddj d|Dd|jtrd }|D]}|cS|rt j d |d y) NrrzMCan't apply wildcard ('*') or load_only() loader option to multiple entities rOc32K|]}t|ywr9rQrLrs r.rNz7_UnboundLoad._find_entity_basestring..s%C3c#h%CrTz?. Specify loader options for each entity individually, such as c3&K|] }d|z yw)zLoad(%s).some_option('*')Nr3r\s r.rNz7_UnboundLoad._find_entity_basestring..s&$'!>#/ 04>"a' .. !II%C(%CC II&+3&   ^^N +H CJ  **:?B r0r9F)rrrrr/r r8rrTrrrrrmrr?rwr#r*rIrHr3r0r.rrsn" Q fN0,\$& %%N60BH8 r0rc$eZdZdZdZdZdZy) loader_optioncyr9r3rs r.r/zloader_option.__init__s r0c|jx|_}||_tt|rt d|zt t|||S)Nz#Load class already has a %s method.)rnamefnhasattrr TypeErrorsetattr)r+rdrcs r.__call__zloader_option.__call__sE;;& D 4 ATJK KdB r0c||_|jj}dd|jiz|j_||_|S)NzProduce a new :class:`_orm.Load` object with the :func:`_orm.%(name)s` option applied. See :func:`_orm.%(name)s` for usage examples. rc) _unbound_fnrdrrc)r+rdfn_docs r._add_unbound_fnzloader_option._add_unbound_fnsG DII    r0cdd|jiz|_tjddd|jizd|}||_|S)Na}Produce a standalone "all" option for :func:`_orm.%(name)s`. .. deprecated:: 0.9 The :func:`_orm.%(name)s_all` function is deprecated, and will be removed in a future release. Please use method chaining with :func:`_orm.%(name)s` instead, as in:: session.query(MyClass).options( %(name)s("someattribute").%(name)s("anotherattribute") ) rcz0.9zThe :func:`.%(name)s_all` function is deprecated, and will be removed in a future release. Please use method chaining with :func:`.%(name)s` insteadF)add_deprecation_to_docstring)rcrr deprecated_unbound_all_fn)r+rds r._add_unbound_all_fnz!loader_option._add_unbound_all_fnsk  DII    T__  (+1499*= >*/   " r0N)rrrr/rhrlrqr3r0r.r`r`s  r0r`Nc0|@t|tst|}|j}nFt j ddn.t |ddr!t|j}|j}|j|ddid }||jd <|S) aIndicate that the given attribute should be eagerly loaded from columns stated manually in the query. This function is part of the :class:`_orm.Load` interface and supports both method-chained and standalone operation. The option is used in conjunction with an explicit join that loads the desired rows, i.e.:: sess.query(Order).\ join(Order.user).\ options(contains_eager(Order.user)) The above query would join from the ``Order`` entity to its related ``User`` entity, and the returned ``Order`` objects would have the ``Order.user`` attribute pre-populated. It may also be used for customizing the entries in an eagerly loaded collection; queries will normally want to use the :meth:`_query.Query.populate_existing` method assuming the primary collection of parent objects may already have been loaded:: sess.query(User).\ join(User.addresses).\ filter(Address.email_address.like('%@aol.com')).\ options(contains_eager(User.addresses)).\ populate_existing() See the section :ref:`contains_eager` for complete usage details. .. seealso:: :ref:`loading_toplevel` :ref:`contains_eager` NzPassing a string name for the 'alias' argument to 'contains_eager()` is deprecated, and will not work in a future release. Please use a sqlalchemy.alias() or sqlalchemy.orm.aliased() construct.r1r2r lazyjoinedF)rXeager_from_alias) r[rRr selectablerr5rr rr#)loadoptraliasinfootr]s r.contains_eagerr{sN %%5>DOOE  6   z4 ( T]] #   . . vx u/F-2F() Mr0cVtjtj|d|Sr)rr?r{r;r=s r.r{r{8s& > $ $##T4 r0c`|j|ddd}|jddddddi|S)alIndicate that for a particular entity, only the given list of column-based attribute names should be loaded; all others will be deferred. This function is part of the :class:`_orm.Load` interface and supports both method-chained and standalone operation. Example - given a class ``User``, load only the ``name`` and ``fullname`` attributes:: session.query(User).options(load_only(User.name, User.fullname)) Example - given a relationship ``User.addresses -> Address``, specify subquery loading for the ``User.addresses`` collection, but on each ``Address`` object load only the ``email_address`` attribute:: session.query(User).options( subqueryload(User.addresses).load_only(Address.email_address) ) For a :class:`_query.Query` that has multiple entities, the lead entity can be specifically referred to using the :class:`_orm.Load` constructor:: session.query(User, Address).join(User.addresses).options( Load(User).load_only(User.name, User.fullname), Load(Address).load_only(Address.email_address) ) .. note:: This method will still load a :class:`_schema.Column` even if the column property is defined with ``deferred=True`` for the :func:`.column_property` function. .. versionadded:: 0.9.0 FTdeferred instrument* undefer_pksr)rwrr]s r. load_onlyr?sGL ( ( E6F  $d 3mT5J Mr0c0tj|Sr9)rr)rs r.rrns #<> # #U ++r0cP|j|ddi}|||jd<|S)a? Indicate that the given attribute should be loaded using joined eager loading. This function is part of the :class:`_orm.Load` interface and supports both method-chained and standalone operation. examples:: # joined-load the "orders" collection on "User" query(User).options(joinedload(User.orders)) # joined-load Order.items and then Item.keywords query(Order).options( joinedload(Order.items).joinedload(Item.keywords)) # lazily load Order.items, but when Items are loaded, # joined-load the keywords collection query(Order).options( lazyload(Order.items).joinedload(Item.keywords)) :param innerjoin: if ``True``, indicates that the joined eager load should use an inner join instead of the default of left outer join:: query(Order).options(joinedload(Order.user, innerjoin=True)) In order to chain multiple eager joins together where some may be OUTER and others INNER, right-nested joins are used to link them:: query(A).options( joinedload(A.bs, innerjoin=False). joinedload(B.cs, innerjoin=True) ) The above query, linking A.bs via "outer" join and B.cs via "inner" join would render the joins as "a LEFT OUTER JOIN (b JOIN c)". When using older versions of SQLite (< 3.7.16), this form of JOIN is translated to use full subqueries as this syntax is otherwise not directly supported. The ``innerjoin`` flag can also be stated with the term ``"unnested"``. This indicates that an INNER JOIN should be used, *unless* the join is linked to a LEFT OUTER JOIN to the left, in which case it will render as LEFT OUTER JOIN. For example, supposing ``A.bs`` is an outerjoin:: query(A).options( joinedload(A.bs). joinedload(B.cs, innerjoin="unnested") ) The above join will render as "a LEFT OUTER JOIN b LEFT OUTER JOIN c", rather than as "a LEFT OUTER JOIN (b JOIN c)". .. note:: The "unnested" flag does **not** affect the JOIN rendered from a many-to-many association table, e.g. a table configured as :paramref:`_orm.relationship.secondary`, to the target table; for correctness of results, these joins are always INNER and are therefore right-nested if linked to an OUTER join. .. versionchanged:: 1.0.0 ``innerjoin=True`` now implies ``innerjoin="nested"``, whereas in 0.9 it implied ``innerjoin="unnested"``. In order to achieve the pre-1.0 "unnested" inner join behavior, use the value ``innerjoin="unnested"``. See :ref:`migration_3008`. .. note:: The joins produced by :func:`_orm.joinedload` are **anonymously aliased**. The criteria by which the join proceeds cannot be modified, nor can the :class:`_query.Query` refer to these joins in any way, including ordering. See :ref:`zen_of_eager_loading` for further detail. To produce a specific SQL JOIN which is explicitly available, use :meth:`_query.Query.join`. To combine explicit JOINs with eager loading of collections, use :func:`_orm.contains_eager`; see :ref:`contains_eager`. .. seealso:: :ref:`loading_toplevel` :ref:`joined_eager_loading` rsrt innerjoin)rr#)rwrrrbs r. joinedloadrss7p . .tfh5G HF)2+& Mr0cNtjtj|d|Sr%)rr?rr}s r.rrs  " "<#:#:D% LLr0c*|j|ddiS)aIndicate that the given attribute should be loaded using subquery eager loading. This function is part of the :class:`_orm.Load` interface and supports both method-chained and standalone operation. examples:: # subquery-load the "orders" collection on "User" query(User).options(subqueryload(User.orders)) # subquery-load Order.items and then Item.keywords query(Order).options( subqueryload(Order.items).subqueryload(Item.keywords)) # lazily load Order.items, but when Items are loaded, # subquery-load the keywords collection query(Order).options( lazyload(Order.items).subqueryload(Item.keywords)) .. seealso:: :ref:`loading_toplevel` :ref:`subquery_eager_loading` rssubqueryrrwrs r. subqueryloadrs<  , ,TFJ3G HHr0cNtjtj|diSr%)rr?rr;s r.rr  " "<#<#  , ,TFJ3G HHr0cNtjtj|diSr%)rr?rrs r.rrrr0c*|j|ddiS)a Indicate that the given attribute should be loaded using "lazy" loading. This function is part of the :class:`_orm.Load` interface and supports both method-chained and standalone operation. .. seealso:: :ref:`loading_toplevel` :ref:`lazy_loading` rsselectrrs r.lazyloadr#s  , ,TFH3E FFr0cNtjtj|diSr%)rr?rrs r.rr5s  " "<#8#8$r JJr0c.|j|ddi}|S)aIndicate that the given attribute should be loaded using an immediate load with a per-attribute SELECT statement. The load is achieved using the "lazyloader" strategy and does not fire off any additional eager loaders. The :func:`.immediateload` option is superseded in general by the :func:`.selectinload` option, which performs the same task more efficiently by emitting a SELECT for all loaded objects. This function is part of the :class:`_orm.Load` interface and supports both method-chained and standalone operation. .. seealso:: :ref:`loading_toplevel` :ref:`selectin_eager_loading` rs immediater)rwrrbs r. immediateloadr:s , . .tfk5J KF Mr0cNtjtj|diSr%)rr?rrs r.rrTs  " "<#=#=tUB OOr0c*|j|ddiS)aIndicate that the given relationship attribute should remain unloaded. The relationship attribute will return ``None`` when accessed without producing any loading effect. This function is part of the :class:`_orm.Load` interface and supports both method-chained and standalone operation. :func:`_orm.noload` applies to :func:`_orm.relationship` attributes; for column-based attributes, see :func:`_orm.defer`. .. note:: Setting this loading strategy as the default strategy for a relationship using the :paramref:`.orm.relationship.lazy` parameter may cause issues with flushes, such if a delete operation needs to load related objects and instead ``None`` was returned. .. seealso:: :ref:`loading_toplevel` rsnoloadrrs r.rrYs0  , ,TFH3E FFr0cNtjtj|diSr%)rr?rrs r.rrts  " "<#6#6eR HHr0c<|j|d|rdiSdiS)aIndicate that the given attribute should raise an error if accessed. A relationship attribute configured with :func:`_orm.raiseload` will raise an :exc:`~sqlalchemy.exc.InvalidRequestError` upon access. The typical way this is useful is when an application is attempting to ensure that all relationship attributes that are accessed in a particular context would have been already loaded via eager loading. Instead of having to read through SQL logs to ensure lazy loads aren't occurring, this strategy will cause them to raise immediately. :func:`_orm.raiseload` applies to :func:`_orm.relationship` attributes only. In order to apply raise-on-SQL behavior to a column-based attribute, use the :paramref:`.orm.defer.raiseload` parameter on the :func:`.defer` loader option. :param sql_only: if True, raise only if the lazy load would emit SQL, but not if it is only checking the identity map, or determining that the related value should just be None due to missing keys. When False, the strategy will raise for all varieties of relationship loading. This function is part of the :class:`_orm.Load` interface and supports both method-chained and standalone operation. .. versionadded:: 1.1 .. seealso:: :ref:`loading_toplevel` :ref:`prevent_lazy_with_raiseload` :ref:`deferred_raiseload` rs raise_on_sqlraiser)rwrsql_onlys r. raiseloadrys4N  , , v~? 7>? r0cNtjtj|d|Sr%)rr?rr}s r.rrs  " "<#9#94 KKr0c&|j|dS)a:Indicate an attribute should load using its default loader style. This method is used to link to other loader options further into a chain of attributes without altering the loader style of the links along the chain. For example, to set joined eager loading for an element of an element:: session.query(MyClass).options( defaultload(MyClass.someattribute). joinedload(MyOtherClass.someotherattribute) ) :func:`.defaultload` is also useful for setting column-level options on a related class, namely that of :func:`.defer` and :func:`.undefer`:: session.query(MyClass).options( defaultload(MyClass.someattribute). defer("some_column"). undefer("some_other_column") ) .. seealso:: :meth:`_orm.Load.options` - allows for complex hierarchical loader option structures with less verbosity than with individual :func:`.defaultload` directives. :ref:`relationship_loader_options` :ref:`deferred_loading_w_multiple` Nrrs r.r9r9sD  , ,T4 88r0cNtjtj|diSr%)rr?r9rs r.r9r9s  " "<#;#;T5" MMr0c@ddd}|rd|d<|j|f|S)aIndicate that the given column-oriented attribute should be deferred, e.g. not loaded until accessed. This function is part of the :class:`_orm.Load` interface and supports both method-chained and standalone operation. e.g.:: from sqlalchemy.orm import defer session.query(MyClass).options( defer("attribute_one"), defer("attribute_two")) session.query(MyClass).options( defer(MyClass.attribute_one), defer(MyClass.attribute_two)) To specify a deferred load of an attribute on a related class, the path can be specified one token at a time, specifying the loading style for each link along the chain. To leave the loading style for a link unchanged, use :func:`_orm.defaultload`:: session.query(MyClass).options(defaultload("someattr").defer("some_column")) A :class:`_orm.Load` object that is present on a certain path can have :meth:`_orm.Load.defer` called multiple times, each will operate on the same parent entity:: session.query(MyClass).options( defaultload("someattr"). defer("some_column"). defer("some_other_column"). defer("another_column") ) :param key: Attribute to be deferred. :param raiseload: raise :class:`.InvalidRequestError` if the column value is to be loaded from emitting SQL. Used to prevent unwanted SQL from being emitted. .. versionadded:: 1.4 .. seealso:: :ref:`deferred_raiseload` :param \*addl_attrs: This option supports the old 0.8 style of specifying a path as a series of attributes, which is now superseded by the method-chained style. .. deprecated:: 0.9 The \*addl_attrs on :func:`_orm.defer` is deprecated and will be removed in a future release. Please use method chaining in conjunction with defaultload() to indicate a path. .. seealso:: :ref:`deferred` :func:`_orm.undefer` Trrr)rwr^rrs r.deferrs1J!5H $  & &vx 88r0c|rtjddtjtj|f|zd|S)Nz}The *addl_attrs on orm.defer is deprecated. Please use method chaining in conjunction with defaultload() to indicate a path.1.3r2F)rr5rr?r)r^ addl_attrsr=s r.rrsH     " "SFZ/ r0c.|j|fdddS)agIndicate that the given column-oriented attribute should be undeferred, e.g. specified within the SELECT statement of the entity as a whole. The column being undeferred is typically set up on the mapping as a :func:`.deferred` attribute. This function is part of the :class:`_orm.Load` interface and supports both method-chained and standalone operation. Examples:: # undefer two columns session.query(MyClass).options(undefer("col1"), undefer("col2")) # undefer all columns specific to a single class using Load + * session.query(MyClass, MyOtherClass).options( Load(MyClass).undefer("*")) # undefer a column on a related object session.query(MyClass).options( defaultload(MyClass.items).undefer('text')) :param key: Attribute to be undeferred. :param \*addl_attrs: This option supports the old 0.8 style of specifying a path as a series of attributes, which is now superseded by the method-chained style. .. deprecated:: 0.9 The \*addl_attrs on :func:`_orm.undefer` is deprecated and will be removed in a future release. Please use method chaining in conjunction with defaultload() to indicate a path. .. seealso:: :ref:`deferred` :func:`_orm.defer` :func:`_orm.undefer_group` FTrr)rwr^s r.undeferr-s$X  & & U$7 r0c|rtjddtjtj|f|zdiS)NzThe *addl_attrs on orm.undefer is deprecated. Please use method chaining in conjunction with defaultload() to indicate a path.rr2F)rr5rr?r)r^rs r.rr^sH     " "sfz15" r0c6|jddd|zdidS)aIndicate that columns within the given deferred group name should be undeferred. The columns being undeferred are set up on the mapping as :func:`.deferred` attributes and include a "group" name. E.g:: session.query(MyClass).options(undefer_group("large_attrs")) To undefer a group of attributes on a related entity, the path can be spelled out using relationship loader options, such as :func:`_orm.defaultload`:: session.query(MyClass).options( defaultload("someattr").undefer_group("large_attrs")) .. versionchanged:: 0.9.0 :func:`_orm.undefer_group` is now specific to a particular entity load path. .. seealso:: :ref:`deferred` :func:`_orm.defer` :func:`_orm.undefer` rNzundefer_group_%sT)rr)rwrcs r. undefer_grouprls0>  & & T&-t4 ' r0c4tj|Sr9)rr)rcs r.rrs > ' ' --r0ctjtjt |}|j |fddid|iS)aApply an ad-hoc SQL expression to a "deferred expression" attribute. This option is used in conjunction with the :func:`_orm.query_expression` mapper-level construct that indicates an attribute which should be the target of an ad-hoc SQL expression. E.g.:: sess.query(SomeClass).options( with_expression(SomeClass.x_y_expr, SomeClass.x + SomeClass.y) ) .. versionadded:: 1.2 :param key: Attribute to be populated. :param expr: SQL expression to be applied to the attribute. .. versionchanged:: 1.4 Loader options such as :func:`_orm.with_expression` take effect only at the **outermost** query used, and should not be used within subqueries or inner elements of a UNION. See the change notes at :ref:`change_8879` for background on how to correctly add arbitrary columns to subqueries. .. note:: the target attribute is populated only if the target object is **not currently loaded** in the current :class:`_orm.Session` unless the :meth:`_query.Query.populate_existing` method is used. Please refer to :ref:`mapper_querytime_expression` for complete usage details. .. seealso:: :ref:`mapper_querytime_expression` query_expressionT expressionr)rexpectrLabeledColumnExprRolerr)rwr^rs r.with_expressionrsTP!! ##%9*%EJ  & & #T*, 1K ' r0cTtjtj|fdd|iS)NFr)rr?r)r^rs r.rrs+  " "$$sfelJ5O r0c r|jddidttd|Dti|S)a~Indicate an eager load should take place for all attributes specific to a subclass. This uses an additional SELECT with IN against all matched primary key values, and is the per-query analogue to the ``"selectin"`` setting on the :paramref:`.mapper.polymorphic_load` parameter. .. versionadded:: 1.2 .. seealso:: :ref:`polymorphic_selectin` selectinload_polymorphicTrJc32K|]}t|ywr9r)rLr5s r.rNz'selectin_polymorphic..s8 8rTr6r)rrPrr)rwclassess r.selectin_polymorphicrsE   #T* 88bA  Nr0clt}d|_t|f|_|j ||Sr)rr*rrr)base_clsruls r.rrs3 BBx "BGG$ Ir0r9r^)5rrrrrxrbaserrrr interfacesr r r path_registryr r rrrrrrsqlrrrrrsql.baserrrrobjectr`r{rlrrrrrrrrr9rrrrrr3r0r.rsx*"#" $&&)*'(&"!G  :|G  TK4K\8F8v<<~  ++\ ,,ZZz MMII@OOIIBOOGG" KK2PPGG4II((V LL!9!9H NNG9G9T  --`     F..--`  ! 4%%&r0