Oǻi:-ddlmZmZmZmZddlmZeZGddZ GddZ GddZ Gd d e Z Gd d e Z Gd dZGddZGddZy))ListOptionalTupleUnion)DEFAULT_DIALECTc(eZdZddededdfdZdZy)LimitoffsetcountreturnNc ||_||_yN)r r )selfr r s _/opt/lhia/marcimex/agent/venv/lib/python3.12/site-packages/redis/commands/search/aggregation.py__init__zLimit.__init__ s  ct|jr+dt|jt|jgSgS)NLIMIT)r strr rs r build_argszLimit.build_args s, ::S-s4::? ?Ir)rr__name__ __module__ __qualname__intrrrrr r s!ss4rr cTeZdZdZdZdeddfdZdeddfdZede edffd Z y) Reducerzr Base reducer object for all reducers. See the `redisearch.reducers` module for the actual reducers. Nargsr c.||_d|_d|_yr)_args_field_aliasrr s rrzReducer.__init__s&* %) %) raliascp|tur&|js td|jdd}||_|S)a Set the alias for this reducer. ### Parameters - **alias**: The value of the alias for this reducer. If this is the special value `aggregation.FIELDNAME` then this reducer will be aliased using the same name as the field upon which it operates. Note that using `FIELDNAME` is only possible on reducers which operate on a single field value. This method returns the `Reducer` object making it suitable for chaining. z(Cannot use FIELDNAME alias with no fieldN) FIELDNAMEr# ValueErrorr$)rr&s rr&z Reducer.alias"s< I ;; !KLL AB  r.c|jSr)r"rs rr z Reducer.args:s zzr) rrr__doc__NAMErrr&propertyrr rrrrrsW D*c*d* 390eCHorrc6eZdZUdZdZeeed<deddfdZy) SortDirectionz@ This special class is used to indicate sort direction. N DIRSTRINGfieldr c||_yr)r2)rr2s rrzSortDirection.__init__Fs  r) rrrr,r1rr__annotations__rrrrr0r0?s* $Ix}#cdrr0ceZdZdZdZy)AsczK Indicate that the given field should be sorted in ascending order ASCNrrrr,r1rrrr6r6JsIrr6ceZdZdZdZy)DesczL Indicate that the given field should be sorted in descending order DESCNr8rrrr:r:RsIrr:ceZdZdZddeddfdZdeddfdZdeeeefde ddfd Z dd Z d e d e ddfd Z deddfdZdeeeefddfdZddZddZdeddfdZddZdde deddfdZdeefdZde ddfdZy)AggregateRequestzH Aggregation request which can be passed to `Client.aggregate`. queryr Nc||_g|_g|_d|_d|_d|_d|_g|_t|_ d|_ d|_ y)a} Create an aggregation request. This request may then be passed to `client.aggregate()`. In order for the request to be usable, it must contain at least one group. - **query** Query string for filtering records. All member methods (except `build_args()`) return the object itself, making them useful for chaining. FrTFIDFN) _query_aggregateplan _loadfields_loadall_max _with_schema _verbatim_cursorr_dialect _add_scores_scorer)rr>s rrzAggregateRequest.__init___sU! )+&(#  "'$"$ , !&# rfieldscR|r|jj||Sd|_|S)aC Indicate the fields to be returned in the response. These fields are returned in addition to any others implicitly specified. ### Parameters - **fields**: If fields not specified, all the fields will be loaded. Otherwise, fields should be given in the format of `@field`. T)rCextendrD)rrLs rloadzAggregateRequest.loadxs0     # #F + !DM rreducersc rt|tr|gn|}dtt|g|}|D]i}|d|jtt|jgz }|j |j|j Y|d|j gz }k|jj ||S)a| Specify by which fields to group the aggregation. ### Parameters - **fields**: Fields to group by. This can either be a single string, or a list of strings. both cases, the field should be specified as `@field`. - **reducers**: One or more reducers. Reducers may be found in the `aggregation` module. GROUPBYREDUCEAS) isinstancerlenr-r rNr$rB)rrLrPretreducers rgroup_byzAggregateRequest.group_bys(4&&#c&k*4V4 .G HgllCGLL0A,BC CC JJw|| $~~)gnn--  . ""3' rc |jD]-\}}d|g}||d|gz }|jj|/|S)aQ Specify one or more projection expressions to add to each result ### Parameters - **kwexpr**: One or more key-value pairs for a projection. The key is the alias for the projection, and the value is the projection expression itself, for example `apply(square_root="sqrt(@foo)")` APPLYrT)itemsrBrN)rkwexprr&exprrWs rapplyzAggregateRequest.applysU"<<> ,KE4D/C e}$    & &s +  ,  rr numcpt||}|jj|j|S)a Sets the limit for the most recent group or query. If no group has been defined yet (via `group_by()`) then this sets the limit for the initial pool of results from the query. Otherwise, this limits the number of items operated on from the previous group. Setting a limit on the initial search results may be useful when attempting to execute an aggregation on a sample of a large data set. ### Parameters - **offset**: Result offset from which to begin paging - **num**: Number of results to return Example of sorting the initial results: ``` AggregateRequest("@sale_amount:[10000, inf]") .limit(0, 10) .group_by("@state", r.count()) ``` Will only group by the states found in the first 10 results of the query `@sale_amount:[10000, inf]`. On the other hand, ``` AggregateRequest("@sale_amount:[10000, inf]") .limit(0, 1000) .group_by("@state", r.count() .limit(0, 10) ``` Will group all the results matching the query, but only return the first 10 groups. If you only wish to return a *top-N* style query, consider using `sort_by()` instead. )r rBrNr)rr r`_limits rlimitzAggregateRequest.limits3Tvs# ""6#4#4#67 rcZg}|D]:}t|ttfr||j|jgz }5||gz }<dt t |g}|j||jdd}|dkDr|dt |gz }|jj||S)a, Indicate how the results should be sorted. This can also be used for *top-N* style queries ### Parameters - **fields**: The fields by which to sort. This can be either a single field or a list of fields. If you wish to specify order, you can use the `Asc` or `Desc` wrapper classes. - **max**: Maximum number of results to return. This can be used instead of `LIMIT` and is also faster. Example of sorting by `foo` ascending and `bar` descending: ``` sort_by(Asc("@foo"), Desc("@bar")) ``` Return the top 10 customers: ``` AggregateRequest() .group_by("@customer", r.sum("@paid").alias(FIELDNAME)) .sort_by(Desc("@paid"), max=10) ``` SORTBYmaxrMAX) rUr6r:r2r1rrVrNgetrB)rrLkwargs fields_argsfrWrfs rsort_byzAggregateRequest.sort_bys:  #A!c4[)55 s"  # S-./ ;jj" 7 E3s8$ $C ""3' r expressionsctt|tr|g}|D]}|jjd|g!|S)z Specify filter for post-query results using predicates relating to values in the result set. ### Parameters - **fields**: Fields to group by. This can either be a single string, or a list of strings. FILTER)rUrrBrN)rrm expressions rfilterzAggregateRequest.filtersD k3 '&-K% ?J    & &*'= > ? rcd|_|S)z| If set, the `schema` property will contain a list of `[field, type]` entries in the result object. T)rFrs r with_schemazAggregateRequest.with_schema!s ! rcd|_|S)zM If set, includes the score as an ordinary field of the row. T)rJrs r add_scoreszAggregateRequest.add_scores)s  rscorerc||_|S)z Use a different scoring function to evaluate document relevance. Default is `TFIDF`. :param scorer: The scoring function to use (e.g. `TFIDF.DOCNORM` or `BM25`) )rK)rrvs rrvzAggregateRequest.scorer0s  rcd|_|S)NT)rGrs rverbatimzAggregateRequest.verbatim;s rr max_idlechdg}|r|dt|gz }|r|dt|dzgz }||_|S)N WITHCURSORCOUNTMAXIDLEi)rrH)rr rzr s rcursorzAggregateRequest.cursor?sF~  Wc%j) )D  YHtO 45 5D  rc|jg}|jr|jd|jr|jd|jr|j d|jg|j r|jd|jr||jz }|jr#|jd|jdne|jrY|jd|jtt|j|j |j|jr&|j dt|jg|j |j|S)N WITHSCHEMAVERBATIMSCORER ADDSCORESLOAD*DIALECT)rArFappendrGrKrNrJrHrDrCrrVrIrB)rrWs rrzAggregateRequest.build_argsHs{{m    JJ| $ >> JJz " << JJ$,,/ 0    JJ{ # << 4<< C == JJv  JJsO    JJv  JJs3t//01 2 JJt'' ( == JJ 3t}}#56 7 4&&' rdialectc||_|S)z Add a dialect field to the aggregate command. - **dialect** - dialect version to execute the query under )rI)rrs rrzAggregateRequest.dialectks    r)r)r r=)rg)rrrr,rrrOrrrrYr_rrcrlrqrsrurvryfloatrrrrrrr=r=Zs$c$D$2C$6 CcN+8? 4$,C,c,.@,\+s+1C+Z%T#Y"7)rr __class__ridrVrrs r__repr__zAggregateResult.__repr__sZ!%dkkoo"''(r$xl; N#9SE 4 r)rrrrrrrrrrrrs!V  # rrN)typingrrrrredis.commands.search.dialectrobjectr)r rr0r6r:r=rrrrrrsm//9 H   ((V-=XXv     r