File: //lib/python3.9/site-packages/redis/commands/search/__pycache__/query.cpython-39.pyc
a
��b#( � @ sN G d d� d�Z G dd� d�ZG dd� de�ZG dd� de�ZG dd � d �Zd
S ) c @ s� e Zd ZdZdd� Zdd� Zdd� Zdd � Zd7d d �Zd
d� Z d8dd�Z
d9dd�Z dd� Z dd� Z
dd� Zdd� Zdd � Zd d � Zd d � Zd!d"� Zd#d$� Zd%d&� Zd'd(� Zd)d*� Zd+d,� Zd-d.� Zd:d0d1�Zd2d3� Ze d d4�d5d6�Z d
S );�QueryaB
Query is used to build complex queries that have more parameters than just
the query string. The query string is set in the constructor, and other
options have setter functions.
The setter functions return the query object, so they can be chained,
i.e. `Query("foo").verbatim().filter(...)` etc.
c C s� || _ d| _d| _d| _d| _d| _d| _d| _d| _d| _ t
� | _ d| _ d| _
d| _d| _g | _g | _g | _d| _d| _d| _dS )z�
Create a new query object.
The query string is set in the constructor, and other options have
setter functions.
� �
FN���)�
_query_string�_offset�_num� _no_content�
_no_stopwords�_fields� _verbatim�_with_payloads� _with_scores�_scorer�list�_filters�_ids�_slop� _in_order�_sortby�_return_fields�_summarize_fields�_highlight_fields� _language� _expander�_dialect)�self� query_string� r �?/usr/lib/python3.9/site-packages/redis/commands/search/query.py�__init__ s* zQuery.__init__c C s | j S )z+Return the query string of this query only.)r �r r r r r ( s zQuery.query_stringc G s
|| _ | S )zTLimit the results to a specific set of pre-known document
ids of any length.)r )r Zidsr r r � limit_ids, s zQuery.limit_idsc G s | j |7 _ | S )z Add fields to return fields.)r �r �fieldsr r r �
return_fields2 s zQuery.return_fieldsNc C s* | j �|� |dur&| j d|f7 _ | S )zJAdd field to return fields (Optional: add 'AS' name
to the field).NZAS)r �append)r �fieldZas_fieldr r r � return_field7 s zQuery.return_fieldc C s |sg S t |t�r|gS t|�S �N)�
isinstance�strr r" r r r �_mk_field_list? s zQuery._mk_field_listc C sz dg}| � |�}|r,|dtt|��g| 7 }|durD|dt|�g7 }|dur\|dt|�g7 }|durp|d|g7 }|| _| S )a�
Return an abridged format of the field, containing only the segments of
the field which contain the matching term(s).
If `fields` is specified, then only the mentioned fields are
summarized; otherwise all results are summarized.
Server side defaults are used for each option (except `fields`)
if not specified
- **fields** List of fields to summarize. All fields are summarized
if not specified
- **context_len** Amount of context to include with each fragment
- **num_frags** Number of fragments per document
- **sep** Separator string to separate fragments
Z SUMMARIZE�FIELDSNZLENZFRAGSZ SEPARATOR)r+ r* �lenr )r r# Z context_lenZ num_frags�sep�argsr r r � summarizeD s
zQuery.summarizec C sL dg}| � |�}|r,|dtt|��g| 7 }|rB|dgt|� 7 }|| _| S )a
Apply specified markup to matched term(s) within the returned field(s).
- **fields** If specified then only those mentioned fields are
highlighted, otherwise all fields are highlighted
- **tags** A list of two strings to surround the match.
Z HIGHLIGHTr, ZTAGS)r+ r* r- r r )r r# �tagsr/ r r r � highlightd s
zQuery.highlightc C s
|| _ | S )z�
Analyze the query as being in the specified language.
:param language: The language (e.g. `chinese` or `english`)
)r )r �languager r r r3 v s zQuery.languagec C s
|| _ | S )zpAllow a maximum of N intervening non matched terms between
phrase terms (0 means exact phrase).
)r )r �slopr r r r4 s z
Query.slopc C s
d| _ | S )z�
Match only documents where the query terms appear in
the same order in the document.
i.e. for the query "hello world", we do not match "world hello"
T)r r r r r �in_order� s zQuery.in_orderc C s
|| _ | 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 �scorerr r r r6 � s z Query.scorerc C s: | j g}|| �� 7 }|| j| j 7 }|d| j| jg7 }|S )z:Format the redis arguments for this query and return them.ZLIMIT)r �_get_args_tagsr r r r )r r/ r r r �get_args� s
zQuery.get_argsc C s� g }| j r|�d� | jr>|�d� |�t| j�� || j7 }| jrN|�d� | jr^|�d� | jr�| jD ] }t|t�s�t d��||j
7 }qj| j r�|�d� | j r�|d| j g7 }| j
r�|�d� | jr�|�d � |�t| j�� || j7 }| jd
k�r|d | jg7 }| j�r|�d � | j�rB|�d
� |�t| j�� || j7 }| j�rvt| jt��s`t d��|�d� || jj
7 }| j�r�|d| jg7 }| j�r�|d| jg7 }| j�r�|d| jg7 }|S )NZ NOCONTENTZINFIELDSZVERBATIMZ NOSTOPWORDSz Did not receive a Filter object.Z WITHPAYLOADSZSCORERZ
WITHSCORESZINKEYSr ZSLOPZINORDERZRETURNz Did not receive a SortByField.ZSORTBY�LANGUAGEZEXPANDERZDIALECT)r r% r
r- r r r r) �Filter�AttributeErrorr/ r r r
r r r r r � SortbyFieldr r r )r r/ �fltr r r r7 � s\
zQuery._get_args_tagsc C s || _ || _| S )z�
Set the paging for the query (defaults to 0..10).
- **offset**: Paging offset for the results. Defaults to 0
- **num**: How many results do we want
)r r )r �offsetZnumr r r �paging� s z Query.pagingc C s
d| _ | S )zWSet the query to be verbatim, i.e. use no query expansion
or stemming.
T)r r r r r �verbatim� s zQuery.verbatimc C s
d| _ | S )z>Set the query to only return ids and not the document content.T)r r r r r �
no_content� s zQuery.no_contentc C s
d| _ | S )z�
Prevent the query from being filtered for stopwords.
Only useful in very big queries that you are certain contain
no stopwords.
T)r r r r r � no_stopwords� s zQuery.no_stopwordsc C s
d| _ | S )z+Ask the engine to return document payloads.T)r r r r r �
with_payloads� s zQuery.with_payloadsc C s
d| _ | S )z0Ask the engine to return document search scores.T)r
r r r r � with_scores� s zQuery.with_scoresc G s
|| _ | S )z�
Limit the search to specific TEXT fields only.
- **fields**: A list of strings, case sensitive field names
from the defined schema.
)r
r" r r r � limit_fields� s zQuery.limit_fieldsc C s | j �|� | S )z�
Add a numeric or geo filter to the query.
**Currently only one of each filter is supported by the engine**
- **flt**: A NumericFilter or GeoFilter object, used on a
corresponding field
)r r% )r r= r r r �
add_filter s zQuery.add_filterTc C s t ||�| _| S )z�
Add a sortby field to the query.
- **field** - the name of the field to sort by
- **asc** - when `True`, sorting will be done in asceding order
)r< r �r r& Zascr r r �sort_by s z
Query.sort_byc C s
|| _ | S )zg
Add a expander field to the query.
- **expander** - the name of the expander
)r )r �expanderr r r rI s zQuery.expander)�dialect�returnc C s
|| _ | S )zw
Add a dialect field to the query.
- **dialect** - dialect version to execute the query under
)r )r rJ r r r rJ & s z
Query.dialect)N)NNNN)NN)T) �__name__�
__module__� __qualname__�__doc__r r r! r$ r' r+ r0 r2 r3 r4 r5 r6 r8 r7 r? r@ rA rB rC rD rE rF rH rI �intrJ r r r r r s4
1
r c @ s e Zd Zdd� ZdS )r: c G s ||gt |� | _d S r( )r r/ )r �keywordr& r/ r r r r 1 s zFilter.__init__N�rL rM rN r r r r r r: 0 s r: c @ s e Zd ZdZdZddd�ZdS )�
NumericFilterz+infz-infFc C s> |s|nd|� �|s|nd|� �g}t j| d|g|�R � d S )N�(ZFILTER�r: r )r r& ZminvalZmaxvalZ minExclusiveZ maxExclusiver/ r r r r 9 s �zNumericFilter.__init__N)FF)rL rM rN ZINFZNEG_INFr r r r r rS 5 s rS c @ s( e Zd ZdZdZdZdZefdd�ZdS )� GeoFilter�mZkmZft�mic C s t �| d|||||� d S )NZ GEOFILTERrU )r r& ZlonZlatZradiusZunitr r r r H s zGeoFilter.__init__N)rL rM rN ZMETERSZ
KILOMETERSZFEETZMILESr r r r r rV B s
rV c @ s e Zd Zddd�ZdS )r< Tc C s ||r
dndg| _ d S )NZASCZDESC)r/ rG r r r r M s zSortbyField.__init__N)TrR r r r r r< L s r< N)r r: rS rV r< r r r r �<module> s 1