File: //usr/lib/python3.9/site-packages/redis/commands/__pycache__/core.cpython-39.pyc
a
��b�> � @ s: d dl Z d dlZd dlZd dlZd dlmZmZmZmZm Z m
Z
m Z m Z m
Z
mZmZmZmZmZ d dlmZ d dlmZmZmZmZ d dlmZm Z m Z m Z m Z m Z m!Z!m"Z"m#Z#m$Z$m%Z%m&Z&m'Z'm(Z(m)Z)m*Z*m+Z+ ddl,m-Z- er�d dl.m/Z0 d dl1m/Z/ eeef Z2G d d
� d
e �Z3e3Z4G d d � d e �Z5e5Z6G d
d� de5�Z6G dd� d�Z7G dd� de �Z8G dd� de8�Z9G dd� de �Z:e:Z;G dd� de �Z<G dd� de<�Z=G dd � d e �Z>e>Z?G d d � d e �Z@e@ZAG d d � d e �ZBeBZCG d!d"� d"e �ZDeDZEG d#d$� d$e �ZFeFZGG d%d&� d&�ZHG d'd(� d(�ZIG d)d*� d*e �ZJeJZKG d+d,� d,e �ZLG d-d.� d.eL�ZMG d/d0� d0e �ZNeNZOG d1d2� d2e �ZPG d3d&� d&�ZHG d4d5� d5eP�ZQG d6d7� d7e �ZReRZSG d8d9� d9�ZTeTZUG d:d;� d;e8eDeFeNe:e<e>e@eB� ZVG d<d=� d=e9eEeGeOe;e=e?eAeC� ZWG d>d?� d?e3eReVe5ePeJeLeT�
ZXG d@dA� dAe4eSeWe6eQeKeMeU�
ZYdS )B� N)�
TYPE_CHECKING�Any�
AsyncIterator� Awaitable�Callable�Dict�Iterable�Iterator�List�Mapping�Optional�Sequence�Tuple�Union)�Literal)�ConnectionError� DataError�
NoScriptError�
RedisError)�
AbsExpiryT�AnyKeyT�BitfieldOffsetT�ChannelT�CommandsProtocol� ConsumerT�
EncodableT�ExpiryT�FieldT�GroupT�KeysT�KeyT�PatternT� ScriptTextT� StreamIdT� TimeoutSecT� ZScoreBoundT� )� list_or_args)�Redisc @ s^ e Zd ZdZd&eedf ed�dd�Zdd� Zeed�d d
�Z d'ee
df ed �d d
�Z eed�dd�Z ed�dd�Z
ed�dd�Zd(ee
df ed�dd�Zed�dd�Zed�dd�Zed�d d �Zd)eeeeeee df eeee df eee eee eee eee eeeeef eeeed �d d!�Zed�d"d#�Zed�d$d%�ZdS )*� ACLCommandszX
Redis Access Control List (ACL) commands.
see: https://redis.io/topics/acl
N)�category�returnc K s& |r
|gng }| j dg|�R i |��S )a?
Returns a list of categories or commands within a category.
If ``category`` is not supplied, returns a list of all categories.
If ``category`` is supplied, returns a list of all commands within
that category.
For more information see https://redis.io/commands/acl-cat
zACL CAT��execute_command)�selfr* �kwargs�pieces� r1 �7/usr/lib/python3.9/site-packages/redis/commands/core.py�acl_cat= s
zACLCommands.acl_catc O s | j d|g|�R i |��S )z�
Simulate the execution of a given command by a given ``username``.
For more information see https://redis.io/commands/acl-dryrun
z
ACL DRYRUNr, )r. �username�argsr/ r1 r1 r2 �
acl_dryrunJ s zACLCommands.acl_dryrun)r4 r+ c O s | j dg|�R i |��S )z�
Delete the ACL for the specified ``username``s
For more information see https://redis.io/commands/acl-deluser
z ACL DELUSERr, �r. r4 r/ r1 r1 r2 � acl_deluserR s zACLCommands.acl_deluser)�bitsr+ c K s` g }|durHz t |�}|dk s&|dkr*t�W n tyF td��Y n0 | jdg|�R i |��S )z�Generate a random password value.
If ``bits`` is supplied then use this number of bits, rounded to
the next multiple of 4.
See: https://redis.io/commands/acl-genpass
Nr i z?genpass optionally accepts a bits argument, between 0 and 4096.z ACL GENPASS)�int�
ValueErrorr r- )r. r9 r/ r0 �br1 r1 r2 � acl_genpassZ s �
zACLCommands.acl_genpassc K s | j d|fi |��S )z�
Get the ACL details for the specified ``username``.
If ``username`` does not exist, return None
For more information see https://redis.io/commands/acl-getuser
z ACL GETUSERr, r7 r1 r1 r2 � acl_getuserl s zACLCommands.acl_getuser�r+ c K s | j di |��S )z�The ACL HELP command returns helpful text describing
the different subcommands.
For more information see https://redis.io/commands/acl-help
�ACL HELP)r@ r, �r. r/ r1 r1 r2 �acl_helpv s zACLCommands.acl_helpc K s | j di |��S )z~
Return a list of all ACLs on the server
For more information see https://redis.io/commands/acl-list
�ACL LIST)rC r, rA r1 r1 r2 �acl_list~ s zACLCommands.acl_list)�countr+ c K s@ g }|dur(t |t�s td��|�|� | jdg|�R i |��S )z�
Get ACL logs as a list.
:param int count: Get logs[0:count].
:rtype: List.
For more information see https://redis.io/commands/acl-log
Nz ACL LOG count must be an integer�ACL LOG)�
isinstancer: r �appendr- )r. rE r/ r5 r1 r1 r2 �acl_log� s
zACLCommands.acl_logc K s dg}| j dg|�R i |��S )z~
Reset ACL logs.
:rtype: Boolean.
For more information see https://redis.io/commands/acl-log
s RESETrF r, )r. r/ r5 r1 r1 r2 �
acl_log_reset� s zACLCommands.acl_log_resetc K s | j di |��S )a
Load ACL rules from the configured ``aclfile``.
Note that the server must be configured with the ``aclfile``
directive to be able to load ACL rules from an aclfile.
For more information see https://redis.io/commands/acl-load
�ACL LOAD)rK r, rA r1 r1 r2 �acl_load� s zACLCommands.acl_loadc K s | j di |��S )a
Save ACL rules to the configured ``aclfile``.
Note that the server must be configured with the ``aclfile``
directive to be able to save ACL rules to an aclfile.
For more information see https://redis.io/commands/acl-save
�ACL SAVE)rM r, rA r1 r1 r2 �acl_save� s zACLCommands.acl_saveF)r4 �enabled�nopass� passwords�hashed_passwords�
categories�commands�keys�channels� selectors�reset�
reset_keys�reset_passwordsr+ c K s� | � � }|g}| r |�d� | r*|�d� |
r8|�d� |rH|�d� n
|�d� |sZ|rf|rftd��|r�t|g �}t|�D ]f\}}|�|�}|�d�r�|�d|d d
� � q||�d �r�|�d |d d
� � q|td
|� d���q||�rht|g �}t|�D ]j\}}|�|�}|�d��r2|�d|d d
� � q�|�d ��rV|�d|d d
� � q�td|� d���q�|�rx|�d� |�r&|D ]�}|�|�}|�d��r�|�|� nz|�d��r�|�d|d d
� � nV|�d��r�|�|� n>|�d ��r|�d|d d
� � ntd|j|dd�� d����q�|�r~|D ]L}|�|�}|�d��sp|�d ��sptd|j|dd�� d���|�|� �q0|�r�|D ]:}|�|�}|�d ��s�|�d ��s�d | }|�|� �q�| �r�| D ] }|�|�}|�d | � �q�|
�r||
D ]�\}}|�|�}|�d��s<|�d ��s<td|j|dd�� d���|�|�}|�d ��sf|�d ��sfd | }|�d ||f � �q�| jd!g|�R i |��S )"a�
Create or update an ACL user.
Create or update the ACL for ``username``. If the user already exists,
the existing ACL is completely overwritten and replaced with the
specified values.
``enabled`` is a boolean indicating whether the user should be allowed
to authenticate or not. Defaults to ``False``.
``nopass`` is a boolean indicating whether the can authenticate without
a password. This cannot be True if ``passwords`` are also specified.
``passwords`` if specified is a list of plain text passwords
to add to or remove from the user. Each password must be prefixed with
a '+' to add or a '-' to remove. For convenience, the value of
``passwords`` can be a simple prefixed string when adding or
removing a single password.
``hashed_passwords`` if specified is a list of SHA-256 hashed passwords
to add to or remove from the user. Each hashed password must be
prefixed with a '+' to add or a '-' to remove. For convenience,
the value of ``hashed_passwords`` can be a simple prefixed string when
adding or removing a single password.
``categories`` if specified is a list of strings representing category
permissions. Each string must be prefixed with either a '+' to add the
category permission or a '-' to remove the category permission.
``commands`` if specified is a list of strings representing command
permissions. Each string must be prefixed with either a '+' to add the
command permission or a '-' to remove the command permission.
``keys`` if specified is a list of key patterns to grant the user
access to. Keys patterns allow '*' to support wildcard matching. For
example, '*' grants access to all keys while 'cache:*' grants access
to all keys that are prefixed with 'cache:'. ``keys`` should not be
prefixed with a '~'.
``reset`` is a boolean indicating whether the user should be fully
reset prior to applying the new ACL. Setting this to True will
remove all existing passwords, flags and privileges from the user and
then apply the specified rules. If this is False, the user's existing
passwords, flags and privileges will be kept and any new specified
rules will be applied on top.
``reset_keys`` is a boolean indicating whether the user's key
permissions should be reset prior to applying any new key permissions
specified in ``keys``. If this is False, the user's existing
key permissions will be kept and any new specified key permissions
will be applied on top.
``reset_passwords`` is a boolean indicating whether to remove all
existing passwords and the 'nopass' flag from the user prior to
applying any new passwords specified in 'passwords' or
'hashed_passwords'. If this is False, the user's existing passwords
and 'nopass' status will be kept and any new specified passwords
or hashed_passwords will be applied on top.
For more information see https://redis.io/commands/acl-setuser
s resets resetkeyss resetpasss ons offz@Cannot set 'nopass' and supply 'passwords' or 'hashed_passwords'� +s >%sr& N� -s <%sz Password z6 must be prefixed with a "+" to add or a "-" to removes #%ss !%szHashed password s nopasss +@s +@%ss -@s -@%sz
Category "T)�forcez"" must be prefixed with "+" or "-"z Command "� %� ~s ~%ss &%ss (%s %s)z ACL SETUSER) � get_encoderrH r r' � enumerate�encode�
startswith�decoder- )r. r4 rO rP rQ rR rS rT rU rV rW rX rY rZ r/ �encoderr0 �i�passwordZhashed_passwordr* �cmd�key�channelr1 r1 r2 � acl_setuser� s� N
�
�
�
�
�
�
zACLCommands.acl_setuserc K s | j di |��S )z�Returns a list of all registered users on the server.
For more information see https://redis.io/commands/acl-users
� ACL USERS)rl r, rA r1 r1 r2 � acl_usersu s zACLCommands.acl_usersc K s | j di |��S )z{Get the username for the current connection
For more information see https://redis.io/commands/acl-whoami
�
ACL WHOAMI)rn r, rA r1 r1 r2 �
acl_whoami| s zACLCommands.acl_whoami)N)N)N) FFNNNNNNNFFF) �__name__�
__module__� __qualname__�__doc__r �str� ResponseTr3 r6 r8 r: r= r> rB rD rI rJ rL rN �boolr r r r r rk rm ro r1 r1 r1 r2 r) 7 sV
�
� @r) c @ sb e Zd ZdZd�dd�Zdd� Zd�eed�d d
�Zed �d d
�Z e
ed�dd�Z d�e e
df e e
df e e
df e edf e edf e
ed�dd�Z
ed �dd�Zdg fe e
df ee ed�dd�Zed �dd�Zed �dd �Ze ed ed ed f ed �d!d"�Zed �d#d$�Zdg d%d%d%d%fe edf ee eeeeed&�d'd(�Zdg d%d%d%d%fe edf ee eeeeed&�d)d*�Zddg d%d%d%d%fee edf ee eeeeed+�d,d-�Z ed �d.d/�Z e
ed0�d1d2�Z d�eeed3�d4d5�Z d�eeed6�d7d8�Z ed �d9d:�Z!e
e e"e
e
f d;�d<d=�Z#d>d?� Z$dd �d@dA�Z%ed �dBdC�Z&d�e'e
e'e
e'e
edD�dEdF�Z(ee
ee e
ee
f dG�dHdI�Z)dJdK� Z*d�e+ee+ edM�dNdO�Z,eeee eef edP�dQdR�Z-ed �dSdT�Z.ed �dUdV�Z/ed �dWdX�Z0eedY�dZd[�Z1dd �d\d]�Z2eed^�d_d`�Z3d�eeda�dbdc�Z4d�eeda�ddde�Z5ed �dfdg�Z6e
edh�didj�Z7eeedk�dldm�Z8eedn�dodp�Z9d�e e
df ee
edq�drds�Z:ed �dtdu�Z;e e
e<f edv�dwdx�Z=ed �dydz�Z>d�e
ee?eeeee e
df ed{� d|d}�Z@e
eed~�dd��ZAdd �d�d��ZBdd �d�d��ZCed �d�d��ZDed �d�d��ZEd�ee edf ed��d�d��ZFed �d�d��ZGd�d�� ZHed �d�d��ZIed �d�d��ZJed �d�d��ZKed �d�d��ZLd�eeeeedd��d�d��ZMd�e e
df e edf ed��d�d��ZNd�e edf ed��d�d��ZOed �d�d��ZPed �d�d��ZQed �d�d��ZReeed��d�d��ZSd�d�� ZTd�d�� ZUdS )��ManagementCommandsz#
Redis management commands
Nc K s8 g }|dur|� |� |� |� | jdg|�R i |��S )a
Authenticates the user. If you do not pass username, Redis will try to
authenticate for the "default" user. If you do pass username, it will
authenticate for the given user.
For more information see https://redis.io/commands/auth
NZAUTH�rH r- )r. rg r4 r/ r0 r1 r1 r2 �auth� s
zManagementCommands.authc K s | j di |��S )z�Tell the Redis server to rewrite the AOF file from data in memory.
For more information see https://redis.io/commands/bgrewriteaof
� BGREWRITEAOF)rz r, rA r1 r1 r2 � bgrewriteaof� s z ManagementCommands.bgrewriteaofT)�scheduler+ c K s* g }|r|� d� | jdg|�R i |��S )z�
Tell the Redis server to save its data to disk. Unlike save(),
this method is asynchronous and returns immediately.
For more information see https://redis.io/commands/bgsave
ZSCHEDULEZBGSAVErx )r. r| r/ r0 r1 r1 r2 �bgsave� s
zManagementCommands.bgsaver? c C s
| � d�S )z�
Provide information on the role of a Redis instance in
the context of replication, by returning if the instance
is currently a master, slave, or sentinel.
For more information see https://redis.io/commands/role
ZROLEr, �r. r1 r1 r2 �role� s zManagementCommands.role)�addressr+ c K s | j d|fi |��S )z�Disconnects the client at ``address`` (ip:port)
For more information see https://redis.io/commands/client-kill
� CLIENT KILLr, )r. r� r/ r1 r1 r2 � client_kill� s z ManagementCommands.client_kill)�_id�_type�addr�skipme�laddr�userr+ c
K s� g }|dur<d} t |��� | vr.td| ����|�d|f� |durpt|t�sVtd��|rf|�d� n
|�d� |dur�|�d|f� |dur�|�d |f� |dur�|�d
|f� |dur�|�d |f� |s�td ��| jd
g|�R i |��S )a�
Disconnects client(s) using a variety of filter options
:param _id: Kills a client by its unique ID field
:param _type: Kills a client by type where type is one of 'normal',
'master', 'slave' or 'pubsub'
:param addr: Kills a client by its 'address:port'
:param skipme: If True, then the client calling the command
will not get killed even if it is identified by one of the filter
options. If skipme is not provided, the server defaults to skipme=True
:param laddr: Kills a client by its 'local (bind) address:port'
:param user: Kills a client for a specific user name
N)�normal�masterZslave�pubsubz CLIENT KILL type must be one of � TYPEz!CLIENT KILL skipme must be a bool)� SKIPMEs YES)r� � NO� IDs ADDRs LADDRs USERzVCLIENT KILL <filter> <value> ... ... <filter> <value> must specify at least one filterr� )rt �lowerr �extendrG rv r- )
r. r� r� r� r� r� r� r/ r5 � client_typesr1 r1 r2 �client_kill_filter� s2
�z%ManagementCommands.client_kill_filterc K s | j di |��S )z�
Returns information and statistics about the current
client connection.
For more information see https://redis.io/commands/client-info
� CLIENT INFO)r� r, rA r1 r1 r2 � client_info� s z ManagementCommands.client_info)r� � client_idr+ c K s� g }|durBd}t |��� |vr.td|����|�d� |�|� t|t�sTtd��|rr|�d� |�d�|�� | jdg|�R i |��S ) aj
Returns a list of currently connected clients.
If type of client specified, only that type will be returned.
:param _type: optional. one of the client types (normal, master,
replica, pubsub)
:param client_id: optional. a list of client ids
For more information see https://redis.io/commands/client-list
N)r� r� Zreplicar� z!CLIENT LIST _type must be one of r� zclient_id must be a listr� � z CLIENT LIST)rt r� r rH rG �list�joinr- )r. r� r� r/ r5 r� r1 r1 r2 � client_list� s
z ManagementCommands.client_listc K s | j di |��S )z�
Returns the current connection name
For more information see https://redis.io/commands/client-getname
�CLIENT GETNAME)r� r, rA r1 r1 r2 �client_getname s z!ManagementCommands.client_getnamec K s | j di |��S )z�
Returns the ID (an integer) of the client to whom we are
redirecting tracking notifications.
see: https://redis.io/commands/client-getredir
�CLIENT GETREDIR)r� r, rA r1 r1 r2 �client_getredir s z"ManagementCommands.client_getredir�ON�OFF�SKIP)�replyr+ c K s2 g d�}||vr t d|����| jd|fi |��S )a�
Enable and disable redis server replies.
``reply`` Must be ON OFF or SKIP,
ON - The default most with server replies to commands
OFF - Disable server responses to commands
SKIP - Skip the response of the immediately following command.
Note: When setting OFF or SKIP replies, you will need a client object
with a timeout specified in seconds, and will need to catch the
TimeoutError.
The test_client_reply unit test illustrates this, and
conftest.py has a client with a timeout.
See https://redis.io/commands/client-reply
)r� r� r� z CLIENT REPLY must be one of z CLIENT REPLY�r r- )r. r� r/ Zrepliesr1 r1 r2 � client_reply# s z ManagementCommands.client_replyc K s | j di |��S )zy
Returns the current connection id
For more information see https://redis.io/commands/client-id
� CLIENT ID)r� r, rA r1 r1 r2 r� : s z ManagementCommands.client_idF)�clientid�prefix�bcast�optin�optout�noloopr+ c C s | � d||||||�S )z�
Turn on the tracking mode.
For more information about the options look at client_tracking func.
See https://redis.io/commands/client-tracking
T��client_tracking�r. r� r� r� r� r� r� r1 r1 r2 �client_tracking_onB s �z%ManagementCommands.client_tracking_onc C s | � d||||||�S )z�
Turn off the tracking mode.
For more information about the options look at client_tracking func.
See https://redis.io/commands/client-tracking
Fr� r� r1 r1 r2 �client_tracking_offU s �z&ManagementCommands.client_tracking_off)�onr� r� r� r� r� r� r+ c K s� t |�dkr |du r td��|r&dgndg} |durB| �d|g� |D ]}
| �d|
g� qF|rh| �d � |rv| �d
� |r�| �d � |r�| �d � | jd
g| �R � S )a�
Enables the tracking feature of the Redis server, that is used
for server assisted client side caching.
``on`` indicate for tracking on or tracking off. The dafualt is on.
``clientid`` send invalidation messages to the connection with
the specified ID.
``bcast`` enable tracking in broadcasting mode. In this mode
invalidation messages are reported for all the prefixes
specified, regardless of the keys requested by the connection.
``optin`` when broadcasting is NOT active, normally don't track
keys in read only commands, unless they are called immediately
after a CLIENT CACHING yes command.
``optout`` when broadcasting is NOT active, normally track keys in
read only commands, unless they are called immediately after a
CLIENT CACHING no command.
``noloop`` don't send notifications about keys modified by this
connection itself.
``prefix`` for broadcasting, register a given key prefix, so that
notifications will be provided only for keys starting with this string.
See https://redis.io/commands/client-tracking
r Fz"Prefix can only be used with bcastr� r� NZREDIRECTZPREFIXZBCASTZOPTINZOPTOUTZNOLOOPzCLIENT TRACKING)�lenr r� rH r- ) r. r� r� r� r� r� r� r� r/ r0 �pr1 r1 r2 r� h s )
z"ManagementCommands.client_trackingc K s | j di |��S )z�
Returns the information about the current client connection's
use of the server assisted client side cache.
See https://redis.io/commands/client-trackinginfo
�CLIENT TRACKINGINFO)r� r, rA r1 r1 r2 �client_trackinginfo� s z&ManagementCommands.client_trackinginfo��namer+ c K s | j d|fi |��S )z}
Sets the current connection name
For more information see https://redis.io/commands/client-setname
zCLIENT SETNAMEr, )r. r� r/ r1 r1 r2 �client_setname� s z!ManagementCommands.client_setname)r� �errorr+ c K s* dt |�g}|r|�d� | j|i |��S )aB
Unblocks a connection by its client id.
If ``error`` is True, unblocks the client with a special error message.
If ``error`` is False (default), the client is unblocked using the
regular timeout mechanism.
For more information see https://redis.io/commands/client-unblock
zCLIENT UNBLOCKs ERROR)r: rH r- )r. r� r� r/ r5 r1 r1 r2 �client_unblock� s
z!ManagementCommands.client_unblock)�timeout�allr+ c K s< dt |�g}t|t�s td��|s,|�d� | j|i |��S )a�
Suspend all the Redis clients for the specified amount of time
:param timeout: milliseconds to pause clients
For more information see https://redis.io/commands/client-pause
:param all: If true (default) all client commands are blocked.
otherwise, clients are only blocked if they attempt to execute
a write command.
For the WRITE mode, some commands have special behavior:
EVAL/EVALSHA: Will block client for all scripts.
PUBLISH: Will block client.
PFCOUNT: Will block client.
WAIT: Acknowledgments will be delayed, so this command will
appear blocked.
z CLIENT PAUSEz'CLIENT PAUSE timeout must be an integerZWRITE)rt rG r: r rH r- )r. r� r� r/ r5 r1 r1 r2 � client_pause� s
z ManagementCommands.client_pausec K s | j di |��S )zv
Unpause all redis clients
For more information see https://redis.io/commands/client-unpause
�CLIENT UNPAUSE)r� r, rA r1 r1 r2 �client_unpause� s z!ManagementCommands.client_unpause��moder+ c C s | � d|�S )z�
Sets the client eviction mode for the current connection.
For more information see https://redis.io/commands/client-no-evict
zCLIENT NO-EVICTr, �r. r� r1 r1 r2 �client_no_evict� s z"ManagementCommands.client_no_evictc K s | j di |��S )z�
Returns dict reply of details about all Redis commands.
For more information see https://redis.io/commands/command
�COMMAND)r� r, rA r1 r1 r2 �command� s zManagementCommands.commandc K s t d��d S �Nz<COMMAND INFO is intentionally not implemented in the client.��NotImplementedErrorrA r1 r1 r2 � command_info� s �z ManagementCommands.command_infoc K s | j di |��S )N�
COMMAND COUNT)r� r, rA r1 r1 r2 �
command_count� s z ManagementCommands.command_count)�moduler* �patternr+ c C sh g }|dur|� d|g� |dur0|� d|g� |durF|� d|g� |rV|�dd� | jdg|�R � S )ay
Return an array of the server's command names.
You can use one of the following filters:
``module``: get the commands that belong to the module
``category``: get the commands in the ACL category
``pattern``: get the commands that match the given pattern
For more information see https://redis.io/commands/command-list/
NZMODULEZACLCATZPATTERNr ZFILTERBYz COMMAND LIST)r� �insertr- )r. r� r* r� r0 r1 r1 r2 � command_list� s z ManagementCommands.command_list�r5 r+ c G s | j dg|�R � S )z�
Returns array of keys from a full Redis command and their usage flags.
For more information see https://redis.io/commands/command-getkeysandflags
zCOMMAND GETKEYSANDFLAGSr, �r. r5 r1 r1 r2 �command_getkeysandflags s z*ManagementCommands.command_getkeysandflagsc G s t d��dS )�m
This function throws a NotImplementedError since it is intentionally
not supported.
z<COMMAND DOCS is intentionally not implemented in the client.Nr� r� r1 r1 r2 � command_docs s �z ManagementCommands.command_docs�*)r� r5 r+ c O s | j d|g|�R i |��S )z�
Return a dictionary of configuration based on the ``pattern``
For more information see https://redis.io/commands/config-get
z
CONFIG GETr, )r. r� r5 r/ r1 r1 r2 �
config_get) s z ManagementCommands.config_get)r� �valuer5 r+ c O s | j d||g|�R i |��S )zwSet config item ``name`` with ``value``
For more information see https://redis.io/commands/config-set
z
CONFIG SETr, )r. r� r� r5 r/ r1 r1 r2 �
config_set3 s z ManagementCommands.config_setc K s | j di |��S )zw
Reset runtime statistics
For more information see https://redis.io/commands/config-resetstat
�CONFIG RESETSTAT)r� r, rA r1 r1 r2 �config_resetstat@ s z#ManagementCommands.config_resetstatc K s | j di |��S )z�
Rewrite config file with the minimal change to reflect running config.
For more information see https://redis.io/commands/config-rewrite
�CONFIG REWRITE)r� r, rA r1 r1 r2 �config_rewriteH s z!ManagementCommands.config_rewritec K s | j di |��S )z�
Returns the number of keys in the current database
For more information see https://redis.io/commands/dbsize
�DBSIZE)r� r, rA r1 r1 r2 �dbsizeP s zManagementCommands.dbsize�ri r+ c K s | j d|fi |��S )z�
Returns version specific meta information about a given key
For more information see https://redis.io/commands/debug-object
z DEBUG OBJECTr, )r. ri r/ r1 r1 r2 � debug_objectX s z ManagementCommands.debug_objectc K s t d��d S )Nz�
DEBUG SEGFAULT is intentionally not implemented in the client.
For more information see https://redis.io/commands/debug-segfault
r� rA r1 r1 r2 �debug_segfault` s �z!ManagementCommands.debug_segfault)r� r+ c K s | j d|fi |��S )zw
Echo the string back from the server
For more information see https://redis.io/commands/echo
ZECHOr, )r. r� r/ r1 r1 r2 �echoi s zManagementCommands.echo)� asynchronousr+ c K s* g }|r|� d� | jdg|�R i |��S )z�
Delete all keys in all databases on the current host.
``asynchronous`` indicates whether the operation is
executed asynchronously by the server.
For more information see https://redis.io/commands/flushall
� ASYNCZFLUSHALLrx �r. r� r/ r5 r1 r1 r2 �flushallq s
zManagementCommands.flushallc K s* g }|r|� d� | jdg|�R i |��S )z�
Delete all keys in the current database.
``asynchronous`` indicates whether the operation is
executed asynchronously by the server.
For more information see https://redis.io/commands/flushdb
r� ZFLUSHDBrx r� r1 r1 r2 �flushdb s
zManagementCommands.flushdbc C s( ddl m} i }g ||< | jdi |��S )z�
Initiates a replication stream from the master.
For more information see https://redis.io/commands/sync
r �� NEVER_DECODE�SYNC)r� �� redis.clientr� r- �r. r� �optionsr1 r1 r2 �sync� s zManagementCommands.sync)�
replicationid�offsetc C s. ddl m} i }g ||< | jd||fi |��S )z�
Initiates a replication stream from the master.
Newer version for `sync`.
For more information see https://redis.io/commands/sync
r r� ZPSYNCr� )r. r� r� r� r� r1 r1 r2 �psync� s zManagementCommands.psync)�first�secondr+ c K s | j d||fi |��S )zg
Swap two databases
For more information see https://redis.io/commands/swapdb
ZSWAPDBr, )r. r� r� r/ r1 r1 r2 �swapdb� s zManagementCommands.swapdb)�indexr+ c K s | j d|fi |��S )zcSelect the Redis logical database at index.
See: https://redis.io/commands/select
ZSELECTr, )r. r� r/ r1 r1 r2 �select� s zManagementCommands.select)�sectionr5 r+ c O s6 |du r| j di |��S | j d|g|�R i |��S dS )am
Returns a dictionary containing information about the Redis server
The ``section`` option can be used to select a specific section
of information
The section option is not supported by older versions of Redis Server,
and will generate ResponseError
For more information see https://redis.io/commands/info
N�INFO)r� r, )r. r� r5 r/ r1 r1 r2 �info� s zManagementCommands.infoc K s | j di |��S )z�
Return a Python datetime object representing the last time the
Redis database was saved to disk
For more information see https://redis.io/commands/lastsave
�LASTSAVE)r� r, rA r1 r1 r2 �lastsave� s zManagementCommands.lastsave)�version_numbersr+ c O s0 |r | j dg|�R i |��S | j di |��S dS )z}
Get the Redis version and a piece of generative computer art
See: https://redis.io/commands/lolwut
zLOLWUT VERSION�LOLWUTN)r� r, )r. r� r/ r1 r1 r2 �lolwut� s zManagementCommands.lolwutc C s
| � d�S )zuPerform a full reset on the connection's server side contenxt.
See: https://redis.io/commands/reset
ZRESETr, r~ r1 r1 r2 rX � s zManagementCommands.reset) �host�portrU �destination_dbr� �copy�replacery r+ c K s� t |g �}|std��g }
|r(|
�d� |r6|
�d� |rN|
�d� |
�|� |
�d� |
�|� | jd||d||g|
�R i | ��S )a�
Migrate 1 or more keys from the current Redis server to a different
server specified by the ``host``, ``port`` and ``destination_db``.
The ``timeout``, specified in milliseconds, indicates the maximum
time the connection between the two servers can be idle before the
command is interrupted.
If ``copy`` is True, the specified ``keys`` are NOT deleted from
the source server.
If ``replace`` is True, this operation will overwrite the keys
on the destination server if they exist.
If ``auth`` is specified, authenticate to the destination server with
the password provided.
For more information see https://redis.io/commands/migrate
z!MIGRATE requires at least one keys COPYs REPLACEs AUTHs KEYSZMIGRATE� )r' r rH r� r- ) r. r r rU r r� r r ry r/ r0 r1 r1 r2 �migrate� s(
���zManagementCommands.migrate)�infotyperi r+ c K s | j d||fd|i|��S )zJ
Return the encoding, idletime, or refcount about the key
ZOBJECTr r, )r. r ri r/ r1 r1 r2 �object s ���zManagementCommands.objectc K s t d��d S )Nz�
MEMORY DOCTOR is intentionally not implemented in the client.
For more information see https://redis.io/commands/memory-doctor
r� rA r1 r1 r2 �
memory_doctor s �z ManagementCommands.memory_doctorc K s t d��d S )Nz�
MEMORY HELP is intentionally not implemented in the client.
For more information see https://redis.io/commands/memory-help
r� rA r1 r1 r2 � memory_help$ s �z ManagementCommands.memory_helpc K s | j di |��S )z~
Return a dictionary of memory stats
For more information see https://redis.io/commands/memory-stats
� MEMORY STATS)r r, rA r1 r1 r2 � memory_stats- s z ManagementCommands.memory_statsc K s | j di |��S )z�
Return an internal statistics report from the memory allocator.
See: https://redis.io/commands/memory-malloc-stats
�MEMORY MALLOC-STATS)r
r, rA r1 r1 r2 �memory_malloc_stats5 s z&ManagementCommands.memory_malloc_stats)ri �samplesr+ c K s6 g }t |t�r |�d|g� | jd|g|�R i |��S )ap
Return the total memory usage for key, its value and associated
administrative overheads.
For nested data structures, ``samples`` is the number of elements to
sample. If left unspecified, the server's default is 5. Use 0 to sample
all elements.
For more information see https://redis.io/commands/memory-usage
s SAMPLESz MEMORY USAGE)rG r: r� r- )r. ri r r/ r5 r1 r1 r2 � memory_usage= s
z ManagementCommands.memory_usagec K s | j di |��S )z�
Attempts to purge dirty pages for reclamation by allocator
For more information see https://redis.io/commands/memory-purge
� MEMORY PURGE)r r, rA r1 r1 r2 � memory_purgeO s z ManagementCommands.memory_purgec G s t d��dS )r� zALATENCY HISTOGRAM is intentionally not implemented in the client.Nr� r� r1 r1 r2 �latency_histogramW s �z$ManagementCommands.latency_histogramc K s | j di |��S )zh
Ping the Redis server
For more information see https://redis.io/commands/ping
�PING)r r, rA r1 r1 r2 �ping` s zManagementCommands.pingc K s | j di |��S )zz
Ask the server to close the connection.
For more information see https://redis.io/commands/quit
�QUIT)r r, rA r1 r1 r2 �quith s zManagementCommands.quitc O s | j dg|�R i |��S )a0
Update the replication settings of a redis replica, on the fly.
Examples of valid arguments include:
NO ONE (set no replication)
host port (set to the host and port of a redis server)
For more information see https://redis.io/commands/replicaof
Z REPLICAOFr, �r. r5 r/ r1 r1 r2 � replicaofp s z ManagementCommands.replicaofc K s | j di |��S )z�
Tell the Redis server to save its data to disk,
blocking until the save is complete
For more information see https://redis.io/commands/save
�SAVE)r r, rA r1 r1 r2 �save{ s zManagementCommands.save�r �nosave�nowr] �abortr+ c K s� |r|rt d��dg}|r$|�d� |r2|�d� |r@|�d� |rN|�d� |r\|�d� z| j|i |�� W n ty� Y dS 0 td ��dS )
a� Shutdown the Redis server. If Redis has persistence configured,
data will be flushed before shutdown.
It is possible to specify modifiers to alter the behavior of the command:
``save`` will force a DB saving operation even if no save points are configured.
``nosave`` will prevent a DB saving operation even if one or more save points
are configured.
``now`` skips waiting for lagging replicas, i.e. it bypasses the first step in
the shutdown sequence.
``force`` ignores any errors that would normally prevent the server from exiting
``abort`` cancels an ongoing shutdown and cannot be combined with other flags.
For more information see https://redis.io/commands/shutdown
�+SHUTDOWN save and nosave cannot both be set�SHUTDOWNr �NOSAVE�NOW�FORCE�ABORTN� SHUTDOWN seems to have failed.�r rH r- r r �r. r r r r] r r/ r5 r1 r1 r2 �shutdown� s$
zManagementCommands.shutdown)r r r+ c K s6 |du r |du r | j di |��S | j d||fi |��S )a
Set the server to be a replicated slave of the instance identified
by the ``host`` and ``port``. If called without arguments, the
instance is promoted to a master instead.
For more information see https://redis.io/commands/slaveof
N)�SLAVEOFr� s ONEr* r, )r. r r r/ r1 r1 r2 �slaveof� s
zManagementCommands.slaveof)�numr+ c K sT ddl m} dg}|dur$|�|� | �� �dd�}|du rDg ||< | j|i |��S )z�
Get the entries from the slowlog. If ``num`` is specified, get the
most recent ``num`` items.
For more information see https://redis.io/commands/slowlog-get
r r� z SLOWLOG GETN�decode_responsesFT)r� r� rH Zget_connection_kwargs�getr- )r. r, r/ r� r5 r- r1 r1 r2 � slowlog_get� s
z ManagementCommands.slowlog_getc K s | j di |��S )z�
Get the number of items in the slowlog
For more information see https://redis.io/commands/slowlog-len
� SLOWLOG LEN)r0 r, rA r1 r1 r2 � slowlog_len� s z ManagementCommands.slowlog_lenc K s | j di |��S )z{
Remove all items in the slowlog
For more information see https://redis.io/commands/slowlog-reset
�
SLOWLOG RESET)r2 r, rA r1 r1 r2 �
slowlog_reset� s z ManagementCommands.slowlog_resetc K s | j di |��S )z�
Returns the server time as a 2-item tuple of ints:
(seconds since epoch, microseconds into this second).
For more information see https://redis.io/commands/time
�TIME)r4 r, rA r1 r1 r2 �time� s zManagementCommands.time)� num_replicasr� r+ c K s | j d||fi |��S )a
Redis synchronous replication
That returns the number of replicas that processed the query when
we finally have at least ``num_replicas``, or when the ``timeout`` was
reached.
For more information see https://redis.io/commands/wait
ZWAITr, )r. r6 r� r/ r1 r1 r2 �wait� s zManagementCommands.waitc C s t d��dS )r� z5HELLO is intentionally not implemented in the client.Nr� r~ r1 r1 r2 �hello� s �zManagementCommands.helloc C s t d��dS )r� z8FAILOVER is intentionally not implemented in the client.Nr� r~ r1 r1 r2 �failover� s �zManagementCommands.failover)N)T)NNNNNN)F)T)NNN)r� )F)F)N)FFN)N)FFFFF)NN)N)Vrp rq rr rs ry r{ rv ru r} r rt r� r r� r� r
r r� r� r� r r� r� r: r
r r� r� r� r� r� r� r� r� r r� r� r� r� r r� r� r� r! r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� �floatr� rX r r r r r
r r r r r r r r r r) r+ r/ r1 r3 r5 r7 r8 r9 r1 r1 r1 r2 rw � sz
�
� 2
��
�
�
� �
� �
� < �� �� $
�� �
�� �
� 0 � � �� + �� rw c sr e Zd Zdd�� fdd� Zdd�� fdd� Zdd�� fdd� Zdd�� fd d
� Zdeeeeedd �d
d�Z� Z S )�AsyncManagementCommandsNr? c � s t � jf i |��S �N��superr� rA �� __class__r1 r2 r� s z$AsyncManagementCommands.command_infoc � s t � jf i |��S r< )r> r� rA r? r1 r2 r� s z&AsyncManagementCommands.debug_segfaultc � s t � jf i |��S r< )r> r rA r? r1 r2 r s z%AsyncManagementCommands.memory_doctorc � s t � jf i |��S r< )r> r
rA r? r1 r2 r
s z#AsyncManagementCommands.memory_helpFr c � s� |r|rt d��dg}|r$|�d� |r2|�d� |r@|�d� |rN|�d� |r\|�d� z| j|i |��I dH W n ty� Y dS 0 td ��dS )
a� Shutdown the Redis server. If Redis has persistence configured,
data will be flushed before shutdown. If the "save" option is set,
a data flush will be attempted even if there is no persistence
configured. If the "nosave" option is set, no data flush will be
attempted. The "save" and "nosave" options cannot both be set.
For more information see https://redis.io/commands/shutdown
r r! r r" r# r$ r% Nr& r' r( r1 r1 r2 r) s$
z AsyncManagementCommands.shutdown)FFFFF)
rp rq rr r� r� r r
rv r) �
__classcell__r1 r1 r? r2 r; s" ��r; c @ s� e Zd ZdZded eeedf d�dd�Zdd� Zed �d
d �Zdee e
eedf d �d
d�Z ee d�dd�Z ee e
d�dd�Z
edd� �Zed�dd�ZdS ) �BitFieldOperationz0
Command builder for BITFIELD commands.
N�r( �
AsyncRedis)�clientri �default_overflowc C s* || _ || _|| _g | _d| _| �� d S )N�WRAP)rE ri �_default_overflow�
operations�_last_overflowrX )r. rE ri rF r1 r1 r2 �__init__? s zBitFieldOperation.__init__c C s" g | _ d| _| �| jp| j� dS )zL
Reset the state of the instance to when it was constructed
rG N)rI rJ �overflowrH r~ r1 r1 r2 rX M s zBitFieldOperation.reset)rL c C s, |� � }|| jkr(|| _| j�d|f� | S )a
Update the overflow algorithm of successive INCRBY operations
:param overflow: Overflow algorithm, one of WRAP, SAT, FAIL. See the
Redis docs for descriptions of these algorithmsself.
:returns: a :py:class:`BitFieldOperation` instance.
ZOVERFLOW)�upperrJ rI rH )r. rL r1 r1 r2 rL U s
zBitFieldOperation.overflow)�fmtr� � incrementrL c C s* |dur| � |� | j�d|||f� | S )a�
Increment a bitfield by a given amount.
:param fmt: format-string for the bitfield being updated, e.g. 'u8'
for an unsigned 8-bit integer.
:param offset: offset (in number of bits). If prefixed with a
'#', this is an offset multiplier, e.g. given the arguments
fmt='u8', offset='#2', the offset will be 16.
:param int increment: value to increment the bitfield by.
:param str overflow: overflow algorithm. Defaults to WRAP, but other
acceptable values are SAT and FAIL. See the Redis docs for
descriptions of these algorithms.
:returns: a :py:class:`BitFieldOperation` instance.
N�INCRBY)rL rI rH )r. rN r� rO rL r1 r1 r2 �incrbyb s
zBitFieldOperation.incrby)rN r� c C s | j �d||f� | S )a�
Get the value of a given bitfield.
:param fmt: format-string for the bitfield being read, e.g. 'u8' for
an unsigned 8-bit integer.
:param offset: offset (in number of bits). If prefixed with a
'#', this is an offset multiplier, e.g. given the arguments
fmt='u8', offset='#2', the offset will be 16.
:returns: a :py:class:`BitFieldOperation` instance.
�GET�rI rH )r. rN r� r1 r1 r2 r. | s
zBitFieldOperation.get)rN r� r� c C s | j �d|||f� | S )a�
Set the value of a given bitfield.
:param fmt: format-string for the bitfield being read, e.g. 'u8' for
an unsigned 8-bit integer.
:param offset: offset (in number of bits). If prefixed with a
'#', this is an offset multiplier, e.g. given the arguments
fmt='u8', offset='#2', the offset will be 16.
:param int value: value to set at the given position.
:returns: a :py:class:`BitFieldOperation` instance.
�SETrS )r. rN r� r� r1 r1 r2 �set� s zBitFieldOperation.setc C s$ d| j g}| jD ]}|�|� q|S )NZBITFIELD)ri rI r� )r. rh �opsr1 r1 r2 r� � s
zBitFieldOperation.commandr? c C s | j }| �� | jj|� S )a#
Execute the operation(s) in a single BITFIELD command. The return value
is a list of values corresponding to each operation. If the client
used to create this instance was a pipeline, the list of values
will be present within the pipeline's execute.
)r� rX rE r- )r. r� r1 r1 r2 �execute� s zBitFieldOperation.execute)N)N)rp rq rr rs r rt rK rX rL r r: rQ r. rU �propertyr� ru rW r1 r1 r1 r2 rB : s* �
� �
�
rB c
@ s` e Zd ZdZeeed�dd�Zd�eee df ee df e
e ed�dd�Z d�ed eee df e
d
�d d �Ze eeed
�dd�Zd�ee ee df ee df e
e ed�dd�Zd�e e ee df eed�dd�Zd�ee ed�dd�ZeZeed�d d �Zed �d d �Zeed!�d"d#�Zeed�d$d%�ZeZd�eeeeeeed&�d'd(�Zd�ee eeeeed)�d*d+�Z e e d,�d-d.�Z eed!�d/d0�Z eed!�d1d2�Z d�eeedf eedf ee df ee df eed3�d4d5�Z!ed �d6d7�Z"ee ed8�d9d:�Z#ee e ed;�d<d=�Z$eeed>�d?d@�Z%d�ee ed�dAdB�Z&e&Z'd�ee(ed�dDdE�Z)d�e*edG�dHdI�Z+d�e e e e edL�dMdN�Z,d�e e e e e edO�dPdQ�Z-e.eedR�dSdT�Z/e0e1ef edU�dVdW�Z2e0e1ef edU�dXdY�Z3ee edZ�d[d\�Z4eed!�d]d^�Z5d�eeeeeeed&�d_d`�Z6d�ee eeeeed)�dadb�Z7e e d,�dcdd�Z8eeede�dfdg�Z9eed!�dhdi�Z:d�e e eedj�dkdl�Z;edm�dndo�Z<eeedp�dqdr�Z=eeds�dtdu�Z>d�ee(eeeee df ee df edv�dwdx�Z?d�eeeedf eedf eeeeee df ee df edy� dzd{�Z@eed|�d}d~�ZAee e ed�d�d��ZBeeeed��d�d��ZCeeed>�d�d��ZDee eed�d�d��ZEd�eFd� eeeeFd� eFd� f eeee df eed�� d�d��ZGeed!�d�d��ZHd�ee e ed��d�d��ZIeed��d�d��ZJeed!�d�d��ZKeed!�d�d��ZLedd�d�d��ZMddm�d�d��ZNeed�d�d��ZOd�e e e
e e
e e
e e
e ee e ePf d��d�d��ZQdS )��BasicKeyCommandsz(
Redis basic key-based commands
)ri r� r+ c C s | � d||�S )a
Appends the string ``value`` to the value at ``key``. If ``key``
doesn't already exist, create it with a value of ``value``.
Returns the new length of the value at ``key``.
For more information see https://redis.io/commands/append
�APPENDr, )r. ri r� r1 r1 r2 rH � s zBasicKeyCommands.appendN)ri �start�endr� r+ c C sx |g}|dur,|dur,|� |� |� |� n(|dur<|du sL|durT|du rTtd��|durf|� |� | jdg|�R � S )z�
Returns the count of set bits in the value of ``key``. Optional
``start`` and ``end`` parameters indicate which bytes to consider
For more information see https://redis.io/commands/bitcount
Nz$Both start and end must be specifiedZBITCOUNT)rH r r- )r. ri r[ r\ r� �paramsr1 r1 r2 �bitcount� s
zBasicKeyCommands.bitcountrC )r. ri rF r+ c C s t | ||d�S )z�
Return a BitFieldOperation instance to conveniently construct one or
more bitfield operations on ``key``.
For more information see https://redis.io/commands/bitfield
)rF )rB )r. ri rF r1 r1 r2 �bitfield� s zBasicKeyCommands.bitfield)� operation�destrU r+ c G s | j d||g|�R � S )z�
Perform a bitwise operation using ``operation`` between ``keys`` and
store the result in ``dest``.
For more information see https://redis.io/commands/bitop
ZBITOPr, )r. r` ra rU r1 r1 r2 �bitop� s zBasicKeyCommands.bitop)ri �bitr[ r\ r� r+ c C s� |dvrt d��||g}|duo(|�|� |durF|durF|�|� n|du r^|dur^t d��|durp|�|� | jdg|�R � S )a[
Return the position of the first bit set to 1 or 0 in a string.
``start`` and ``end`` defines search range. The range is interpreted
as a range of bytes and not a range of bits, so start=0 and end=2
means to look at the first three bytes.
For more information see https://redis.io/commands/bitpos
)r r& zbit must be 0 or 1Nz0start argument is not set, when end is specifiedZBITPOS�r rH r- )r. ri rc r[ r\ r� r] r1 r1 r2 �bitpos� s
zBasicKeyCommands.bitposF)�source� destinationr r r+ c C s> ||g}|dur |� d|g� |r,|�d� | jdg|�R � S )a�
Copy the value stored in the ``source`` key to the ``destination`` key.
``destination_db`` an alternative destination database. By default,
the ``destination`` key is created in the source Redis database.
``replace`` whether the ``destination`` key should be removed before
copying the value to it. By default, the value is not copied if
the ``destination`` key already exists.
For more information see https://redis.io/commands/copy
NZDB�REPLACEZCOPY)r� rH r- )r. rf rg r r r] r1 r1 r2 r s
zBasicKeyCommands.copyr& )r� �amountr+ c C s | � d||�S )z�
Decrements the value of ``key`` by ``amount``. If no key exists,
the value will be initialized as 0 - ``amount``
For more information see https://redis.io/commands/decrby
ZDECRBYr, �r. r� ri r1 r1 r2 �decrby s zBasicKeyCommands.decrby��namesr+ c G s | j dg|�R � S )z@
Delete one or more keys specified by ``names``
ZDELr, �r. rm r1 r1 r2 �delete* s zBasicKeyCommands.delete�r� c C s | � |� d S r< )ro �r. r� r1 r1 r2 � __delitem__0 s z BasicKeyCommands.__delitem__r� c C s, ddl m} i }g ||< | jd|fi |��S )z�
Return a serialized version of the value stored at the specified key.
If key does not exist a nil bulk reply is returned.
For more information see https://redis.io/commands/dump
r r� ZDUMPr� )r. r� r� r� r1 r1 r2 �dump3 s zBasicKeyCommands.dumpc G s | j dg|�R � S )z
Returns the number of ``names`` that exist
For more information see https://redis.io/commands/exists
ZEXISTSr, rn r1 r1 r2 �exists@ s zBasicKeyCommands.exists)r� r5 �nx�xx�gt�ltr+ c C sl t |tj�rt|�� �}t� }|r,|�d� |r:|�d� |rH|�d� |rV|�d� | jd||g|�R � S )a;
Set an expire flag on key ``name`` for ``time`` seconds with given
``option``. ``time`` can be represented by an integer or a Python timedelta
object.
Valid options are:
NX -> Set expiry only when the key has no expiry
XX -> Set expiry only when the key has an existing expiry
GT -> Set expiry only when the new expiry is greater than current one
LT -> Set expiry only when the new expiry is less than current one
For more information see https://redis.io/commands/expire
�NX�XX�GT�LTZEXPIRE�rG �datetime� timedeltar: �
total_secondsr� rH r- �r. r� r5 ru rv rw rx �
exp_optionr1 r1 r2 �expireJ s
zBasicKeyCommands.expire)r� �whenru rv rw rx r+ c C sr t |tj�r tt�|�� ��}t� }|r2|�d� |r@|�d� |rN|�d� |r\|�d� | jd||g|�R � S )aH
Set an expire flag on key ``name`` with given ``option``. ``when``
can be represented as an integer indicating unix time or a Python
datetime object.
Valid options are:
-> NX -- Set expiry only when the key has no expiry
-> XX -- Set expiry only when the key has an existing expiry
-> GT -- Set expiry only when the new expiry is greater than current one
-> LT -- Set expiry only when the new expiry is less than current one
For more information see https://redis.io/commands/expireat
ry rz r{ r| ZEXPIREAT) rG r~ r: r5 �mktime� timetupler� rH r- )r. r� r� ru rv rw rx r� r1 r1 r2 �expireato s
zBasicKeyCommands.expireatr� c C s | � d|�S )z�
Returns the absolute Unix timestamp (since January 1, 1970) in seconds
at which the given key will expire.
For more information see https://redis.io/commands/expiretime
Z
EXPIRETIMEr, �r. ri r1 r1 r2 �
expiretime� s zBasicKeyCommands.expiretimec C s | � d|�S )z�
Return the value at key ``name``, or None if the key doesn't exist
For more information see https://redis.io/commands/get
rR r, rq r1 r1 r2 r. � s zBasicKeyCommands.getc C s | � d|�S )a-
Get the value at key ``name`` and delete the key. This command
is similar to GET, except for the fact that it also deletes
the key on success (if and only if the key's value type
is a string).
For more information see https://redis.io/commands/getdel
ZGETDELr, rq r1 r1 r2 �getdel� s zBasicKeyCommands.getdel)r� �ex�px�exat�pxat�persistr+ c C sd ||||h}t |�dks(t |�dkr0|r0td��g }|durh|�d� t|tj�r^t|�� �}|�|� |dur�|�d� t|tj�r�t|�� d �}|�|� |dur�|�d� t|tj�r�t|jd �} tt �
|� � ��| }|�|� |du�r@|�d
� t|tj��r6t|jd �}
tt �
|� � ��d |
}|�|� |�rP|�d � | j d |g|�R � S )
a�
Get the value of key and optionally set its expiration.
GETEX is similar to GET, but is a write command with
additional options. All time parameters can be given as
datetime.timedelta or integers.
``ex`` sets an expire flag on key ``name`` for ``ex`` seconds.
``px`` sets an expire flag on key ``name`` for ``px`` milliseconds.
``exat`` sets an expire flag on key ``name`` for ``ex`` seconds,
specified in unix time.
``pxat`` sets an expire flag on key ``name`` for ``ex`` milliseconds,
specified in unix time.
``persist`` remove the time to live associated with ``name``.
For more information see https://redis.io/commands/getex
� r& zK``ex``, ``px``, ``exat``, ``pxat``, and ``persist`` are mutually exclusive.N�EX�PX�� �EXAT�@B �PXAT�PERSISTZGETEX)
r� r rH rG r~ r r: r� � microsecondr5 r� r� r- ) r. r� r� r� r� r� r� Zopsetr0 �s�msr1 r1 r2 �getex� s> �
zBasicKeyCommands.getexc C s" | � |�}|dur|S t|��dS )zg
Return the value at key ``name``, raises a KeyError if the key
doesn't exist.
N)r. �KeyError�r. r� r� r1 r1 r2 � __getitem__� s
z BasicKeyCommands.__getitem__)r� r� r+ c C s | � d||�S )z�
Returns an integer indicating the value of ``offset`` in ``name``
For more information see https://redis.io/commands/getbit
ZGETBITr, )r. r� r� r1 r1 r2 �getbit� s zBasicKeyCommands.getbit)ri r[ r\ r+ c C s | � d|||�S )z�
Returns the substring of the string value stored at ``key``,
determined by the offsets ``start`` and ``end`` (both are inclusive)
For more information see https://redis.io/commands/getrange
ZGETRANGEr, )r. ri r[ r\ r1 r1 r2 �getrange s zBasicKeyCommands.getrange�r� r� r+ c C s | � d||�S )a1
Sets the value at key ``name`` to ``value``
and returns the old value at key ``name`` atomically.
As per Redis 6.2, GETSET is considered deprecated.
Please use SET with GET parameter in new code.
For more information see https://redis.io/commands/getset
ZGETSETr, r� r1 r1 r2 �getset s
zBasicKeyCommands.getsetc C s | � d||�S )z�
Increments the value of ``key`` by ``amount``. If no key exists,
the value will be initialized as ``amount``
For more information see https://redis.io/commands/incrby
rP r, rj r1 r1 r2 rQ s zBasicKeyCommands.incrby� �?c C s | � d||�S )z�
Increments the value at key ``name`` by floating ``amount``.
If no key exists, the value will be initialized as ``amount``
For more information see https://redis.io/commands/incrbyfloat
Z INCRBYFLOATr, rj r1 r1 r2 � incrbyfloat% s z BasicKeyCommands.incrbyfloatr� �r� r+ c K s | j d|fi |��S )z~
Returns a list of keys matching ``pattern``
For more information see https://redis.io/commands/keys
ZKEYSr, �r. r� r/ r1 r1 r2 rU . s zBasicKeyCommands.keys�LEFT�RIGHT)�
first_list� second_list�srcra r+ c C s ||||g}| j dg|�R � S )a
Atomically returns and removes the first/last element of a list,
pushing it as the first/last element on the destination list.
Returns the element being popped and pushed.
For more information see https://redis.io/commands/lmove
ZLMOVEr, )r. r� r� r� ra r] r1 r1 r2 �lmove6 s
zBasicKeyCommands.lmove)r� r� r� r� ra r+ c C s |||||g}| j dg|�R � S )zo
Blocking version of lmove.
For more information see https://redis.io/commands/blmove
ZBLMOVEr, )r. r� r� r� r� ra r] r1 r1 r2 �blmoveC s
zBasicKeyCommands.blmove�rU r5 r+ c G s> ddl m} t||�}i }|s&g ||< | jdg|�R i |��S )z�
Returns a list of values ordered identically to ``keys``
For more information see https://redis.io/commands/mget
r )�EMPTY_RESPONSEZMGET)r� r� r' r- )r. rU r5 r� r� r1 r1 r2 �mgetS s
zBasicKeyCommands.mget)�mappingr+ c C s. g }|� � D ]}|�|� q | jdg|�R � S )a
Sets key/values based on a mapping. Mapping is a dictionary of
key/value pairs. Both keys and values should be strings or types that
can be cast to a string via str().
For more information see https://redis.io/commands/mset
ZMSET��itemsr� r- �r. r� r� �pairr1 r1 r2 �mseta s zBasicKeyCommands.msetc C s. g }|� � D ]}|�|� q | jdg|�R � S )av
Sets key/values based on a mapping if none of the keys are already set.
Mapping is a dictionary of key/value pairs. Both keys and values
should be strings or types that can be cast to a string via str().
Returns a boolean indicating if the operation was successful.
For more information see https://redis.io/commands/msetnx
ZMSETNXr� r� r1 r1 r2 �msetnxn s zBasicKeyCommands.msetnx)r� �dbr+ c C s | � d||�S )z�
Moves the key ``name`` to a different Redis database ``db``
For more information see https://redis.io/commands/move
ZMOVEr, )r. r� r� r1 r1 r2 �move| s zBasicKeyCommands.movec C s | � d|�S )zw
Removes an expiration on ``name``
For more information see https://redis.io/commands/persist
r� r, rq r1 r1 r2 r� � s zBasicKeyCommands.persistc C sp t |tj�r t|�� d �}t� }|r0|�d� |r>|�d� |rL|�d� |rZ|�d� | jd||g|�R � S )aA
Set an expire flag on key ``name`` for ``time`` milliseconds
with given ``option``. ``time`` can be represented by an
integer or a Python timedelta object.
Valid options are:
NX -> Set expiry only when the key has no expiry
XX -> Set expiry only when the key has an existing expiry
GT -> Set expiry only when the new expiry is greater than current one
LT -> Set expiry only when the new expiry is less than current one
For more information see https://redis.io/commands/pexpire
r� ry rz r{ r| ZPEXPIREr} r� r1 r1 r2 �pexpire� s
zBasicKeyCommands.pexpirec C s� t |tj�r4t|jd �}tt�|�� ��d | }t� }|rH|�d� |rV|�d� |rd|�d� |rr|�d� | j d||g|�R � S )ab
Set an expire flag on key ``name`` with given ``option``. ``when``
can be represented as an integer representing unix time in
milliseconds (unix time * 1000) or a Python datetime object.
Valid options are:
NX -> Set expiry only when the key has no expiry
XX -> Set expiry only when the key has an existing expiry
GT -> Set expiry only when the new expiry is greater than current one
LT -> Set expiry only when the new expiry is less than current one
For more information see https://redis.io/commands/pexpireat
r� ry rz r{ r| Z PEXPIREAT)
rG r~ r: r� r5 r� r� r� rH r- ) r. r� r� ru rv rw rx r� r� r1 r1 r2 � pexpireat� s
zBasicKeyCommands.pexpireatc C s | � d|�S )z�
Returns the absolute Unix timestamp (since January 1, 1970) in milliseconds
at which the given key will expire.
For more information see https://redis.io/commands/pexpiretime
Z PEXPIRETIMEr, r� r1 r1 r2 � pexpiretime� s z BasicKeyCommands.pexpiretime)r� �time_msr� c C s, t |tj�r t|�� d �}| �d|||�S )a
Set the value of key ``name`` to ``value`` that expires in ``time_ms``
milliseconds. ``time_ms`` can be represented by an integer or a Python
timedelta object
For more information see https://redis.io/commands/psetex
r� ZPSETEX�rG r~ r r: r� r- )r. r� r� r� r1 r1 r2 �psetex� s zBasicKeyCommands.psetexc C s | � d|�S )z�
Returns the number of milliseconds until the key ``name`` will expire
For more information see https://redis.io/commands/pttl
ZPTTLr, rq r1 r1 r2 �pttl� s zBasicKeyCommands.pttl)ri rE �
withvaluesr+ c C s8 g }|dur|� |� |r$|� d� | jd|g|�R � S )ap
Return a random field from the hash value stored at key.
count: if the argument is positive, return an array of distinct fields.
If called with a negative count, the behavior changes and the command
is allowed to return the same field multiple times. In this case,
the number of returned fields is the absolute value of the
specified count.
withvalues: The optional WITHVALUES modifier changes the reply so it
includes the respective values of the randomly selected hash fields.
For more information see https://redis.io/commands/hrandfield
NZ
WITHVALUESZ
HRANDFIELDrx )r. ri rE r� r] r1 r1 r2 �
hrandfield� s
zBasicKeyCommands.hrandfieldr? c K s | j di |��S )zx
Returns the name of a random key
For more information see https://redis.io/commands/randomkey
� RANDOMKEY)r� r, rA r1 r1 r2 � randomkey s zBasicKeyCommands.randomkey�r� �dstr+ c C s | � d||�S )zr
Rename key ``src`` to ``dst``
For more information see https://redis.io/commands/rename
ZRENAMEr, �r. r� r� r1 r1 r2 �rename s zBasicKeyCommands.rename)r� r� c C s | � d||�S )z�
Rename key ``src`` to ``dst`` if ``dst`` doesn't already exist
For more information see https://redis.io/commands/renamenx
ZRENAMENXr, r� r1 r1 r2 �renamenx s zBasicKeyCommands.renamenx)r� �ttlr� r �absttl�idletime� frequencyr+ c C s� |||g}|r|� d� |r&|� d� |durf|� d� z|� t|�� W n tyd td��Y n0 |dur�|� d� z|� t|�� W n ty� td��Y n0 | jdg|�R � S ) a�
Create a key using the provided serialized value, previously obtained
using DUMP.
``replace`` allows an existing key on ``name`` to be overridden. If
it's not specified an error is raised on collision.
``absttl`` if True, specified ``ttl`` should represent an absolute Unix
timestamp in milliseconds in which the key will expire. (Redis 5.0 or
greater).
``idletime`` Used for eviction, this is the number of seconds the
key must be idle, prior to execution.
``frequency`` Used for eviction, this is the frequency counter of
the object stored at the key, prior to execution.
For more information see https://redis.io/commands/restore
rh ZABSTTLNZIDLETIMEzidletimemust be an integerZFREQz frequency must be an integerZRESTORE)rH r: r; r r- ) r. r� r� r� r r� r� r� r] r1 r1 r2 �restore! s$
zBasicKeyCommands.restore) r� r� r� r� ru rv �keepttlr. r� r� r+ c C s� ||g} i } |dur\| � d� t|tj�r>| � t|�� �� n t|t�rT| � |� ntd��|dur�| � d� t|tj�r�| � t|�� d �� n t|t�r�| � |� ntd��| dur�| � d� t| tj�r�t| jd �}
tt� | �
� ��|
} | � | � |
du�rP| � d � t|
tj��rFt|
jd �}tt� |
�
� ��d | }
| � |
� |�r`| � d
� |�rp| � d � |�r�| � d � |�r�| � d
� d| d< | j dg| �R i | ��S )a
Set the value at key ``name`` to ``value``
``ex`` sets an expire flag on key ``name`` for ``ex`` seconds.
``px`` sets an expire flag on key ``name`` for ``px`` milliseconds.
``nx`` if set to True, set the value at key ``name`` to ``value`` only
if it does not exist.
``xx`` if set to True, set the value at key ``name`` to ``value`` only
if it already exists.
``keepttl`` if True, retain the time to live associated with the key.
(Available since Redis 6.0)
``get`` if True, set the value at key ``name`` to ``value`` and return
the old value stored at key, or None if the key did not exist.
(Available since Redis 6.2)
``exat`` sets an expire flag on key ``name`` for ``ex`` seconds,
specified in unix time.
``pxat`` sets an expire flag on key ``name`` for ``ex`` milliseconds,
specified in unix time.
For more information see https://redis.io/commands/set
Nr� z$ex must be datetime.timedelta or intr� r� z$px must be datetime.timedelta or intr� r� r� ZKEEPTTLry rz rR Tr. rT ) rH rG r~ r r: r� r r� r5 r� r� r- )r. r� r� r� r� ru rv r� r. r� r� r0 r� r� r� r1 r1 r2 rU S sL )
zBasicKeyCommands.set�r� r� c C s | � ||� d S r< )rU r� r1 r1 r2 � __setitem__� s z BasicKeyCommands.__setitem__)r� r� r� r+ c C s |rdp
d}| � d|||�S )z�
Flag the ``offset`` in ``name`` as ``value``. Returns an integer
indicating the previous value of ``offset``.
For more information see https://redis.io/commands/setbit
r& r ZSETBITr, �r. r� r� r� r1 r1 r2 �setbit� s zBasicKeyCommands.setbit)r� r5 r� r+ c C s( t |tj�rt|�� �}| �d|||�S )z�
Set the value of key ``name`` to ``value`` that expires in ``time``
seconds. ``time`` can be represented by an integer or a Python
timedelta object.
For more information see https://redis.io/commands/setex
ZSETEXr� )r. r� r5 r� r1 r1 r2 �setex� s zBasicKeyCommands.setexc C s | � d||�S )z�
Set the value of key ``name`` to ``value`` if key doesn't exist
For more information see https://redis.io/commands/setnx
ZSETNXr, r� r1 r1 r2 �setnx� s zBasicKeyCommands.setnxc C s | � d|||�S )a!
Overwrite bytes in the value of ``name`` starting at ``offset`` with
``value``. If ``offset`` plus the length of ``value`` exceeds the
length of the original value, the new value will be larger than before.
If ``offset`` exceeds the length of the original value, null bytes
will be used to pad between the end of the previous value and the start
of what's being injected.
Returns the length of the new string.
For more information see https://redis.io/commands/setrange
ZSETRANGEr, r� r1 r1 r2 �setrange� s
zBasicKeyCommands.setrange�strings�LCSrU ) �algo�value1�value2�specific_argumentr� �idx� minmatchlen� withmatchlenr+ c
K s� dg}
||
vr&d� |
�} td| � ���|dvr6td��|rF|rFtd��||�� ||g} |rd| �d� |rr| �d� zt|� | �d |g� W n ty� Y n0 |r�| �d
� | jd g| �R ||||d �| ��S )
a�
Implements complex algorithms that operate on strings.
Right now the only algorithm implemented is the LCS algorithm
(longest common substring). However new algorithms could be
implemented in the future.
``algo`` Right now must be LCS
``value1`` and ``value2`` Can be two strings or two keys
``specific_argument`` Specifying if the arguments to the algorithm
will be keys or strings. strings is the default.
``len`` Returns just the len of the match.
``idx`` Returns the match positions in each string.
``minmatchlen`` Restrict the list of matches to the ones of a given
minimal length. Can be provided only when ``idx`` set to True.
``withmatchlen`` Returns the matches with the len of the match.
Can be provided only when ``idx`` set to True.
For more information see https://redis.io/commands/stralgo
r� z, z The supported algorithms are: )rU r� z-specific_argument can be only keys or stringsz(len and idx cannot be provided together.s LENs IDXs MINMATCHLENs WITHMATCHLENZSTRALGO)r� r� r� r� )r� r rM rH r: r� � TypeErrorr- )
r. r� r� r� r� r� r� r� r� r/ Zsupported_algoZsupported_algos_strr0 r1 r1 r2 �stralgo� s@
����zBasicKeyCommands.stralgoc C s | � d|�S )z�
Return the number of bytes stored in the value of ``name``
For more information see https://redis.io/commands/strlen
ZSTRLENr, rq r1 r1 r2 �strlen s zBasicKeyCommands.strlen����r� r[ r\ r+ c C s | � d|||�S )z�
Return a substring of the string at key ``name``. ``start`` and ``end``
are 0-based integers specifying the portion of the string to return.
ZSUBSTRr, �r. r� r[ r\ r1 r1 r2 �substr s zBasicKeyCommands.substrr� c G s | j dg|�R � S )z�
Alters the last access time of a key(s) ``*args``. A key is ignored
if it does not exist.
For more information see https://redis.io/commands/touch
ZTOUCHr, r� r1 r1 r2 �touch' s zBasicKeyCommands.touchc C s | � d|�S )z�
Returns the number of seconds until the key ``name`` will expire
For more information see https://redis.io/commands/ttl
ZTTLr, rq r1 r1 r2 r� 0 s zBasicKeyCommands.ttlc C s | � d|�S )zs
Returns the type of key ``name``
For more information see https://redis.io/commands/type
ZTYPEr, rq r1 r1 r2 �type8 s zBasicKeyCommands.typec G s t �td�� dS )z�
Watches the values at keys ``names``, or None if the key doesn't exist
For more information see https://redis.io/commands/watch
z!Call WATCH from a Pipeline objectN��warnings�warn�DeprecationWarningrn r1 r1 r2 �watch@ s zBasicKeyCommands.watchc C s t �td�� dS )z�
Unwatches the value at key ``name``, or None of the key doesn't exist
For more information see https://redis.io/commands/unwatch
z#Call UNWATCH from a Pipeline objectNr� r~ r1 r1 r2 �unwatchH s zBasicKeyCommands.unwatchc G s | j dg|�R � S )z�
Unlink one or more keys specified by ``names``
For more information see https://redis.io/commands/unlink
ZUNLINKr, rn r1 r1 r2 �unlinkP s zBasicKeyCommands.unlinkr )�key1�key2r� r� r� r� r+ c C sZ ||g}|r|� d� |r$|� d� |dkr:|�d|g� |rH|� d� | jdg|�R � S )a�
Find the longest common subsequence between ``key1`` and ``key2``.
If ``len`` is true the length of the match will will be returned.
If ``idx`` is true the match position in each strings will be returned.
``minmatchlen`` restrict the list of matches to the ones of
the given ``minmatchlen``.
If ``withmatchlen`` the length of the match also will be returned.
For more information see https://redis.io/commands/lcs
ZLENZIDXr Z MINMATCHLENZ WITHMATCHLENr� �rH r� r- )r. r� r� r� r� r� r� r0 r1 r1 r2 �lcsX s
zBasicKeyCommands.lcs)NNN)N)NNN)NF)r& )FFFF)FFFF)NNNNF)r& )r� )r� )r� r� )r� r� )FFFF)FFFF)NF)FFNN)NNFFFFNN)r� FFNF)r� )FFr F)Rrp rq rr rs r r ru rH r r: r rt r^ rB r_ rb re rv r rk Zdecrro rr rs rt � __contains__r r� r r� r� r. r� r� r� r� r� r� rQ �incrr: r� r! rU r� r� r r� r r r� r� r� r� r� r� r� r� r� r� r� r� r� r� rU r� r� r� r� r� r r� r� r� r� r� r� r� r� r� r� r� r1 r1 r1 r2 rY � s�
�
� �
�
�
� # �
�
�� ) �� % �
� C
�� ��
�� ( �� $ ��
�
� 6 �
� U
�
� @ � �rY c sp e Zd Zed�dd�Zed�dd�Zed�dd�Zeed�d d
�Zed d �� fd
d� Z d d�� fdd� Z
� Z S )�AsyncBasicKeyCommandsrp c C s t d��d S )Nz2Async Redis client does not support class deletion�r� rq r1 r1 r2 rr w s z!AsyncBasicKeyCommands.__delitem__c C s t d��d S )Nz3Async Redis client does not support class inclusionr� rq r1 r1 r2 r� z s z"AsyncBasicKeyCommands.__contains__c C s t d��d S )Nz3Async Redis client does not support class retrievalr� rq r1 r1 r2 r� } s z!AsyncBasicKeyCommands.__getitem__r� c C s t d��d S )Nz4Async Redis client does not support class assignmentr� r� r1 r1 r2 r� � s z!AsyncBasicKeyCommands.__setitem__Nrl c � s t � j|� S r< )r> r� rn r? r1 r2 r� � s zAsyncBasicKeyCommands.watchr? c � s
t � �� S r< )r> r� r~ r? r1 r2 r� � s z AsyncBasicKeyCommands.unwatch) rp rq rr r rr r� r� r r� r� r� rA r1 r1 r? r2 r� v s r� c
@ sH e Zd ZdZdEeee eee e f d�dd�Z
dFeee eee e f d�dd�Z dGe e ee eeee ee f d�d d
�Z
d d �eeee e ee ee d
�dd�Zdd d�eee e ee eee e f d�dd�Ze eeeee ee f d�dd�Ze e e e eee ef d�dd�Ze eee ef d�d d �ZdHe ee ee edf d �d d �Ze eeee ef d!�d"d#�Ze eeee ef d!�d$d%�Ze eeeee e f d&�d'd(�Ze ee eee ef d)�d*d+�Ze ee eee e f d,�d-d.�Ze eeeee e f d&�d/d0�ZdIe ee ee edf d �d1d2�Z e e eee e f d3�d4d5�Z e eeee ef d!�d6d7�Z e e eee ef d8�d9d:�Z dJe e ee ee ee ee edf d;�d<d=�Z dKe ee ee ee eee e!e!ee ee! eeef d?�
d@dA�Z"dLe ee ee ee eee e!e!e dB�dCdD�Z#dS )M� ListCommandsz^
Redis commands for List data type.
see: https://redis.io/topics/data-types#lists
r �rU r� r+ c C s2 |du r d}t |d�}|�|� | jdg|�R � S )a
LPOP a value off of the first non-empty list
named in the ``keys`` list.
If none of the lists in ``keys`` has a value to LPOP, then block
for ``timeout`` seconds, or until a value gets pushed on to one
of the lists.
If timeout is 0, then block indefinitely.
For more information see https://redis.io/commands/blpop
Nr ZBLPOP�r' rH r- �r. rU r� r1 r1 r2 �blpop� s
zListCommands.blpopc C s2 |du r d}t |d�}|�|� | jdg|�R � S )a
RPOP a value off of the first non-empty list
named in the ``keys`` list.
If none of the lists in ``keys`` has a value to RPOP, then block
for ``timeout`` seconds, or until a value gets pushed on to one
of the lists.
If timeout is 0, then block indefinitely.
For more information see https://redis.io/commands/brpop
Nr ZBRPOPr� r� r1 r1 r2 �brpop� s
zListCommands.brpop)r� r� r� r+ c C s |du r d}| � d|||�S )ac
Pop a value off the tail of ``src``, push it on the head of ``dst``
and then return it.
This command blocks until a value is in ``src`` or until ``timeout``
seconds elapse, whichever is first. A ``timeout`` value of 0 blocks
forever.
For more information see https://redis.io/commands/brpoplpush
Nr Z
BRPOPLPUSHr, )r. r� r� r� r1 r1 r2 �
brpoplpush� s
zListCommands.brpoplpushr& )rE )r� �numkeysr5 � directionrE r+ c G s* ||g|�|�d�|�}| j dg|�R � S )a[
Pop ``count`` values (default 1) from first non-empty in the list
of provided key names.
When all lists are empty this command blocks the connection until another
client pushes to it or until the timeout, timeout of 0 blocks indefinitely
For more information see https://redis.io/commands/blmpop
�COUNTZBLMPOPr, )r. r� r� r rE r5 r1 r1 r2 �blmpop� s zListCommands.blmpopN)r rE )�num_keysr5 r rE r+ c G s< |gt |� |g }|dkr*|�d|g� | jdg|�R � S )z�
Pop ``count`` values (default 1) first non-empty list key from the list
of args provided key names.
For more information see https://redis.io/commands/lmpop
r& r ZLMPOP)r� r� r- )r. r r rE r5 r1 r1 r2 �lmpop� s
zListCommands.lmpop)r� r� r+ c C s | � d||�S )z�
Return the item from list ``name`` at position ``index``
Negative indexes are supported and will return an item at the
end of the list
For more information see https://redis.io/commands/lindex
ZLINDEXr, )r. r� r� r1 r1 r2 �lindex� s zListCommands.lindex)r� �where�refvaluer� r+ c C s | � d||||�S )a$
Insert ``value`` in list ``name`` either immediately before or after
[``where``] ``refvalue``
Returns the new length of the list on success or -1 if ``refvalue``
is not in the list.
For more information see https://redis.io/commands/linsert
ZLINSERTr, )r. r� r r r� r1 r1 r2 �linsert
s zListCommands.linsertr� c C s | � d|�S )zy
Return the length of the list ``name``
For more information see https://redis.io/commands/llen
ZLLENr, rq r1 r1 r2 �llen
s zListCommands.llen�r� rE r+ c C s& |dur| � d||�S | � d|�S dS )az
Removes and returns the first elements of the list ``name``.
By default, the command pops a single element from the beginning of
the list. When provided with the optional ``count`` argument, the reply
will consist of up to count elements, depending on the list's length.
For more information see https://redis.io/commands/lpop
NZLPOPr, �r. r� rE r1 r1 r2 �lpop
s
zListCommands.lpop�r� �valuesr+ c G s | j d|g|�R � S )z�
Push ``values`` onto the head of the list ``name``
For more information see https://redis.io/commands/lpush
ZLPUSHr, �r. r� r r1 r1 r2 �lpush%
s zListCommands.lpushc G s | j d|g|�R � S )z�
Push ``value`` onto the head of the list ``name`` if ``name`` exists
For more information see https://redis.io/commands/lpushx
ZLPUSHXr, r r1 r1 r2 �lpushx-
s zListCommands.lpushxr� c C s | � d|||�S )a
Return a slice of the list ``name`` between
position ``start`` and ``end``
``start`` and ``end`` can be negative numbers just like
Python slicing notation
For more information see https://redis.io/commands/lrange
ZLRANGEr, r� r1 r1 r2 �lrange5
s
zListCommands.lrange)r� rE r� r+ c C s | � d|||�S )a�
Remove the first ``count`` occurrences of elements equal to ``value``
from the list stored at ``name``.
The count argument influences the operation in the following ways:
count > 0: Remove elements equal to value moving from head to tail.
count < 0: Remove elements equal to value moving from tail to head.
count = 0: Remove all elements equal to value.
For more information see https://redis.io/commands/lrem
ZLREMr, )r. r� rE r� r1 r1 r2 �lremA
s zListCommands.lrem)r� r� r� r+ c C s | � d|||�S )z�
Set element at ``index`` of list ``name`` to ``value``
For more information see https://redis.io/commands/lset
ZLSETr, )r. r� r� r� r1 r1 r2 �lsetO
s zListCommands.lsetc C s | � d|||�S )a
Trim the list ``name``, removing all values not within the slice
between ``start`` and ``end``
``start`` and ``end`` can be negative numbers just like
Python slicing notation
For more information see https://redis.io/commands/ltrim
ZLTRIMr, r� r1 r1 r2 �ltrimW
s
zListCommands.ltrimc C s& |dur| � d||�S | � d|�S dS )as
Removes and returns the last elements of the list ``name``.
By default, the command pops a single element from the end of the list.
When provided with the optional ``count`` argument, the reply will
consist of up to count elements, depending on the list's length.
For more information see https://redis.io/commands/rpop
NZRPOPr, r r1 r1 r2 �rpopc
s
zListCommands.rpopr� c C s | � d||�S )z�
RPOP a value off of the ``src`` list and atomically LPUSH it
on to the ``dst`` list. Returns the value.
For more information see https://redis.io/commands/rpoplpush
Z RPOPLPUSHr, r� r1 r1 r2 � rpoplpushr
s zListCommands.rpoplpushc G s | j d|g|�R � S )z�
Push ``values`` onto the tail of the list ``name``
For more information see https://redis.io/commands/rpush
ZRPUSHr, r r1 r1 r2 �rpush{
s zListCommands.rpushr� c C s | � d||�S )z�
Push ``value`` onto the tail of the list ``name`` if ``name`` exists
For more information see https://redis.io/commands/rpushx
ZRPUSHXr, r� r1 r1 r2 �rpushx�
s zListCommands.rpushx)r� r� �rankrE �maxlenr+ c C s\ ||g}|dur |� d|g� |dur4|� d|g� |durJ|� d|g� | jdg|�R � S )ab
Get position of ``value`` within the list ``name``
If specified, ``rank`` indicates the "rank" of the first element to
return in case there are multiple copies of ``value`` in the list.
By default, LPOS returns the position of the first occurrence of
``value`` in the list. When ``rank`` 2, LPOS returns the position of
the second ``value`` in the list. If ``rank`` is negative, LPOS
searches the list in reverse. For example, -1 would return the
position of the last occurrence of ``value`` and -2 would return the
position of the next to last occurrence of ``value``.
If specified, ``count`` indicates that LPOS should return a list of
up to ``count`` positions. A ``count`` of 2 would return a list of
up to 2 positions. A ``count`` of 0 returns a list of all positions
matching ``value``. When ``count`` is specified and but ``value``
does not exist in the list, an empty list is returned.
If specified, ``maxlen`` indicates the maximum number of list
elements to scan. A ``maxlen`` of 1000 will only return the
position(s) of items within the first 1000 entries in the list.
A ``maxlen`` of 0 (the default) will scan the entire list.
For more information see https://redis.io/commands/lpos
NZRANKr ZMAXLENZLPOS�r� r- )r. r� r� r rE r r0 r1 r1 r2 �lpos�
s !zListCommands.lposF)
r� r[ r, �byr. �desc�alpha�store�groupsr+ c
C s, |dur|du s |dur(|du r(t d��|g}
|durD|
�d|g� |durd|durd|
�d||g� |dur�t|ttf�r�|
�d|g� n|D ]} |
�d| g� q�|r�|
�d� |r�|
�d� |dur�|
�d|g� | r�|r�t|ttf�s�t|�d k r�t d
��d | �rt|�ndi} | jd g|
�R i | ��S )
a�
Sort and return the list, set or sorted set at ``name``.
``start`` and ``num`` allow for paging through the sorted data
``by`` allows using an external key to weight and sort the items.
Use an "*" to indicate where in the key the item value is located
``get`` allows for returning items from external keys rather than the
sorted data itself. Use an "*" to indicate where in the key
the item value is located
``desc`` allows for reversing the sort
``alpha`` allows for sorting lexicographically rather than numerically
``store`` allows for storing the result of the sort into
the key ``store``
``groups`` if set to True and if ``get`` contains at least two
elements, sort will return a list of tuples, each containing the
values fetched from the arguments to ``get``.
For more information see https://redis.io/commands/sort
N�,``start`` and ``num`` must both be specifieds BY� LIMITs GET� DESCs ALPHA� STOREr� zVwhen using "groups" the "get" argument must be specified and contain at least two keysr" ZSORT)r r� rG �bytesrt rH r� r- )
r. r� r[ r, r r. r r r! r" r0 �gr� r1 r1 r2 �sort�
s2 %
�zListCommands.sort)ri r[ r, r r. r r r+ c C s | j |||||||d�S )a�
Returns the elements contained in the list, set or sorted set at key.
(read-only variant of the SORT command)
``start`` and ``num`` allow for paging through the sorted data
``by`` allows using an external key to weight and sort the items.
Use an "*" to indicate where in the key the item value is located
``get`` allows for returning items from external keys rather than the
sorted data itself. Use an "*" to indicate where in the key
the item value is located
``desc`` allows for reversing the sort
``alpha`` allows for sorting lexicographically rather than numerically
For more information see https://redis.io/commands/sort_ro
)r[ r, r r. r r )r) )r. ri r[ r, r r. r r r1 r1 r2 �sort_ro s �zListCommands.sort_ro)r )r )r )N)N)NNN)NNNNFFNF)NNNNFF)$rp rq rr rs r
r r: r r r� r� r� rt r� r: r r r r r r r r r r r r r r r r r r rv r) r* r1 r1 r1 r2 r� � s� �� �� �
� �� �� � � " " � � 0 �
� K �
�r� c @ sz e Zd ZdZdeeedf eedf eedf ed�dd�Z deedf eedf eedf e
d�dd �Z d e eeedf eedf ed
�d d �Z
d e eedf eedf e
d
�dd�Zd e eeedf eedf ed
�dd�Zd eeedf eedf e
d
�dd�Zdddefe eeedf eedf eeef ed�dd�Zddefe eedf eedf eeef e
d�dd�ZdS ) � ScanCommandszF
Redis SCAN commands.
see: https://redis.io/commands/scan
r N)�cursor�matchrE r� r+ c K s` |g}|dur |� d|g� |dur2|� d|g� |durH|� d|g� | jdg|�R i |��S )a^
Incrementally return lists of key names. Also return a cursor
indicating the scan position.
``match`` allows for filtering the keys by pattern
``count`` provides a hint to Redis about the number of keys to
return per batch.
``_type`` filters the returned values by a particular Redis type.
Stock Redis instances allow for the following types:
HASH, LIST, SET, STREAM, STRING, ZSET
Additionally, Redis modules can expose other types as well.
For more information see https://redis.io/commands/scan
N� MATCH� COUNTr� ZSCANr )r. r, r- rE r� r/ r0 r1 r1 r2 �scan+ s zScanCommands.scan�r- rE r� r+ c k s: d}|dkr6| j f ||||d�|��\}}|E dH qdS �a*
Make an iterator using the SCAN command so that the client doesn't
need to remember the cursor position.
``match`` allows for filtering the keys by pattern
``count`` provides a hint to Redis about the number of keys to
return per batch.
``_type`` filters the returned values by a particular Redis type.
Stock Redis instances allow for the following types:
HASH, LIST, SET, STREAM, STRING, ZSET
Additionally, Redis modules can expose other types as well.
�0r )r, r- rE r� N�r0 )r. r- rE r� r/ r, �datar1 r1 r2 � scan_iterL s ��
zScanCommands.scan_iter)r� r, r- rE r+ c C sF ||g}|dur |� d|g� |dur4|� d|g� | jdg|�R � S )a<
Incrementally return lists of elements in a set. Also return a cursor
indicating the scan position.
``match`` allows for filtering the keys by pattern
``count`` allows for hint the minimum number of returns
For more information see https://redis.io/commands/sscan
Nr. r/ ZSSCANr �r. r� r, r- rE r0 r1 r1 r2 �sscanh s zScanCommands.sscan�r� r- rE r+ c c s2 d}|dkr.| j ||||d�\}}|E dH qdS �a
Make an iterator using the SSCAN command so that the client doesn't
need to remember the cursor position.
``match`` allows for filtering the keys by pattern
``count`` allows for hint the minimum number of returns
r3 r �r, r- rE N�r8 �r. r� r- rE r, r5 r1 r1 r2 �
sscan_iter� s zScanCommands.sscan_iterc C sF ||g}|dur |� d|g� |dur4|� d|g� | jdg|�R � S )a<
Incrementally return key/value slices in a hash. Also return a cursor
indicating the scan position.
``match`` allows for filtering the keys by pattern
``count`` allows for hint the minimum number of returns
For more information see https://redis.io/commands/hscan
Nr. r/ ZHSCANr r7 r1 r1 r2 �hscan� s zScanCommands.hscanc c s6 d}|dkr2| j ||||d�\}}|�� E dH qdS �a
Make an iterator using the HSCAN command so that the client doesn't
need to remember the cursor position.
``match`` allows for filtering the keys by pattern
``count`` allows for hint the minimum number of returns
r3 r r; N�r? r� r= r1 r1 r2 �
hscan_iter� s zScanCommands.hscan_iter)r� r, r- rE �score_cast_funcr+ c C sT ||g}|dur |� d|g� |dur4|� d|g� d|i}| jdg|�R i |��S )a�
Incrementally return lists of elements in a sorted set. Also return a
cursor indicating the scan position.
``match`` allows for filtering the keys by pattern
``count`` allows for hint the minimum number of returns
``score_cast_func`` a callable used to cast the score return value
For more information see https://redis.io/commands/zscan
Nr. r/ rC ZZSCANr )r. r� r, r- rE rC r0 r� r1 r1 r2 �zscan� s zScanCommands.zscan�r� r- rE rC r+ c c s4 d}|dkr0| j |||||d�\}}|E dH qdS �aL
Make an iterator using the ZSCAN command so that the client doesn't
need to remember the cursor position.
``match`` allows for filtering the keys by pattern
``count`` allows for hint the minimum number of returns
``score_cast_func`` a callable used to cast the score return value
r3 r )r, r- rE rC N�rD )r. r� r- rE rC r, r5 r1 r1 r2 �
zscan_iter� s �
zScanCommands.zscan_iter)r NNN)NNN)r NN)NN)r NN)NN)rp rq rr rs r: r r! rt ru r0 r r6 r r8 r> r? rB r: r� r rD rH r1 r1 r1 r2 r+ % s� �
� # �
� �
� �
� �
� �
� �
� �
�r+ c @ s� e Zd Zd
eedf eedf eedf ed�dd�Zde eedf eedf ed�dd�Z
deeedf eedf ed�dd �Z dde fe eedf eedf ee
ef ed
�d d �ZdS )�AsyncScanCommandsNr1 c K sF d}|dkrB| j f ||||d�|��I dH \}}|D ]
}|V q4qdS r2 r4 )r. r- rE r� r/ r, r5 �dr1 r1 r2 r6 � s ��zAsyncScanCommands.scan_iterr9 c C s> d}|dkr:| j ||||d�I dH \}}|D ]
}|V q,qdS r: r< )r. r� r- rE r, r5 rJ r1 r1 r2 r> s �z AsyncScanCommands.sscan_iterc C sB d}|dkr>| j ||||d�I dH \}}|�� D ]
}|V q0qdS r@ rA )r. r� r- rE r, r5 �itr1 r1 r2 rB + s � z AsyncScanCommands.hscan_iterrE c C s@ d}|dkr<| j |||||d�I dH \}}|D ]
}|V q.qdS rF rG )r. r� r- rE rC r, r5 rJ r1 r1 r2 rH A s �z AsyncScanCommands.zscan_iter)NNN)NN)NN)rp rq rr r r! r: rt r r6 r r> rB r: r� r rH r1 r1 r1 r2 rI � sF �
� �
� �
� �
�rI c @ s e Zd ZdZeeeee ef d�dd�Z eeee ef d�dd�Z
e e eee e f d�d d
�Z
ee e eee ef d �d d
�Ze e eee e f d�dd�Zd.ee e eeee ef d�dd�Zee e eee ef d �dd�Zeeeee ef d�dd�Zeeee e f d�dd�Zee e eee e e e f d�d d �Zeeeeee ef d �d d �Zd/eee eee d!f d"�d#d$�Zd0eee eee d!f d%�d&d'�Zeeeee ef d�d(d)�Ze e eee e f d�d*d+�Zee e eee ef d �d,d-�Z d!S )1� SetCommandsz\
Redis commands for Set data type.
see: https://redis.io/topics/data-types#sets
r
c G s | j d|g|�R � S )zs
Add ``value(s)`` to set ``name``
For more information see https://redis.io/commands/sadd
ZSADDr, r r1 r1 r2 �sadde s zSetCommands.saddr� c C s | � d|�S )z�
Return the number of elements in set ``name``
For more information see https://redis.io/commands/scard
ZSCARDr, rq r1 r1 r2 �scardm s zSetCommands.scardr� c G s t ||�}| jdg|�R � S )z�
Return the difference of sets specified by ``keys``
For more information see https://redis.io/commands/sdiff
ZSDIFF�r' r- �r. rU r5 r1 r1 r2 �sdiffu s
zSetCommands.sdiff)ra rU r5 r+ c G s t ||�}| jd|g|�R � S )z�
Store the difference of sets specified by ``keys`` into a new
set named ``dest``. Returns the number of keys in the new set.
For more information see https://redis.io/commands/sdiffstore
Z
SDIFFSTORErO �r. ra rU r5 r1 r1 r2 �
sdiffstore~ s
zSetCommands.sdiffstorec G s t ||�}| jdg|�R � S )z�
Return the intersection of sets specified by ``keys``
For more information see https://redis.io/commands/sinter
ZSINTERrO rP r1 r1 r2 �sinter� s
zSetCommands.sinterr �r� rU �limitr+ c C s$ |g|�d�|�}| j dg|�R � S )a�
Return the cardinality of the intersect of multiple sets specified by ``keys`.
When LIMIT provided (defaults to 0 and means unlimited), if the intersection
cardinality reaches limit partway through the computation, the algorithm will
exit and yield limit as the cardinality
For more information see https://redis.io/commands/sintercard
�LIMITZ
SINTERCARDr, �r. r� rU rV r5 r1 r1 r2 �
sintercard� s zSetCommands.sintercardc G s t ||�}| jd|g|�R � S )z�
Store the intersection of sets specified by ``keys`` into a new
set named ``dest``. Returns the number of keys in the new set.
For more information see https://redis.io/commands/sinterstore
Z SINTERSTORErO rR r1 r1 r2 � sinterstore� s
zSetCommands.sinterstorer� c C s | � d||�S )z�
Return a boolean indicating if ``value`` is a member of set ``name``
For more information see https://redis.io/commands/sismember
Z SISMEMBERr, r� r1 r1 r2 � sismember� s zSetCommands.sismemberc C s | � d|�S )z}
Return all members of the set ``name``
For more information see https://redis.io/commands/smembers
ZSMEMBERSr, rq r1 r1 r2 �smembers� s zSetCommands.smembers)r� r r5 r+ c G s t ||�}| jd|g|�R � S )z�
Return whether each value in ``values`` is a member of the set ``name``
as a list of ``bool`` in the order of ``values``
For more information see https://redis.io/commands/smismember
Z
SMISMEMBERrO )r. r� r r5 r1 r1 r2 �
smismember� s
zSetCommands.smismember)r� r� r� r+ c C s | � d|||�S )z�
Move ``value`` from set ``src`` to set ``dst`` atomically
For more information see https://redis.io/commands/smove
ZSMOVEr, )r. r� r� r� r1 r1 r2 �smove� s zSetCommands.smoveNr
c C s& |dur|gpg }| j d|g|�R � S )z�
Remove and return a random member of set ``name``
For more information see https://redis.io/commands/spop
NZSPOPr, )r. r� rE r5 r1 r1 r2 �spop� s zSetCommands.spop)r� �numberr+ c C s& |dur|gpg }| j d|g|�R � S )a?
If ``number`` is None, returns a random member of set ``name``.
If ``number`` is supplied, returns a list of ``number`` random
members of set ``name``. Note this is only available when running
Redis 2.6+.
For more information see https://redis.io/commands/srandmember
NZ SRANDMEMBERr, )r. r� r` r5 r1 r1 r2 � srandmember� s zSetCommands.srandmemberc G s | j d|g|�R � S )zv
Remove ``values`` from set ``name``
For more information see https://redis.io/commands/srem
ZSREMr, r r1 r1 r2 �srem� s zSetCommands.sremc G s t ||�}| jdg|�R � S )z�
Return the union of sets specified by ``keys``
For more information see https://redis.io/commands/sunion
ZSUNIONrO rP r1 r1 r2 �sunion� s
zSetCommands.sunionc G s t ||�}| jd|g|�R � S )z�
Store the union of sets specified by ``keys`` into a new
set named ``dest``. Returns the number of keys in the new set.
For more information see https://redis.io/commands/sunionstore
Z SUNIONSTORErO rR r1 r1 r2 � sunionstore� s
zSetCommands.sunionstore)r )N)N) rp rq rr rs rt r r r r: rM rN r
r� rQ rS rT rY rZ rv r[ r\ r] r^ r r_ ra rb rc rd r1 r1 r1 r2 rL _ sB
�
�
� � � "
� �
�rL c
@ s� e Zd ZdZeeeed�dd�ZdEee e
e f ee e
df eee edf e e
df ed � d
d �ZdFeeee
e
e e
df eed
�dd�ZdGeeee
ee ee ge e
df e e
df e e
df eeed� dd�Zeeed�dd�ZdHeeeeee
ed�dd�Zeeeed�dd �Zeeed �d d �Zeeeed�d d!�ZdIeeeee
ed"�d#d$�Zeeed �d%d&�Z eed'�d(d)�Z dJeeed*�d+d,�Z eed'�d-d.�Z eeed �d/d0�Z dKeeeee
e edf e e
df ed1�d2d3�Z!dLeeee e
df ed6�d7d8�Z"dMe eef e e
df e e
df ed9�d:d;�Z#dNe$e$e eef e e
df e e
df eed<�d=d>�Z%dOeeee e
df ed?�d@dA�Z&dPee e
df ee edf e e
df edB�dCdD�Z'dS )Q�StreamCommandsz]
Redis commands for Stream data type.
see: https://redis.io/topics/streams-intro
)r� � groupname�idsr+ c G s | j d||g|�R � S )a
Acknowledges the successful processing of one or more messages.
name: name of the stream.
groupname: name of the consumer group.
*ids: message ids to acknowledge.
For more information see https://redis.io/commands/xack
ZXACKr, )r. r� rf rg r1 r1 r2 �xack
s zStreamCommands.xackr� NTF) r� �fields�idr � approximate�
nomkstream�minidrV r+ c C s g } |dur |dur t d��|durdt|t�r6|dk r>t d��| �d� |rV| �d� | �t|�� |dur�| �d� |r�| �d� | �|� |dur�| �d|g� |r�| �d � | �|� t|t�r�t|�d
kr�t d ��|�� D ]}
| �|
� q�| j d |g| �R � S )
a�
Add to a stream.
name: name of the stream
fields: dict of field/value pairs to insert into the stream
id: Location to insert this record. By default it is appended.
maxlen: truncate old stream members beyond this size.
Can't be specified with minid.
approximate: actual stream length may be slightly more than maxlen
nomkstream: When set to true, do not make a stream
minid: the minimum id in the stream to query.
Can't be specified with maxlen.
limit: specifies the maximum number of entries to retrieve
For more information see https://redis.io/commands/xadd
Nz8Only one of ```maxlen``` or ```minid``` may be specifiedr& z&XADD maxlen must be a positive integer� MAXLENr_ � MINIDr$ s
NOMKSTREAMr z$XADD fields must be a non-empty dictZXADD)
r rG r: rH rt r� �dictr� r� r- ) r. r� ri rj r rk rl rm rV r0 r� r1 r1 r2 �xadd
s6 �
zStreamCommands.xaddr )r� rf � consumername�
min_idle_time�start_idrE �justidr+ c
C s� zt |�dk rtd��W n ty* Y n0 i }|||||g} z&t |�dk rTtd��| �d|g� W n tyv Y n0 |r�| �d� d|d< | jdg| �R i |��S ) a�
Transfers ownership of pending stream entries that match the specified
criteria. Conceptually, equivalent to calling XPENDING and then XCLAIM,
but provides a more straightforward way to deal with message delivery
failures via SCAN-like semantics.
name: name of the stream.
groupname: name of the consumer group.
consumername: name of a consumer that claims the message.
min_idle_time: filter messages that were idle less than this amount of
milliseconds.
start_id: filter messages with equal or greater ID.
count: optional integer, upper limit of the number of entries that the
command attempts to claim. Set to 100 by default.
justid: optional boolean, false by default. Return just an array of IDs
of messages successfully claimed, without returning the actual message
For more information see https://redis.io/commands/xautoclaim
r z6XAUTOCLAIM min_idle_time must be a nonnegative integer�%XPENDING count must be a integer >= 0r/ � JUSTIDT� parse_justidZ
XAUTOCLAIM)r: r r� r� rH r- )
r. r� rf rr rs rt rE ru r/ r0 r1 r1 r2 �
xautoclaimS
s& �
zStreamCommands.xautoclaim) r� rf rr rs � message_ids�idler5 �
retrycountr] ru r+ c
C s> t |t�r|dk rtd��t |ttf�r,|s4td��i } |||t|�g} | �t|�� |dur�t |t�sptd��| �dt|�f� |dur�t |t�s�td��| �dt|�f� |dur�t |t�s�td ��| �d
t|�f� | r�t | t�s�td ��| �d � |
�r&t |
t��std
��| �d� d| d< | j dg| �R i | ��S )a�
Changes the ownership of a pending message.
name: name of the stream.
groupname: name of the consumer group.
consumername: name of a consumer that claims the message.
min_idle_time: filter messages that were idle less than this amount of
milliseconds
message_ids: non-empty list or tuple of message IDs to claim
idle: optional. Set the idle time (last time it was delivered) of the
message in ms
time: optional integer. This is the same as idle but instead of a
relative amount of milliseconds, it sets the idle time to a specific
Unix time (in milliseconds).
retrycount: optional integer. set the retry counter to the specified
value. This counter is incremented every time a message is delivered
again.
force: optional boolean, false by default. Creates the pending message
entry in the PEL even if certain specified IDs are not already in the
PEL assigned to a different client.
justid: optional boolean, false by default. Return just an array of IDs
of messages successfully claimed, without returning the actual message
For more information see https://redis.io/commands/xclaim
r z3XCLAIM min_idle_time must be a non negative integerzLXCLAIM message_ids must be a non empty list or tuple of message IDs to claimNz XCLAIM idle must be an integers IDLEz XCLAIM time must be an integers TIMEz$XCLAIM retrycount must be an integers
RETRYCOUNTz XCLAIM force must be a booleans FORCEz XCLAIM justid must be a booleanrw Trx ZXCLAIM)
rG r: r r� �tuplert r� rv rH r- )
r. r� rf rr rs rz r{ r5 r| r] ru r/ r0 r1 r1 r2 �xclaim�
s> %�
zStreamCommands.xclaim)r� rg r+ c G s | j d|g|�R � S )z�
Deletes one or more messages from a stream.
name: name of the stream.
*ids: message ids to delete.
For more information see https://redis.io/commands/xdel
ZXDELr, )r. r� rg r1 r1 r2 �xdel�
s zStreamCommands.xdel�$)r� rf rj �mkstream� entries_readr+ c C s: d|||g}|r|� d� |dur0|�d|g� | j|� S )a/
Create a new consumer group associated with a stream.
name: name of the stream.
groupname: name of the consumer group.
id: ID of the last item in the stream to consider already delivered.
For more information see https://redis.io/commands/xgroup-create
z
XGROUP CREATEs MKSTREAMN� ENTRIESREADr� )r. r� rf rj r� r� r0 r1 r1 r2 �
xgroup_create�
s
z StreamCommands.xgroup_create)r� rf rr r+ c C s | � d|||�S )ax
Remove a specific consumer from a consumer group.
Returns the number of pending messages that the consumer had before it
was deleted.
name: name of the stream.
groupname: name of the consumer group.
consumername: name of consumer to delete
For more information see https://redis.io/commands/xgroup-delconsumer
zXGROUP DELCONSUMERr, �r. r� rf rr r1 r1 r2 �xgroup_delconsumer�
s
z!StreamCommands.xgroup_delconsumer)r� rf r+ c C s | � d||�S )z�
Destroy a consumer group.
name: name of the stream.
groupname: name of the consumer group.
For more information see https://redis.io/commands/xgroup-destroy
zXGROUP DESTROYr, �r. r� rf r1 r1 r2 �xgroup_destroy s z StreamCommands.xgroup_destroyc C s | � d|||�S )a�
Consumers in a consumer group are auto-created every time a new
consumer name is mentioned by some command.
They can be explicitly created by using this command.
name: name of the stream.
groupname: name of the consumer group.
consumername: name of consumer to create.
See: https://redis.io/commands/xgroup-createconsumer
zXGROUP CREATECONSUMERr, r� r1 r1 r2 �xgroup_createconsumer
s
�z$StreamCommands.xgroup_createconsumer)r� rf rj r� r+ c C s2 |||g}|dur |� d|g� | jdg|�R � S )a4
Set the consumer group last delivered ID to something else.
name: name of the stream.
groupname: name of the consumer group.
id: ID of the last item in the stream to consider already delivered.
For more information see https://redis.io/commands/xgroup-setid
Nr� z XGROUP SETIDr )r. r� rf rj r� r0 r1 r1 r2 � xgroup_setid s
zStreamCommands.xgroup_setidc C s | � d||�S )z�
Returns general information about the consumers in the group.
name: name of the stream.
groupname: name of the consumer group.
For more information see https://redis.io/commands/xinfo-consumers
zXINFO CONSUMERSr, r� r1 r1 r2 �xinfo_consumers/ s z StreamCommands.xinfo_consumersr� c C s | � d|�S )z�
Returns general information about the consumer groups of the stream.
name: name of the stream.
For more information see https://redis.io/commands/xinfo-groups
z XINFO GROUPSr, rq r1 r1 r2 � xinfo_groups9 s zStreamCommands.xinfo_groups)r� �fullr+ c C s8 |g}i }|r |� d� d|i}| jdg|�R i |��S )z�
Returns general information about the stream.
name: name of the stream.
full: optional boolean, false by default. Return full summary
For more information see https://redis.io/commands/xinfo-stream
s FULLr� z XINFO STREAMrx )r. r� r� r0 r� r1 r1 r2 � xinfo_streamB s
zStreamCommands.xinfo_streamc C s | � d|�S )z�
Returns the number of elements in a given stream.
For more information see https://redis.io/commands/xlen
ZXLENr, rq r1 r1 r2 �xlenQ s zStreamCommands.xlenc C s | � d||�S )z�
Returns information about pending messages of a group.
name: name of the stream.
groupname: name of the consumer group.
For more information see https://redis.io/commands/xpending
�XPENDINGr, r� r1 r1 r2 �xpendingY s zStreamCommands.xpending)r� rf �min�maxrE rr r{ r+ c C s� |||hdhkr4|dus |dur(t d��| �||�S ||g}|du sT|du sT|du r\t d��z&t|�dk rrt d��|�d|g� W n ty� Y n0 z(t|�dk r�t d��|�|||g� W n ty� Y n0 |r�|�|� | jdg|�R d d
i�S ) a�
Returns information about pending messages, in a range.
name: name of the stream.
groupname: name of the consumer group.
idle: available from version 6.2. filter entries by their
idle-time, given in milliseconds (optional).
min: minimum stream ID.
max: maximum stream ID.
count: number of messages to return
consumername: name of a consumer to filter by (optional).
Nznif XPENDING is provided with idle time or consumername, it must be provided with min, max and count parameterszNXPENDING must be provided with min, max and count parameters, or none of them.r z$XPENDING idle must be a integer >= 0ZIDLErv r� Z parse_detailT)r r� r: r� r� rH r- ) r. r� rf r� r� rE rr r{ r0 r1 r1 r2 �xpending_rangec s4 � �
z StreamCommands.xpending_range�-�+)r� r� r� rE r+ c C sV ||g}|durBt |t�r"|dk r*td��|�d� |�t|�� | jd|g|�R � S )a�
Read stream values within an interval.
name: name of the stream.
start: first stream ID. defaults to '-',
meaning the earliest available.
finish: last stream ID. defaults to '+',
meaning the latest available.
count: if set, only return this many items, beginning with the
earliest available.
For more information see https://redis.io/commands/xrange
Nr& z'XRANGE count must be a positive integerr/ ZXRANGE�rG r: r rH rt r- )r. r� r� r� rE r0 r1 r1 r2 �xrange� s
zStreamCommands.xrange)�streamsrE �blockr+ c C s� g }|dur>t |t�r |dk r&td��|�d� |�t|�� |durxt |t�rX|dk r`td��|�d� |�t|�� t |t�r�t|�dkr�td��|�d � t|�� � \}}|� |� |� |� | j
d
g|�R � S ) a�
Block and monitor multiple streams for new data.
streams: a dict of stream names to stream IDs, where
IDs indicate the last ID already seen.
count: if set, only return this many items, beginning with the
earliest available.
block: number of milliseconds to wait, if nothing already present.
For more information see https://redis.io/commands/xread
Nr z*XREAD block must be a non-negative integer� BLOCKr& z&XREAD count must be a positive integerr/ z&XREAD streams must be a non empty dict� STREAMSZXREAD) rG r: r rH rt rp r� �zipr� r� r- )r. r� rE r� r0 rU r r1 r1 r2 �xread� s$
zStreamCommands.xread)rf rr r� rE r� �noackr+ c C s� d||g}|durDt |t�r$|dk r,td��|�d� |�t|�� |dur~t |t�r^|dk rftd��|�d� |�t|�� |r�|�d � t |t�r�t|�dkr�td
��|�d � |�|�� � |�|� � � | j
d g|�R � S )
a=
Read from a stream via a consumer group.
groupname: name of the consumer group.
consumername: name of the requesting consumer.
streams: a dict of stream names to stream IDs, where
IDs indicate the last ID already seen.
count: if set, only return this many items, beginning with the
earliest available.
block: number of milliseconds to wait, if nothing already present.
noack: do not add messages to the PEL
For more information see https://redis.io/commands/xreadgroup
s GROUPNr& z+XREADGROUP count must be a positive integerr/ r z/XREADGROUP block must be a non-negative integerr� s NOACKz+XREADGROUP streams must be a non empty dictr� Z
XREADGROUP) rG r: r rH rt rp r� r� rU r r- )r. rf rr r� rE r� r� r0 r1 r1 r2 �
xreadgroup� s&
zStreamCommands.xreadgroup)r� r� r� rE r+ c C sV ||g}|durBt |t�r"|dk r*td��|�d� |�t|�� | jd|g|�R � S )a�
Read stream values within an interval, in reverse order.
name: name of the stream
start: first stream ID. defaults to '+',
meaning the latest available.
finish: last stream ID. defaults to '-',
meaning the earliest available.
count: if set, only return this many items, beginning with the
latest available.
For more information see https://redis.io/commands/xrevrange
Nr& z*XREVRANGE count must be a positive integerr/ Z XREVRANGEr� )r. r� r� r� rE r0 r1 r1 r2 � xrevrange s
zStreamCommands.xrevrange)r� r rk rm rV r+ c C s� g }|dur |dur t d��|du r4|du r4t d��|durF|�d� |durX|�d� |rf|�d� |durx|�|� |dur�|�|� |dur�|�d� |�|� | jd|g|�R � S ) a�
Trims old messages from a stream.
name: name of the stream.
maxlen: truncate old stream messages beyond this size
Can't be specified with minid.
approximate: actual stream length may be slightly more than maxlen
minid: the minimum id in the stream to query
Can't be specified with maxlen.
limit: specifies the maximum number of entries to retrieve
For more information see https://redis.io/commands/xtrim
Nz4Only one of ``maxlen`` or ``minid`` may be specifiedz0One of ``maxlen`` or ``minid`` must be specifiedrn ro r_ r$ ZXTRIMrd )r. r� r rk rm rV r0 r1 r1 r2 �xtrim! s&
zStreamCommands.xtrim)r� NTFNN)r NF)NNNFF)r� FN)N)F)NN)r� r� N)NN)NNF)r� r� N)NTNN)(rp rq rr rs r r r# ru rh r r r r r: rv rq r ry r
r r~ r r r� r� r� r� r� r� r� r� r� r� r� r� r� rt r� r� r� r1 r1 r1 r2 re
s$ �
� = �
� : �
� I �� � � ��
�
� < �
� �
� ( �
� - �
� �
�re c @ s� e Zd ZdZdheeeef eeeeeee d� dd�Z
ee d�dd�Z ee e e d �d
d �Z
dieee d �d
d�Zeee d�dd�Zeeee d�dd�Zdjeeedf ee d�dd�Zdkeeee eeef f eedf e d�dd�Zdleee eeee ef d �d d �Zd d!� Z dmeeedf e d"�d#d$�Z dneeedf e d"�d%d&�Z doeeee d'�d(d)�Z dpee e d*�d+d,�Z!dqee e d*�d-d.�Z"dreee e#e e#e e#e eee$ e$f d0�d1d2�Z%dseeee e#e e#e e#e e#e$ d3�d4d5�Z&ddddeddfeedf eeeeeeeee'e(df eedf eedf e d6� d7d8�Z)ddeddddfeeeeeee'e(f eeeee d9� d:d;�Z*defeeeeee'e(f e d<�d=d>�Z+dteeeeeeeeedf eedf e d?�
d@dA�Z,dueeeeedf eedf e dB�dCdD�Z-dveeeeedf eedf e dE�dFdG�Z.dddefee e eedf eedf eee'e(f e dH�dIdJ�Z/dddefee e eedf eedf eee'e(f dK�dLdM�Z0eee dN�dOdP�Z1ee2e dQ�dRdS�Z3eeee d �dTdU�Z4eeee d �dVdW�Z5ee e e d �dXdY�Z6eee dN�dZd[�Z7eee dN�d\d]�Z8dweee eeef f eedf ee d�d^d_�Z9dxeeee eeef f eedf e d�d`da�Z:eee e db�dcdd�Z;dyeeedf eee eeef f eedf e de�dfdg�Z<dS )z�SortedSetCommandszw
Redis commands for Sorted Sets data type.
see: https://redis.io/topics/data-types-intro#redis-sorted-sets
F) r� r� ru rv �chr� rw rx r+ c C s |s t d��|r |r t d��|r,|r,t d��|rDt|�dkrDt d��|rX|sP|rXt d��g } i }
|rn| �d� |r|| �d� |r�| �d � |r�| �d
� d |
d < |r�| �d
� |r�| �d� |�� D ] } | �| d � | �| d � q�| jd|g| �R i |
��S )a�
Set any number of element-name, score pairs to the key ``name``. Pairs
are specified as a dict of element-names keys to score values.
``nx`` forces ZADD to only create new elements and not to update
scores for elements that already exist.
``xx`` forces ZADD to only update scores of elements that already
exist. New elements will not be added.
``ch`` modifies the return value to be the numbers of elements changed.
Changed elements include new elements that were added and elements
whose scores changed.
``incr`` modifies ZADD to behave like ZINCRBY. In this mode only a
single element/score pair can be specified and the score is the amount
the existing score will be incremented by. When using this mode the
return value of ZADD will be the new score of the element.
``LT`` Only update existing elements if the new score is less than
the current score. This flag doesn't prevent adding new elements.
``GT`` Only update existing elements if the new score is greater than
the current score. This flag doesn't prevent adding new elements.
The return value of ZADD varies based on the mode specified. With no
options, ZADD returns the number of new elements added to the sorted
set.
``NX``, ``LT``, and ``GT`` are mutually exclusive options.
See: https://redis.io/commands/ZADD
z-ZADD requires at least one element/score pairz)ZADD allows either 'nx' or 'xx', not bothz)ZADD allows either 'gt' or 'lt', not bothr& zFZADD option 'incr' only works when passing a single element/score pairz/Only one of 'nx', 'lt', or 'gr' may be defined.s NXs XXs CHs INCRTZas_scores GTs LTr ZZADD)r r� rH r� r- ) r. r� r� ru rv r� r� rw rx r0 r� r� r1 r1 r2 �zaddV s> ,�
zSortedSetCommands.zaddr� c C s | � d|�S )z�
Return the number of elements in the sorted set ``name``
For more information see https://redis.io/commands/zcard
ZZCARDr, rq r1 r1 r2 �zcard� s zSortedSetCommands.zcard)r� r� r� r+ c C s | � d|||�S )z�
Returns the number of elements in the sorted set at key ``name`` with
a score between ``min`` and ``max``.
For more information see https://redis.io/commands/zcount
ZZCOUNTr, �r. r� r� r� r1 r1 r2 �zcount� s zSortedSetCommands.zcount)rU �
withscoresr+ c C s. t |�g|�}|r |�d� | jdg|�R � S )z�
Returns the difference between the first and all successive input
sorted sets provided in ``keys``.
For more information see https://redis.io/commands/zdiff
�
WITHSCORESZZDIFF)r� rH r- )r. rU r� r0 r1 r1 r2 �zdiff� s
zSortedSetCommands.zdiff)ra rU r+ c C s" t |�g|�}| jd|g|�R � S )z�
Computes the difference between the first and all successive input
sorted sets provided in ``keys`` and stores the result in ``dest``.
For more information see https://redis.io/commands/zdiffstore
Z
ZDIFFSTORE)r� r- )r. ra rU r0 r1 r1 r2 �
zdiffstore� s z SortedSetCommands.zdiffstore)r� ri r� r+ c C s | � d|||�S )z�
Increment the score of ``value`` in sorted set ``name`` by ``amount``
For more information see https://redis.io/commands/zincrby
ZZINCRBYr, )r. r� ri r� r1 r1 r2 �zincrby� s zSortedSetCommands.zincrbyN)rU � aggregater� r+ c C s | j dd|||d�S )a1
Return the intersect of multiple sorted sets specified by ``keys``.
With the ``aggregate`` option, it is possible to specify how the
results of the union are aggregated. This option defaults to SUM,
where the score of an element is summed across the inputs where it
exists. When this option is set to either MIN or MAX, the resulting
set will contain the minimum or maximum score of an element across
the inputs where it exists.
For more information see https://redis.io/commands/zinter
ZZINTERN�r� �� _zaggregate�r. rU r� r� r1 r1 r2 �zinter� s zSortedSetCommands.zinter)ra rU r� r+ c C s | � d|||�S )a+
Intersect multiple sorted sets specified by ``keys`` into a new
sorted set, ``dest``. Scores in the destination will be aggregated
based on the ``aggregate``. This option defaults to SUM, where the
score of an element is summed across the inputs where it exists.
When this option is set to either MIN or MAX, the resulting set will
contain the minimum or maximum score of an element across the inputs
where it exists.
For more information see https://redis.io/commands/zinterstore
Z ZINTERSTOREr� �r. ra rU r� r1 r1 r2 � zinterstore� s z SortedSetCommands.zinterstorer rU c C s$ |g|�d�|�}| j dg|�R � S )a�
Return the cardinality of the intersect of multiple sorted sets
specified by ``keys`.
When LIMIT provided (defaults to 0 and means unlimited), if the intersection
cardinality reaches limit partway through the computation, the algorithm will
exit and yield limit as the cardinality
For more information see https://redis.io/commands/zintercard
rW Z
ZINTERCARDr, rX r1 r1 r2 �
zintercard� s z SortedSetCommands.zintercardc C s | � d|||�S )z�
Return the number of items in the sorted set ``name`` between the
lexicographical range ``min`` and ``max``.
For more information see https://redis.io/commands/zlexcount
Z ZLEXCOUNTr, r� r1 r1 r2 � zlexcount s zSortedSetCommands.zlexcountr
c C s4 |dur|gpg }ddi}| j d|g|�R i |��S )z�
Remove and return up to ``count`` members with the highest scores
from the sorted set ``name``.
For more information see https://redis.io/commands/zpopmax
Nr� TZZPOPMAXr, �r. r� rE r5 r� r1 r1 r2 �zpopmax s zSortedSetCommands.zpopmaxc C s4 |dur|gpg }ddi}| j d|g|�R i |��S )z�
Remove and return up to ``count`` members with the lowest scores
from the sorted set ``name``.
For more information see https://redis.io/commands/zpopmin
Nr� TZZPOPMINr, r� r1 r1 r2 �zpopmin s zSortedSetCommands.zpopmin)ri rE r� r+ c C s8 g }|dur|� |� |r$|� d� | jd|g|�R � S )a�
Return a random element from the sorted set value stored at key.
``count`` if the argument is positive, return an array of distinct
fields. If called with a negative count, the behavior changes and
the command is allowed to return the same field multiple times.
In this case, the number of returned fields is the absolute value
of the specified count.
``withscores`` The optional WITHSCORES modifier changes the reply so it
includes the respective scores of the randomly selected elements from
the sorted set.
For more information see https://redis.io/commands/zrandmember
Nr� Z ZRANDMEMBERrx )r. ri rE r� r] r1 r1 r2 � zrandmember$ s
z SortedSetCommands.zrandmemberr� c C s2 |du r d}t |d�}|�|� | jdg|�R � S )a�
ZPOPMAX a value off of the first non-empty sorted set
named in the ``keys`` list.
If none of the sorted sets in ``keys`` has a value to ZPOPMAX,
then block for ``timeout`` seconds, or until a member gets added
to one of the sorted sets.
If timeout is 0, then block indefinitely.
For more information see https://redis.io/commands/bzpopmax
Nr ZBZPOPMAXr� r� r1 r1 r2 �bzpopmax> s
zSortedSetCommands.bzpopmaxc C s2 |du r d}t |d�}|�|� | jdg|�R � S )a�
ZPOPMIN a value off of the first non-empty sorted set
named in the ``keys`` list.
If none of the sorted sets in ``keys`` has a value to ZPOPMIN,
then block for ``timeout`` seconds, or until a member gets added
to one of the sorted sets.
If timeout is 0, then block indefinitely.
For more information see https://redis.io/commands/bzpopmin
Nr ZBZPOPMINr� r� r1 r1 r2 �bzpopminQ s
zSortedSetCommands.bzpopminr& )r rU r� r� rE r+ c C sb |g| }|r|s|s |s t �n|r0|�d� n
|�d� |dkrP|�d|g� | jdg|�R � S )z�
Pop ``count`` values (default 1) off of the first non-empty sorted set
named in the ``keys`` list.
For more information see https://redis.io/commands/zmpop
�MIN�MAXr& r ZZMPOP�r rH r� r- )r. r rU r� r� rE r5 r1 r1 r2 �zmpopd s
zSortedSetCommands.zmpop)r� r� rU r� r� rE r+ c C s` ||g|�}|r|s |s&|s&t d��n|r6|�d� n
|�d� |�d|g� | jdg|�R � S )a�
Pop ``count`` values (default 1) off of the first non-empty sorted set
named in the ``keys`` list.
If none of the sorted sets in ``keys`` has a value to pop,
then block for ``timeout`` seconds, or until a member gets added
to one of the sorted sets.
If timeout is 0, then block indefinitely.
For more information see https://redis.io/commands/bzmpop
z+Either min or max, but not both must be setr� r� r ZBZMPOPr� )r. r� r� rU r� r� rE r5 r1 r1 r2 �bzmpop} s
zSortedSetCommands.bzmpop) ra r� r[ r\ r �byscore�bylexr� rC r� r, r+ c
C s� |r|rt d��| d ur | d u s0| d ur8| d u r8t d��|rH| rHt d��|g}
|r\|
�|� |
�|||g� |rz|
�d� |r�|
�d� |r�|
�d� | d ur�| d ur�|
�d| | g� | r�|
�d� | |
d �}| j|
i |��S )
Nz8``byscore`` and ``bylex`` can not be specified together.z.``offset`` and ``num`` must both be specified.z;``withscores`` not supported in combination with ``bylex``.ZBYSCOREZBYLEXZREVrW r� �r� rC r� )r. r� ra r� r[ r\ r r� r� r� rC r� r, r0 r� r1 r1 r2 �_zrange� s4 � �
zSortedSetCommands._zrange) r� r[ r\ r r� rC r� r� r� r, r+ c C sN |s.|s.| du r.|
du r.|r.| � |||||�S | �dd||||||||| |
� S )a�
Return a range of values from sorted set ``name`` between
``start`` and ``end`` sorted in ascending order.
``start`` and ``end`` can be negative, indicating the end of the range.
``desc`` a boolean indicating whether to sort the results in reversed
order.
``withscores`` indicates to return the scores along with the values.
The return type is a list of (value, score) pairs.
``score_cast_func`` a callable used to cast the score return value.
``byscore`` when set to True, returns the range of elements from the
sorted set having scores equal or between ``start`` and ``end``.
``bylex`` when set to True, returns the range of elements from the
sorted set between the ``start`` and ``end`` lexicographical closed
range intervals.
Valid ``start`` and ``end`` must start with ( or [, in order to specify
whether the range interval is exclusive or inclusive, respectively.
``offset`` and ``num`` are specified, then return a slice of the range.
Can't be provided when using ``bylex``.
For more information see https://redis.io/commands/zrange
NZZRANGE)� zrevranger� ) r. r� r[ r\ r r� rC r� r� r� r, r1 r1 r2 �zrange� s + �zSortedSetCommands.zrange)r� r[ r\ r� rC r+ c C s4 d|||g}|r|� d� ||d�}| j|i |��S )a�
Return a range of values from sorted set ``name`` between
``start`` and ``end`` sorted in descending order.
``start`` and ``end`` can be negative, indicating the end of the range.
``withscores`` indicates to return the scores along with the values
The return type is a list of (value, score) pairs
``score_cast_func`` a callable used to cast the score return value
For more information see https://redis.io/commands/zrevrange
Z ZREVRANGE�
WITHSCORESr� rx )r. r� r[ r\ r� rC r0 r� r1 r1 r2 r� s
zSortedSetCommands.zrevrange)
ra r� r[ r\ r� r� r r� r, r+ c
C s | � d|||||||dd|| � S )a�
Stores in ``dest`` the result of a range of values from sorted set
``name`` between ``start`` and ``end`` sorted in ascending order.
``start`` and ``end`` can be negative, indicating the end of the range.
``byscore`` when set to True, returns the range of elements from the
sorted set having scores equal or between ``start`` and ``end``.
``bylex`` when set to True, returns the range of elements from the
sorted set between the ``start`` and ``end`` lexicographical closed
range intervals.
Valid ``start`` and ``end`` must start with ( or [, in order to specify
whether the range interval is exclusive or inclusive, respectively.
``desc`` a boolean indicating whether to sort the results in reversed
order.
``offset`` and ``num`` are specified, then return a slice of the range.
Can't be provided when using ``bylex``.
For more information see https://redis.io/commands/zrangestore
Z ZRANGESTOREFN)r� )
r. ra r� r[ r\ r� r� r r� r, r1 r1 r2 � zrangestore s #�z SortedSetCommands.zrangestore)r� r� r� r[ r, r+ c C s^ |dur|du s |dur(|du r(t d��d|||g}|durT|durT|�d||g� | j|� S )a
Return the lexicographical range of values from sorted set ``name``
between ``min`` and ``max``.
If ``start`` and ``num`` are specified, then return a slice of the
range.
For more information see https://redis.io/commands/zrangebylex
Nr# Z ZRANGEBYLEXr$ �r r� r- )r. r� r� r� r[ r, r0 r1 r1 r2 � zrangebylexQ s z SortedSetCommands.zrangebylex)r� r� r� r[ r, r+ c C s^ |dur|du s |dur(|du r(t d��d|||g}|durT|durT|�d||g� | j|� S )a)
Return the reversed lexicographical range of values from sorted set
``name`` between ``max`` and ``min``.
If ``start`` and ``num`` are specified, then return a slice of the
range.
For more information see https://redis.io/commands/zrevrangebylex
Nr# ZZREVRANGEBYLEXrW r� )r. r� r� r� r[ r, r0 r1 r1 r2 �zrevrangebylexi s z SortedSetCommands.zrevrangebylex)r� r� r� r[ r, r� rC r+ c
C s| |dur|du s |dur(|du r(t d��d|||g}|durT|durT|�d||g� |rb|�d� ||d�} | j|i | ��S )a�
Return a range of values from the sorted set ``name`` with scores
between ``min`` and ``max``.
If ``start`` and ``num`` are specified, then return a slice
of the range.
``withscores`` indicates to return the scores along with the values.
The return type is a list of (value, score) pairs
`score_cast_func`` a callable used to cast the score return value
For more information see https://redis.io/commands/zrangebyscore
Nr# Z
ZRANGEBYSCORErW r� r� �r r� rH r- )
r. r� r� r� r[ r, r� rC r0 r� r1 r1 r2 �
zrangebyscore� s
z SortedSetCommands.zrangebyscore)r� r� r� r[ r, r� rC c
C s| |dur|du s |dur(|du r(t d��d|||g}|durT|durT|�d||g� |rb|�d� ||d�} | j|i | ��S )a
Return a range of values from the sorted set ``name`` with scores
between ``min`` and ``max`` in descending order.
If ``start`` and ``num`` are specified, then return a slice
of the range.
``withscores`` indicates to return the scores along with the values.
The return type is a list of (value, score) pairs
``score_cast_func`` a callable used to cast the score return value
For more information see https://redis.io/commands/zrevrangebyscore
Nr# ZZREVRANGEBYSCORErW r� r� r� )
r. r� r� r� r[ r, r� rC r0 r� r1 r1 r2 �zrevrangebyscore� s
z"SortedSetCommands.zrevrangebyscorer� c C s | � d||�S )z�
Returns a 0-based value indicating the rank of ``value`` in sorted set
``name``
For more information see https://redis.io/commands/zrank
ZZRANKr, r� r1 r1 r2 �zrank� s zSortedSetCommands.zrankr
c G s | j d|g|�R � S )z�
Remove member ``values`` from sorted set ``name``
For more information see https://redis.io/commands/zrem
ZZREMr, r r1 r1 r2 �zrem� s zSortedSetCommands.zremc C s | � d|||�S )a
Remove all elements in the sorted set ``name`` between the
lexicographical range specified by ``min`` and ``max``.
Returns the number of elements removed.
For more information see https://redis.io/commands/zremrangebylex
ZZREMRANGEBYLEXr, r� r1 r1 r2 �zremrangebylex� s z SortedSetCommands.zremrangebylexc C s | � d|||�S )ae
Remove all elements in the sorted set ``name`` with ranks between
``min`` and ``max``. Values are 0-based, ordered from smallest score
to largest. Values can be negative indicating the highest scores.
Returns the number of elements removed
For more information see https://redis.io/commands/zremrangebyrank
ZZREMRANGEBYRANKr, r� r1 r1 r2 �zremrangebyrank� s z!SortedSetCommands.zremrangebyrankc C s | � d|||�S )z�
Remove all elements in the sorted set ``name`` with scores
between ``min`` and ``max``. Returns the number of elements removed.
For more information see https://redis.io/commands/zremrangebyscore
ZZREMRANGEBYSCOREr, r� r1 r1 r2 �zremrangebyscore� s z"SortedSetCommands.zremrangebyscorec C s | � d||�S )z�
Returns a 0-based value indicating the descending rank of
``value`` in sorted set ``name``
For more information see https://redis.io/commands/zrevrank
ZZREVRANKr, r� r1 r1 r2 �zrevrank� s zSortedSetCommands.zrevrankc C s | � d||�S )z�
Return the score of element ``value`` in sorted set ``name``
For more information see https://redis.io/commands/zscore
ZZSCOREr, r� r1 r1 r2 �zscore s zSortedSetCommands.zscorec C s | j dd|||d�S )a@
Return the union of multiple sorted sets specified by ``keys``.
``keys`` can be provided as dictionary of keys and their weights.
Scores will be aggregated based on the ``aggregate``, or SUM if
none is provided.
For more information see https://redis.io/commands/zunion
ZZUNIONNr� r� r� r1 r1 r2 �zunion s zSortedSetCommands.zunionc C s | � d|||�S )a
Union multiple sorted sets specified by ``keys`` into
a new sorted set, ``dest``. Scores in the destination will be
aggregated based on the ``aggregate``, or SUM if none is provided.
For more information see https://redis.io/commands/zunionstore
Z ZUNIONSTOREr� r� r1 r1 r2 � zunionstore s
z SortedSetCommands.zunionstore)ri �membersr+ c C s( |s t d��|g| }| jdg|�R � S )ay
Returns the scores associated with the specified members
in the sorted set stored at key.
``members`` should be a list of the member name.
Return type is a list of score.
If the member does not exist, a None will be returned
in corresponding position.
For more information see https://redis.io/commands/zmscore
z(ZMSCORE members must be a non-empty listZZMSCOREr� )r. ri r� r0 r1 r1 r2 �zmscore' s
zSortedSetCommands.zmscore)r� ra rU r� r+ c K s� |g}|d ur|� |� |� t|�� t|t�rD|�� |�� }}nd }|�|� |rj|� d� |�|� |r�|�� dv r�|� d� |� |� ntd��|� dd�r�|� d� | j
|i |��S )Ns WEIGHTS)ZSUMr� r� s AGGREGATEz!aggregate can be sum, min or max.r� Fr� ) rH r� rG rp rU r r� rM r r. r- )r. r� ra rU r� r� r0 Zweightsr1 r1 r2 r� 7 s&
z SortedSetCommands._zaggregate)FFFFFF)F)NF)N)r )N)N)NF)r )r )FFr& )FFr& )FFFNN)NN)NN)NF)N)N)=rp rq rr rs r r r r rv ru r� r� r% r� r r� r� r: r� r rt r� r
r� r: r
r r� r� r� r� r� r$ r� r� r r� r� r� r� r r� r� r� r� r� r� r� r� r� r r� r� r� r� r� r� r� r� r� r� r1 r1 r1 r2 r� P s� �
� N
�� �
� �
� �� �� �� '�
� /�
� B�
� ! �
� 7 �
� �
� �
� '�
� " � �
� �
� �
�r� c @ sD e Zd ZdZeeed�dd�Zeed�dd�Zeeed�d d
�Z d S ) �HyperlogCommandszr
Redis commands of HyperLogLogs data type.
see: https://redis.io/topics/data-types-intro#hyperloglogs
r
c G s | j d|g|�R � S )z�
Adds the specified elements to the specified HyperLogLog.
For more information see https://redis.io/commands/pfadd
ZPFADDr, r r1 r1 r2 �pfadd_ s zHyperlogCommands.pfadd)�sourcesr+ c G s | j dg|�R � S )z�
Return the approximated cardinality of
the set observed by the HyperLogLog at key(s).
For more information see https://redis.io/commands/pfcount
ZPFCOUNTr, )r. r� r1 r1 r2 �pfcountg s zHyperlogCommands.pfcount)ra r� r+ c G s | j d|g|�R � S )z�
Merge N different HyperLogLogs into a single one.
For more information see https://redis.io/commands/pfmerge
ZPFMERGEr, )r. ra r� r1 r1 r2 �pfmergep s zHyperlogCommands.pfmergeN)
rp rq rr rs r r ru r� r� r� r1 r1 r1 r2 r� Y s r� c @ s� e Zd ZdZeeeee ef d�dd�Z eeeee
e
f d�dd�Z eeeee e e e f d�dd �Z
eeee ef d
�d d �Zd)eeeeee ef d�dd�Zd*eeeeee ef d�dd�Zeeee ef d
�dd�Zeeee ef d
�dd�Zd+ee e e e e e e e eee ef d�dd�Zeeeeee
e
f d �d d �Zeeeee ef d �d d!�Zeeeeee ef d"�d#d$�Zeeee ef d
�d%d&�Zeeeee ef d�d'd(�ZdS ),� HashCommandszk
Redis commands for Hash data type.
see: https://redis.io/topics/data-types-intro#redis-hashes
)r� rU r+ c G s | j d|g|�R � S )zu
Delete ``keys`` from hash ``name``
For more information see https://redis.io/commands/hdel
ZHDELr, )r. r� rU r1 r1 r2 �hdel� s zHashCommands.hdel)r� ri r+ c C s | � d||�S )z�
Returns a boolean indicating if ``key`` exists within hash ``name``
For more information see https://redis.io/commands/hexists
ZHEXISTSr, �r. r� ri r1 r1 r2 �hexists� s zHashCommands.hexistsc C s | � d||�S )z�
Return the value of ``key`` within the hash ``name``
For more information see https://redis.io/commands/hget
ZHGETr, r� r1 r1 r2 �hget� s zHashCommands.hgetr� c C s | � d|�S )z�
Return a Python dict of the hash's name/value pairs
For more information see https://redis.io/commands/hgetall
ZHGETALLr, rq r1 r1 r2 �hgetall� s zHashCommands.hgetallr& )r� ri ri r+ c C s | � d|||�S )z�
Increment the value of ``key`` in hash ``name`` by ``amount``
For more information see https://redis.io/commands/hincrby
ZHINCRBYr, �r. r� ri ri r1 r1 r2 �hincrby� s zHashCommands.hincrbyr� c C s | � d|||�S )z�
Increment the value of ``key`` in hash ``name`` by floating ``amount``
For more information see https://redis.io/commands/hincrbyfloat
Z HINCRBYFLOATr, r� r1 r1 r2 � hincrbyfloat� s zHashCommands.hincrbyfloatc C s | � d|�S )z�
Return the list of keys within hash ``name``
For more information see https://redis.io/commands/hkeys
ZHKEYSr, rq r1 r1 r2 �hkeys� s zHashCommands.hkeysc C s | � d|�S )z�
Return the number of elements in hash ``name``
For more information see https://redis.io/commands/hlen
ZHLENr, rq r1 r1 r2 �hlen� s zHashCommands.hlenN)r� ri r� r� r� r+ c C sf |du r|s|st d��|p g }|dur6|�||f� |rR|�� D ]}|�|� qB| jd|g|�R � S )a{
Set ``key`` to ``value`` within hash ``name``,
``mapping`` accepts a dict of key/value pairs that will be
added to hash ``name``.
``items`` accepts a list of key/value pairs that will be
added to hash ``name``.
Returns the number of fields that were added.
For more information see https://redis.io/commands/hset
Nz 'hset' with no key value pairsZHSET)r r� r� r- )r. r� ri r� r� r� r� r1 r1 r2 �hset� s zHashCommands.hset)r� ri r� r+ c C s | � d|||�S )z�
Set ``key`` to ``value`` within hash ``name`` if ``key`` does not
exist. Returns 1 if HSETNX created a field, otherwise 0.
For more information see https://redis.io/commands/hsetnx
ZHSETNXr, )r. r� ri r� r1 r1 r2 �hsetnx� s zHashCommands.hsetnx)r� r� r+ c C s` t j| jj� d| jj� d�tdd� |s0td��g }|�� D ]}|�|� q<| jd|g|�R � S )z�
Set key to value within hash ``name`` for each corresponding
key and value from the ``mapping`` dict.
For more information see https://redis.io/commands/hmset
z .hmset() is deprecated. Use z.hset() instead.r� )�
stacklevelz"'hmset' with 'mapping' of length 0ZHMSET) r� r� r@ rp r� r r� r� r- )r. r� r� r� r� r1 r1 r2 �hmset� s
�� zHashCommands.hmset)r� rU r5 r+ c G s t ||�}| jd|g|�R � S )z�
Returns a list of values ordered identically to ``keys``
For more information see https://redis.io/commands/hmget
ZHMGETrO )r. r� rU r5 r1 r1 r2 �hmget s
zHashCommands.hmgetc C s | � d|�S )z�
Return the list of values within hash ``name``
For more information see https://redis.io/commands/hvals
ZHVALSr, rq r1 r1 r2 �hvals s zHashCommands.hvalsc C s | � d||�S )z�
Return the number of bytes stored in the value of ``key``
within hash ``name``
For more information see https://redis.io/commands/hstrlen
ZHSTRLENr, r� r1 r1 r2 �hstrlen s zHashCommands.hstrlen)r& )r� )NNNN) rp rq rr rs rt r
r r r: r� rv r� r r� rp r� r� r: r� r� r� r� r� r� r� r� r� r� r1 r1 r1 r2 r� | sH �
�� ��
�� r� c @ sP e Zd ZdZded�dd�Zd eee df ee e
df ed d�d d
�Z dS ) �Script�I
An executable Lua script object returned by ``register_script``
r( ��registered_client�scriptc C s> || _ || _t|t�r*|j�� }|�|�}t�|�� � | _
d S r< � r� r� rG rt �connection_poolr` rb �hashlib�sha1� hexdigest�sha�r. r� r� re r1 r1 r2 rK % s
�Script.__init__N)r( N�rU r5 rE c C s� |pg }|pg }|du r | j }t|�t|� }ddlm} t||�rP|j�| � z |j| jt |�g|�R � W S t
y� |� | j �| _|j| jt |�g|�R � Y S 0 dS �z1Execute the script, passing any required ``args``Nr )�Pipeline�
r� r} r� r rG �scripts�add�evalshar� r� r � script_loadr� �r. rU r5 rE r r1 r1 r2 �__call__1 s
�Script.__call__)NNN� rp rq rr rs r" rK r r
r r r r r1 r1 r1 r2 r� s ��r� c @ sP e Zd ZdZded�dd�Zd eee df ee e
df ed d�d d
�Z dS ) � AsyncScriptr� rD r� c C s> || _ || _t|t�r*|j�� }|�|�}t�|�� � | _
d S r< r� r� r1 r1 r2 rK R s
zAsyncScript.__init__N)rD Nr c � s� |pg }|pg }|du r | j }t|�t|� }ddlm} t||�rP|j�| � z"|j| jt |�g|�R � I dH W S t
y� |� | j �I dH | _|j| jt |�g|�R � I dH Y S 0 dS r )
r� r} �redis.asyncio.clientr rG r r r r� r� r r r� r r1 r1 r2 r ^ s
" zAsyncScript.__call__)NNNr r1 r1 r1 r2 r M s ��r c @ sR e Zd ZdZeeed�dd�Zdeed�dd�Z ed �d
d �Z
eed �d
d�Z dS )�PubSubCommandszG
Redis PubSub commands.
see https://redis.io/topics/pubsub
)rj �messager+ c K s | j d||fi |��S )z�
Publish ``message`` on ``channel``.
Returns the number of subscribers the message was delivered to.
For more information see https://redis.io/commands/publish
ZPUBLISHr, )r. rj r r/ r1 r1 r2 �publish� s zPubSubCommands.publishr� r� c K s | j d|fi |��S )z�
Return a list of channels that have at least one subscriber
For more information see https://redis.io/commands/pubsub-channels
zPUBSUB CHANNELSr, r� r1 r1 r2 �pubsub_channels� s z PubSubCommands.pubsub_channelsr? c K s | j di |��S )z�
Returns the number of subscriptions to patterns
For more information see https://redis.io/commands/pubsub-numpat
�
PUBSUB NUMPAT)r r, rA r1 r1 r2 �
pubsub_numpat� s z PubSubCommands.pubsub_numpatr� c O s | j dg|�R i |��S )z�
Return a list of (channel, number of subscribers) tuples
for each channel given in ``*args``
For more information see https://redis.io/commands/pubsub-numsub
z
PUBSUB NUMSUBr, r r1 r1 r2 �
pubsub_numsub� s z PubSubCommands.pubsub_numsubN)r� ) rp rq rr rs r r ru r r! r r r r1 r1 r1 r2 r z s
r c @ sD e Zd ZdZeeeeeee ef d�dd�Z eeeeee ef d�dd�Z
eeeeee ef d�dd �Z eeeeeee ef d
�d d �Z eeeeee ef d
�dd�Z
eeeeee ef d
�dd�Zeed�dd�Zdd�dd�Zd'eed ed f ed�d d �Zed�d d �Zeed �d!d"�Zd#eed$�d%d&�ZdS )(�ScriptCommandsz|
Redis Lua script commands. see:
https://redis.com/ebook/part-3-next-steps/chapter-11-scripting-redis-with-lua/
)r� r� r� �
keys_and_argsr+ c G s | j |||g|�R � S r< r, )r. r� r� r� r r1 r1 r2 �_eval� s zScriptCommands._eval)r� r� r r+ c G s | j d||g|�R � S )a�
Execute the Lua ``script``, specifying the ``numkeys`` the script
will touch and the key names and argument values in ``keys_and_args``.
Returns the result of the script.
In practice, use the object returned by ``register_script``. This
function exists purely for Redis API completion.
For more information see https://redis.io/commands/eval
ZEVAL�r �r. r� r� r r1 r1 r2 �eval� s
zScriptCommands.evalc G s | j d||g|�R � S )aM
The read-only variant of the EVAL command
Execute the read-only Lue ``script`` specifying the ``numkeys`` the script
will touch and the key names and argument values in ``keys_and_args``.
Returns the result of the script.
For more information see https://redis.io/commands/eval_ro
ZEVAL_ROr r r1 r1 r2 �eval_ro� s zScriptCommands.eval_ro)r� r� r� r r+ c G s | j |||g|�R � S r< r, )r. r� r� r� r r1 r1 r2 �_evalsha� s zScriptCommands._evalsha)r� r� r r+ c G s | j d||g|�R � S )a�
Use the ``sha`` to execute a Lua script already registered via EVAL
or SCRIPT LOAD. Specify the ``numkeys`` the script will touch and the
key names and argument values in ``keys_and_args``. Returns the result
of the script.
In practice, use the object returned by ``register_script``. This
function exists purely for Redis API completion.
For more information see https://redis.io/commands/evalsha
ZEVALSHA�r �r. r� r� r r1 r1 r2 r � s zScriptCommands.evalshac G s | j d||g|�R � S )a�
The read-only variant of the EVALSHA command
Use the ``sha`` to execute a read-only Lua script already registered via EVAL
or SCRIPT LOAD. Specify the ``numkeys`` the script will touch and the
key names and argument values in ``keys_and_args``. Returns the result
of the script.
For more information see https://redis.io/commands/evalsha_ro
Z
EVALSHA_ROr r r1 r1 r2 �
evalsha_ro� s
zScriptCommands.evalsha_ror� c G s | j dg|�R � S )a'
Check if a script exists in the script cache by specifying the SHAs of
each script as ``args``. Returns a list of boolean values indicating if
if each already script exists in the cache.
For more information see https://redis.io/commands/script-exists
z
SCRIPT EXISTSr, r� r1 r1 r2 �
script_exists� s z ScriptCommands.script_existsNr? c G s t d��d S )Nz<SCRIPT DEBUG is intentionally not implemented in the client.r� r� r1 r1 r2 � script_debug� s �zScriptCommands.script_debugr� �ASYNC)� sync_typer+ c C s6 |dvrt d��|du r g }n|g}| jdg|�R � S )z�Flush all scripts from the script cache.
``sync_type`` is by default SYNC (synchronous) but it can also be
ASYNC.
For more information see https://redis.io/commands/script-flush
)r� r" NzpSCRIPT FLUSH defaults to SYNC in redis > 6.2, or accepts SYNC/ASYNC. For older versions, of redis leave as None.Nz SCRIPT FLUSHr� )r. r# r0 r1 r1 r2 � script_flush s
�zScriptCommands.script_flushc C s
| � d�S )z�
Kill the currently executing Lua script
For more information see https://redis.io/commands/script-kill
z SCRIPT KILLr, r~ r1 r1 r2 � script_kill s zScriptCommands.script_kill)r� r+ c C s | � d|�S )z�
Load a Lua ``script`` into the script cache. Returns the SHA.
For more information see https://redis.io/commands/script-load
z SCRIPT LOADr, �r. r� r1 r1 r2 r s zScriptCommands.script_loadr( �r. r� r+ c C s
t | |�S �a
Register a Lua ``script`` specifying the ``keys`` it will touch.
Returns a Script object that is callable and hides the complexity of
deal with scripts, keys, and shas. This is the preferred way to work
with Lua scripts.
)r� r& r1 r1 r2 �register_script' s z ScriptCommands.register_script)N)rp rq rr rs rt r: r� r r r r r r r r ru r r! r r$ r% r" r r� r) r1 r1 r1 r2 r � s: � � � � � �
�� r c s4 e Zd Zdd�� fdd� Zdeed�dd�Z� ZS ) �AsyncScriptCommandsNr? c � s
t � �� S r< )r> r! r� r? r1 r2 r! 2 s z AsyncScriptCommands.script_debugrD r' c C s
t | |�S r( )r r& r1 r1 r2 r) 5 s z#AsyncScriptCommands.register_script)rp rq rr r! r" r r) rA r1 r1 r? r2 r* 1 s r* c @ s" e Zd ZdZd!eee eeeed�dd�Z d"ee
e
e e df ed�dd �Z
ee
ed
�d d �Zee
ed
�d
d�Zd#eeeee e df eeee edf e e df e edf e edf eed�dd�Zd$ee
ee e df eeee edf e e df e edf e edf eed�
dd�Ze ee edf ed�dd�Zd%ee e
df e edf e edf e e edf e edf e edf e e df e edf eeeeed�dd�Zd&eee e
df e edf e edf e e edf e edf e edf e e df e edf eeed �d d �Ze ee edf ed�d d �ZdS )'� GeoCommandszr
Redis Geospatial commands.
see: https://redis.com/redis-best-practices/indexing-patterns/geospatial/
F)r� r ru rv r� r+ c C st |r|rt d��t|�d dkr(t d��|g}|r<|�d� |rJ|�d� |rX|�d� |�|� | jdg|�R � S ) aA
Add the specified geospatial items to the specified key identified
by the ``name`` argument. The Geospatial items are given as ordered
members of the ``values`` argument, each item or place is formed by
the triad longitude, latitude and name.
Note: You can use ZREM to remove elements.
``nx`` forces ZADD to only create new elements and not to update
scores for elements that already exist.
``xx`` forces ZADD to only update scores of elements that already
exist. New elements will not be added.
``ch`` modifies the return value to be the numbers of elements changed.
Changed elements include new elements that were added and elements
whose scores changed.
For more information see https://redis.io/commands/geoadd
z+GEOADD allows either 'nx' or 'xx', not both� r z4GEOADD requires places with lon, lat and name valuesry rz ZCHZGEOADD)r r� rH r� r- )r. r� r ru rv r� r0 r1 r1 r2 �geoaddE s
zGeoCommands.geoaddN)r� �place1�place2�unitr+ c C s@ |||g}|r |dvr t d��n|r.|�|� | jdg|�R � S )a
Return the distance between ``place1`` and ``place2`` members of the
``name`` key.
The units must be one of the following : m, km mi, ft. By default
meters are used.
For more information see https://redis.io/commands/geodist
��mZkm�miZftzGEODIST invalid unitZGEODISTrd )r. r� r. r/ r0 r0 r1 r1 r2 �geodisto s
zGeoCommands.geodistr
c G s | j d|g|�R � S )z�
Return the geo hash string for each item of ``values`` members of
the specified key identified by the ``name`` argument.
For more information see https://redis.io/commands/geohash
ZGEOHASHr, r r1 r1 r2 �geohash� s zGeoCommands.geohashc G s | j d|g|�R � S )a
Return the positions of each item of ``values`` as members of
the specified key identified by the ``name`` argument. Each position
is represented by the pairs lon and lat.
For more information see https://redis.io/commands/geopos
ZGEOPOSr, r r1 r1 r2 �geopos� s zGeoCommands.geopos)r� � longitude�latitude�radiusr0 �withdist� withcoord�withhashrE r) r! �
store_dist�anyr+ c C s& | j d||||||||| |
| | |
d�S )a
Return the members of the specified key identified by the
``name`` argument which are within the borders of the area specified
with the ``latitude`` and ``longitude`` location and the maximum
distance from the center specified by the ``radius`` value.
The units must be one of the following : m, km mi, ft. By default
``withdist`` indicates to return the distances of each place.
``withcoord`` indicates to return the latitude and longitude of
each place.
``withhash`` indicates to return the geohash string of each place.
``count`` indicates to return the number of elements up to N.
``sort`` indicates to return the places in a sorted way, ASC for
nearest to fairest and DESC for fairest to nearest.
``store`` indicates to save the places names in a sorted set named
with a specific key, each element of the destination sorted set is
populated with the score got from the original geo sorted set.
``store_dist`` indicates to save the places names in a sorted set
named with a specific key, instead of ``store`` the sorted set
destination score is set with the distance.
For more information see https://redis.io/commands/georadius
Z GEORADIUS� r0 r: r; r< rE r) r! r= r> ��_georadiusgeneric)r. r� r7 r8 r9 r0 r: r; r< rE r) r! r= r> r1 r1 r2 � georadius� s .�zGeoCommands.georadius)
r� �memberr9 r0 r: r; r< rE r) r! r= r> r+ c
C s$ | j d||||||||| |
| | d�
S )a�
This command is exactly like ``georadius`` with the sole difference
that instead of taking, as the center of the area to query, a longitude
and latitude value, it takes the name of a member already existing
inside the geospatial index represented by the sorted set.
For more information see https://redis.io/commands/georadiusbymember
ZGEORADIUSBYMEMBERr? r@ )
r. r� rC r9 r0 r: r; r< rE r) r! r= r> r1 r1 r2 �georadiusbymember� s �z GeoCommands.georadiusbymember)r� r5 r/ r+ c O s` t |�}|d r&|d dvr&td��n"|d r>|�|d � n
|�d� |d rd|d d u rdtd��dD ]\}}|| rh|�|� qh|d d ur�|�d |d g� |d r�|�d
� |d r�|d d kr�|�d � n |d d
kr�|�d
� ntd��|d �r|d �rtd��|d �r,|�d|d g� |d �rH|�d|d g� | j|g|�R i |��S )Nr0 r1 zGEORADIUS invalid unitr2 r> rE z+``any`` can't be provided without ``count``))r: ZWITHDIST)r; Z WITHCOORD)r< ZWITHHASHr �ANYr) �ASC�DESCzGEORADIUS invalid sortr! r= z3GEORADIUS store and store_dist cant be set togetherr& � STOREDIST)r� r rH r� r- �r. r� r5 r/ r0 Zarg_nameZ byte_reprr1 r1 r2 rA � s8
z GeoCommands._georadiusgenericr2 )r� rC r7 r8 r0 r9 �width�heightr) rE r> r; r: r< r+ c C s, | j d||||||||| |
| | |
|ddd�S )aE
Return the members of specified key identified by the
``name`` argument, which are within the borders of the
area specified by a given shape. This command extends the
GEORADIUS command, so in addition to searching within circular
areas, it supports searching within rectangular areas.
This command should be used in place of the deprecated
GEORADIUS and GEORADIUSBYMEMBER commands.
``member`` Use the position of the given existing
member in the sorted set. Can't be given with ``longitude``
and ``latitude``.
``longitude`` and ``latitude`` Use the position given by
this coordinates. Can't be given with ``member``
``radius`` Similar to GEORADIUS, search inside circular
area according the given radius. Can't be given with
``height`` and ``width``.
``height`` and ``width`` Search inside an axis-aligned
rectangle, determined by the given height and width.
Can't be given with ``radius``
``unit`` must be one of the following : m, km, mi, ft.
`m` for meters (the default value), `km` for kilometers,
`mi` for miles and `ft` for feet.
``sort`` indicates to return the places in a sorted way,
ASC for nearest to farest and DESC for farest to nearest.
``count`` limit the results to the first count matching items.
``any`` is set to True, the command will return as soon as
enough matches are found. Can't be provided without ``count``
``withdist`` indicates to return the distances of each place.
``withcoord`` indicates to return the latitude and longitude of
each place.
``withhash`` indicates to return the geohash string of each place.
For more information see https://redis.io/commands/geosearch
Z GEOSEARCHN�rC r7 r8 r0 r9 rJ rK r) rE r> r; r: r< r! r= ��_geosearchgeneric)r. r� rC r7 r8 r0 r9 rJ rK r) rE r> r; r: r< r1 r1 r2 � geosearch( s& 4�zGeoCommands.geosearch)ra r� rC r7 r8 r0 r9 rJ rK r) rE r> � storedistr+ c C s. | j d||||||||| |
| | dddd|
d�S )a�
This command is like GEOSEARCH, but stores the result in
``dest``. By default, it stores the results in the destination
sorted set with their geospatial information.
if ``store_dist`` set to True, the command will stores the
items in a sorted set populated with their distance from the
center of the circle or box, as a floating-point number.
For more information see https://redis.io/commands/geosearchstore
ZGEOSEARCHSTORENrL rM )r. ra r� rC r7 r8 r0 r9 rJ rK r) rE r> rP r1 r1 r2 �geosearchstorep s( �zGeoCommands.geosearchstorec O s$ t |�}|d d u r4|d d u s,|d d u r4td��|d rf|d sL|d rTtd��|�d|d g� |d r�|d r�|�d|d |d g� |d d u r�|d d u s�|d
d u r�td ��|d d u r�td
��|d �� dvr�td��|d �r$|d �s|d
�r td��|�d|d |d g� |d �rV|d
�rV|�d|d |d
|d g� |d �r�|d �� dk�r~|�d� n&|d �� dk�r�|�d� ntd��|d �r�|�d|d g� |d �r�|�d � n|d �r�td ��d D ] \}}|| �r�|�|� �q�| j|g|�R i |��S ) NrC r7 r8 z4GEOSEARCH must have member or longitude and latitudez?GEOSEARCH member and longitude or latitude cant be set togethers
FROMMEMBERs
FROMLONLATr9 rJ rK z.GEOSEARCH must have radius or width and heightr0 zGEOSEARCH must have unitr1 zGEOSEARCH invalid unitz9GEOSEARCH radius and width or height cant be set togethers BYRADIUSs BYBOXr) rF s ASCrG r% zGEOSEARCH invalid sortrE r/ r> s ANYz1GEOSEARCH ``any`` can't be provided without count))r: s WITHDIST)r; s WITHCOORD)r< s WITHHASH)r= rH )r� r r� r� rM rH r- rI r1 r1 r2 rN � sZ ��
�
z GeoCommands._geosearchgeneric)FFF)N) NFFFNNNNF) NFFFNNNNF)
NNNr2 NNNNNFFFF) NNNr2 NNNNNFF)rp rq rr rs r r
r rv ru r- r r rt r4 r5 r6 r: r: rB rD rA rO rQ rN r1 r1 r1 r2 r+ ? s �� + �� �
� D �
� (� 1 �
� L �
� 0�r+ c @ s� e Zd ZdZed�dd�Zdeeee eee ed�dd�Z ed�d d
�Z
ed�d d �Z dd�d
d�Z ed�dd�Z
ed�dd�Zed�dd�ZdS )�ModuleCommandszO
Redis Module commands.
see: https://redis.io/topics/modules-intro
r? c G s | j d|g|�R � S )z�
Loads the module from ``path``.
Passes all ``*args`` to the module, during loading.
Raises ``ModuleError`` if a module is not found at ``path``.
For more information see https://redis.io/commands/module-load
z MODULE LOADr, )r. �pathr5 r1 r1 r2 � module_load� s zModuleCommands.module_loadN)rS r� r5 r+ c C sP g }|dur |� d� |�|� |dur<|� d� |�|� | jd|g|�R � S )z�
Loads a module from a dynamic library at runtime with configuration directives.
For more information see https://redis.io/commands/module-loadex
NZCONFIGZARGSz
MODULE LOADEXr� )r. rS r� r5 r0 r1 r1 r2 �
module_loadex� s
z ModuleCommands.module_loadexc C s | � d|�S )z�
Unloads the module ``name``.
Raises ``ModuleError`` if ``name`` is not in loaded modules.
For more information see https://redis.io/commands/module-unload
z
MODULE UNLOADr, rq r1 r1 r2 �
module_unload
s z ModuleCommands.module_unloadc C s
| � d�S )z�
Returns a list of dictionaries containing the name and version of
all loaded modules.
For more information see https://redis.io/commands/module-list
z MODULE LISTr, r~ r1 r1 r2 � module_list s zModuleCommands.module_listc C s t d��d S r� r� r~ r1 r1 r2 r� s �zModuleCommands.command_infoc C s
| � d�S )Nr� r, r~ r1 r1 r2 r� ! s z ModuleCommands.command_countc G s | j dg|�R � S )NzCOMMAND GETKEYSr, r� r1 r1 r2 �command_getkeys$ s z ModuleCommands.command_getkeysc C s
| � d�S )Nr� r, r~ r1 r1 r2 r� ' s zModuleCommands.command)NN)rp rq rr rs ru rT rt r r
rU rV rW r� r� rX r� r1 r1 r1 r2 rR � s
�
� rR c @ s0 e Zd ZdZdd� Zg g dfdd�Zdd� ZdS ) r� r� c C s< || _ || _t|t�r(| �� }|�|�}t�|��� | _ d S r< )
r� r� rG rt r` rb r� r� r� r� r� r1 r1 r2 rK 0 s
r� Nc C s� |du r| j }t|�t|� }ddlm} t||�r@|j�| � z |j| jt |�g|�R � W S t
y� |� | j �| _|j| jt |�g|�R � Y S 0 dS r r r r1 r1 r2 r < s
r
c C s0 z | j �� W S ty* | j j�� Y S 0 dS )z4Get the encoder to encode string scripts into bytes.N)r� r` �AttributeErrorr� r~ r1 r1 r2 r` P s zScript.get_encoder)rp rq rr rs rK r r` r1 r1 r1 r2 r� + s c s" e Zd Zdd�� fdd� Z� ZS )�AsyncModuleCommandsNr? c � s
t � �� S r< r= r~ r? r1 r2 r� d s z AsyncModuleCommands.command_info)rp rq rr r� rA r1 r1 r? r2 rZ c s rZ c @ s: e Zd ZdZed�dd�Zed�dd�Zed�dd�Zd S )
�ClusterCommandsz*
Class for Redis Cluster commands
r? c O s" | j d|�� � �g|�R i |��S )NzCLUSTER )r- rM )r. Z cluster_argr5 r/ r1 r1 r2 �clusterm s zClusterCommands.clusterc K s | j di |��S )z�
Disables read queries for a connection to a Redis Cluster slave node.
For more information see https://redis.io/commands/readwrite
� READWRITE)r] r, rA r1 r1 r2 � readwritep s zClusterCommands.readwritec K s | j di |��S )z�
Enables read queries for a connection to a Redis Cluster replica node.
For more information see https://redis.io/commands/readonly
�READONLY)r_ r, rA r1 r1 r2 �readonlyx s zClusterCommands.readonlyN)rp rq rr rs ru r\ r^ r` r1 r1 r1 r2 r[ h s r[ c @ sp e Zd ZdZd%eee eee ef d�dd�Z eeee ef d�dd�Z
d&eeee ef d
�d d �Z d'ee ee eee e f d�dd�Z
eeee eee ef d�dd�Zeee eee ef d�dd�Zeee eee ef d�dd�Zeee ef d�dd�Zd(eee eee ef d �d d �Zeee ef d�d d!�Zeee e f d�d"d#�Zd$S ))�FunctionCommandsz!
Redis Function commands
F)�coder r+ c C s* |r
dgng }|� |� | jdg|�R � S )a�
Load a library to Redis.
:param code: the source code (must start with
Shebang statement that provides a metadata about the library)
:param replace: changes the behavior to overwrite the existing library
with the new contents.
Return the library name that was loaded.
For more information see https://redis.io/commands/function-load
rh z
FUNCTION LOADrx )r. rb r r0 r1 r1 r2 �
function_load� s
z FunctionCommands.function_load)�libraryr+ c C s | � d|�S )z�
Delete the library called ``library`` and all its functions.
For more information see https://redis.io/commands/function-delete
zFUNCTION DELETEr, )r. rd r1 r1 r2 �function_delete� s z FunctionCommands.function_deleter� r� c C s | � d|�S )zw
Deletes all the libraries.
For more information see https://redis.io/commands/function-flush
zFUNCTION FLUSHr, r� r1 r1 r2 �function_flush� s z FunctionCommands.function_flushr� )rd �withcoder+ c C s( d|g}|r|� d� | jdg|�R � S )z�
Return information about the functions and libraries.
:param library: pecify a pattern for matching library names
:param withcode: cause the server to include the libraries source
implementation in the reply
Z LIBRARYNAMEZWITHCODEz
FUNCTION LISTrx )r. rd rg r5 r1 r1 r2 �
function_list� s
z FunctionCommands.function_list)r� r� r r+ c G s | j |||g|�R � S r< r, )r. r� �functionr� r r1 r1 r2 �_fcall� s zFunctionCommands._fcall)r� r r+ c G s | j d||g|�R � S )zf
Invoke a function.
For more information see https://redis.io/commands/fcall
ZFCALL�rj �r. ri r� r r1 r1 r2 �fcall� s zFunctionCommands.fcallc G s | j d||g|�R � S )z�
This is a read-only variant of the FCALL command that cannot
execute commands that modify data.
For more information see https://redis.io/commands/fcal_ro
ZFCALL_ROrk rl r1 r1 r2 �fcall_ro� s zFunctionCommands.fcall_ror? c C s( ddl m} i }g ||< | jdi |��S )z�
Return the serialized payload of loaded libraries.
For more information see https://redis.io/commands/function-dump
r r� �
FUNCTION DUMP)ro r� r� r1 r1 r2 �
function_dump� s z FunctionCommands.function_dumprZ )�payload�policyr+ c C s | � d||�S )z�
Restore libraries from the serialized ``payload``.
You can use the optional policy argument to provide a policy
for handling existing libraries.
For more information see https://redis.io/commands/function-restore
zFUNCTION RESTOREr, )r. rq rr r1 r1 r2 �function_restore� s
z!FunctionCommands.function_restorec C s
| � d�S )z�
Kill a function that is currently executing.
For more information see https://redis.io/commands/function-kill
z
FUNCTION KILLr, r~ r1 r1 r2 �
function_kill� s z FunctionCommands.function_killc C s
| � d�S )z�
Return information about the function that's currently running
and information about the available execution engines.
For more information see https://redis.io/commands/function-stats
zFUNCTION STATSr, r~ r1 r1 r2 �function_stats� s z FunctionCommands.function_statsN)F)r� )r� F)rZ )rp rq rr rs rt r rv r r rc re rf r
rh r: rj rm rn rp rs rt ru r1 r1 r1 r2 ra � s< �� � �
� � � �� ra c @ s e Zd ZdZdS )�DataAccessCommandsz�
A class containing all of the implemented data access redis commands.
This class is to be used as a mixin for synchronous Redis clients.
N�rp rq rr rs r1 r1 r1 r2 rv s rv c @ s e Zd ZdZdS )�AsyncDataAccessCommandsz�
A class containing all of the implemented data access redis commands.
This class is to be used as a mixin for asynchronous Redis clients.
Nrw r1 r1 r1 r2 rx s rx c @ s e Zd ZdZdS )� CoreCommandsz�
A class containing all of the implemented redis commands. This class is
to be used as a mixin for synchronous Redis clients.
Nrw r1 r1 r1 r2 ry " s
ry c @ s e Zd ZdZdS )�AsyncCoreCommandsz�
A class containing all of the implemented redis commands. This class is
to be used as a mixin for asynchronous Redis clients.
Nrw r1 r1 r1 r2 rz 2 s
rz )Zr~ r� r5 r� �typingr r r r r r r r r
r r r
r r Z redis.compatr Zredis.exceptionsr r r r Z redis.typingr r r r r r r r r r r r r! r" r# r$ r% Zhelpersr' r
r( rD r� ru r) ZAsyncACLCommandsrw r; rB rY r� r� ZAsyncListCommandsr+ rI rL ZAsyncSetCommandsre ZAsyncStreamCommandsr� ZAsyncSortedSetCommandsr� ZAsyncHyperlogCommandsr� ZAsyncHashCommandsr� r r ZAsyncPubSubCommandsr r* r+ ZAsyncGeoCommandsrR rZ r[ ZAsyncClusterCommandsra ZAsyncFunctionCommandsrv rx ry rz r1 r1 r1 r2 �<module> s� @ L O 3p S Sh * F "--) &F8y
�
�
�
�