File: //lib/python3.9/site-packages/redis/__pycache__/client.cpython-39.pyc
a
��b* � @ s� d dl Z d dlZd dlZd dlZd dlZd dlZd dlmZ d dlm Z m
Z
m Z m Z d dl
mZmZmZ d dlmZmZmZmZmZmZmZmZ d dlmZ d dl m Z m Z dZ d Z 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#� Z0d}d%d&�Z1d'd(� Z2d)d*� Z3d+d,� Z4d-d.� Z5d/d0� Z6d1d2� Z7d3d4� Z8d5d6� Z9d7d8� Z:d9d:� Z;d;d<� Z<d=d>� Z=d?d@� Z>dAdB� Z?dCdD� Z@dEdF� ZAdGdH� ZBdIdJ� ZCdKdL� ZDdMdN� ZEdOdP� ZFdQdR� ZGdSdT� ZHdUdV� ZIdWdX� ZJdYdZ� ZKd[d\� ZLd]d^� ZMd_d`� ZNdadb� ZOdcdd� ZPdedf� ZQdgdh� ZRdidj� ZSdkdl� ZTdmdn� ZUdodp� ZVG dqdr� dr�ZWG dsdt� dteWe
e e �ZXeXZYG dudv� dv�ZZG dwdx� dx�Z[G dydz� dzej\�Z]G d{d|� d|eX�Z^dS )~� N)�chain)� CoreCommands�RedisModuleCommands�SentinelCommands� list_or_args)�ConnectionPool�
SSLConnection�UnixDomainSocketConnection)�ConnectionError�ExecAbortError� ModuleError� PubSubError�
RedisError�
ResponseError� TimeoutError�
WatchError��Lock)�safe_str� str_if_bytes� �EMPTY_RESPONSE� NEVER_DECODEc C s6 | sdS z t | �} W n ty( Y dS 0 tj�| �S )z5Converts a unix timestamp to a Python datetime objectN)�int�
ValueError�datetimeZ
fromtimestamp��response� r �0/usr/lib/python3.9/site-packages/redis/client.py�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" |� � D ]\}}|| |�� < qd S r! )�items�upper)�self�data�k�vr r r �__init__6 s z CaseInsensitiveDict.__init__c s t � �|�� �S r! )�super� __contains__r) �r* r, �� __class__r r r0 : s z CaseInsensitiveDict.__contains__c s t � �|�� � d S r! )r/ � __delitem__r) r1 r2 r r r4 = s z CaseInsensitiveDict.__delitem__c s t � �|�� �S r! )r/ � __getitem__r) r1 r2 r r r5 @ s z CaseInsensitiveDict.__getitem__Nc s t � �|�� |�S r! )r/ �getr) )r* r, �defaultr2 r r r6 C s zCaseInsensitiveDict.getc s t � �|�� |� d S r! )r/ � __setitem__r) )r* r, r- r2 r r r8 F s z CaseInsensitiveDict.__setitem__c s t |�}t� �|� d S r! )r' r/ �update�r* r+ r2 r r r9 I s zCaseInsensitiveDict.update)N) �__name__�
__module__� __qualname__�__doc__r. r0 r4 r5 r6 r8 r9 �
__classcell__r r r2 r r' 3 s r' c C sP t | �} d| } tdd� | �� D ��} d}|D ] }|| v r.t| | �| |< q.| 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>T r z%parse_debug_object.<locals>.<genexpr>)�refcountZserializedlengthZlruZlru_seconds_idle)r r" r$ r )r Z
int_fieldsZfieldr r r �parse_debug_objectN s rF c C s |dv rt | �S | S )z&Parse the results of an OBJECT command)ZidletimerE )� int_or_none)r Zinfotyper r r � parse_object` s rH c s� i }t | �} � fdd�� | �� D ]�}|r |�d�s |�d�dkr�|�dd�\}}|dkrh|�dd�\}}|dkr�|�d g ��� |�� q�� |�||< q |�d
g ��|� q |S ) z;Parse the result of Redis's INFO command into a Python dictc s� d| vsd| vrJz d| v r$t | �W S t| �W S W q~ tyF | Y S 0 n4i }| �d�D ] }|�dd�\}}� |�||< qX|S d S )N�,�=�.� )�floatr r r$ �rsplit)�valueZsub_dict�itemr, r- �� get_valuer r rR l 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_infog s r_ c K s@ t | ddd�}|�� D ]$\}}|�d�rt |ddd�||< q|S )z!Parse the results of MEMORY STATST)� decode_keys�decode_string_valueszdb.)�
pairs_to_dictr( rX )r �kwargsZstatsr^ rO r r r �parse_memory_stats� s
� rd )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�portZquorumzrole-reported-timez s-down-timezslave-priorityzslave-repl-offsetzvoted-leader-epochc C s: t | t�}t|d �d��}dD ]\}}||v ||< q |S )N�flagsrI ))Z is_masterZmaster)Zis_slaveZslave)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
rn c C s t tt| ��S r! �rn �mapr r r r r �parse_sentinel_master� s rq c C s, i }| D ] }t tt|��}|||d < q|S )Nrl ro )r rk rP �stater r r �parse_sentinel_masters� s
rs c C s dd� | D �S )Nc S s g | ]}t tt|���qS r ro �rC rP r r r �
<listcomp>� r 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 ry Fc C st | du r 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 )rp r r" �zip�iter)r r` ra �keys�values�itr r r rb � s
rb c C sX t | �}i }t||�D ]<\}}||v rJz|| |�}W n tyH Y n0 |||< q|S r! )r| r{ � Exception)r Z type_infor rk r^ rO r r r rh � s
rh 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
Z
withscores�score_cast_func)r6 rM r| �listr{ rp )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 r! r �rC �i��nr r r ru r z&sort_return_tuples.<locals>.<listcomp>)r6 r� r{ �range�r r� r r� r �sort_return_tuples s r� c C s | d u r d S t | �S r! rx r r r r rG s rG c C sL | d u r d S g }| D ]2}|d ur<|� |d t|d �f� q|� d� q|S )Nr rL )NN)r[ rb )r r+ �rr r r �parse_stream_list s r� c C s t | dd�S )NT�r` �rb r r r r �pairs_to_dict_with_str_keys( s r� c C s t tt| ��S r! )r� rp r� r r r r �parse_list_of_dicts, s r� c K s |� dd�r| S t| �S )N� parse_justidF�r6 r� r� r r r � parse_xclaim0 s r� c K s |� dd�r| d S t| d �S )Nr� FrL r� r� r r r �parse_xautoclaim6 s r� c K s� t | dd�}|�dd�sj|d }|d ur@|d t |d �f|d< |d }|d ur�|d t |d �f|d< n,d d
� |d D �|d < d d
� |d D �|d< |S )NTr� ZfullFz first-entryr rL z
last-entryc S s i | ]\}}|t |��qS r r� )rC Z_id�entryr r r �
<dictcomp>F r z&parse_xinfo_stream.<locals>.<dictcomp>�entriesc S s g | ]}t |d d��qS )Tr� r� )rC �groupr r r ru G s z&parse_xinfo_stream.<locals>.<listcomp>r� )rb r6 )r r� r+ �firstZlastr r r �parse_xinfo_stream< s �
r� c C s | d u r g S dd� | D �S )Nc S s g | ]}|d t |d �g�qS )r rL )r� �rC r� r r r ru P r z parse_xread.<locals>.<listcomp>r r r r r � parse_xreadM s r� c K sD |� dd�rt| �S dd� | d p$g D �}| d | d | d |d �S )
NZ parse_detailFc S s g | ]\}}|t |�d ��qS ))rl �pendingrx )rC r� �pr r r ru V r z"parse_xpending.<locals>.<listcomp>� r rL rz )r� �min�max� consumers)r6 �parse_xpending_range)r r� r� r r r �parse_xpendingS s �r� c s d� � fdd�| D �S )N)Z
message_idZconsumerZtime_since_deliveredZtimes_deliveredc s g | ]}t t� |���qS r )r" r{ r� �r, r r ru a r z(parse_xpending_range.<locals>.<listcomp>r r r r� r r� _ s r� c C s | d u r d S t | �S r! �rM r r r r �
float_or_noned s r� c C s t | �dkS �N�OK�r r r r r �bool_okj s r� c K s& | d u r d S |� d�r t| �S t| �S )NZas_score)r6 rM r r� r r r �
parse_zaddn s
r� c K s8 g }t | ��� D ]"}|�tdd� |�d�D ��� q|S )Nc s s | ]}|� d d�V qdS )rJ rL NrB )rC Zpairr r r rD z r z$parse_client_list.<locals>.<genexpr>� )r rW r[ r" r$ )r r� Zclients�cr r r �parse_client_listv s r� c K s dd� | D �} | rt | �p i S )Nc S s g | ]}|d urt |�nd �qS r! r� r� r r r ru r z$parse_config_get.<locals>.<listcomp>r� r� r r r �parse_config_get~ s r� c K s | \}}t |�|fS r! rx �r r� �cursorr� r r r �
parse_scan� s r� c K s | \}}t |�|rt|�p i fS r! )r rb r� r r r � parse_hscan� s r� c K s8 |� dt�}| \}}t|�}t|�tt|t||���fS )Nr� )r6 rM r| r r� r{ rp )r r� r� r� r� r r r r � parse_zscan� s r� c K s dd� | D �S )Nc S s g | ]}|d urt |�nd �qS r! r� )rC Zscorer r r ru � r z!parse_zmscore.<locals>.<listcomp>r r� r r r �
parse_zmscore� s r� c s2 |� dd�rdnd��fdd�� � fdd�| D �S ) N�decode_responsesFr� � c sd | d t | d �t | d �d�}t| d t�rB� �| d �|d< n | d |d< � �| d �|d< |S ) Nr rL rz )�id�
start_timeZdurationr� �commandZ
complexity� )r �
isinstancer� �join)rP rk )�spacer r �
parse_item� s z%parse_slowlog_get.<locals>.parse_itemc s g | ] }� |��qS r r rt )r� r r ru � r z%parse_slowlog_get.<locals>.<listcomp>)r6 r� r )r� r� r �parse_slowlog_get� s r� c K s~ |� dd�rt| �S |� dd�rv|� dd�r@dd� | d D �}ndd� | d D �}t| d �|t| d
�t| d �iS t| �S ) a
Parse the response from `STRALGO` command.
Without modifiers the returned value is string.
When LEN is given the command returns the length of the result
(i.e integer).
When IDX is given the command returns a dictionary with the LCS
length and all the ranges in both the strings, start and end
offset for each string, where there are matches.
When WITHMATCHLEN is given, each array representing a match will
also have the length of the match at the beginning of the array.
�lenF�idxZ withmatchlenc S s0 g | ](}t |d �gttt|dd � �� �qS )rT N)r r� rp �tuple�rC �matchr r r ru � s �z!parse_stralgo.<locals>.<listcomp>rL c S s g | ]}t tt|���qS r )r� rp r� r� r r r ru � r r rz r� )r6 r r )r r� �matchesr r r �
parse_stralgo� s � �r� c K s t | �} tdd� | �� D ��S )Nc s s | ]}|r|� d �V qdS r@ rB )rC r] r r r rD � r z%parse_cluster_info.<locals>.<genexpr>)r r" rW r� r r r �parse_cluster_info� s r� c
C s� | � d�}| � d�d d� \}}}}}}}} |� d�d }||||||g g | dkrVdndd� }
t|�d kr�t|dd � �\} } | | |
d
< |
d < ||
fS ) Nr� � �@r � connectedTF) �node_idrf � master_idZlast_ping_sentZlast_pong_rcvd�epoch�slots�
migrationsr� � r� r� )r$ r� � _parse_slots)
r] Z
line_itemsr� Zaddrrf r� �ping�pongr� r� Z node_dictr� r� r r r �_parse_node_line� s"
"� r� c C s� g g }}| D ]�}d|v rF|dd� � dd�\}}|�||dd�� qd|v rz|dd� � dd�\}}|�||dd�� qdd � |� d
�D �}|�|� q||fS ) Nz->-rL rT Z migrating)Zslotr� rr z-<-Z importingc S s g | ]}|�qS r r )rC �slr r r ru � r z _parse_slots.<locals>.<listcomp>�-)r$ r[ )Z slot_rangesr� r� Zs_rangeZslot_idZ dst_node_idZ src_node_idr r r r� � s
�
� r� c K s( t | ttf�r| �� } tdd� | D ��S )z�
@see: https://redis.io/commands/cluster-nodes # string / bytes
@see: https://redis.io/commands/cluster-replicas # list of string / bytes
c s s | ]}t t|��V qd S r! )r� r )rC Znoder r r rD � r z&parse_cluster_nodes.<locals>.<genexpr>)r� �str�bytesrW r" r� r 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 )z�
Parse the response of 'GEOSEARCH', GEORADIUS' and 'GEORADIUSBYMEMBER'
commands according to 'withdist', 'withhash' and 'withcoord' labels.
�storeZ
store_dist�withdist� withcoord�withhashc S s t | d �t | d �fS rw r� �Zllr r r �<lambda> r z)parse_geosearch_generic.<locals>.<lambda>)r� r� r� c S s | S r! r ��xr r r r� r c s g | ]}�| r� | �qS r r )rC �o)�castr� r r ru r z+parse_geosearch_generic.<locals>.<listcomp>)r� r� r� c s$ g | ] }t td d� t� |����qS )c S s | d | d �S rw r )Zfvr r r r� r z4parse_geosearch_generic.<locals>.<listcomp>.<lambda>)r� rp r{ r� )�fr r ru r )�typer� rM r )r r� Z
response_listr )r� r� r� r �parse_geosearch_generic s �
r� c K s� i }| D ]�}i }t |d �}||d< t|d �|d< dd� |d D �|d< |d |d
< |d |d < |d
|d< t|�dkr�|d |d< |d |d< |d |d< |||< q|S )Nr rl rL Zarityc S s g | ] }t |��qS r r� )rC rm r r r ru ( r z!parse_command.<locals>.<listcomp>rz rf r� Z
first_key_posr� Z last_key_pos� Z
step_count� Ztipsr� Zkey_specificationsr� � subcommands)r r r� )r r� �commandsr� Zcmd_dictZcmd_namer r r �
parse_command! s
r� c K s" t t| dd d� | dd d� ��S )Nr rz rL )r� r{ r� r r r �parse_pubsub_numsub4 s r� c K s t | t�r| S t| �dkS r� �r� r r r� r r r �parse_client_kill8 s
r� c K sx | d u r d S t | dd�}ttt|d ��|d< ttt|d ��|d< t|d �|d< t|d t�spt|d t�r�tt|d ��d��|d< |d dgkr�g |d< d |v r�t|d t�s�t|d t�r�tt|d ��d��|d < |d dgkr�g |d < d
|v �rd d � |d
D �|d
< g g }}|d �d�D ]&}d
|v �rF|�|� n
|�|� �q,||d< ||d< d|d v |d< |S )NTr� rf Z passwordsr� r} r� � �channelsZ selectorsc S s g | ]}t tt|���qS r �r� rp r )rC �selectorr r r ru Q s z%parse_acl_getuser.<locals>.<listcomp>r� �
categoriesZonZenabled) rb r� rp r r� r� r� r$ r[ )r r� r+ r� r� r� r r r �parse_acl_getuser> s8
�
r� c K sp | d u r d S t | t�rdg }| D ]B}t|dd�}|�dd�}t|�|d< t|d �|d< |�|� q nt| �}|S )NTz client-infor� z age-seconds)r� r� rb r6 �parse_client_inforM r[ r� )r r� r+ �logZlog_data� client_infor r r �
parse_acl_logc s
r� c C sP i }t | ��d�}|D ]}|�d�\}} | ||< qdD ]}t|| �||< q6|S )zg
Parsing client-info in ACL Log in following format.
"key1=value1 key2=value2 key3=value3"
r� rJ > Zomem�multizargv-memZollZageZqbufztot-memZoblr� z qbuf-free�subZidle�dbZpsub)r r$ r )rO r� Zinfosr\ r^ Zint_keyr r r r� u 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
r6 r� )r6 r r� r r r �parse_set_result� s
r c p @ s� e Zd Zi ede��ede��ede��eddd� ��ede��ede��ed e ��ed
d d� ��ed d
d� ��ede
��eddd� ��ede ��ede ��ede
��eddd� ��dd� eeedd� dd� e ee e dd� eeeeeee dd� e edd� e e d d� d d� e e e e d d� ed d� e eee e e e e eeed d� ee e ee e e d!d� d"d� eeed#d� eee e e e e e d$d� e d%d� e e e!d&d� ee"d'd� e e ee e e e#e$e%e e e e&e e&e'e(ee e"d(d� e)e*e eee e+e+e,e-e.e/e0d)�n�Z1d*S )+�
AbstractRediszyAUTH COPY EXPIRE EXPIREAT PEXPIRE PEXPIREAT HEXISTS HMSET 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 r� r� �r� r r r r� � r zAbstractRedis.<lambda>ZSORTzZSCORE ZINCRBY GEODISTz|FLUSHALL FLUSHDB LSET LTRIM MSET PFMERGE ASKING READONLY READWRITE RENAME SAVE SELECT SHUTDOWN SLAVEOF SWAPDB WATCH UNWATCH z BLPOP BRPOPc C s | r t | �pd S r! )r� r r r r r� � r z SDIFF SINTER SMEMBERS SUNIONc C s | r t | �pt � S r! )rj r r r r r� � r zSZPOPMAX ZPOPMIN ZINTER ZDIFF ZUNION ZRANGE ZRANGEBYSCORE ZREVRANGE ZREVRANGEBYSCOREzBZPOPMIN BZPOPMAXc C s" | r | d | d t | d �fp d S )Nr rL rz r� r r r r r� � r zZRANK ZREVRANKzXREVRANGE XRANGEzXREAD XREADGROUPzBGREWRITEAOF BGSAVEc C s dS r r r r r r r� � r c C s t tt| ��S r! r� r r r r r� � r c C s t tt| ��S r! r� r r r r r� � r c C s t tt| ��S r! r� r r r r r� � r c C s t tt| ��S r! r� r r r r r� � r c C s | rt | �dkpdS )NrL Frx r r r r r� � r c C s t tt| ��S r! r� r r r r r� � r c C s t | �S r! rx r� r r r r� � r c C s t | �S r! rx r� r r r r� � r c C s t tt| ��S r! r� r r r r r� � r c C s t | �S r! rx r� r r r r� � r c C s t tt| ��S r! r� r r r r r� r c C s t tt| ��S r! r� r r r r r�
r c C s t tdd� | ��S )Nc S s$ | d ur t | d �t | d �fS d S rw r� r� r r r r� r z(AbstractRedis.<lambda>.<locals>.<lambda>)r� rp r r r r r� s �c C s | r t | �pi S r! r� r r r r r� r c C s dd� | D �S )Nc S s g | ] }t |��qS r r� )rC �mr r r ru r z*AbstractRedis.<lambda>.<locals>.<listcomp>r r r r r r� r c C s t | �dkS )NZPONGr� r r r r r� r c C s | r| p
d S r! r r r r r r� r c C s t tt| ��S r! )r� rp �boolr r r r r� # r c C s t | d �t | d �fS rw rx r� r r r r� 8 r )nzACL CATz ACL DELUSERz ACL GENPASSz ACL GETUSERzACL HELPzACL LISTzACL LOADzACL LOGzACL SAVEz ACL SETUSERz ACL USERSz
ACL WHOAMIzCLIENT GETNAMEz CLIENT IDz CLIENT KILLz CLIENT LISTz CLIENT INFOzCLIENT SETNAMEzCLIENT UNBLOCKz CLIENT PAUSEzCLIENT GETREDIRzCLIENT TRACKINGINFOzCLUSTER ADDSLOTSzCLUSTER ADDSLOTSRANGEz CLUSTER COUNT-FAILURE-REPORTSzCLUSTER COUNTKEYSINSLOTzCLUSTER DELSLOTSzCLUSTER DELSLOTSRANGEzCLUSTER FAILOVERzCLUSTER FORGETzCLUSTER GETKEYSINSLOTz CLUSTER INFOzCLUSTER KEYSLOTz CLUSTER MEETz
CLUSTER NODESzCLUSTER REPLICASzCLUSTER REPLICATEz
CLUSTER RESETzCLUSTER SAVECONFIGzCLUSTER SET-CONFIG-EPOCHzCLUSTER SETSLOTzCLUSTER SLAVESZCOMMANDz
COMMAND COUNTzCOMMAND GETKEYSz
CONFIG GETzCONFIG RESETSTATz
CONFIG SETz DEBUG OBJECTzFUNCTION DELETEzFUNCTION FLUSHzFUNCTION RESTOREZGEOHASHZGEOPOSZ GEOSEARCHZ GEORADIUSZGEORADIUSBYMEMBERZHGETALLZHSCAN�INFOZLASTSAVEz MEMORY PURGEz MEMORY STATSz MEMORY USAGEz MODULE LOADz
MODULE UNLOADz MODULE LISTZOBJECT�PINGZQUITZSTRALGOz
PUBSUB NUMSUBZ RANDOMKEYZRESETZSCAN�
SCRIPT EXISTSz SCRIPT FLUSHz SCRIPT KILL� SCRIPT LOADzSENTINEL CKQUORUMzSENTINEL FAILOVERzSENTINEL FLUSHCONFIGz SENTINEL GET-MASTER-ADDR-BY-NAMEzSENTINEL MASTERzSENTINEL MASTERSzSENTINEL MONITORzSENTINEL RESETzSENTINEL REMOVEzSENTINEL SENTINELSz SENTINEL SETzSENTINEL SLAVESZSETz SLOWLOG GETz SLOWLOG LENz
SLOWLOG RESETZSSCANZTIMEZXCLAIMZ
XAUTOCLAIMz
XGROUP CREATEzXGROUP DELCONSUMERzXGROUP DESTROYz XGROUP SETIDzXINFO CONSUMERSz XINFO GROUPSz XINFO STREAMZXPENDINGZZADDZZSCANZZMSCOREN)2r; r< r= r& r r rM r� r� r� r� rG r� r� r r� r� r� r� r� r� r� r� r� rF r� r� r_ r rd r rH r� r� r� ry rq rs rv r r� r� r� r� r� r� r� r� r� �RESPONSE_CALLBACKSr r r r r � sD ����������� � �� ��%��(�)�*�+ �,� �r c % @ s e Zd ZdZedd� �Zdddddddddddd ddd
d
g d
ddd dddd
dd
d
dddd
dddddf%d d
�Zdd� Zdd� Zdd� Z dd� Z
dd� Z d6dd�Z dd � Z
d7d d �Zd d!� Zd"d#� Zd$d%� Zd&d'� Zd(d)� Zd*d+� Zd,d-� Zd.d/� Zd0d1� Zd2d3� Zd4d5� ZdS )8�Redisa�
Implementation of the Redis protocol.
This abstract class provides a Python interface to all Redis commands
and an implementation of the Redis protocol.
Pipelines derive from this, implementing how
the commands are sent and received to the Redis server. Based on
configuration, an instance will either use a ConnectionPool, or
Connection object to talk to redis.
c K s t j|fi |��}| |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)�cls�urlrc r
r r r r V s *zRedis.from_urlZ localhosti� r Nzutf-8�strictF�requiredc& ' C s | s�|
dur t �td�� |
} |dur8t �td�� |} |du rJ|�t� ||#||| | ||t�|$�| |!|"|%d�
}&|
dur�|&�|
td�� n@|&�|||||d�� |r�|&�t ||||||||| || | d�
� t
f i |&��} | | _ d| _ | r�| j �
d �| _ t| jj�| _dS )
a4
Initialize a new Redis client.
To specify a retry policy for specific errors, first set
`retry_on_error` to a list of the error/s to retry on, then set
`retry` to a valid `Retry` object.
To retry on TimeoutError, `retry_on_timeout` can also be set to `True`.
Nz/"charset" is deprecated. Use "encoding" insteadz5"errors" is deprecated. Use "encoding_errors" insteadT)
r� �username�password�socket_timeout�encoding�encoding_errorsr� �retry_on_error�retry�max_connections�health_check_interval� client_name�redis_connect_func)�path�connection_class)�hostre �socket_connect_timeout�socket_keepalive�socket_keepalive_options)
r � ssl_keyfile� ssl_certfile�
ssl_cert_reqs� ssl_ca_certs� ssl_ca_data�ssl_check_hostname� ssl_password� ssl_ca_path�ssl_validate_ocsp_stapled�ssl_validate_ocsp�ssl_ocsp_context�ssl_ocsp_expected_cert�_)�warnings�warn�DeprecationWarningr[ r �copy�deepcopyr9 r r r r
�
connection�get_connectionr' r3 r �response_callbacks)'r* r re r� r r r! r" r# r
Zunix_socket_pathr r �charset�errorsr� �retry_on_timeoutr Zsslr$ r% r& r' r+ r( r) r* r- r, r. r/ r �single_connection_clientr r r r r rc r r r r. � s� /����
�����
��zRedis.__init__c C s t | �j� dt| j�� d�S )N�<�>)r� r; �reprr
�r* r r r �__repr__ s zRedis.__repr__c C s
| j �� S )z!Get the connection pool's encoder)r
� get_encoderr@ r r r rB s zRedis.get_encoderc C s | j jS )z'Get the connection's key-word arguments)r
Zconnection_kwargsr@ r r r �get_connection_kwargs s zRedis.get_connection_kwargsc C s || j |< dS )z Set a custom Response CallbackN)r8 )r* r� r% r r r �set_response_callback s zRedis.set_response_callbackc C s t | ||� dS )a
This function can be used to add externally defined redis modules,
and their namespaces to the redis client.
funcname - A string containing the name of the function to create
func - The function, being added to this class.
ex: Assume that one has a custom redis module named foomod that
creates command named 'foo.dothing' and 'foo.anotherthing' in redis.
To load function functions into this namespace:
from redis import Redis
from foomodule import F
r = Redis()
r.load_external_module("foo", F)
r.foo().dothing('your', 'arguments')
For a concrete example see the reimport of the redisjson module in
tests/test_connection.py::test_loading_external_modules
N)�setattr)r* �funcname�funcr r r �load_external_module s zRedis.load_external_moduleTc 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
r8 )r* � transaction�
shard_hintr r r �pipeline& s �zRedis.pipelinec
O s� |� dd�}|� dd�}|� dd�}| �d|��~}z:|rB|j|� ||�}|�� } |rZ|n| W W d � S ty� |dur�|dkr�t�|� Y q2Y q20 q2W d � n1 s�0 Y 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.
rK N�value_from_callableF� watch_delayTr )�poprL �watch�executer �time�sleep)
r* rG Zwatchesrc rK rM rN �pipeZ
func_valueZ
exec_valuer r r rJ 2 s
zRedis.transaction皙�����?c C s" |du r t }|| ||||||d�S )aL
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`` indicates whether calling ``acquire`` should block until
the lock has been acquired or to fail immediately, causing ``acquire``
to return False and the lock not being acquired. Defaults to True.
Note this value can be overridden by passing a ``blocking``
argument to ``acquire``.
``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. Note that as
of redis-py 3.0, the only lock class we implement is ``Lock`` (which is
a Lua-based lock). So, it's unlikely you'll need this parameter, unless
you have created your own custom lock class.
``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)�timeoutrS �blocking�blocking_timeout� thread_localr )r* rl rV rS rW rX Z
lock_classrY r r r �lockH s >�z
Redis.lockc K s t | jfi |��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* rc r r r �pubsub� s z Redis.pubsubc C s
t | j�S r! )�Monitorr
r@ r r r �monitor� s z
Redis.monitorc C s | j | jdd�S )NT)r
r< )r3 r
r@ r r r �client� s �z Redis.clientc C s | S r! r r@ r r r � __enter__� s zRedis.__enter__c C s | � � d S r! ��close�r* �exc_type� exc_value� tracebackr r r �__exit__� s zRedis.__exit__c C s | � � d S r! ra r@ r r r �__del__� s z
Redis.__del__c C s. t | d�sd S | j}|r*d | _| j�|� d S )Nr6 )�hasattrr6 r
�release�r* �connr r r rb � s
z Redis.closec O s |j |� | j||fi |��S )z7
Send a command and parse the response
)� send_command�parse_response)r* rl � command_name�argsr� r r r � _send_command_parse_response� s
z"Redis._send_command_parse_responsec C s. |� � |jdu s&t|t|j��du r*|�dS )z�
Close the connection and raise an exception
if retry_on_error is not set or the error
is not one of the specified error types
NF)�
disconnectr r� r� �r* rl �errorr r r �_disconnect_raise� s ��zRedis._disconnect_raisec sz �j }� d ��jp$|j�fi ����z<�j�� ����fdd���fdd��W �js`|��� S n�jst|��� 0 dS )z.Execute a command and return a parsed responser c s �j ��g� �R i ���S r! �rq r �rp ro rl r� r* r r r� � s ���z'Redis.execute_command.<locals>.<lambda>c s �� � | �S r! )ru �rt �rl r* r r r� � r N)r
r6 r7 r �call_with_retryrj )r* rp r� Zpoolr rw r �execute_command� s �
� �zRedis.execute_commandc K sp z"t |v r|jdd�}n|�� }W n( tyJ t|v rD|t Y S � Y n0 || jv rl| j| |fi |��S |S )z'Parses a response from the Redis serverT)Zdisable_decoding)r �
read_responser r r8 )r* r6 ro r� r r r r rn � s
zRedis.parse_response)TN)NrU TNNT)r; r< r= r> � classmethodr r. rA rB rC rD rH rL rJ rZ r\ r^ r_ r` rg rh rb rq ru r{ rn r r r r r I s�
.�
}
�
J 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
r7 r6 )r* r
r r r r. � s zMonitor.__init__c C s0 | j �d� | j �� }t|�s,td|� ���| S )Nr~ zMONITOR failed: )r6 rm r| r� r �r* r r r r r` � s
zMonitor.__enter__c G s | j �� | j�| j � d S r! )r6 rr r
rj )r* rp r r r rg 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��forcer� rL z\"�"Zluar� Zunixr� NrA Ztcp)rR r� �client_address� client_port� client_typer� )r6 r| r� r� �encoder�decoder$ �
monitor_rer� r� r� �
command_re�findall�replacerX rN rM r ) r* r Z command_timeZ command_datar Zdb_idr� r� r� r� r� r r r � next_command
s2
�zMonitor.next_commandc c s | � � V q 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� r. r` rg r� r� r r r r r] � s
#r] c @ s� e Zd ZdZdZdZdZd;dd�Zd d
� Zd d � Z d
d� Z
dd� Z dd� Z dd� Z
edd� �Zdd� Zdd� Zdd � Zd d � Zd<d!d"�Zd#d$� Zd%d&� Zd'd(� Zd)d*� Zd+d,� Zd-d.� Zd/d0� Zd1d2� Z d=d3d4�Z d>d5d6�Z d?d7d8�Z d@d9d:�Z dS )Ar[ 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.
)�message�pmessage)� unsubscribe� punsubscribezredis-py-health-checkNFc C s| || _ || _|| _d | _t�� | _|| _| jd u r>| j �� | _| j� | j
�| _ | jj rdd| j
g| _
n d| j g| _
| �� d S )Nr� s pong)r
rK �ignore_subscribe_messagesr6 � threading�Event�subscribed_eventr� rB �encode�HEALTH_CHECK_MESSAGE�health_check_response_br� �health_check_response�reset)r* r
rK r� r� r r r r. @ s
zPubSub.__init__c C s | S r! r r@ r r r r` X s zPubSub.__enter__c C s | � � d S r! �r� rc r r r rg [ s zPubSub.__exit__c C s$ z | � � W n ty Y n0 d S r! �r� r� r@ r r r rh ^ s zPubSub.__del__c C s^ | j r.| j �� | j �� | j�| j � d | _ i | _d| _t� | _i | _ t� | _
| j � � d S )Nr )
r6 rr Zclear_connect_callbacksr
rj r� � health_check_response_counterrj � pending_unsubscribe_channels�patterns� pending_unsubscribe_patternsr� �clearr@ r r r r� g s
z PubSub.resetc C s | � � d S r! r� r@ r r r rb t s z PubSub.closec C s� | j �� | j�� | jrVi }| j�� D ] \}}||| jj|dd�< q(| jf i |�� | jr�i }| j�� D ] \}}||| jj|dd�< qj| j f i |�� dS )zBRe-subscribe to any channels and patterns previously subscribed toTr� N)
r� r� r� r� r( r� r� � subscriber� �
psubscribe)r* r6 r� r, r- r� r r r �
on_connectw s
zPubSub.on_connectc C s
| j �� S )z@Indicates if there are subscriptions to any channels or patterns)r� �is_setr@ r r r �
subscribed� s zPubSub.subscribedc G sj | j du r*| j�d| j�| _ | j �| j� | j }d| j i}| jsJ| �� | j||j g|�R i |�� dS )z#Execute a publish/subscribe commandNr\ � check_health)
r6 r
r7 rK Zregister_connect_callbackr� r� � clean_health_check_responses�_executerm )r* rp r6 rc r r r r{ � s
� zPubSub.execute_commandc C st d}| j }| jdkrp|dkrp| j||j|jd�rf| �||j�}| �|�rX| jd8 _ntd�|���|d8 }q
dS )zG
If any health check responses are present, clean them
�
r �rV rL z?A non health check response was cleaned by execute_command: {0}N) r6 r� r� �can_readr r| �is_health_check_responser
�format)r* Zttlrl r r r r r� � s
��z#PubSub.clean_health_check_responsesc C s( |� � |jrt|t�s |�|�� dS )z�
Close the connection and raise an exception
if retry_on_timeout is not set or the error
is not a TimeoutError. Otherwise, try to reconnect
N)rr r; r� r Zconnectrs r r r �_disconnect_raise_connect� s z PubSub._disconnect_raise_connectc s$ �j �� ��fdd���fdd��S )aU
Connect manually upon disconnection. If the Redis server is down,
this will fail and raise a ConnectionError as desired.
After reconnection, the ``on_connect`` callback should have been
called by the # connection to resubscribe us to any channels and
patterns we were previously listening to
c s �� i ���S r! r r )rp r� rc r r r� � r z!PubSub._execute.<locals>.<lambda>c s �� � | �S r! )r� rx ry r r r� � r )r rz )r* rl r� rp rc r )rp r� rl rc r* r r� � s �zPubSub._executeTr c C sf | j }|du rtd��| �� |s8| j||j|d�s8dS | �||j�}| �|�rb| jd8 _dS |S )z3Parse the response from a publish/subscribe commandN�Npubsub connection not set: did you forget to call subscribe() or psubscribe()?r� rL )r6 � RuntimeErrorr� r� r� r| r� r� )r* �blockrV rl r r r r rn � s �
zPubSub.parse_responsec C s || j | jfv S )z�
Check if the response is a health check response.
If there are no subscriptions redis responds to PING command with a
bulk response, instead of a multi-bulk with "pong" and the response.
)r� r� r r r r r� � s �z PubSub.is_health_check_responsec C sN | j }|d u rtd��|jrJt�� |jkrJ|jd| jdd� | jd7 _d S )Nr� r F)r� rL )r6 r� r rR Znext_health_checkrm r� r� rk 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 )rC r, r- �r� r� r r r� r z*PubSub._normalize_keys.<locals>.<dictcomp>)r� r� r� r( r: r r� r �_normalize_keys� s zPubSub._normalize_keysc O s� |rt |d |dd� �}t�|�}|�|� | jdg|�� �R � }| �|�}| j�|� | jsp| j �
� d| _ | 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 NZ
PSUBSCRIBE)r r" r# r9 r{ r} r� r� r� r� rj r� r� �difference_update)r* rp rc Z new_patterns�ret_valr r r r� s
zPubSub.psubscribec G sP |r,t |d |dd� �}| �t�|��}n| j}| j�|� | jdg|�R � S )zj
Unsubscribe from the supplied patterns. If empty, unsubscribe from
all patterns.
r rL NZ PUNSUBSCRIBE)r r� r" r# r� r� r9 r{ )r* rp r� r r r r� s zPubSub.punsubscribec O s� |rt |d |dd� �}t�|�}|�|� | jdg|�� �R � }| �|�}| j�|� | jsp| j �
� d| _ | 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 NZ SUBSCRIBE)r r" r# r9 r{ r} r� r� r� r� rj r� r� r� )r* rp rc Z new_channelsr� r r r r� ) s
zPubSub.subscribec G sP |r,t |d |dd� �}| �t�|��}n| j}| j�|� | jdg|�R � S )zi
Unsubscribe from the supplied channels. If empty, unsubscribe from
all channels
r rL NZ UNSUBSCRIBE)r r� r" r# r� r� r9 r{ )r* rp r� r r r r� C s zPubSub.unsubscribec c s, | j r(| �| jdd��}|dur |V q dS )zBListen for messages on channels this client has been subscribed toT)r� N)r� �handle_messagern r r r r r� P s z
PubSub.listenc C s` | j s>t�� }| j�|�du r:t�� | }td|| �}ndS | jd|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.
Tg NF)r� rV )r� rR r� �waitr� rn r� )r* r� rV r� Z
time_spentr r r r � get_messageW s zPubSub.get_messagec C s |du r dn|}| � d|�S )z'
Ping the Redis server
Nr� r �r{ )r* r� r r r r� r s z PubSub.pingc C s` |du r dS t |d �}|dkr<||d |d |d d�}n2|dkrX|dd|d d�}n|d|d |d d�}|| jv r�|d kr�|d }|| jv r�| j�|� | j�|d� n,|d }|| jv r�| j�|� | j�|d� | js�| js�| j� � || j
v �r@|dk�r| j� |d
d�}n| j� |d d�}|�r\||� dS n |dk�r\|�sX| j �r\dS |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.
Nr r� rL rz r� )r� �pattern�channelr+ r� r� r� r� )
r �UNSUBSCRIBE_MESSAGE_TYPESr� �remover� rO r� r� r� r� �PUBLISH_MESSAGE_TYPESr6 r� )r* r r� Z message_typer� r� r� �handlerr r r r� y sV ���
zPubSub.handle_messagec C st | j �� D ] \}}|d u r
td|� d���q
| j�� D ] \}}|d u r6td|� d���q6t| |||d�}|�� |S )Nz
Channel: 'z' has no handler registeredz
Pattern: ')�daemon�exception_handler)r� r( r
r� �PubSubWorkerThread�start)r* �
sleep_timer� r� r� r� r� �threadr r r �
run_in_thread� s �zPubSub.run_in_thread)NFN)Tr )Fr )N)F)r FN)!r; r< r= r> r� r� r� r. r` rg rh r� rb r� �propertyr� r{ r� r� r� rn r� r� r� r� r� r� r� r� r� r� r� r� r r r r r[ 3 sB �
Ar[ c s. e Zd Zd � fdd� Zdd� Zdd� Z� ZS )
r� FNc s0 t � �� || _|| _|| _|| _t�� | _d S r! ) r/ r. r� r\ r� r� r� r� �_running)r* r\ r� r� r� r2 r r r. � s
zPubSubWorkerThread.__init__c
C s� | j �� rd S | j �� | j}| j}| j �� r�z|jd|d� W q$ ty~ } z&| jd u r\� | �||| � W Y d }~q$d }~0 0 q$|�� d S )NT)r� rV ) r� r� rj r\ r� r� �
BaseExceptionr� rb )r* r\ r� �er r r �run� s
&zPubSubWorkerThread.runc C s | j �� d S r! )r� r� r@ r r r �stop� s zPubSubWorkerThread.stop)FN)r; r< r= r. r� r� r? r r r2 r r� � s r� c @ s� e Zd ZdZh d�Zdd� Zdd� Zdd� Zd d
� Zd d � Z d
d� Z
dd� Z dd� Z dd� Z
dd� Zdd� Zdd� Zdd � Zd d � Zd d � Zd!d"� Zd#d$� Zd%d&� Zd'd(� Zd3d*d+�Zd,d-� Zd.d/� Zd0d1� Zd2S )4rI 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.
> �EXEC�DISCARD�UNWATCHc C s0 || _ d | _|| _|| _|| _d| _| �� d S )NF)r
r6 r8 rJ rK �watchingr� )r* r
r8 rJ rK r r r r. � s zPipeline.__init__c C s | S r! r r@ r r r r` s zPipeline.__enter__c C s | � � d S r! r� rc r r r rg
s zPipeline.__exit__c C s$ z | � � W n ty Y n0 d S r! r� r@ r r r rh
s zPipeline.__del__c C s
t | j�S r! )r� �
command_stackr@ 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� | _| jrR| jrRz| j�d� | j�� W n tyP | j�� Y n0 d| _d| _ | jrx| j
� | j� d | _d S )Nr� F) r� rj �scriptsr� r6 rm r| r
rr �explicit_transactionr
rj r@ r r r r� 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� 1 s �zPipeline.multic O s8 | j s|d dkr(| js(| j|i |��S | j|i |��S )Nr �WATCH)r� r� �immediate_execute_command�pipeline_execute_command)r* rp rc r r r r{ > s zPipeline.execute_commandc C s< |� � | jr | �� td��|jr.t|t�s8| �� � dS )z�
Close the connection, reset watching state and
raise an exception if we were watching,
retry_on_timeout is not set,
or the error is not a TimeoutError
�=A ConnectionError occurred on while watching one or more keysN)rr r� r� r r; r� r rs r r r �_disconnect_reset_raiseC s �z Pipeline._disconnect_reset_raisec sP � d ��j ��s(�j���j����_ �j�� ����fdd���fdd��S )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 c s �j ��g� �R i ���S r! rv r rw r r r� h s ���z4Pipeline.immediate_execute_command.<locals>.<lambda>c s �� � | �S r! )r� rx ry r r r� k r )r6 r
r7 rK r rz �r* rp r� r rw r r� Y 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� r[ r� r r r r� n s z!Pipeline.pipeline_execute_commandc C s t di fg|di fg�}|�dd� |D ��}|�|� g }z| �|d� W n2 ty| } z|�d|f� W Y d }~n
d }~0 0 t|�D ]�\}} t| d v r�|�|| d t f� q�z| �|d� W q� t�y } z0| �||d | d � |�||f� W Y d }~q�d }~0 0 q�z| �|d�}
W n( t �yH |�rB|d d �� Y n0 d| _
|
d u �rbt d ��|D ]\}}|
� ||� �qft
|
�t
|�k�r�| j�� td
��|�r�| �||
� g } t|
|�D ]R\} }
t| t��s|
\}}|d }|| jv �r| j| | fi |��} | �| � �q�| S ) N)�MULTI)r� c S s g | ]\}}t |vr|�qS r )r )rC rp r� r r r ru � r z1Pipeline._execute_transaction.<locals>.<listcomp>r0 r rL FzWatched variable changed.z6Wrong number of response items from pipeline execution)r �
pack_commands�send_packed_commandrn r r[ � enumerater �annotate_exceptionr r� r �insertr� r6 rr �raise_first_errorr{ r� r� r8 )r* r6 r� �raise_on_errorZcmds�all_cmdsr: r� r� r� r r+ r� �cmdrp r� ro r r r �_execute_transaction} sZ �
$ &
� z Pipeline._execute_transactionc C s� |� dd� |D ��}|�|� g }|D ]Z\}}z"|�| j||d fi |��� W q& ty~ } z|�|� W Y d }~q&d }~0 0 q&|r�| �||� |S )Nc S s g | ] \}}|�qS r r )rC rp r0 r r r ru � r z.Pipeline._execute_pipeline.<locals>.<listcomp>r )r� r� r[ rn r r� ) r* r6 r� r� r� r rp r� r� r r r �_execute_pipeline� s
"" zPipeline._execute_pipelinec C s> t |�D ]0\}}t|t�r| �||d || d � |�qd S )NrL r )r� r� r r� )r* r� r r� r� r r r r� � s
zPipeline.raise_first_errorc C sF d� tt|��}d|� d|� d|jd � �}|f|jdd � |_d S )Nr� z
Command # z (z ) of pipeline caused error: r rL )r� rp r rp )r* � exceptionZnumberr� r� �msgr r r r� � s ��zPipeline.annotate_exceptionc K s: t j| ||fi |��}|| jv r(d| _n|dkr6d| _|S )NFr� T)r rn �UNWATCH_COMMANDSr� )r* r6 ro r� rk r r r rn � s
zPipeline.parse_responsec C s` t | j�}| j}dd� |D �}|dg|�R � }t|�s\t||�D ]\}}|s@|d|j�|_q@d S )Nc S s g | ]
}|j �qS r )�sha)rC �sr r r ru � r z)Pipeline.load_scripts.<locals>.<listcomp>r r
)r� r� r� �allr{ Zscriptr� )r* r� Z immediateZshas�existsr� Zexistr r r � load_scripts� s
zPipeline.load_scriptsc C s4 |� � | jrtd��|jr&t|t�s0| �� � dS )z�
Close the connection, raise an exception if we were watching,
and raise an exception if retry_on_timeout is not set,
or the error is not a TimeoutError
r� N)rr r� r r; r� r r� rs r r r �_disconnect_raise_reset� s �z Pipeline._disconnect_raise_resetTc s� �j ��s�jsg S �jr"��� �js.�jr6�j�n�j��j� � s\�j �
d�j �� � �_z0� j �
� ���fdd�� �fdd��W ��� S ��� 0 dS )z0Execute all the commands in the current pipeliner� c s �� ���S r! r r )rl rQ r� �stackr r r� r z"Pipeline.execute.<locals>.<lambda>c s �� � | �S r! )r� rx ry r r r� r N)r� r� r� r� rJ r� r� r� r6 r
r7 rK r rz r� )r* r� r )rl rQ r� r* r� r rQ s(
��zPipeline.executec C s | � d� dS )zg
Flushes all previously queued commands
See: https://redis.io/commands/DISCARD
r� Nr� r@ r r r �discard" s zPipeline.discardc G s | j rtd��| jdg|�R � S )z$Watches the values at keys ``names``z"Cannot issue a WATCH after a MULTIr� )r� r r{ )r* �namesr r r rP ) s zPipeline.watchc C s | j r| �d�pdS )z'Unwatches all previously specified keysr� T)r� r{ r@ r r r �unwatch/ s zPipeline.unwatchN)T) r; r< r= r> r� r. r` rg rh r� r� r� r� r{ r� r� r� r� r� r� r� rn r� r� rQ r� rP r� r r r r rI � s2
C
rI )FF)_r4 r r� r� rR r1 � itertoolsr Zredis.commandsr r r r Zredis.connectionr r r Zredis.exceptionsr
r r r
r r r r Z
redis.lockr Z redis.utilsr r Z SYM_EMPTYr r r r& r" r' rF rH r_ rd r ri rn rq rs rv ry rb rh r� r� rG 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 Z StrictRedisr] r[ �Threadr� rI r r r r �<module> s� (
, �
!% ! 'C