o i:-@sddlmZmZmZmZddlmZeZGdddZ GdddZ GdddZ Gd d d e Z Gd d d e Z Gd ddZGdddZGdddZdS))ListOptionalTupleUnion)DEFAULT_DIALECTc@s,eZdZd dededdfddZdd ZdS) LimitroffsetcountreturnNcCs||_||_dSN)rr )selfrr r U/home/ubuntu/.local/lib/python3.10/site-packages/redis/commands/search/aggregation.py__init__ s zLimit.__init__cCs |jrdt|jt|jgSgS)NLIMIT)r strrr r r r build_args szLimit.build_args)rr__name__ __module__ __qualname__intrrr r r rrs rc@sReZdZdZdZdeddfddZdeddfdd Zede ed ffd d Z dS) Reducerzr Base reducer object for all reducers. See the `redisearch.reducers` module for the actual reducers. Nargsr cGs||_d|_d|_dSr )_args_field_aliasr rr r rr zReducer.__init__aliascCs.|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)r r r r rr "s z Reducer.alias.cCs|jSr )rrr r rr:sz Reducer.args) rrr__doc__NAMErrr propertyrrr r r rrsrc@s4eZdZUdZdZeeed<deddfddZdS) SortDirectionz@ This special class is used to indicate sort direction. N DIRSTRINGfieldr cCs ||_dSr )r))r r)r r rrFs zSortDirection.__init__) rrrr$r(rr__annotations__rr r r rr'?s r'c@eZdZdZdZdS)AsczK Indicate that the given field should be sorted in ascending order ASCNrrrr$r(r r r rr,Jr,c@r+)DesczL Indicate that the given field should be sorted in descending order DESCNr.r r r rr0Rr/r0c@seZdZdZd-deddfddZdeddfd d Zdeeeefd e ddfd d Z d.ddZ de de ddfddZ deddfddZdeeeefddfddZd.ddZd.ddZdeddfddZd.d d!Zd/d$e d%eddfd&d'Zdeefd(d)Zd*e ddfd+d,ZdS)0AggregateRequestzH Aggregation request which can be passed to `Client.aggregate`. *queryr NcCsF||_g|_g|_d|_d|_d|_d|_g|_t|_ d|_ d|_ dS)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)r r4r r rr_s  zAggregateRequest.__init__fieldscGs|r |j||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)r8extendr9)r rAr r rloadxs  zAggregateRequest.loadreducerscGst|tr|gn|}dtt|g|}|D]!}|d|jtt|jg7}||j|jdur7|d|jg7}q|j||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. GROUPBYREDUCENAS) isinstancerlenr%rrBrr7)r rArDretreducerr r rgroup_bys   zAggregateRequest.group_bycKs>|D]\}}d|g}|dur|d|g7}|j|q|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)")` APPLYNrG)itemsr7rB)r kwexprr exprrJr r rapplys   zAggregateRequest.applyrnumcCst||}|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. )rr7rBr)r rrR_limitr r rlimits *zAggregateRequest.limitcOsg}|D]}t|ttfr||j|jg7}q||g7}qdtt|g}|||dd}|dkr;|dt|g7}|j ||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) rHr,r0r)r(rrIrBgetr7)r rAkwargs fields_argsfrJrVr r rsort_bys    zAggregateRequest.sort_by expressionscCs.t|tr|g}|D] }|jd|gq |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)rHrr7rB)r r] expressionr r rfilters zAggregateRequest.filtercC d|_|S)z| If set, the `schema` property will contain a list of `[field, type]` entries in the result object. T)r;rr r r with_schema!szAggregateRequest.with_schemacCra)zM If set, includes the score as an ordinary field of the row. T)r?rr r r add_scores)szAggregateRequest.add_scoresscorercC ||_|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`) )r@)r rdr r rrd0szAggregateRequest.scorercCra)NT)r<rr r rverbatim;szAggregateRequest.verbatimrr max_idlecCs<dg}|r |dt|g7}|r|dt|dg7}||_|S)N WITHCURSORCOUNTMAXIDLEi)rr=)r r rhrr r rcursor?szAggregateRequest.cursorcCs|jg}|jr |d|jr|d|jr|d|jg|jr'|d|jr/||j7}|jr=|d|dn|j rU|d|t t |j ||j |j rb|dt |j g||j |S)N WITHSCHEMAVERBATIMSCORER ADDSCORESLOADr3DIALECT)r6r;appendr<r@rBr?r=r9r8rrIr>r7)r rJr r rrHs,         zAggregateRequest.build_argsdialectcCre)z Add a dialect field to the aggregate command. - **dialect** - dialect version to execute the query under )r>)r rtr r rrtkszAggregateRequest.dialect)r3)r r2)rrg)rrrr$rrrCrrrrLrQrrTr\r`rbrcrdrffloatrlrrtr r r rr2Zs, .-    #r2c@s&eZdZdeddfddZddZdS)Cursorcidr NcCs||_d|_d|_dS)Nr)rwrhr r rwr r rrvrzCursor.__init__cCs@t|jg}|jr|dt|jg7}|jr|dt|jg7}|S)Nrkrj)rrwrhr rr r rr{s zCursor.build_argsrr r r rrvus rvc@s,eZdZdeddfddZdefddZdS)AggregateResultrlr NcCs||_||_||_dSr )rowsrlschema)r rzrlr{r r rrrzAggregateResult.__init__c Cs@|jr|jjnd}d|jjdt|ddt|jd|d S)N)rlrw __class__ridrIrzrxr r r__repr__szAggregateResult.__repr__)rrrrvrrrr r r rrysryN)typingrrrrredis.commands.search.dialectrobjectr"rrr'r,r0r2rvryr r r rs  +