Your IP : 216.73.216.213
B
�aɻ � @ s� d dl mZ d dlZd dlZd dlZd dlZd dlZd dlZd dlZd dl m
Z
m Z m Z d dl
mZ d dlmZmZmZmZmZmZmZmZmZmZ d dlmZm Z dZ dZ d d
� Z d d � Z d
d� Z!G dd� de"�Z#dd� Z$dd� Z%dd� Z&dd� Z'e(e(e(e(e(e(e(e(e(e(e(e(e(e(e(e(e(e(e(e(e(e(e(d�Z)dd� Z*d d � Z+d d � Z,d d!� Z-d"d#� Z.dwd%d&�Z/d'd(� Z0d)d*� Z1d+d,� Z2d-d.� Z3d/d0� Z4d1d2� Z5d3d4� Z6d5d6� Z7d7d8� Z8d9d:� Z9d;d<� Z:d=d>� Z;d?d@� Z<dAdB� Z=dCdD� Z>dEdF� Z?dGdH� Z@dIdJ� ZAdKdL� ZBdMdN� ZCdOdP� ZDdQdR� ZEdSdT� ZFdUdV� ZGdWdX� ZHdYdZ� ZId[d\� ZJd]d^� ZKd_d`� ZLdadb� ZMdcdd� ZNdedf� ZOdgdh� ZPG didj� dj�ZQeQZRG dkdl� dl�ZSG dmdn� dn�ZTG dodp� dpejU�ZVG dqdr� dreQ�ZWG dsdt� dt�ZXG dudv� dv�ZYdS )x� )�chainN)�ConnectionPool�UnixDomainSocketConnection�
SSLConnection)�Lock)
�ConnectionError� DataError�ExecAbortError�
NoScriptError� PubSubError�
RedisError�
ResponseError� TimeoutError�
WatchError� ModuleError)�safe_str� str_if_bytes� �EMPTY_RESPONSEc C sX y*t | � t| ttf�r | g} nt| �} W n tk
rD | g} Y nX |rT| �|� | S )N)�iter�
isinstance�bytes�str�list� TypeError�extend)�keys�args� r �=/opt/alt/python37/lib/python3.7/site-packages/redis/client.py� list_or_args s
r c C s6 | sdS y t | �} W n tk
r( dS X tj�| �S )z5Converts a unix timestamp to a Python datetime objectN)�int�
ValueError�datetimeZ
fromtimestamp)�responser r r �timestamp_to_datetime/ s r% c C s t �| �� |�S )N)�dict�fromkeys�split)Z
key_string�callbackr r r �string_keys_to_dict: s r* c sf e Zd ZdZdd� Z� fdd�Z� fdd�Z� fdd �Zd� fd d � Z� fd
d�Z � fdd�Z
� Z S )�CaseInsensitiveDictz?Case insensitive dict implementation. Assumes string keys only.c C s& x |� � D ]\}}|| |�� < q
W d S )N)�items�upper)�self�data�k�vr r r �__init__A s z CaseInsensitiveDict.__init__c s t � �|�� �S )N)�super� __contains__r- )r. r0 )� __class__r r r4 E s z CaseInsensitiveDict.__contains__c s t � �|�� � d S )N)r3 � __delitem__r- )r. r0 )r5 r r r6 H s z CaseInsensitiveDict.__delitem__c s t � �|�� �S )N)r3 � __getitem__r- )r. r0 )r5 r r r7 K s z CaseInsensitiveDict.__getitem__Nc s t � �|�� |�S )N)r3 �getr- )r. r0 �default)r5 r r r8 N s zCaseInsensitiveDict.getc s t � �|�� |� d S )N)r3 � __setitem__r- )r. r0 r1 )r5 r r r: Q s z CaseInsensitiveDict.__setitem__c s t |�}t� �|� d S )N)r+ r3 �update)r. r/ )r5 r r r; T s zCaseInsensitiveDict.update)N) �__name__�
__module__� __qualname__�__doc__r2 r4 r6 r7 r8 r: r; �
__classcell__r r )r5 r r+ > s r+ c C sT t | �} d| } tdd� | �� D ��} d}x$|D ] }|| kr0t| | �| |< q0W | S )zDParse the results of Redis's DEBUG OBJECT command into a Python dictztype:c s s | ]}|� d �V qdS )�:N)r( )�.0Zkvr r r � <genexpr>_ s z%parse_debug_object.<locals>.<genexpr>)�refcountZserializedlengthZlruZlru_seconds_idle)r r& r( r! )r$ Z
int_fieldsZfieldr r r �parse_debug_objectY s
rE c C s |dkrt | �S | S )z&Parse the results of an OBJECT command)ZidletimerD )� int_or_none)r$ �infotyper r r � parse_objectk s rH c s� i }t | �} � fdd�� x�| �� D ]�}|r"|�d�s"|�d�dkr�|�dd�\}}|dkrj|�dd�\}}|dkr�|�d g ��� |�� q�� |�||< q"|�d
g ��|� q"W |S ) z;Parse the result of Redis's INFO command into a Python dictc s� d| ksd| krDy d| kr"t | �S t| �S W q| tk
r@ | S X n8i }x.| �d�D ] }|�dd�\}}� |�||< qTW |S d S )N�,�=�.� )�floatr! r" r( �rsplit)�valueZsub_dict�itemr0 r1 )� get_valuer r rQ w s z parse_info.<locals>.get_value�#rA ���rL Z cmdstat_host�module�modulesZ__raw__)r �
splitlines�
startswith�findr( rN �
setdefault�append)r$ �info�line�keyrO r )rQ r �
parse_infor s r^ c K sD t | ddd�}x0|�� D ]$\}}|�d�rt |ddd�||< qW |S )z!Parse the results of MEMORY STATST)� decode_keys�decode_string_valueszdb.)�
pairs_to_dictr, rW )r$ �kwargsZstatsr] rO r r r �parse_memory_stats� s
rc )zcan-failover-its-masterz config-epochzdown-after-millisecondszfailover-timeoutz info-refreshzlast-hello-messagezlast-ok-ping-replyzlast-ping-replyzlast-ping-sentzmaster-link-down-timez master-portznum-other-sentinelsz
num-slavesz o-down-timezpending-commandszparallel-syncs�port�quorumzrole-reported-timez s-down-timezslave-priorityzslave-repl-offsetzvoted-leader-epochc C s> t | t�}t|d �d��}x dD ]\}}||k||< q"W |S )N�flagsrI ))Z is_master�master)Zis_slave�slave)Zis_sdownZs_down)Zis_odownZo_down)Z is_sentinel�sentinel)Zis_disconnectedZ disconnected)Zis_master_downZ master_down)�pairs_to_dict_typed�SENTINEL_STATE_TYPES�setr( )rP �resultrf �name�flagr r r �parse_sentinel_state� s
rp c C s t tt| ��S )N)rp �mapr )r$ r r r �parse_sentinel_master� s rr c C s0 i }x&| D ] }t tt|��}|||d < q
W |S )Nrn )rp rq r )r$ rm rP �stater r r �parse_sentinel_masters� s
rt c C s dd� | D �S )Nc S s g | ]}t tt|���qS r )rp rq r )rB rP r r r �
<listcomp>� s z7parse_sentinel_slaves_and_sentinels.<locals>.<listcomp>r )r$ r r r �#parse_sentinel_slaves_and_sentinels� s rv c C s | r| d t | d �fpd S )Nr rL )r! )r$ r r r �parse_sentinel_get_master� s rw Fc C st | dkr i S |s|rZ| ddd� }|r0t t|�}| ddd� }|rLt t|�}tt||��S t| �}tt||��S dS )z-Create a dict given a list of key/value pairsN� rL )rq r r& �zipr )r$ r_ r` r �values�itr r r ra � s
ra c C s^ t | �}i }xLt||�D ]>\}}||krNy|| |�}W n tk
rL Y nX |||< qW |S )N)r ry � Exception)r$ Z type_infor{ rm r] rO r r r rj � s rj c K s: | r|� d�s| S |� dt�}t| �}tt|t||���S )zr
If ``withscores`` is specified in the options, return the response as
a list of (value, score) pairs
�
withscores�score_cast_func)r8 rM r r ry rq )r$ �optionsr~ r{ r r r �zset_score_pairs s
r� c s: �r|� d�s�S |d � tt� �fdd�t� �D �� �S )z�
If ``groups`` is specified, return the response as a list of
n-element tuples with n being the value found in options['groups']
�groupsc s g | ]}�|d � � �qS )Nr )rB �i)�nr$ r r ru s z&sort_return_tuples.<locals>.<listcomp>)r8 r ry �range)r$ r r )r� r$ r �sort_return_tuples s r� c C s | d kr d S t | �S )N)r! )r$ r r r rF s rF c C sP | d kr d S g }x:| D ]2}|d k r>|� |d t|d �f� q|� d� qW |S )Nr rL )NN)rZ ra )r$ r/ �rr r r �parse_stream_list% s
r� c C s t | dd�S )NT)r_ )ra )r$ r r r �pairs_to_dict_with_str_keys1 s r� c C s t tt| ��S )N)r rq r� )r$ r r r �parse_list_of_dicts5 s r� c K s |� dd�r| S t| �S )N� parse_justidF)r8 r� )r$ r r r r � parse_xclaim9 s r� c K s |� dd�r| d S t| d �S )Nr� FrL )r8 r� )r$ r r r r �parse_xautoclaim? s r� c C s` t | dd�}|d }|d k r4|d t |d �f|d< |d }|d k r\|d t |d �f|d< |S )NT)r_ z first-entryr rL z
last-entry)ra )r$ r/ �firstZlastr r r �parse_xinfo_streamE s r� c C s | d kr g S dd� | D �S )Nc S s g | ]}|d t |d �g�qS )r rL )r� )rB r� r r r ru S s z parse_xread.<locals>.<listcomp>r )r$ r r r � parse_xreadP s r� c K sD |� dd�rt| �S dd� | d p$g D �}| d | d | d |d �S )
N� parse_detailFc S s g | ]\}}|t |�d ��qS ))rn �pending)r! )rB r� �pr r r ru Y s z"parse_xpending.<locals>.<listcomp>� r rL rx )r� �min�max� consumers)r8 �parse_xpending_range)r$ r r� r r r �parse_xpendingV s r� c s d� � fdd�| D �S )N)Z
message_idZconsumerZtime_since_deliveredZtimes_deliveredc s g | ]}t t� |���qS r )r& ry )rB r� )r0 r r ru d s z(parse_xpending_range.<locals>.<listcomp>r )r$ r )r0 r r� b s r� c C s | d kr d S t | �S )N)rM )r$ r r r �
float_or_noneg s r� c C s t | �dkS )N�OK)r )r$ r r r �bool_okm s r� c K s& | d kr d S |� d�r t| �S t| �S )N�as_score)r8 rM r! )r$ r r r r �
parse_zaddq s
r� c K s< g }x2t | ��� D ]"}|�tdd� |�d�D ��� qW |S )Nc s s | ]}|� d d�V qdS )rJ rL N)r( )rB �pairr r r rC } s z$parse_client_list.<locals>.<genexpr>� )r rV rZ r& r( )r$ r Zclients�cr r r �parse_client_listy s "r� c K s dd� | D �} | rt | �p i S )Nc S s g | ]}|d k rt |�nd �qS )N)r )rB r� r r r ru � s z$parse_config_get.<locals>.<listcomp>)ra )r$ r r r r �parse_config_get� s r� c K s | \}}t |�|fS )N)r! )r$ r �cursorr� r r r �
parse_scan� s r� c K s | \}}t |�|rt|�p i fS )N)r! ra )r$ r r� r� r r r � parse_hscan� s r� c K s8 |� dt�}| \}}t|�}t|�tt|t||���fS )Nr~ )r8 rM r r! r ry rq )r$ r r~ r� r� r{ r r r � parse_zscan� s r� c s& |� dd�rdnd� � fdd�| D �S )N�decode_responsesFr� � c sT g | ]L}|d t |d �t |d �t|d t�r>� �|d �n � �|d �d��qS )r rL rx r� � )�idZ
start_timeZduration�command)r! r r �join)rB rP )�spacer r ru � s
z%parse_slowlog_get.<locals>.<listcomp>)r8 )r$ r r )r� r �parse_slowlog_get� s
r� c K s t | �} tdd� | �� D ��S )Nc s s | ]}|r|� d �V qdS )rA N)r( )rB r\ r r r rC � s z%parse_cluster_info.<locals>.<genexpr>)r r& rV )r$ r r r r �parse_cluster_info� s r� c C sl | � d�}| � d�d d� \}}}}}}}} dd� |dd � D �}
|||||||
| dkr\dndd�} || fS ) Nr� � c S s g | ]}|� d ��qS )�-)r( )rB Zslr r r ru � s z$_parse_node_line.<locals>.<listcomp>� connectedTF)�node_idrf � master_idZlast_ping_sentZlast_pong_rcvd�epoch�slotsr� )r( ) r\ Z
line_itemsr� �addrrf r� �ping�pongr� r� r� Z node_dictr r r �_parse_node_line� s
"r� c K s t | ��� }tdd� |D ��S )Nc s s | ]}t |�V qd S )N)r� )rB r\ r r r rC � s z&parse_cluster_nodes.<locals>.<genexpr>)r rV r& )r$ r Z raw_linesr r r �parse_cluster_nodes� s r� c s� �d s�d r| S t | �tkr(| g}n| }�d sH�d sH�d sH|S tdd� td�� d d� g��� �fd
d �d D �7 ��fd
d �|D �S )N�store�
store_dist�withdist� withcoord�withhashc S s t | d �t | d �fS )Nr rL )rM )�llr r r �<lambda>� r z)parse_georadius_generic.<locals>.<lambda>)r� r� r� c S s | S )Nr )�xr r r r� � r c s g | ]}�| r� | �qS r r )rB �o)�castr r r ru � s z+parse_georadius_generic.<locals>.<listcomp>)r� r� r� c s$ g | ] }t td d� t� |����qS )c S s | d | d �S )Nr rL r )Zfvr r r r� � r z4parse_georadius_generic.<locals>.<listcomp>.<lambda>)r rq ry )rB r� )�fr r ru � s )�typer rM r! )r$ r Z
response_listr )r� r� r r �parse_georadius_generic� s
r� c K s" t t| dd d� | dd d� ��S )Nr rx rL )r ry )r$ r r r r �parse_pubsub_numsub� s r� c K s t | t�r| S t| �dkS )Nr� )r r! r )r$ r r r r �parse_client_kill� s
r� c K s� | d kr d S t | dd�}ttt|d ��|d< ttt|d ��|d< t|d �|d< g g }}x4|d �d�D ]"}d|kr�|�|� qn|�|� qnW ||d< ||d< d |d k|d
< |S ) NT)r_ rf � passwords�commandsr� �@�
categories�on�enabled)ra r rq r r( rZ )r$ r r/ r� r� r� r r r �parse_acl_getuser� s
r� c K st | d kr d S t | t�rhg }xT| D ]B}t|dd�}|�dd�}t|�|d< t|d �|d< |�|� q W nt| �}|S )NTz client-info� z age-seconds)r r ra r8 �parse_client_inforM rZ r� )r$ r r/ �logZlog_data� client_infor r r �
parse_acl_log s
r� c C sX i }t | ��d�}x"|D ]}|�d�\}} | ||< qW x dD ]}t|| �||< q<W |S )zg
Parsing client-info in ACL Log in following format.
"key1=value1 key2=value2 key3=value3"
r� rJ > �qbuf�psub�argv-mem�db�idle�sub�multi�tot-mem�omem�obl�ager� �oll� qbuf-free)r r( r! )rO r� Zinfosr[ r] Zint_keyr r r r� s
r� c C s t | t�r| �dS )NT)r r )r$ r r r �parse_module_result( s
r� c K s |� d�r| S | o t| �dkS )z�
Handle SET result since GET argument is available since Redis 6.2.
Parsing SET result into:
- BOOL
- String when GET argument is used
r8 r� )r8 r )r$ r r r r �parse_set_result. s
r� c h @ s> e Zd ZdZede�ede�ede�eddd� �ede�ed e �ed
e
�ed d d� �ed
dd� �ede �eddd� �ede �ede
�ede�eddd� �dd� eeedd� e
ee
e
dd� eeeeeee
dd� e
e
dd� d d� e
e
e
ed d� e
ee
e
e
e
e
eee
e
ed d� d d� eed d� eee e
e e e e d!d� e d"d� e d#d� e!d$d� e
e
ee"e#e$e
e
e%e
e%e&e'ee
e!d%d� e(e)e
eee
e*e*e+e,e-e.d&�X�Z/e0d'd(� �Z1�dHd1d2�Z2d3d4� Z3d5d6� Z4�dId8d9�Z5d:d;� Z6�dJd=d>�Z7d?d@� Z8dAdB� Z9dCdD� Z:dEdF� Z;dGdH� Z<dIdJ� Z=dKdL� Z>dMdN� Z?dOdP� Z@�dKdQdR�ZAdSdT� ZBdUdV� ZCdWdX� ZDdYdZ� ZE�dLd[d\�ZFd]d^� ZGd_d`� ZHdadb� ZI�dMdcdd�ZJdedf� ZKdgdh� ZLdidj� ZMdkdl� ZNdmdn� ZO�dNdodp�ZPdqdr� ZQ�dOdsdt�ZRdudv� ZSdwdx� ZTdydz� ZU�dPd{d|�ZVd}d~� ZWdd�� ZXd�d�� ZYd�d�� ZZ�dQd�d��Z[d�d�� Z\d�d�� Z]d�d�� Z^d�d�� Z_d�d�� Z`d�d�� Za�dRd�d��Zb�dSd�d��Zcd�d�� Zd�dTd�d��Zed�d�� Zf�dUd�d��Zgd�d�� Zhd�d�� Zi�dVd�d��Zjd�d�� Zkd�d�� Zld�d�� Zmd�d�� Znd�d�� Zod�d�� Zpd�d�� Zqd�d�� Zrd�d�� Zsd�d�� Ztd�d�� Zud�d�� Zv�dWd�d��Zw�dXd�d��Zx�dYd�dÄZyd�dń Zzd�dDŽ Z{d�dɄ Z|d�d˄ Z}d�d̈́ Z~�dZd�dτZ�d[d�dфZ�d�dӄ Z��d\d�dՄZ��d]d�dׄZ��d^d�dڄZ��d_d�d܄Z�d�dބ Z�d�d� Z�d�d� Z�d�d� Z�e�Z�d�d� Z�d�d� Z�d�d� Z�d�d� Z��d`d�d�Z�d�d� Z�d�d� Z�d�d� Z�d�d�� Z��dad�d��Z��dbd�d��Z��dcd�d��Z��ddd�d��Z��de�d�d�Z��df�d�d�Z��d�d� Z��d�d � Z��d
�d � Z��d �d
� Z��d�d� Z��d�d� Z��d�d� Z��d�d� Z��d�d� Z��dg�d�d�Z��d�d� Z��d �d � Z��d �d � Z��dh�d �d!�Z��di�d"�d#�Z��d$�d%� Z��d&�d'� Z��d(�d)� Z��d*�d+� Z��d,�d-� Z��d.�d/� Z��dj�d1�d2�Z��d3�d4� Z��d5�d6� Z��d7�d8� Z��d9�d:� Z��d;�d<� Z��d=�d>� Z��dk�d?�d@�Z��dl�dA�dB�Z��dm�dC�dD�Z��dE�dF� Z��dG�dH� Z��dI�dJ� Z��dn�dK�dL�Z��dM�dN� Z��dO�dP� Z��dQ�dR� Z��dS�dT� Z��dU�dV� Z��dW�dX� Zdo�dY�dZ�ZÐd[�d\� ZĐd]�d^� ZŐd_�d`� ZƐdp�da�db�Zǐdq�dc�dd�ZȐdr�de�df�Zɐds�dg�dh�Zʐdt�di�dj�Zːdu�dk�dl�Z̐dv�dm�dn�Z͐dw�do�dp�Z�d+d,d,ef�dq�dr�Z�d,d,ef�ds�dt�ZАdu�dv� Zѐdw�dx� ZҐdy�dz� ZӐd{�d|� ZԐd}�d~� ZՐd�d�� Zd��d�� Zאd��d�� Zؐd��d�� Zِdx�d��d��Zڐdy�d��d��Zېd��d�� Zܐd��d�� Zݐd��d�� Zސd��d�� Zߐdz�d��d��Z�d{�d��d��Z�d|�d��d��Z�d��d�� Z�d}�d��d��Z�d��d�� Z�d��d�� Z�d��d�� Z�d��d�� Z�d��d�� Z�d��d�� Z�d��d�� Z�d��d�� Z�d~�d��d��Z�d�d��d��Z�d��d��d��Z�d��d��d��Z�d��d��d��Z�d��d��d��Z�d��d��d��Z�d��d�� Z�d��d�� Z��d��ddÄZ��dĐdń Z��dƐdDŽ Z��d��dȐdɄZ��d��dʐd˄Z��d̐d̈́ Z��d��dΐdτZ��d��dАdфZ��d��dҐdӄZ��d��dԐdՄZ��d��ddׄ�Z d/d/ef�dؐdل�Z�dڐdۄ �Z�d��dܐd݄�Z�d��dސd߄�Zd,d,d/ef�d�d��Z�d�d� �Z�d�d� �Z�d�d� �Z�d�d� �Z �d�d� �Z
d/ef�d�d��Z d,d,d/ef�d�d��Z �d�d� �Z
�d�d� �Z�d��d�d���Z�d��d��d���Z�d��d��d���Z�d��d�� �Z�d��d�� �Z�d��d�� �Z�d �d� �Z�d�d� �Z�d�d� �Z�d�d� �Z�d��d�d ��Z�d��d
�d ��Z�d �d
� �Z�d�d� �Z �d��d�d��Z �d�d� �Z �d�d� �Z �d�d� �Z �d�d� �Z!�d�d� �Z"�d �d � �Z#�d��d �d ��Z$�d �d!� �Z%�d"�d#� �Z&�d$�d%� �Z'�d&�d'� �Z(�d(�d)� �Z)�d*�d+� �Z*�d,�d-� �Z+�d.�d/� �Z,�d0�d1� �Z-�d2�d3� �Z.�d4�d5� �Z/�d��d6�d7��Z0�d8�d9� �Z1�d:�d;� �Z2�d��d<�d=��Z3�d��d>�d?��Z4�d@�dA� �Z5�dB�dC� �Z6�dD�dE� �Z7�dF�dG� �Z8d,S (� �Redisa&
Implementation of the Redis protocol.
This abstract class provides a Python interface to all Redis commands
and an implementation of the Redis protocol.
Connection and Pipeline derive from this, implementing how
the commands are sent and received to the Redis server
ztAUTH COPY EXPIRE EXPIREAT HEXISTS HMSET LMOVE BLMOVE MOVE MSETNX PERSIST PSETEX RENAMENX SISMEMBER SMOVE SETEX SETNXa BITCOUNT BITPOS DECRBY DEL EXISTS GEOADD GETBIT HDEL HLEN HSTRLEN INCRBY LINSERT LLEN LPUSHX PFADD PFCOUNT RPUSHX SADD SCARD SDIFFSTORE SETBIT SETRANGE SINTERSTORE SREM STRLEN SUNIONSTORE UNLINK XACK XDEL XLEN XTRIM ZCARD ZLEXCOUNT ZREM ZREMRANGEBYLEX ZREMRANGEBYRANK ZREMRANGEBYSCOREzINCRBYFLOAT HINCRBYFLOATz LPUSH RPUSHc C s t | t�r| pt| �dkS )Nr� )r r! r )r� r r r r� [ r zRedis.<lambda>�SORTzZSCORE ZINCRBY GEODISTzuFLUSHALL FLUSHDB LSET LTRIM MSET PFMERGE READONLY READWRITE RENAME SAVE SELECT SHUTDOWN SLAVEOF SWAPDB WATCH UNWATCH z BLPOP BRPOPc C s | r t | �pd S )N)�tuple)r� r r r r� d r z SDIFF SINTER SMEMBERS SUNIONc C s | r t | �pt � S )N)rl )r� r r r r� g r zSZPOPMAX ZPOPMIN ZINTER ZDIFF ZUNION ZRANGE ZRANGEBYSCORE ZREVRANGE ZREVRANGEBYSCOREzBZPOPMIN BZPOPMAXc C s" | r | d | d t | d �fp d S )Nr rL rx )rM )r� r r r r� n s zZRANK ZREVRANKzXREVRANGE XRANGEzXREAD XREADGROUPzBGREWRITEAOF BGSAVEc C s dS )NTr )r� r r r r� s r c C s t tt| ��S )N)r rq r )r� r r r r� t r c C s t tt| ��S )N)r rq r )r� r r r r� x r c C s t tt| ��S )N)r rq r )r� r r r r� } r c C s | rt | �dkpdS )NrL F)r! )r� r r r r� � r c C s t | �S )N)r! )r� r r r r� � r c C s t | �S )N)r! )r� r r r r� � r c C s t | �S )N)r! )r� r r r r� � r c C s t tt| ��S )N)r rq r )r� r r r r� � r c C s t tdd� | ��S )Nc S s$ | d k r t | d �t | d �fS d S )Nr rL )rM )r� r r r r� � s z Redis.<lambda>.<locals>.<lambda>)r rq )r� r r r r� � s
c C s | r t | �pi S )N)ra )r� r r r r� � r c C s dd� | D �S )Nc S s g | ] }t |��qS r )ra )rB �mr r r ru � s z"Redis.<lambda>.<locals>.<listcomp>r )r� r r r r� � r c C s t | �dkS )NZPONG)r )r� r r r r� � r c C s | r| p
d S )Nr )r� r r r r� � r c C s t tt| ��S )N)r rq �bool)r� r r r r� � r c C s t | d �t | d �fS )Nr rL )r! )r� r r r r� � r )XzACL CATz ACL DELUSERz ACL GENPASSz ACL GETUSERzACL LISTzACL LOADzACL LOGzACL SAVEz ACL SETUSERz ACL USERSz
ACL WHOAMIzCLIENT GETNAMEz CLIENT IDz CLIENT KILLz CLIENT LISTz CLIENT INFOzCLIENT SETNAMEzCLIENT UNBLOCKz CLIENT PAUSEzCLUSTER ADDSLOTSz CLUSTER COUNT-FAILURE-REPORTSzCLUSTER COUNTKEYSINSLOTzCLUSTER DELSLOTSzCLUSTER FAILOVERzCLUSTER FORGETz CLUSTER INFOzCLUSTER KEYSLOTz CLUSTER MEETz
CLUSTER NODESzCLUSTER REPLICATEz
CLUSTER RESETzCLUSTER SAVECONFIGzCLUSTER SET-CONFIG-EPOCHzCLUSTER SETSLOTzCLUSTER SLAVESz
CONFIG GETzCONFIG RESETSTATz
CONFIG SETz DEBUG OBJECT�GEOHASH�GEOPOS� GEORADIUS�GEORADIUSBYMEMBER�HGETALL�HSCAN�INFO�LASTSAVEz MEMORY PURGEz MEMORY STATSz MEMORY USAGEz MODULE LOADz
MODULE UNLOADz MODULE LIST�OBJECT�PINGz
PUBSUB NUMSUB� RANDOMKEY�SCANz
SCRIPT EXISTSz SCRIPT FLUSHz SCRIPT KILLz SCRIPT LOADz SENTINEL GET-MASTER-ADDR-BY-NAMEzSENTINEL MASTERzSENTINEL MASTERSzSENTINEL MONITORzSENTINEL REMOVEzSENTINEL SENTINELSz SENTINEL SETzSENTINEL SLAVES�SETz SLOWLOG GETz SLOWLOG LENz
SLOWLOG RESET�SSCAN�TIME�XCLAIM�
XAUTOCLAIMz
XGROUP CREATEzXGROUP DELCONSUMERzXGROUP DESTROYz XGROUP SETIDzXINFO CONSUMERSz XINFO GROUPSz XINFO STREAM�XPENDING�ZADD�ZSCANc K s t j|f|�}| |d�S )a
Return a Redis client object configured from the given URL
For example::
redis://[[username]:[password]]@localhost:6379/0
rediss://[[username]:[password]]@localhost:6379/0
unix://[[username]:[password]]@/path/to/socket.sock?db=0
Three URL schemes are supported:
- `redis://` creates a TCP socket connection. See more at:
<https://www.iana.org/assignments/uri-schemes/prov/redis>
- `rediss://` creates a SSL wrapped TCP socket connection. See more at:
<https://www.iana.org/assignments/uri-schemes/prov/rediss>
- ``unix://``: creates a Unix Domain Socket connection.
The username, password, hostname, path and all querystring values
are passed through urllib.parse.unquote in order to replace any
percent-encoded values with their corresponding characters.
There are several ways to specify a database number. The first value
found will be used:
1. A ``db`` querystring option, e.g. redis://localhost?db=0
2. If using the redis:// or rediss:// schemes, the path argument
of the url, e.g. redis://localhost/0
3. A ``db`` keyword argument to this function.
If none of these options are specified, the default db=0 is used.
All querystring options are cast to their appropriate Python types.
Boolean arguments can be specified with string values "True"/"False"
or "Yes"/"No". Values that cannot be properly cast cause a
``ValueError`` to be raised. Once parsed, the querystring arguments
and keyword arguments are passed to the ``ConnectionPool``'s
class initializer. In the case of conflicting arguments, querystring
arguments always win.
)�connection_pool)r �from_url)�clsZurlrb r� r r r r � s )zRedis.from_url� localhost�� r N�utf-8�strictF�requiredc C s� | s�|
d k r t �td�� |
} |d k r8t �td�� |} ||||| | |||||d� } |
d k rn| �|
td�� n2| �|||||d�� |r�| �t|||||d�� tf | �} | | _d | _|r�| j� d�| _t
| j j �| _
d S )Nz/"charset" is deprecated. Use "encoding" insteadz5"errors" is deprecated. Use "encoding_errors" instead) r� �username�password�socket_timeout�encoding�encoding_errorsr� �retry_on_timeout�max_connections�health_check_interval� client_name)�path�connection_class)�hostrd �socket_connect_timeout�socket_keepalive�socket_keepalive_options)r � ssl_keyfile� ssl_certfile�
ssl_cert_reqs� ssl_ca_certs�ssl_check_hostname�_)�warnings�warn�DeprecationWarningr; r r r r� �
connection�get_connectionr+ r5 �RESPONSE_CALLBACKS�response_callbacks) r. r rd r� r r r r r r� Zunix_socket_pathr
r �charset�errorsr� r Zsslr r r r r r
�single_connection_clientr r r rb r r r r2 � sZ
zRedis.__init__c C s dt | �jt| j�f S )Nz%s<%s>)r� r< �reprr� )r. r r r �__repr__B s zRedis.__repr__c C s || j |< dS )z Set a custom Response CallbackN)r" )r. r� r) r r r �set_response_callbackE s zRedis.set_response_callbackTc C s t | j| j||�S )a_
Return a new pipeline object that can queue multiple commands for
later execution. ``transaction`` indicates whether all commands
should be executed atomically. Apart from making a group of operations
atomic, pipelines are useful for reducing the back-and-forth overhead
between the client and server.
)�Pipeliner� r" )r. � transaction�
shard_hintr r r �pipelineI s
zRedis.pipelinec
O s� |� dd�}|� dd�}|� dd�}| �d|��h}x`y*|rD|j|� ||�}|�� } |r\|S | S tk
r� |dk r�|dkr�t�|� w4Y q4X q4W W dQ R X dS )z�
Convenience method for executing the callable `func` as a transaction
while watching all keys specified in `watches`. The 'func' callable
should expect a single argument which is a Pipeline object.
r+ N�value_from_callableF� watch_delayTr )�popr, �watch�executer �time�sleep)
r. �funcZwatchesrb r+ r- r. �pipeZ
func_valueZ
exec_valuer r r r* W s
zRedis.transaction皙�����?c C s |dkr t }|| |||||d�S )a$
Return a new Lock object using key ``name`` that mimics
the behavior of threading.Lock.
If specified, ``timeout`` indicates a maximum life for the lock.
By default, it will remain locked until release() is called.
``sleep`` indicates the amount of time to sleep per loop iteration
when the lock is in blocking mode and another client is currently
holding the lock.
``blocking_timeout`` indicates the maximum amount of time in seconds to
spend trying to acquire the lock. A value of ``None`` indicates
continue trying forever. ``blocking_timeout`` can be specified as a
float or integer, both representing the number of seconds to wait.
``lock_class`` forces the specified lock implementation.
``thread_local`` indicates whether the lock token is placed in
thread-local storage. By default, the token is placed in thread local
storage so that a thread only sees its token, not a token set by
another thread. Consider the following timeline:
time: 0, thread-1 acquires `my-lock`, with a timeout of 5 seconds.
thread-1 sets the token to "abc"
time: 1, thread-2 blocks trying to acquire `my-lock` using the
Lock instance.
time: 5, thread-1 has not yet completed. redis expires the lock
key.
time: 5, thread-2 acquired `my-lock` now that it's available.
thread-2 sets the token to "xyz"
time: 6, thread-1 finishes its work and calls release(). if the
token is *not* stored in thread local storage, then
thread-1 would see the token value as "xyz" and would be
able to successfully release the thread-2's lock.
In some use cases it's necessary to disable thread local storage. For
example, if you have code where one thread acquires a lock and passes
that lock instance to a worker thread to release later. If thread
local storage isn't disabled in this case, the worker thread won't see
the token set by the thread that acquired the lock. Our assumption
is that these cases aren't common and as such default to using
thread local storage. N)�timeoutr3 �blocking_timeout� thread_local)r )r. rn r7 r3 r8 Z
lock_classr9 r r r �lockm s
-
z
Redis.lockc K s t | jf|�S )z�
Return a Publish/Subscribe object. With this object, you can
subscribe to channels and listen for messages that get published to
them.
)�PubSubr� )r. rb r r r �pubsub� s z Redis.pubsubc C s
t | j�S )N)�Monitorr� )r. r r r �monitor� s z
Redis.monitorc C s | j | jdd�S )NT)r� r% )r5 r� )r. r r r �client� s z Redis.clientc C s | S )Nr )r. r r r � __enter__� s zRedis.__enter__c C s | � � d S )N)�close)r. �exc_type� exc_value� tracebackr r r �__exit__� s zRedis.__exit__c C s | � � d S )N)rA )r. r r r �__del__� s z
Redis.__del__c C s | j }|r d | _ | j�|� d S )N)r r� �release)r. �connr r r rA � s z Redis.closec
O s� | j }|d }| jp |j|f|�}zvy|j|� | j||f|�S ttfk
r� } z4|�� |jrlt |t�sn� |j|� | j||f|�S d}~X Y nX W d| js�|�
|� X dS )z.Execute a command and return a parsed responser N) r� r r � send_command�parse_responser r �
disconnectr r rG )r. r r Zpool� command_namerH �er r r �execute_command� s
"zRedis.execute_commandc K sT y |� � }W n& tk
r2 t|kr,|t S � Y nX || jkrP| j| |f|�S |S )z'Parses a response from the Redis server)�
read_responser
r r" )r. r rL r r$ r r r rJ � s
zRedis.parse_responsec C s |r
|gng }| j d|�� S )z�
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.
�ACL CAT)rP )rN )r. �category�piecesr r r �acl_cat� s z
Redis.acl_catc C s | � d|�S )z-Delete the ACL for the specified ``username``z ACL DELUSER)rN )r. r r r r � acl_deluser� s zRedis.acl_deluserc C s
| � d�S )z Generate a random password valuez ACL GENPASS)rN )r. r r r � acl_genpass� s zRedis.acl_genpassc C s | � d|�S )zz
Get the ACL details for the specified ``username``.
If ``username`` does not exist, return None
z ACL GETUSER)rN )r. r r r r � acl_getuser� s zRedis.acl_getuserc C s
| � d�S )z'Return a list of all ACLs on the serverzACL LIST)rN )r. r r r �acl_list� s zRedis.acl_listc C s6 g }|dk r(t |t�s td��|�|� | jd|�� S )zl
Get ACL logs as a list.
:param int count: Get logs[0:count].
:rtype: List.
Nz ACL LOG count must be an integer�ACL LOG)rX )r r! r rZ rN )r. �countr r r r �acl_log� s
z
Redis.acl_logc C s dg}| j d|�� S )z:
Reset ACL logs.
:rtype: Boolean.
s RESET�ACL LOG)r[ )rN )r. r r r r �
acl_log_reset s zRedis.acl_log_resetc C s
| � d�S )z�
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.
zACL LOAD)rN )r. r r r �acl_load s zRedis.acl_loadc C s
| � d�S )z�
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.
zACL SAVE)rN )r. r r r �acl_save s zRedis.acl_savec C s� | j �� } |g}
| r |
�d� |
r,|
�d� | r:|
�d� |rJ|
�d� n
|
�d� |s\|rh|rhtd��|r�t|g �}xnt|�D ]b\}}| �|�}|�d�r�|
�d|d d
� � q�|�d �r�|
�d |d d
� � q�td
| ��q�W |�rlt|g �}xtt|�D ]h\}}| �|�}|�d��r6|
�d|d d
� � n0|�d ��rZ|
�d|d d
� � n td| ���q W |�r||
�d� |�r*x�|D ]�}| �|�}|�d��r�|
�|� nv|�d��r�|
�d|d d
� � nR|�d��r�|
�|� n:|�d ��r|
�d|d d
� � ntd| j|dd� ���q�W |�r�xP|D ]H}| �|�}|�d��sr|�d ��srtd| j|dd� ��|
�|� �q6W |�r�x&|D ] }| �|�}|
�d| � �q�W | j d |
�� S ) aA
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.
s resets resetkeyss resetpasss ons offz@Cannot set 'nopass' and supply 'passwords' or 'hashed_passwords'� +s >%srL N� -s <%szBPassword %d must be prefixeed with a "+" to add or a "-" to removes #%ss !%szIHashed %d password must be prefixeed with a "+" to add or a "-" to removes nopasss +@s +@%ss -@s -@%sz.Category "%s" must be prefixed with "+" or "-"T)�forcez-Command "%s" must be prefixed with "+" or "-"s ~%s� ACL SETUSER)rb )
r� � get_encoderrZ r r � enumerate�encoderW �decoderN )r. r r� Znopassr� Zhashed_passwordsr� r� r �resetZ
reset_keysZreset_passwords�encoderrR r� r Zhashed_passwordrQ �cmdr] r r r � acl_setuser( sx ?
zRedis.acl_setuserc C s
| � d�S )z5Returns a list of all registered users on the server.z ACL USERS)rN )r. r r r � acl_users� s zRedis.acl_usersc C s
| � d�S )z+Get the username for the current connectionz
ACL WHOAMI)rN )r. r r r �
acl_whoami� s zRedis.acl_whoamic C s
| � d�S )zBTell the Redis server to rewrite the AOF file from data in memory.Z BGREWRITEAOF)rN )r. r r r � bgrewriteaof� s zRedis.bgrewriteaofc C s
| � d�S )z�
Tell the Redis server to save its data to disk. Unlike save(),
this method is asynchronous and returns immediately.
ZBGSAVE)rN )r. r r r �bgsave� s z Redis.bgsavec C s | � d|�S )z/Disconnects the client at ``address`` (ip:port)z CLIENT KILL)rN )r. Zaddressr r r � client_kill� s zRedis.client_killc C s� g }|dk r<d}t |��� |kr.td|f ��|�d|f� |dk rpt|t�sVtd��|rf|�d� n
|�d� |dk r�|�d|f� |dk r�|�d |f� |dk r�|�d
|f� |s�td ��| jd
|�� S )aR
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
:param laddr: Kills a cient by its 'local (bind) address:port'
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
N)�normalrg rh r< z"CLIENT KILL type must be one of %rs TYPEz!CLIENT KILL skipme must be a bool)s SKIPMEs YES)s SKIPMEs NOs IDs ADDRs LADDRzVCLIENT KILL <filter> <value> ... ... <filter> <value> must specify at least one filter� CLIENT KILL)rq )r �lowerr r r r� rN )r. Z_id�_typer� ZskipmeZladdrr � client_typesr r r �client_kill_filter� s,
zRedis.client_kill_filterc C s
| � d�S )za
Returns information and statistics about the current
client connection.
z CLIENT INFO)rN )r. r r r r� � s zRedis.client_infoc C sl g }|dk rBd}t |��� |kr.td|f ��|�d� |�|� |dk r^|�d� |�|� | jd|�� S )z�
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)
N)rp rg Zreplicar< z#CLIENT LIST _type must be one of %rs TYPEs ID� CLIENT LIST)rv )r rr r rZ rN )r. rs � client_idr rt r r r � client_list� s
zRedis.client_listc C s
| � d�S )z#Returns the current connection namezCLIENT GETNAME)rN )r. r r r �client_getname s zRedis.client_getnamec C s
| � d�S )z!Returns the current connection idz CLIENT ID)rN )r. r r r rw s zRedis.client_idc C s | � d|�S )z Sets the current connection namezCLIENT SETNAME)rN )r. rn r r r �client_setname s zRedis.client_setnamec C s$ dt |�g}|r|�d� | j|� S )z�
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.
zCLIENT UNBLOCKs ERROR)r! rZ rN )r. rw �errorr r r r �client_unblock s
zRedis.client_unblockc C s" t |t�std��| �dt|��S )z�
Suspend all the Redis clients for the specified amount of time
:param timeout: milliseconds to pause clients
z'CLIENT PAUSE timeout must be an integerz CLIENT PAUSE)r r! r rN r )r. r7 r r r � client_pause, s
zRedis.client_pausec C s
| � d�S )z+
Unpause all redis clients
zCLIENT UNPAUSE)rN )r. r r r �client_unpause5 s zRedis.client_unpausec C s
| � d�S )zDDisables read queries for a connection to a Redis Cluster slave nodeZ READWRITE)rN )r. r r r � readwrite; s zRedis.readwritec C s
| � d�S )zEEnables read queries for a connection to a Redis Cluster replica nodeZREADONLY)rN )r. r r r �readonly? s zRedis.readonly�*c C s | � d|�S )z=Return a dictionary of configuration based on the ``pattern``z
CONFIG GET)rN )r. �patternr r r �
config_getC s zRedis.config_getc C s | � d||�S )z'Set config item ``name`` with ``value``z
CONFIG SET)rN )r. rn rO r r r �
config_setG s zRedis.config_setc C s
| � d�S )zReset runtime statisticszCONFIG RESETSTAT)rN )r. r r r �config_resetstatK s zRedis.config_resetstatc C s
| � d�S )zERewrite config file with the minimal change to reflect running configzCONFIG REWRITE)rN )r. r r r �config_rewriteO s zRedis.config_rewritec C s
| � d�S )z2Returns the number of keys in the current databaseZDBSIZE)rN )r. r r r �dbsizeS s z Redis.dbsizec C s | � d|�S )z;Returns version specific meta information about a given keyz DEBUG OBJECT)rN )r. r] r r r � debug_objectW s zRedis.debug_objectc C s | � d|�S )z$Echo the string back from the serverZECHO)rN )r. rO r r r �echo[ s z
Redis.echoc C s g }|r|� d� | jd|�� S )z�
Delete all keys in all databases on the current host.
``asynchronous`` indicates whether the operation is
executed asynchronously by the server.
s ASYNC�FLUSHALL)r� )rZ rN )r. � asynchronousr r r r �flushall_ s
zRedis.flushallc C s g }|r|� d� | jd|�� S )z�
Delete all keys in the current database.
``asynchronous`` indicates whether the operation is
executed asynchronously by the server.
s ASYNC�FLUSHDB)r� )rZ rN )r. r� r r r r �flushdbk s
z
Redis.flushdbc C s | � d||�S )zSwap two databasesZSWAPDB)rN )r. r� �secondr r r �swapdbw s z Redis.swapdbc C s" |dkr| � d�S | � d|�S dS )a,
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
Nr� )rN )r. Zsectionr r r r[ { s
z
Redis.infoc C s
| � d�S )zy
Return a Python datetime object representing the last time the
Redis database was saved to disk
r� )rN )r. r r r �lastsave� s zRedis.lastsavec
C s| t |g �}|std��g } |r(| �d� |r6| �d� |rN| �d� | �|� | �d� | �|� | jd||d||f| �� 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.
z!MIGRATE requires at least one keys COPYs REPLACEs AUTHs KEYSZMIGRATEr� )r r rZ r rN )
r. r rd r �destination_dbr7 �copy�replaceZauthrR r r r �migrate� s
z
Redis.migratec C s | j d|||d�S )z8Return the encoding, idletime, or refcount about the keyr� )rG )rN )r. rG r] r r r �object� s z Redis.objectc C s
| � d�S )z#Return a dictionary of memory statsz MEMORY STATS)rN )r. r r r � memory_stats� s zRedis.memory_statsc C s. g }t |t�r |�d|g� | jd|f|�� S )a'
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.
s SAMPLESz MEMORY USAGE)r r! r rN )r. r] Zsamplesr r r r � memory_usage� s
zRedis.memory_usagec C s
| � d�S )z:Attempts to purge dirty pages for reclamation by allocatorz MEMORY PURGE)rN )r. r r r � memory_purge� s zRedis.memory_purgec C s
| � d�S )zPing the Redis serverr� )rN )r. r r r r� � s z
Redis.pingc C s
| � d�S )zm
Tell the Redis server to save its data to disk,
blocking until the save is complete
�SAVE)rN )r. r r r �save� s z
Redis.savec G s t �td�� dS )z"Redis Sentinel's SENTINEL command.z%Use the individual sentinel_* methodsN)r r r )r. r r r r ri � s zRedis.sentinelc C s | � d|�S )z:Returns a (host, port) pair for the given ``service_name``z SENTINEL GET-MASTER-ADDR-BY-NAME)rN )r. � service_namer r r � sentinel_get_master_addr_by_name� s z&Redis.sentinel_get_master_addr_by_namec C s | � d|�S )z<Returns a dictionary containing the specified masters state.zSENTINEL MASTER)rN )r. r� r r r �sentinel_master� s zRedis.sentinel_masterc C s
| � d�S )z>Returns a list of dictionaries containing each master's state.zSENTINEL MASTERS)rN )r. r r r �sentinel_masters� s zRedis.sentinel_mastersc C s | � d||||�S )z,Add a new master to Sentinel to be monitoredzSENTINEL MONITOR)rN )r. rn Ziprd re r r r �sentinel_monitor� s zRedis.sentinel_monitorc C s | � d|�S )z*Remove a master from Sentinel's monitoringzSENTINEL REMOVE)rN )r. rn r r r �sentinel_remove� s zRedis.sentinel_removec C s | � d|�S )z0Returns a list of sentinels for ``service_name``zSENTINEL SENTINELS)rN )r. r� r r r �sentinel_sentinels� s zRedis.sentinel_sentinelsc C s | � d|||�S )z5Set Sentinel monitoring parameters for a given masterz SENTINEL SET)rN )r. rn ZoptionrO r r r � sentinel_set� s zRedis.sentinel_setc C s | � d|�S )z-Returns a list of slaves for ``service_name``zSENTINEL SLAVES)rN )r. r� r r r �sentinel_slaves� s zRedis.sentinel_slavesc C sb |r|rt d��dg}|r$|�d� |r2|�d� y| j|� W n tk
rT dS X td��dS )an 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.
z+SHUTDOWN save and nosave cannot both be setZSHUTDOWNr� ZNOSAVENz SHUTDOWN seems to have failed.)r rZ rN r r )r. r� Znosaver r r r �shutdown� s
zRedis.shutdownc C s, |dkr |dkr | � ddd�S | � d||�S )z�
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.
NZSLAVEOFs NOs ONE)rN )r. r rd r r r �slaveof s z
Redis.slaveofc C s8 dg}|dk r|� |� | jj�dd�}| j|d|i�S )zw
Get the entries from the slowlog. If ``num`` is specified, get the
most recent ``num`` items.
z SLOWLOG GETNr� F)rZ r� Zconnection_kwargsr8 rN )r. �numr r� r r r � slowlog_get s
zRedis.slowlog_getc C s
| � d�S )z&Get the number of items in the slowlogz SLOWLOG LEN)rN )r. r r r � slowlog_len* s zRedis.slowlog_lenc C s
| � d�S )z Remove all items in the slowlogz
SLOWLOG RESET)rN )r. r r r �
slowlog_reset. s zRedis.slowlog_resetc C s
| � d�S )z�
Returns the server time as a 2-item tuple of ints:
(seconds since epoch, microseconds into this second).
r� )rN )r. r r r r2 2 s z
Redis.timec C s | � d||�S )z�
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.
ZWAIT)rN )r. Z num_replicasr7 r r r �wait9 s z
Redis.waitc C s | � d||�S )z�
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``.
ZAPPEND)rN )r. r] rO r r r rZ C s z Redis.appendc C sb |g}|dk r,|dk r,|� |� |� |� n(|dk r<|dksL|dk rT|dkrTtd��| jd|�� S )z�
Returns the count of set bits in the value of ``key``. Optional
``start`` and ``end`` parameters indicate which bytes to consider
Nz$Both start and end must be specified�BITCOUNT)r� )rZ r rN )r. r] �start�end�paramsr r r �bitcountK s
zRedis.bitcountc C s t | ||d�S )z�
Return a BitFieldOperation instance to conveniently construct one or
more bitfield operations on ``key``.
)�default_overflow)�BitFieldOperation)r. r] r� r r r �bitfieldY s zRedis.bitfieldc G s | j d||f|�� S )z|
Perform a bitwise operation using ``operation`` between ``keys`` and
store the result in ``dest``.
ZBITOP)rN )r. Z operation�destr r r r �bitop` s z Redis.bitopc C sl |dkrt d��||g}|dk o(|�|� |dk rF|dk rF|�|� n|dkr^|dk r^t d��| jd|�� 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.
)r rL zbit must be 0 or 1Nz0start argument is not set, when end is specified�BITPOS)r� )r rZ rN )r. r] �bitr� r� r� r r r �bitposg s z Redis.bitposc C s: ||g}|dk r |� d|g� |r,|�d� | jd|�� 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.
NZDB�REPLACE�COPY)r� )r rZ rN )r. �sourceZ destinationr� r� r� r r r r� { s
z
Redis.copyrL c C s | � ||�S )z�
Decrements the value of ``key`` by ``amount``. If no key exists,
the value will be initialized as 0 - ``amount``
)�decrby)r. rn �amountr r r �decr� s z
Redis.decrc C s | � d||�S )z�
Decrements the value of ``key`` by ``amount``. If no key exists,
the value will be initialized as 0 - ``amount``
ZDECRBY)rN )r. rn r� r r r r� � s z Redis.decrbyc G s | j d|�� S )z.Delete one or more keys specified by ``names``�DEL)r� )rN )r. �namesr r r �delete� s z Redis.deletec C s | � |� d S )N)r� )r. rn r r r r6 � s zRedis.__delitem__c C s | � d|�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.
ZDUMP)rN )r. rn r r r �dump� s z
Redis.dumpc G s | j d|�� S )z*Returns the number of ``names`` that exist�EXISTS)r� )rN )r. r� r r r �exists� s z Redis.existsc C s& t |tj�rt|�� �}| �d||�S )z�
Set an expire flag on key ``name`` for ``time`` seconds. ``time``
can be represented by an integer or a Python timedelta object.
ZEXPIRE)r r# � timedeltar! �
total_secondsrN )r. rn r2 r r r �expire� s z Redis.expirec C s, t |tj�r tt�|�� ��}| �d||�S )z�
Set an expire flag on key ``name``. ``when`` can be represented
as an integer indicating unix time or a Python datetime object.
ZEXPIREAT)r r# r! �mod_time�mktime� timetuplerN )r. rn �whenr r r �expireat� s zRedis.expireatc C s | � d|�S )zT
Return the value at key ``name``, or None if the key doesn't exist
�GET)rN )r. rn r r r r8 � s z Redis.getc C s | � d|�S )z�
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).
ZGETDEL)rN )r. rn r r r �getdel� s z Redis.getdelc C sh t ||||g�}t|�dks,t|�dkr6|r6tdd��g }|dk rn|�d� t|tj�rdt|�� �}|�|� |dk r�|�d� t|tj�r�t|�� d �}|�|� |dk r�|�d � t|tj�r�t|j d
�} tt
� |� � ��| }|�|� |dk �rF|�d � t|tj��r<t|j d �}
tt
� |� � ��d |
}|�|� |�rV|�d � | j
d
|f|�� 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``.
rx rL z"``ex``, ``px``, ``exat``, ``pxat``z'and ``persist`` are mutually exclusive.N�EX�PXi� ZEXATi@B ZPXAT�PERSISTZGETEX)rl �lenr rZ r r# r� r! r� � microsecondr� r� r� rN ) r. rn �ex�pxZexatZpxat�persistZopsetrR �s�msr r r �getex� s<
z Redis.getexc C s" | � |�}|dk r|S t|��dS )zg
Return the value at key ``name``, raises a KeyError if the key
doesn't exist.
N)r8 �KeyError)r. rn rO r r r r7 s
zRedis.__getitem__c C s | � d||�S )z@Returns a boolean indicating the value of ``offset`` in ``name``ZGETBIT)rN )r. rn �offsetr r r �getbit s z Redis.getbitc 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)
ZGETRANGE)rN )r. r] r� r� r r r �getrange s zRedis.getrangec C s | � d||�S )z�
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.
ZGETSET)rN )r. rn rO r r r �getset s z Redis.getsetc C s | � ||�S )z�
Increments the value of ``key`` by ``amount``. If no key exists,
the value will be initialized as ``amount``
)�incrby)r. rn r� r r r �incr( s z
Redis.incrc C s | � d||�S )z�
Increments the value of ``key`` by ``amount``. If no key exists,
the value will be initialized as ``amount``
�INCRBY)rN )r. rn r� r r r r� / s z Redis.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``
Z INCRBYFLOAT)rN )r. rn r� r r r � incrbyfloat8 s zRedis.incrbyfloatc C s | � d|�S )z+Returns a list of keys matching ``pattern``ZKEYS)rN )r. r� r r r r ? s z
Redis.keys�LEFT�RIGHTc C s ||||g}| j d|�� S )z�
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.
�LMOVE)r� )rN )r. �
first_list� second_list�srcr� r� r r r �lmoveC s z Redis.lmovec C s |||||g}| j d|�� S )z,
Blocking version of lmove.
�BLMOVE)r� )rN )r. r� r� r7 r� r� r� r r r �blmoveL s z Redis.blmovec G s* t ||�}i }|sg |t< | jd|�|�S )zJ
Returns a list of values ordered identically to ``keys``
�MGET)r� )r r rN )r. r r r r r r �mgetT s
z
Redis.mgetc C s. g }x|� � D ]}|�|� qW | jd|�� S )z�
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().
�MSET)r� )r, r rN )r. �mappingr, r� r r r �mset^ s z
Redis.msetc C s. g }x|� � D ]}|�|� qW | jd|�� S )a3
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.
�MSETNX)r� )r, r rN )r. r� r, r� r r r �msetnxi s z Redis.msetnxc C s | � d||�S )z;Moves the key ``name`` to a different Redis database ``db``ZMOVE)rN )r. rn r� r r r �moveu s z
Redis.movec C s | � d|�S )z!Removes an expiration on ``name``r� )rN )r. rn r r r r� y s z
Redis.persistc C s* t |tj�r t|�� d �}| �d||�S )z�
Set an expire flag on key ``name`` for ``time`` milliseconds.
``time`` can be represented by an integer or a Python timedelta
object.
i� ZPEXPIRE)r r# r� r! r� rN )r. rn r2 r r r �pexpire} s z
Redis.pexpirec C sB t |tj�r4t|jd �}tt�|�� ��d | }| �d||�S )z�
Set an expire flag on key ``name``. ``when`` can be represented
as an integer representing unix time in milliseconds (unix time * 1000)
or a Python datetime object.
i� Z PEXPIREAT)r r# r! r� r� r� r� rN )r. rn r� r� r r r � pexpireat� s zRedis.pexpireatc C s, t |tj�r t|�� d �}| �d|||�S )z�
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
i� ZPSETEX)r r# r� r! r� rN )r. rn Ztime_msrO r r r �psetex� s z Redis.psetexc C s | � d|�S )zEReturns the number of milliseconds until the key ``name`` will expireZPTTL)rN )r. rn r r r �pttl� s z
Redis.pttlc C s6 g }|dk r|� |� |r$|� d� | jd|f|�� S )a)
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.
NZ
WITHVALUESZ
HRANDFIELD)rZ rN )r. r] rY Z
withvaluesr� r r r �
hrandfield� s
zRedis.hrandfieldc C s
| � d�S )z Returns the name of a random keyr� )rN )r. r r r � randomkey� s zRedis.randomkeyc C s | � d||�S )z/
Rename key ``src`` to ``dst``
ZRENAME)rN )r. r� �dstr r r �rename� s z Redis.renamec C s | � d||�S )z>Rename key ``src`` to ``dst`` if ``dst`` doesn't already existZRENAMENX)rN )r. r� r� r r r �renamenx� s zRedis.renamenxc C s4 |||g}|r|� d� |r&|� d� | jd|�� 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).
r� ZABSTTL�RESTORE)r� )rZ rN )r. rn �ttlrO r� Zabsttlr� r r r �restore� s
z
Redis.restorec C s� ||g} i }
|dk r@| � d� t|tj�r6t|�� �}| � |� |dk rx| � d� t|tj�rnt|�� d �}| � |� |r�| � d� |r�| � d� |r�| � d� |r�| � d� d |
d
< | jd | �|
�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 when key did not exist.
(Available since Redis 6.2)
Nr� r� i� ZNXZXXZKEEPTTLr� Tr8 r� )r� )rZ r r# r� r! r� rN ) r. rn rO r� r� �nx�xxZkeepttlr8 rR r r r r rl � s,
z Redis.setc C s | � ||� d S )N)rl )r. rn rO r r r r: s zRedis.__setitem__c C s |rdp
d}| � d|||�S )z�
Flag the ``offset`` in ``name`` as ``value``. Returns a boolean
indicating the previous value of ``offset``.
rL r ZSETBIT)rN )r. rn r� rO r r r �setbit s z Redis.setbitc 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.
ZSETEX)r r# r� r! r� rN )r. rn r2 rO r r r �setex s z Redis.setexc C s | � d||�S )z?Set the value of key ``name`` to ``value`` if key doesn't existZSETNX)rN )r. rn rO r r r �setnx s z Redis.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.
ZSETRANGE)rN )r. rn r� rO r r r �setrange s zRedis.setrangec C s | � d|�S )z:Return the number of bytes stored in the value of ``name``ZSTRLEN)rN )r. rn r r r �strlen, s z Redis.strlenrS 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.
ZSUBSTR)rN )r. rn r� r� r r r �substr0 s z Redis.substrc G s | j d|�� S )zs
Alters the last access time of a key(s) ``*args``. A key is ignored
if it does not exist.
�TOUCH)r )rN )r. r r r r �touch7 s z Redis.touchc C s | � d|�S )z@Returns the number of seconds until the key ``name`` will expireZTTL)rN )r. rn r r r r� > s z Redis.ttlc C s | � d|�S )z Returns the type of key ``name``ZTYPE)rN )r. rn r r r r� B s z
Redis.typec G s t �td�� dS )zX
Watches the values at keys ``names``, or None if the key doesn't exist
z!Call WATCH from a Pipeline objectN)r r r )r. r� r r r r0 F s z Redis.watchc C s t �td�� dS )zW
Unwatches the value at key ``name``, or None of the key doesn't exist
z#Call UNWATCH from a Pipeline objectN)r r r )r. r r r �unwatchL s z
Redis.unwatchc G s | j d|�� S )z.Unlink one or more keys specified by ``names``�UNLINK)r )rN )r. r� r r r �unlinkS s z Redis.unlinkc C s. |dkr d}t |d�}|�|� | jd|�� 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.
Nr �BLPOP)r )r rZ rN )r. r r7 r r r �blpopX s
z Redis.blpopc C s. |dkr d}t |d�}|�|� | jd|�� 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.
Nr �BRPOP)r )r rZ rN )r. r r7 r r r �brpopi s
z Redis.brpopc C s |dkr d}| � d|||�S )a
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.
Nr Z
BRPOPLPUSH)rN )r. r� r� r7 r r r �
brpoplpushz s zRedis.brpoplpushc 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
ZLINDEX)rN )r. rn �indexr r r �lindex� s z Redis.lindexc C s | � d||||�S )z�
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.
ZLINSERT)rN )r. rn �whereZrefvaluerO r r r �linsert� s z
Redis.linsertc C s | � d|�S )z&Return the length of the list ``name``ZLLEN)rN )r. rn r r r �llen� s z
Redis.llenc C s& |dk r| � d||�S | � d|�S dS )a9
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.
NZLPOP)rN )r. rn rY r r r �lpop� s z
Redis.lpopc G s | j d|f|�� S )z2Push ``values`` onto the head of the list ``name``ZLPUSH)rN )r. rn rz r r r �lpush� s z Redis.lpushc C s | � d||�S )zDPush ``value`` onto the head of the list ``name`` if ``name`` existsZLPUSHX)rN )r. rn rO r r r �lpushx� s z Redis.lpushxc C s | � d|||�S )z�
Return a slice of the list ``name`` between
position ``start`` and ``end``
``start`` and ``end`` can be negative numbers just like
Python slicing notation
ZLRANGE)rN )r. rn r� r� r r r �lrange� s z Redis.lrangec 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.
ZLREM)rN )r. rn rY rO r r r �lrem� s
z
Redis.lremc C s | � d|||�S )z.Set ``position`` of list ``name`` to ``value``ZLSET)rN )r. rn r rO r r r �lset� s z
Redis.lsetc C s | � d|||�S )z�
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
ZLTRIM)rN )r. rn r� r� r r r �ltrim� s z Redis.ltrimc C s& |dk r| � d||�S | � d|�S dS )a2
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.
NZRPOP)rN )r. rn rY r r r �rpop� s z
Redis.rpopc 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.
Z RPOPLPUSH)rN )r. r� r� r r r � rpoplpush� s zRedis.rpoplpushc G s | j d|f|�� S )z2Push ``values`` onto the tail of the list ``name``ZRPUSH)rN )r. rn rz r r r �rpush� s z Redis.rpushc C s | � d||�S )zDPush ``value`` onto the tail of the list ``name`` if ``name`` existsZRPUSHX)rN )r. rn rO r r r �rpushx� s z Redis.rpushxc C sX ||g}|dk r |� d|g� |dk r4|� d|g� |dk rJ|� d|g� | jd|�� S )a
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.
NZRANKZCOUNTZMAXLEN�LPOS)r# )r rN )r. rn rO ZrankrY �maxlenrR r r r �lpos� s z
Redis.lposc
C sV |dk r|dks |dk r(|dkr(t d��|g}
|dk rJ|
�d� |
�|� |dk rx|dk rx|
�d� |
�|� |
�|� |dk r�t|ttf�r�|
�d� |
�|� n"x |D ]} |
�d� |
�| � q�W |r�|
�d� |r�|
�d� |dk r�|
�d� |
�|� | �r0|�r(t|ttf��s(t|�d k �r0t d
��d | �r@t|�ndi} | jd
|
�| �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``.
Nz,``start`` and ``num`` must both be specifieds BYs LIMITs GETs DESCs ALPHAs STORErx zVwhen using "groups" the "get" argument must be specified and contain at least two keysr� r� )r� )r rZ r r r r� rN )
r. rn r� r� Zbyr8 �descZalphar� r� rR �gr r r r �sort s<
$z
Redis.sortc C sV |g}|dk r |� d|g� |dk r2|� d|g� |dk rH|� d|g� | jd|�� 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.
Ns MATCHs COUNTs TYPEr� )r� )r rN )r. r� �matchrY rs rR r r r �scan[ s z
Redis.scanc c s6 d}x,|dkr0| j ||||d�\}}|E dH qW dS )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) rY rs N)r* )r. r) rY rs r� r/ r r r � scan_iters s
zRedis.scan_iterc C sB ||g}|dk r |� d|g� |dk r4|� d|g� | jd|�� S )z�
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
Ns MATCHs COUNTr� )r� )r rN )r. rn r� r) rY rR r r r �sscan� s z Redis.sscanc c s6 d}x,|dkr0| j ||||d�\}}|E dH qW dS )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
r+ r )r� r) rY N)r- )r. rn r) rY r� r/ r r r �
sscan_iter� s
zRedis.sscan_iterc C sB ||g}|dk r |� d|g� |dk r4|� d|g� | jd|�� S )z�
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
Ns MATCHs COUNTr� )r� )r rN )r. rn r� r) rY rR r r r �hscan� s z Redis.hscanc c s: d}x0|dkr4| j ||||d�\}}|�� E dH qW dS )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
r+ r )r� r) rY N)r/ r, )r. rn r) rY r� r/ r r r �
hscan_iter� s
zRedis.hscan_iterc C sL ||g}|dk r |� d|g� |dk r4|� d|g� d|i}| jd|�|�S )aM
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
Ns MATCHs COUNTr~ r� )r� )r rN )r. rn r� r) rY r~ rR r r r r �zscan� s z Redis.zscanc c s8 d}x.|dkr2| j |||||d�\}}|E dH qW dS )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
r+ r )r� r) rY r~ N)r1 )r. rn r) rY r~ r� r/ r r r �
zscan_iter� s
zRedis.zscan_iterc G s | j d|f|�� S )z Add ``value(s)`` to set ``name``ZSADD)rN )r. rn rz r r r �sadd� s z
Redis.saddc C s | � d|�S )z-Return the number of elements in set ``name``ZSCARD)rN )r. rn r r r �scard� s z Redis.scardc G s t ||�}| jd|�� S )z3Return the difference of sets specified by ``keys``�SDIFF)r5 )r rN )r. r r r r r �sdiff� s
z Redis.sdiffc G s t ||�}| jd|f|�� 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.
Z
SDIFFSTORE)r rN )r. r� r r r r r �
sdiffstore� s
zRedis.sdiffstorec G s t ||�}| jd|�� S )z5Return the intersection of sets specified by ``keys``�SINTER)r8 )r rN )r. r r r r r �sinter
s
z Redis.sinterc G s t ||�}| jd|f|�� 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.
Z SINTERSTORE)r rN )r. r� r r r r r � sinterstore
s
zRedis.sinterstorec C s | � d||�S )zDReturn a boolean indicating if ``value`` is a member of set ``name``Z SISMEMBER)rN )r. rn rO r r r � sismember
s zRedis.sismemberc C s | � d|�S )z&Return all members of the set ``name``ZSMEMBERS)rN )r. rn r r r �smembers
s zRedis.smembersc C s | � d|||�S )z9Move ``value`` from set ``src`` to set ``dst`` atomicallyZSMOVE)rN )r. r� r� rO r r r �smove
s z Redis.smovec C s$ |dk r|gpg }| j d|f|�� S )z1Remove and return a random member of set ``name``NZSPOP)rN )r. rn rY r r r r �spop
s z
Redis.spopc C s$ |dk r|gpg }| j d|f|�� S )z�
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+.
NZ SRANDMEMBER)rN )r. rn �numberr r r r � srandmember!
s zRedis.srandmemberc G s | j d|f|�� S )z#Remove ``values`` from set ``name``ZSREM)rN )r. rn rz r r r �srem,
s z
Redis.sremc G s t ||�}| jd|�� S )z.Return the union of sets specified by ``keys``�SUNION)rB )r rN )r. r r r r r �sunion0
s
z Redis.sunionc G s t ||�}| jd|f|�� 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.
Z SUNIONSTORE)r rN )r. r� r r r r r � sunionstore5
s
zRedis.sunionstorec G s | j d||f|�� S )z�
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.
ZXACK)rN )r. rn � groupname�idsr r r �xack>
s z
Redis.xackc C s� g }|dk rLt |t�r |dk r&td��|�d� |r>|�d� |�t|�� |rZ|�d� |�|� t |t�rzt|�dkr�td��x|�� D ]}|�|� q�W | j d |f|�� 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
approximate: actual stream length may be slightly more than maxlen
nomkstream: When set to true, do not make a stream
NrL z&XADD maxlen must be a positive integers MAXLEN� ~s
NOMKSTREAMr z$XADD fields must be a non-empty dictZXADD)
r r! r rZ r r& r� r, r rN ) r. rn Zfieldsr� r$ � approximateZ
nomkstreamrR r� r r r �xaddG
s
z
Redis.xaddc
C s� yt |�dk rtd��W n tk
r, Y nX i }|||||g} y&t |�dk rVtd��| �d|g� W n tk
rz Y nX |r�| �d� d|d< | jd | �|�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
r z6XAUTOCLAIM min_idle_time must be a nonnegative integerz%XPENDING count must be a integer >= 0s COUNTs JUSTIDTr� r� )r� )r! r r r rZ rN )
r. rn rE � consumername�
min_idle_timeZstart_idrY �justidrb rR r r r �
xautoclaimc
s"
zRedis.xautoclaimc
C s6 t |t�r|dk rtd��t |ttf�r,|s4td��i } |||t|�g} | �t|�� |dk r�t |t�sptd��| �dt|�f� |dk r�t |t�s�td��| �dt|�f� |dk r�t |t�s�td ��| �d
t|�f� | r�t | t�s�td ��| �d � |
�r&t |
t��std
��| �d� d| d< | j d| �| �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
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 booleans JUSTIDTr� r� )r� )
r r! r r r� r r r� rZ rN )
r. rn rE rK rL Z message_idsr� r2 Z
retrycountra rM rb rR r r r �xclaim�
s:
z Redis.xclaimc G s | j d|f|�� S )z�
Deletes one or more messages from a stream.
name: name of the stream.
*ids: message ids to delete.
ZXDEL)rN )r. rn rF r r r �xdel�
s z
Redis.xdel�$c C s$ d|||g}|r|� d� | j|� S )z�
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.
z
XGROUP CREATEs MKSTREAM)rZ rN )r. rn rE r� ZmkstreamrR r r r �
xgroup_create�
s
zRedis.xgroup_createc C s | � d|||�S )a)
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
zXGROUP DELCONSUMER)rN )r. rn rE rK r r r �xgroup_delconsumer�
s
zRedis.xgroup_delconsumerc C s | � d||�S )z|
Destroy a consumer group.
name: name of the stream.
groupname: name of the consumer group.
zXGROUP DESTROY)rN )r. rn rE r r r �xgroup_destroy�
s zRedis.xgroup_destroyc C s | � d|||�S )z�
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.
z XGROUP SETID)rN )r. rn rE r� r r r � xgroup_setid�
s zRedis.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.
zXINFO CONSUMERS)rN )r. rn rE r r r �xinfo_consumers�
s zRedis.xinfo_consumersc C s | � d|�S )zx
Returns general information about the consumer groups of the stream.
name: name of the stream.
z XINFO GROUPS)rN )r. rn r r r � xinfo_groups s zRedis.xinfo_groupsc C s | � d|�S )za
Returns general information about the stream.
name: name of the stream.
z XINFO STREAM)rN )r. rn r r r � xinfo_stream s zRedis.xinfo_streamc C s | � d|�S )zC
Returns the number of elements in a given stream.
ZXLEN)rN )r. rn r r r �xlen s z
Redis.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.
r� )rN )r. rn rE r r r �xpending s zRedis.xpendingc C s� |||hdhkr4|dk s |dk r(t d��| �||�S ||g}|dksT|dksT|dkr\t d��y&t|�dk rrt d��|�d|g� W n tk
r� Y nX y(t|�dk r�t d��|�|||g� W n tk
r� Y nX | jd |�d d
i�S ) a�
Returns information about pending messages, in a range.
name: name of the stream.
groupname: name of the consumer group.
min: minimum stream ID.
max: maximum stream ID.
count: number of messages to return
consumername: name of a consumer to filter by (optional).
idle: available from version 6.2. filter entries by their
idle-time, given in milliseconds (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 >= 0ZIDLEz%XPENDING count must be a integer >= 0r� r� T)r� )r rZ r! r r rN ) r. rn rE r� r� rY rK r� rR r r r �xpending_range s(
zRedis.xpending_ranger� �+c C sT ||g}|dk rBt |t�r"|dk r*td��|�d� |�t|�� | jd|f|�� 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.
NrL z'XRANGE count must be a positive integers COUNTZXRANGE)r r! r rZ r rN )r. rn r� r� rY rR r r r �xrangeE s
z Redis.xrangec C s� g }|dk r>t |t�r |dk r&td��|�d� |�t|�� |dk rxt |t�rX|dk r`td��|�d� |�t|�� t |t�r�t|�dkr�td��|�d � t|�� � \}}|� |� |� |� | j
d |�� S ) an
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.
Nr z*XREAD block must be a non-negative integers BLOCKrL z&XREAD count must be a positive integers COUNTz&XREAD streams must be a non empty dicts STREAMS�XREAD)r^ ) r r! r rZ r r& r� ry r, r rN )r. �streamsrY �blockrR r rz r r r �xreadY s$
z Redis.xreadc C s� d||g}|dk rDt |t�r$|dk r,td��|�d� |�t|�� |dk r~t |t�r^|dk rftd��|�d� |�t|�� |r�|�d � t |t�r�t|�dkr�td
��|�d � |�|�� � |�|� � � | j
d
|�� 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
s GROUPNrL z+XREADGROUP count must be a positive integers COUNTr z/XREADGROUP block must be a non-negative integers BLOCKs NOACKz+XREADGROUP streams must be a non empty dicts STREAMS�
XREADGROUP)rb ) r r! r rZ r r& r� r r rz rN )r. rE rK r_ rY r` ZnoackrR r r r �
xreadgroupu s&
zRedis.xreadgroupc C sT ||g}|dk rBt |t�r"|dk r*td��|�d� |�t|�� | jd|f|�� 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.
NrL z*XREVRANGE count must be a positive integers COUNTZ XREVRANGE)r r! r rZ r rN )r. rn r� r� rY rR r r r � xrevrange� s
zRedis.xrevrangec C s� g }|dk r |dk r t dd��|dk r0|�d� |dk rB|�d� |rP|�d� |dk rb|�|� |dk rt|�|� |dk r�|�d� |�|� | jd|f|�� S ) aV
Trims old messages from a stream.
name: name of the stream.
maxlen: truncate old stream messages beyond this size
approximate: actual stream length may be slightly more than maxlen
minin: the minimum id in the stream to query
limit: specifies the maximum number of entries to retrieve
Nz'Only one of ```maxlen``` or ```minid```zmay be specifieds MAXLENs MINIDrH s LIMITZXTRIM)r rZ rN )r. rn r$ rI Zminid�limitrR r r r �xtrim� s$
z Redis.xtrimc C s� |s t d��|r |r t d��|r4t|�dkr4t d��|dkrT|dk sL|dk rTt d��g } i }
|rj| �d� |rx| �d � |r�| �d
� |r�| �d � d|
d < |r�| �d
� |r�| �d� x,|�� D ] } | �| d � | �| d � q�W | jd|f| �|
�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 bothrL zFZADD option 'incr' only works when passing a single element/score pairTNz/Only one of 'nx', 'lt', or 'gr' may be defined.s NXs XXs CHs INCRr� s GTs LTr r� )r r� rZ r, rN ) r. rn r� r r Zchr� �gt�ltrR r r� r r r �zadd� s6 "
z
Redis.zaddc C s | � d|�S )z8Return the number of elements in the sorted set ``name``ZZCARD)rN )r. rn r r r �zcard s z Redis.zcardc C s | � d|||�S )z�
Returns the number of elements in the sorted set at key ``name`` with
a score between ``min`` and ``max``.
ZZCOUNT)rN )r. rn r� r� r r r �zcount s z Redis.zcountc C s* t |�f|�}|r |�d� | jd|�� S )z}
Returns the difference between the first and all successive input
sorted sets provided in ``keys``.
�
WITHSCORES�ZDIFF)rm )r� rZ rN )r. r r} rR r r r �zdiff s
z Redis.zdiffc C s t |�f|�}| jd|f|�� S )z�
Computes the difference between the first and all successive input
sorted sets provided in ``keys`` and stores the result in ``dest``.
Z
ZDIFFSTORE)r� rN )r. r� r rR r r r �
zdiffstore s zRedis.zdiffstorec C s | � d|||�S )zEIncrement the score of ``value`` in sorted set ``name`` by ``amount``ZZINCRBY)rN )r. rn r� rO r r r �zincrby( s z
Redis.zincrbyc C s | j dd|||d�S )a�
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.
ZZINTERN)r} )� _zaggregate)r. r � aggregater} r r r �zinter, s
z Redis.zinterc 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.
Z ZINTERSTORE)rq )r. r� r rr r r r � zinterstore9 s
zRedis.zinterstorec C s | � d|||�S )z�
Return the number of items in the sorted set ``name`` between the
lexicographical range ``min`` and ``max``.
Z ZLEXCOUNT)rN )r. rn r� r� r r r � zlexcountE s zRedis.zlexcountc C s. |dk r|gpg }ddi}| j d|f|�|�S )zy
Remove and return up to ``count`` members with the highest scores
from the sorted set ``name``.
Nr} TZZPOPMAX)rN )r. rn rY r r r r r �zpopmaxL s z
Redis.zpopmaxc C s. |dk r|gpg }ddi}| j d|f|�|�S )zx
Remove and return up to ``count`` members with the lowest scores
from the sorted set ``name``.
Nr} TZZPOPMIN)rN )r. rn rY r r r r r �zpopminW s z
Redis.zpopminc C s6 g }|dk r|� |� |r$|� d� | jd|f|�� S )aQ
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.
Nrl Z ZRANDMEMBER)rZ rN )r. r] rY r} r� r r r � zrandmemberb s
zRedis.zrandmemberc C s. |dkr d}t |d�}|�|� | jd|�� S )aR
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.
Nr �BZPOPMAX)ry )r rZ rN )r. r r7 r r r �bzpopmaxx s
zRedis.bzpopmaxc C s. |dkr d}t |d�}|�|� | jd|�� S )aR
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.
Nr �BZPOPMIN)r{ )r rZ rN )r. r r7 r r r �bzpopmin� s
zRedis.bzpopminc C sF |r| � |||||�S d|||g}|r0|�d� ||d�}| j||�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 descendingly
``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
ZZRANGEs
WITHSCORES)r} r~ )� zrevrangerZ rN ) r. rn r� r� r& r} r~ rR r r r r �zrange� s
z Redis.zrangec C s | � d||||�S )z�
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.
Z ZRANGESTORE)rN )r. r� rn r� r� r r r � zrangestore� s zRedis.zrangestorec C s^ |dk r|dks |dk r(|dkr(t d��d|||g}|dk rT|dk rT|�d||g� | j|� S )z�
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.
Nz,``start`` and ``num`` must both be specifiedZ ZRANGEBYLEXs LIMIT)r r rN )r. rn r� r� r� r� rR r r r � zrangebylex� s zRedis.zrangebylexc C s^ |dk r|dks |dk r(|dkr(t d��d|||g}|dk rT|dk rT|�d||g� | j|� S )z�
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.
Nz,``start`` and ``num`` must both be specifiedZZREVRANGEBYLEXs LIMIT)r r rN )r. rn r� r� r� r� rR r r r �zrevrangebylex� s zRedis.zrevrangebylexc
C sx |dk r|dks |dk r(|dkr(t d��d|||g}|dk rT|dk rT|�d||g� |rb|�d� ||d�} | j|| �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
Nz,``start`` and ``num`` must both be specifiedZ
ZRANGEBYSCOREs LIMITs
WITHSCORES)r} r~ )r r rZ rN )
r. rn r� r� r� r� r} r~ rR r r r r �
zrangebyscore� s
zRedis.zrangebyscorec C s | � d||�S )zi
Returns a 0-based value indicating the rank of ``value`` in sorted set
``name``
ZZRANK)rN )r. rn rO r r r �zrank� s z Redis.zrankc G s | j d|f|�� S )z1Remove member ``values`` from sorted set ``name``ZZREM)rN )r. rn rz r r r �zrem
s z
Redis.zremc C s | � d|||�S )z�
Remove all elements in the sorted set ``name`` between the
lexicographical range specified by ``min`` and ``max``.
Returns the number of elements removed.
ZZREMRANGEBYLEX)rN )r. rn r� r� r r r �zremrangebylex
s zRedis.zremrangebylexc C s | � d|||�S )a
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
ZZREMRANGEBYRANK)rN )r. rn r� r� r r r �zremrangebyrank
s zRedis.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.
ZZREMRANGEBYSCORE)rN )r. rn r� r� r r r �zremrangebyscore
s zRedis.zremrangebyscorec C s0 d|||g}|r|� d� ||d�}| j||�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
Z ZREVRANGEs
WITHSCORES)r} r~ )rZ rN )r. rn r� r� r} r~ rR r r r r r}
s
zRedis.zrevrangec
C sx |dk r|dks |dk r(|dkr(t d��d|||g}|dk rT|dk rT|�d||g� |rb|�d� ||d�} | j|| �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
Nz,``start`` and ``num`` must both be specifiedZZREVRANGEBYSCOREs LIMITs
WITHSCORES)r} r~ )r r rZ rN )
r. rn r� r� r� r� r} r~ rR r r r r �zrevrangebyscore4
s
zRedis.zrevrangebyscorec C s | � d||�S )zt
Returns a 0-based value indicating the descending rank of
``value`` in sorted set ``name``
ZZREVRANK)rN )r. rn rO r r r �zrevrankP
s zRedis.zrevrankc C s | � d||�S )z<Return the score of element ``value`` in sorted set ``name``ZZSCORE)rN )r. rn rO r r r �zscoreW
s z Redis.zscorec C s | j dd|||d�S )z�
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.
ZZUNIONN)r} )rq )r. r rr r} r r r �zunion[
s z Redis.zunionc C s | � d|||�S )z�
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.
Z ZUNIONSTORE)rq )r. r� r rr r r r � zunionstoree
s zRedis.zunionstorec K s� |g}|d k r|� |� |� t|�� t|t�rD|�� |�� }}nd }|�|� |rj|� d� |�|� |r�|�� dkr�|� d� |� |� ntd��|� dd�r�|� d� | j
||�S )Ns WEIGHTS)ZSUMZMIN�MAXs AGGREGATEz!aggregate can be sum, min or max.r} Fs
WITHSCORES) rZ r� r r& r rz r r- r r8 rN )r. r� r� r rr r rR Zweightsr r r rq m
s&
zRedis._zaggregatec G s | j d|f|�� S )z9Adds the specified elements to the specified HyperLogLog.ZPFADD)rN )r. rn rz r r r �pfadd�
s z Redis.pfaddc G s | j d|�� S )zo
Return the approximated cardinality of
the set observed by the HyperLogLog at key(s).
�PFCOUNT)r� )rN )r. �sourcesr r r �pfcount�
s z
Redis.pfcountc G s | j d|f|�� S )z1Merge N different HyperLogLogs into a single one.ZPFMERGE)rN )r. r� r� r r r �pfmerge�
s z
Redis.pfmergec G s | j d|f|�� S )z"Delete ``keys`` from hash ``name``ZHDEL)rN )r. rn r r r r �hdel�
s z
Redis.hdelc C s | � d||�S )zCReturns a boolean indicating if ``key`` exists within hash ``name``ZHEXISTS)rN )r. rn r] r r r �hexists�
s z
Redis.hexistsc C s | � d||�S )z4Return the value of ``key`` within the hash ``name``ZHGET)rN )r. rn r] r r r �hget�
s z
Redis.hgetc C s | � d|�S )z3Return a Python dict of the hash's name/value pairsr� )rN )r. rn r r r �hgetall�
s z
Redis.hgetallc C s | � d|||�S )z=Increment the value of ``key`` in hash ``name`` by ``amount``ZHINCRBY)rN )r. rn r] r� r r r �hincrby�
s z
Redis.hincrbyc C s | � d|||�S )zX
Increment the value of ``key`` in hash ``name`` by floating ``amount``
Z HINCRBYFLOAT)rN )r. rn r] r� r r r � hincrbyfloat�
s zRedis.hincrbyfloatc C s | � d|�S )z,Return the list of keys within hash ``name``ZHKEYS)rN )r. rn r r r �hkeys�
s z Redis.hkeysc C s | � d|�S )z.Return the number of elements in hash ``name``ZHLEN)rN )r. rn r r r �hlen�
s z
Redis.hlenc C s` |dkr|st d��g }|dk r.|�||f� |rNx|�� D ]}|�|� q<W | jd|f|�� S )z�
Set ``key`` to ``value`` within hash ``name``,
``mapping`` accepts a dict of key/value pairs that will be
added to hash ``name``.
Returns the number of fields that were added.
Nz 'hset' with no key value pairsZHSET)r r r, rN )r. rn r] rO r� r, r� r r r �hset�
s z
Redis.hsetc 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.
ZHSETNX)rN )r. rn r] rO r r r �hsetnx�
s z Redis.hsetnxc C s^ t jd| jj| jjf tdd� |s,td��g }x|�� D ]}|�|� q:W | jd|f|�� S )z
Set key to value within hash ``name`` for each corresponding
key and value from the ``mapping`` dict.
z0%s.hmset() is deprecated. Use %s.hset() instead.rx )�
stacklevelz"'hmset' with 'mapping' of length 0ZHMSET) r r r5 r< r r r, r rN )r. rn r� r, r� r r r �hmset�
s z Redis.hmsetc G s t ||�}| jd|f|�� S )z8Returns a list of values ordered identically to ``keys``ZHMGET)r rN )r. rn r r r r r �hmget�
s
z Redis.hmgetc C s | � d|�S )z.Return the list of values within hash ``name``ZHVALS)rN )r. rn r r r �hvals�
s z Redis.hvalsc C s | � d||�S )zh
Return the number of bytes stored in the value of ``key``
within hash ``name``
ZHSTRLEN)rN )r. rn r] r r r �hstrlen�
s z
Redis.hstrlenc C s | � d||�S )z}
Publish ``message`` on ``channel``.
Returns the number of subscribers the message was delivered to.
ZPUBLISH)rN )r. �channel�messager r r �publish�
s z
Redis.publishc C s | � d|�S )zM
Return a list of channels that have at least one subscriber
zPUBSUB CHANNELS)rN )r. r� r r r �pubsub_channels�
s zRedis.pubsub_channelsc C s
| � d�S )zA
Returns the number of subscriptions to patterns
z
PUBSUB NUMPAT)rN )r. r r r �
pubsub_numpat s zRedis.pubsub_numpatc G s | j d|�� S )zv
Return a list of (channel, number of subscribers) tuples
for each channel given in ``*args``
�
PUBSUB NUMSUB)r� )rN )r. r r r r �
pubsub_numsub s zRedis.pubsub_numsubc G s | j d|�� f|�� S )Nz
CLUSTER %s)rN r- )r. Z cluster_argr r r r �cluster
s z
Redis.clusterc G s | j d||f|�� S )aP
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.
ZEVAL)rN )r. �script�numkeys�
keys_and_argsr r r �eval s z
Redis.evalc G s | j d||f|�� 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.
ZEVALSHA)rN )r. �shar� r� r r r �evalsha s
z
Redis.evalshac G s | j d|�� S )z�
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.
�
SCRIPT EXISTS)r� )rN )r. r r r r �
script_exists' s zRedis.script_existsc C s
| � d�S )z'Flush all scripts from the script cachez SCRIPT FLUSH)rN )r. r r r � script_flush/ s zRedis.script_flushc C s
| � d�S )z'Kill the currently executing Lua scriptz SCRIPT KILL)rN )r. r r r � script_kill3 s zRedis.script_killc C s | � d|�S )z=Load a Lua ``script`` into the script cache. Returns the SHA.z SCRIPT LOAD)rN )r. r� r r r � script_load7 s zRedis.script_loadc 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.
)�Script)r. r� r r r �register_script; s zRedis.register_scriptc G s* t |�d dkrtd��| jd|f|�� S )a
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.
r� r z4GEOADD requires places with lon, lat and name valuesZGEOADD)r� r rN )r. rn rz r r r �geoaddE s z Redis.geoaddc C s< |||g}|r |dkr t d��n|r.|�|� | jd|�� S )z�
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.
)r� �km�mi�ftzGEODIST invalid unit�GEODIST)r� )r rZ rN )r. rn Zplace1Zplace2�unitrR r r r �geodistQ s
z
Redis.geodistc G s | j d|f|�� S )z�
Return the geo hash string for each item of ``values`` members of
the specified key identified by the ``name`` argument.
r� )rN )r. rn rz r r r �geohash_ s z
Redis.geohashc G s | j d|f|�� S )z�
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.
r� )rN )r. rn rz r r r �geoposf s z Redis.geoposc
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.
r� )r� r� r� r� rY r( r� r� )�_georadiusgeneric)
r. rn Z longitudeZlatitude�radiusr� r� r� r� rY r( r� r� r r r � georadiusn s zRedis.georadiusc C s" | j d||||||||| |
| d� S )a3
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.
r� )r� r� r� r� rY r( r� r� )r� ) r. rn �memberr� r� r� r� r� rY r( r� r� r r r �georadiusbymember� s zRedis.georadiusbymemberc O s& t |�}|d r&|d dkr&td��n"|d r>|�|d � n
|�d� x"dD ]\}}|| rN|�|� qNW |d r�|�d|d g� |d r�|d d kr�|�d
� n |d d kr�|�d � ntd
��|d r�|d r�td��|d r�|�d|d g� |d �r|�d|d g� | j|f|�|�S )Nr� )r� r� r� r� zGEORADIUS invalid unitr� ))r� s WITHDIST)r� s WITHCOORD)r� s WITHHASHrY s COUNTr( ZASCs ASCZDESCs DESCzGEORADIUS invalid sortr� r� z3GEORADIUS store and store_dist cant be set togethers STOREs STOREDIST)r r rZ r rN )r. r� r rb rR Zarg_nameZ byte_reprr r r r� � s2
zRedis._georadiusgenericc C s | � d|�S )zv
Loads the module from ``path``.
Raises ``ModuleError`` if a module is not found at ``path``.
z MODULE LOAD)rN )r. r r r r � module_load� s zRedis.module_loadc C s | � d|�S )zs
Unloads the module ``name``.
Raises ``ModuleError`` if ``name`` is not in loaded modules.
z
MODULE UNLOAD)rN )r. rn r r r �
module_unload� s zRedis.module_unloadc C s
| � d�S )zo
Returns a list of dictionaries containing the name and version of
all loaded modules.
z MODULE LIST)rN )r. r r r � module_list� s zRedis.module_list)r r r NNNNNNNr r NNFFFNNr NFNFr NN)TN)Nr6 NNT)N)N)
FFNNNNNFFF)NNNNN)NN)F)r� )F)F)N)FFN)N)FF)NN)N)NN)N)NN)NF)rL )rL )NNNNF)rL )rL )r� )r� )r� r� )r� r� )NF)FF)NNFFFF)rS )r )r )r )N)N)NNN)NNNNFFNF)r NNN)NNN)r NN)NN)r NN)NN)N)N)r� NTF)r NF)NNNFF)rQ F)NN)r� r\ N)NN)NNF)r\ r� N)NTNN)FFFFNN)F)NF)N)N)N)NF)r )r )NN)NN)NF)N)N)rL )r� )NNN)r� )N)NFFFNNNN)NFFFNNNN(9 r< r= r> r? r* r� r! rM r� r� r� r� rF r� r� r r� r� r� r� r� r� r� r� rE r� r� r^ r% rc r� rH r� r� rw rr rt rv r� r� r� r� r� r� r� r� r� r! � classmethodr r2 r' r( r, r* r: r< r> r? r@ rE rF rA rN rJ rS rT rU rV rW rZ r\ r] r^ rj rk rl rm rn ro ru r� rx ry rw rz r| r} r~ r r� r� r� r� r� r� r� r� r� r� r� r[ r� r� r� r� r� r� r� r� ri r� r� r� r� r� r� r� r� r� r� r� r� r� r2 r� rZ r� r� r� r� r� r� r� r� r6 r� r� r4 r� r� r8 r� r� r7 r� r� r� r� r� r� r r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r rl r: r r r r r r r
r� r� r0 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/ r0 r1 r2 r3 r4 r6 r7 r9 r: r; r< r= r> r@ rA rC rD rG rJ rN rO rP rR rS rT rU rV rW rX rY rZ r[ r] ra rc rd rf ri rj rk rn ro rp rs rt ru rv rw rx rz r| r~ r r� r� r� r� r� r� r� r� r} r� r� r� r� r� rq 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� < sB
, : 2 % "
7
0
$ C ( : ( ! ?
$ (r� c @ sL e Zd ZdZe�d�Ze�d�Zdd� Zdd� Z dd � Z
d
d � Z d d
� Z dS )r= z�
Monitor is useful for handling the MONITOR command to the redis server.
next_command() method returns one command from monitor
listen() method yields commands from monitor.
z\[(\d+) (.*)\] (.*)z"(.*?)(?<!\\)"c C s || _ | j �d�| _d S )N�MONITOR)r� r r )r. r� r r r r2 � s zMonitor.__init__c C s. | j �d� | j �� }t|�s*td| ��| S )Nr� zMONITOR failed: %s)r rI rO r� r )r. r$ r r r r@ � s
zMonitor.__enter__c G s | j �� | j�| j � d S )N)r rK r� rG )r. r r r r rE � s
zMonitor.__exit__c C s� | j �� }t|t�r&| j jj|dd�}|�dd�\}}| j�|�}|� � \}}}d�
| j � |��}|�
dd�}|dkr�d}d} d}
n4|�d �r�d }|d
d � } d }
n|�d d�\}} d
}
t|�t|�|| |
|d�S )z)Parse the response from a monitor commandT)ra r� rL z\"�"Zluar� Zunix� NrA Ztcp)r2 r� �client_address� client_port� client_typer� )r rO r r rh rf r( �
monitor_rer) r� r� �
command_re�findallr� rW rN rM r! ) r. r$ Z command_timeZ command_datar� Zdb_idr� r� r� r� r� r r r � next_command� s0
zMonitor.next_commandc c s x| � � V qW dS )z)Listen for commands coming to the server.N)r� )r. r r r �listen! s zMonitor.listenN)
r< r= r> r? �re�compiler� r� r2 r@ rE r� r� r r r r r= � s
#r= c @ s� e Zd ZdZdZdZdZd5dd�Zd d
� Zd d � Z d
d� Z
dd� Z dd� Z dd� Z
edd� �Zdd� Zdd� Zd6d d �Zd d � Zd!d"� Zd#d$� Zd%d&� Zd'd(� Zd)d*� Zd+d,� Zd7d-d.�Zd8d/d0�Zd9d1d2�Z d:d3d4�Z dS );r; a*
PubSub provides publish, subscribe and listen support to Redis channels.
After subscribing to one or more channels, the listen() method will block
until a message arrives on one of the subscribed channels. That message
will be returned and it's safe to start listening again.
)r� �pmessage)� unsubscribe� punsubscribezredis-py-health-checkNFc C sZ || _ || _|| _d | _| j �� | _| jjr:d| jg| _nd| j� | j�g| _| �
� d S )Nr� s pong) r� r+ �ignore_subscribe_messagesr rc rh r� �HEALTH_CHECK_MESSAGE�health_check_responsere rg )r. r� r+ r� r r r r2 3 s zPubSub.__init__c C s | S )Nr )r. r r r r@ E s zPubSub.__enter__c C s | � � d S )N)rg )r. rB rC rD r r r rE H s zPubSub.__exit__c C s& y | � � W n tk
r Y nX d S )N)rg r| )r. r r r rF K s zPubSub.__del__c C sN | j r.| j �� | j �� | j�| j � d | _ i | _t� | _i | _t� | _ d S )N)
r rK Zclear_connect_callbacksr� rG �channelsrl � pending_unsubscribe_channels�patterns� pending_unsubscribe_patterns)r. r r r rg T s
z PubSub.resetc C s | � � d S )N)rg )r. r r r rA _ s z PubSub.closec C s� | j �� | j�� | jrVi }x*| j�� D ] \}}||| jj|dd�< q*W | jf |� | jr�i }x*| j�� D ] \}}||| jj|dd�< qlW | j f |� dS )zBRe-subscribe to any channels and patterns previously subscribed toT)ra N)
r� �clearr� r� r, rh rf � subscriber� �
psubscribe)r. r r� r0 r1 r� r r r �
on_connectb s
zPubSub.on_connectc C s t | jp | j�S )z@Indicates if there are subscriptions to any channels or patterns)r� r� r� )r. r r r �
subscribedt s zPubSub.subscribedc G sV | j dkr*| j�d| j�| _ | j �| j� | j }d| j i}| j||jf|�|� dS )z#Execute a publish/subscribe commandNr< � check_health) r r� r r+ Zregister_connect_callbackr� r� �_executerI )r. r r rb r r r rN y s
zPubSub.execute_commandc
O s^ y
|||�S t tfk
rX } z,|�� |jr8t|t�s:� |�� |||�S d }~X Y nX d S )N)r r rK r r Zconnect)r. r r� r rb rM r r r r� � s
zPubSub._executeTr c C sX | j }|dkrtd��| �� |s2|j|d�s2dS | �||j�}|jrT|| jkrTdS |S )z3Parse the response from a publish/subscribe commandNzNpubsub connection not set: did you forget to call subscribe() or psubscribe()?)r7 )r � RuntimeErrorr� Zcan_readr� rO r r� )r. r` r7 rH r$ r r r rJ � s
zPubSub.parse_responsec C s@ | j }|d krtd��|jr<t�� |jkr<|jd| jdd� d S )NzNpubsub connection not set: did you forget to call subscribe() or psubscribe()?r� F)r� )r r� r r2 Znext_health_checkrI r� )r. rH r r r r� � s
zPubSub.check_healthc s( | j j�| j j� � �fdd�|�� D �S )z�
normalize channel/pattern names to be either bytes or strings
based on whether responses are automatically decoded. this saves us
from coercing the value for each message coming in.
c s i | ]\}}|� �|���qS r r )rB r0 r1 )rf re r r �
<dictcomp>� s z*PubSub._normalize_keys.<locals>.<dictcomp>)rh re rf r, )r. r/ r )rf re r �_normalize_keys� s zPubSub._normalize_keysc O sf |rt |d |dd� �}t�|�}|�|� | jd|�� �� }| �|�}| j�|� | j� |� |S )aE
Subscribe to channel patterns. Patterns supplied as keyword arguments
expect a pattern name as the key and a callable as the value. A
pattern's callable will be invoked automatically when a message is
received on that pattern rather than producing a message via
``listen()``.
r rL N�
PSUBSCRIBE)r� )
r r& r' r; rN r r� r� r� �difference_update)r. r rb Z new_patterns�ret_valr r r r� � s
zPubSub.psubscribec G sL |r,t |d |dd� �}| �t�|��}n| j}| j�|� | jd|�� S )zj
Unsubscribe from the supplied patterns. If empty, unsubscribe from
all patterns.
r rL N� PUNSUBSCRIBE)r� )r r� r& r' r� r� r; rN )r. r r� r r r r� � s zPubSub.punsubscribec O sf |rt |d |dd� �}t�|�}|�|� | jd|�� �� }| �|�}| j�|� | j� |� |S )aR
Subscribe to channels. Channels supplied as keyword arguments expect
a channel name as the key and a callable as the value. A channel's
callable will be invoked automatically when a message is received on
that channel rather than producing a message via ``listen()`` or
``get_message()``.
r rL N� SUBSCRIBE)r� )
r r& r' r; rN r r� r� r� r� )r. r rb Z new_channelsr� r r r r� � s
zPubSub.subscribec G sL |r,t |d |dd� �}| �t�|��}n| j}| j�|� | jd|�� S )zi
Unsubscribe from the supplied channels. If empty, unsubscribe from
all channels
r rL N� UNSUBSCRIBE)r� )r r� r& r' r� r� r; rN )r. r r� r r r r� � s zPubSub.unsubscribec c s0 x*| j r*| �| jdd��}|dk r|V qW dS )zBListen for messages on channels this client has been subscribed toT)r` N)r� �handle_messagerJ )r. r$ r r r r� s z
PubSub.listenc C s" | j d|d�}|r | �||�S dS )z�
Get the next message if one is available, otherwise None.
If timeout is specified, the system will wait for `timeout` seconds
before returning. Timeout should be specified as a floating point
number.
F)r` r7 N)rJ r� )r. r� r7 r$ r r r � get_message s zPubSub.get_messagec C s |dkr dn|}| � d|�S )z'
Ping the Redis server
Nr� r� )rN )r. r� r r r r� s z PubSub.pingc C s< t |d �}|dkr0||d |d |d d�}n2|dkrL|dd|d d�}n|d|d |d d�}|| jkr�|d kr�|d }|| jkr�| j�|� | j�|d� n,|d }|| jkr�| j�|� | j�|d� || jk�r |dkr�| j� |d
d�}n| j� |d d�}|�r8||� dS n |dk�r8|�s4| j
�r8dS |S ) z�
Parses a pub/sub message. If the channel or pattern was subscribed to
with a message handler, the handler is invoked instead of a parsed
message being returned.
r r� rL rx r� )r� r� r� r/ r� Nr� r� r� ) r �UNSUBSCRIBE_MESSAGE_TYPESr� �remover� r/ r� r� �PUBLISH_MESSAGE_TYPESr8 r� )r. r$ r� Z message_typer� r� r� �handlerr r r r� $ sH
zPubSub.handle_messagec C st x*| j �� D ] \}}|d kr td| ��q W x*| j�� D ] \}}|d kr8td| ��q8W t| |||d�}|�� |S )Nz'Channel: '%s' has no handler registeredz'Pattern: '%s' has no handler registered)�daemon�exception_handler)r� r, r r� �PubSubWorkerThreadr� )r. �
sleep_timer� r� r� r� r� �threadr r r �
run_in_thread_ s zPubSub.run_in_thread)NF)Tr )Fr )N)F)r FN) r< r= r> r? r� r� r� r2 r@ rE rF rg rA r� �propertyr� rN r� rJ r� r� r� r� r� r� r� r� r� r� r� r r r r r; ' s8
; r; c s. e Zd Zd � fdd� Zdd� Zdd� Z� ZS )
r� FNc s0 t � �� || _|| _|| _|| _t�� | _d S )N) r3 r2 r� r< r� r� � threading�Event�_running)r. r< r� r� r� )r5 r r r2 u s
zPubSubWorkerThread.__init__c
C s� | j �� rd S | j �� | j}| j}x^| j �� r�y|jd|d� W q& tk
r~ } z | jd kr`� | �||| � W d d }~X Y q&X q&W |�� d S )NT)r� r7 ) r� �is_setrl r< r� r� �
BaseExceptionr� rA )r. r< r� rM r r r �run~ s
$zPubSubWorkerThread.runc C s | j �� d S )N)r� r� )r. r r r �stop� s zPubSubWorkerThread.stop)FN)r< r= r> r2 r r r@ r r )r5 r r� t s r� c @ s� e Zd ZdZdddhZdd� Zdd� Zd d
� Zd d � Zd
d� Z dd� Z
dd� Z dd� Z dd� Z
dd� Zdd� Zdd � Zd d � Zd d � Zd!d"� Zd#d$� Zd%d&� Zd/d(d)�Zd*d+� Zd,d-� Zd.S )0r) a_
Pipelines provide a way to transmit multiple commands to the Redis server
in one transmission. This is convenient for batch processing, such as
saving all the values in a list to Redis.
All commands executed within a pipeline are wrapped with MULTI and EXEC
calls. This guarantees all commands executed in the pipeline will be
executed atomically.
Any command raising an exception does *not* halt the execution of
subsequent commands in the pipeline. Instead, the exception is caught
and its instance is placed into the response list returned by execute().
Code iterating over the response list should be able to deal with an
instance of an exception as a potential value. In general, these will be
ResponseError exceptions, such as those raised when issuing a command
on a key of a different datatype.
ZDISCARD�EXEC�UNWATCHc C s0 || _ d | _|| _|| _|| _d| _| �� d S )NF)r� r r" r* r+ �watchingrg )r. r� r" r* r+ r r r r2 � s zPipeline.__init__c C s | S )Nr )r. r r r r@ � s zPipeline.__enter__c C s | � � d S )N)rg )r. rB rC rD r r r rE � s zPipeline.__exit__c C s& y | � � W n tk
r Y nX d S )N)rg r| )r. r r r rF � s zPipeline.__del__c C s
t | j�S )N)r� �
command_stack)r. r r r �__len__� s zPipeline.__len__c C s dS )z1Pipeline instances should always evaluate to TrueTr )r. r r r �__bool__� s zPipeline.__bool__c C s~ g | _ t� | _| jrT| jrTy| j�d� | j�� W n tk
rR | j�� Y nX d| _d| _ | jrz| j
� | j� d | _d S )Nr F) r rl �scriptsr r rI rO r rK �explicit_transactionr� rG )r. r r r rg � s zPipeline.resetc C s& | j rtd��| jr td��d| _ dS )z�
Start a transactional block of the pipeline after WATCH commands
are issued. End the transactional block with `execute`.
z"Cannot issue nested calls to MULTIz:Commands without an initial WATCH have already been issuedTN)r r r )r. r r r r� � s
zPipeline.multic O s0 | j s|d dkr$| js$| j||�S | j||�S )Nr �WATCH)r r �immediate_execute_command�pipeline_execute_command)r. r rb r r r rN � s zPipeline.execute_commandc O s� |d }| j }|s(| j�|| j�}|| _ y|j|� | j||f|�S ttfk
r� } zz|�� | j rv| �
� t d��|j r�t
|t�s�| �
� � y|j|� | j||f|�S ttfk
r� | �
� � Y nX W dd}~X Y nX dS )z�
Execute a command immediately, but don't auto-retry on a
ConnectionError if we're already WATCHing a variable. Used when
issuing WATCH or subsequent commands retrieving their values but before
MULTI is called.
r z=A ConnectionError occurred on while watching one or more keysN)r r� r r+ rI rJ r r rK r rg r r r )r. r r rL rH rM r r r r
� s.
z"Pipeline.immediate_execute_commandc O s | j �||f� | S )ar
Stage a command to be executed when execute() is next called
Returns the current Pipeline object back so commands can be
chained together, such as:
pipe = pipe.set('foo', 'bar').incr('baz').decr('bang')
At some other point, you can then run: pipe.execute(),
which will execute all commands queued in the pipe.
)r rZ )r. r r r r r r s z!Pipeline.pipeline_execute_commandc C s t di fg|di fg�}|�dd� |D ��}|�|� g }y| �|d� W n0 tk
rz } z|�d|f� W d d }~X Y nX x�t|�D ]�\}} t| d kr�|�|| d t f� q�y| �|d� W q� tk
�r
} z(| �||d | d � |�||f� W d d }~X Y q�X q�W y| �|d�}
W n* t k
�rJ |�rD|d d �� Y nX d| _
|
d k�rdt d ��x |D ]\}}|
� ||� �qjW t
|
�t
|�k�r�| j�� td
��|�r�| �||
� g } x\t|
|�D ]N\} }
t| t��s |
\}}|d }|| jk�r | j| | f|�} | �| � �q�W | S ) N)�MULTI)r c S s g | ]\}}t |kr|�qS r )r )rB r r r r r ru , s z1Pipeline._execute_transaction.<locals>.<listcomp>r r rL FzWatched variable changed.z6Wrong number of response items from pipeline execution)r �
pack_commands�send_packed_commandrJ r
rZ rd r �annotate_exceptionr r r �insertr� r rK �raise_first_errorry r r| r" )r. r r� �raise_on_errorZcmds�all_cmdsr$ rM r� r� r$ r/ r� ri r r rL r r r �_execute_transaction* sR
$
z Pipeline._execute_transactionc C s� |� dd� |D ��}|�|� g }x\|D ]T\}}y |�| j||d f|�� W q( tk
rz } z|�|� W d d }~X Y q(X q(W |r�| �||� |S )Nc S s g | ] \}}|�qS r r )rB r r r r r ru m s z.Pipeline._execute_pipeline.<locals>.<listcomp>r )r r rZ rJ r
r ) r. r r� r r r$ r r rM r r r �_execute_pipelinek s
zPipeline._execute_pipelinec C sB x<t |�D ]0\}}t|t�r
| �||d || d � |�q
W d S )NrL r )rd r r
r )r. r� r$ r� r� r r r r | s
zPipeline.raise_first_errorc C s> d� tt|��}d|||jd f }|f|jdd � |_d S )Nr� z.Command # %d (%s) of pipeline caused error: %sr rL )r� rq r r )r. Z exceptionr? r� ri �msgr r r r � s zPipeline.annotate_exceptionc K s6 t j| ||f|�}|| jkr$d| _n|dkr2d| _|S )NFr T)r� rJ �UNWATCH_COMMANDSr )r. r rL r rm r r r rJ � s
zPipeline.parse_responsec C s` t | j�}| j}dd� |D �}|d|�� }t|�s\x(t||�D ]\}}|s>|d|j�|_q>W d S )Nc S s g | ]
}|j �qS r )r� )rB r� r r r ru � s z)Pipeline.load_scripts.<locals>.<listcomp>�
SCRIPT EXISTSz SCRIPT LOAD)r )r r
r
�allry r� r� )r. r
Z immediateZshasr� r� Zexistr r r � load_scripts� s
zPipeline.load_scriptsTc
C s� | j }|s| jsg S | jr"| �� | js.| jr6| j}n| j}| j}|s\| j �
d| j �}|| _zhy ||||�S t t
fk
r� } z4|�� | jr�td��|jr�t|t
�s�� ||||�S d}~X Y nX W d| �� X dS )z0Execute all the commands in the current pipeliner z=A ConnectionError occurred on while watching one or more keysN)r r r
r r* r r r r r� r r+ r r rK r r r rg )r. r �stackr1 rH rM r r r r1 � s.
zPipeline.executec G s | j rtd��| jd|�� S )z$Watches the values at keys ``names``z"Cannot issue a WATCH after a MULTIr )r )r r rN )r. r� r r r r0 � s zPipeline.watchc C s | j r| �d�pdS )z'Unwatches all previously specified keysr T)r rN )r. r r r r � s zPipeline.unwatchN)T)r< r= r> r? r r2 r@ rE rF r r rg r� rN r
r r r r r rJ r r1 r0 r r r r r r) � s,
*A
'r) c @ s( e Zd ZdZdd� Zg g dfdd�ZdS )r� z?An executable Lua script object returned by ``register_script``c C s> || _ || _t|t�r*|j�� }|�|�}t�|�� � | _
d S )N) �registered_clientr� r r r� rc re �hashlibZsha1Z hexdigestr� )r. r r� rh r r r r2 � s
zScript.__init__Nc C s� |dkr| j }t|�t|� }t|t�r4|j�| � y|j| jt|�f|�� S t k
r� |�
| j �| _|j| jt|�f|�� S X dS )z1Execute the script, passing any required ``args``N) r r� r r) r
�addr� r� r� r
r� r� )r. r r r? r r r �__call__� s
zScript.__call__)r< r= r> r? r2 r" r r r r r� � s r� c @ sX e Zd ZdZddd�Zdd� Zdd� Zdd d
�Zd d � Zd
d� Z e
dd� �Z dd� Z dS )r� z0
Command builder for BITFIELD commands.
Nc C s || _ || _|| _| �� d S )N)r? r] �_default_overflowrg )r. r? r] r� r r r r2 � s zBitFieldOperation.__init__c C s" g | _ d| _| �| jp| j� dS )zL
Reset the state of the instance to when it was constructed
ZWRAPN)�
operations�_last_overflow�overflowr# )r. r r r rg � s zBitFieldOperation.resetc 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)r- r% r$ rZ )r. r& r r r r& s
zBitFieldOperation.overflowc C s* |dk r| � |� | 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.
Nr� )r& r$ rZ )r. �fmtr� Z incrementr& r r r r� s
zBitFieldOperation.incrbyc 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.
r� )r$ rZ )r. r' r� r r r r8 % s
zBitFieldOperation.getc 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.
r� )r$ rZ )r. r' r� rO r r r rl 2 s zBitFieldOperation.setc C s( d| j g}x| jD ]}|�|� qW |S )NZBITFIELD)r] r$ r )r. ri Zopsr r r r� @ s
zBitFieldOperation.commandc 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� rg r? rN )r. r� r r r r1 G s zBitFieldOperation.execute)N)N)
r< r= r> r? r2 rg r& r� r8 rl r� r� r1 r r r r r� � s
r� )FF)Z� itertoolsr r# r r2 r� r� r� r Zredis.connectionr r r Z
redis.lockr Zredis.exceptionsr r r r
r r r
r r r Z redis.utilsr r Z SYM_EMPTYr r r% r* r& r+ rE rH r^ rc r! rk rp rr rt rv rw ra rj r� r� rF 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� Z StrictRedisr= r; �Threadr� r) r� r� r r r r �<module> s� 0 ,
?B O! ="