File: //opt/saltstack/salt/extras-3.10/redis/asyncio/__pycache__/client.cpython-310.pyc
o
��ex� � @ s� d dl Z d dlZd dlZd dlZd dlZd dlZd dlmZmZm Z m
Z
m Z m Z m
Z
mZmZmZmZmZmZmZmZmZmZ d dlmZmZmZm Z d dl m Z m Z m Z m!Z! d dl"m#Z# d dl$m%Z% d dl&m'Z'm(Z(m)Z)m*Z* d dl+m,Z,m-Z-m.Z.m/Z/ d d l0m1Z1m2Z2 d d
l3m4Z4 d d l5m6Z6m7Z7m8Z8m9Z9m:Z:m;Z;m<Z< d d l=m>Z>m?Z?m@Z@ d d
lAmBZBmCZCmDZDmEZEmFZFmGZG e e eHeHf ge
d f ZIede@d�ZJede@e?�ZKeddd�ZLedee>eMf d�ZNer�d dlOmPZP G dd� de1�ZQG dd� de1�ZReeQeRf ZSG dd� de)e-e,e.�ZTeTZUG dd� de2�ZVG d d � d �ZWG d d � d �ZXG d d!� d!e1�ZYG d"d#� d#e1�ZZeeYeZf Z[eeeeHe\f d$f eeHef f Z]ee] Z^G d%d&� d&eT�Z_dS )'� N)�
TYPE_CHECKING�Any�
AsyncIterator� Awaitable�Callable�Dict�Iterable�List�Mapping�MutableMapping�Optional�Set�Tuple�Type�TypeVar�Union�cast)�_RedisCallbacks�_RedisCallbacksRESP2�_RedisCallbacksRESP3�bool_ok)�
Connection�ConnectionPool�
SSLConnection�UnixDomainSocketConnection��Lock)�Retry)�EMPTY_RESPONSE� NEVER_DECODE�
AbstractRedis�CaseInsensitiveDict)�AsyncCoreCommands�AsyncRedisModuleCommands�AsyncSentinelCommands� list_or_args)�Protocol� TypedDict)�CredentialProvider)�ConnectionError�ExecAbortError� PubSubError�
RedisError�
ResponseError� TimeoutError�
WatchError)�ChannelT�
EncodableT�KeyT)�HIREDIS_AVAILABLE�_set_info_logger�deprecated_function�get_lib_version�safe_str� str_if_bytes�_KeyT)�bound�_ArgT�_RedisT�Redis�_NormalizeKeysT)�Scriptc @ � e Zd Zdefdd�ZdS )�ResponseCallbackProtocol�responsec K � d S �N� ��selfrB �kwargsrE rE �7/opt/saltstack/salt/extras-3.10/redis/asyncio/client.py�__call__T � z!ResponseCallbackProtocol.__call__N��__name__�
__module__� __qualname__r rJ rE rE rE rI rA S � rA c @ r@ )� AsyncResponseCallbackProtocolrB c � � �d S rD rE rF rE rE rI rJ Y � �z&AsyncResponseCallbackProtocol.__call__NrL rE rE rE rI rQ X rP rQ c F @ s� e Zd ZU dZeeeef ef e d< e
d�dede de e fdd ��Z
e
d
ed d ed d fd
d��Zdddddddddddddddddddddddddddde� ddddddd�#dededeeef de e d e e d e e d e e d e eeeeef f d e e d e e d!ed"ed#e d$e d%e e d&e d'e e d(e e d)ed*e e d+e e d,e d-e ej d.e e de d/ed0e e d1e e d2e e d3e e d4e e de e d5e e d6e e fDd7d8�Zd9d:� Zd;d<� Z d=e d e fd>d?�Z d@edAefdBdC�Z dDdE� Z dFdG� Z!d e dH fdIdJ�Z"d�dKdL�Z#dMdN� Z$ d�dPe dQe e d dRfdSdT�Z%ddddU�dVe&dRgee'e(e' f f dWe)dQe e dXe dYe e f
dZd[�Z* \ O Od�d]e)d^e e d_ed`e dae e dbe ee+ dce d e+fddde�Z,d�dgdh�Z-d�djdk�Z.d�dldm�Z/d=e d e fdndo�Z0dpdq� Z1drZ2e3j4e5j6fdse'dte'd dfdudv�Z7d�dwe e d dfdxdy�Z8e9dzd{d|d}�d�dwe e d dfd~d��Z:d�d�� Z;d�e<d�e=fd�d��Z>d�d�� Z?d�e<d�eeef fd�d��Z@dS )�r= a�
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.
�response_callbacksFN�url�single_connection_client�auto_close_connection_poolc K sD t j|fi |��}| ||d�}|durt�td�� nd}||_|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@]/path/to/socket.sock?db=0[&password=password]
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_poolrV N��"auto_close_connection_pool" is deprecated since version 5.0.1. Please create a ConnectionPool explicitly and provide to the Redis() constructor instead.T)r �from_url�warnings�warn�DeprecationWarningrW )�clsrU rV rW rH rY �clientrE rE rI r[ q s 2��� zRedis.from_urlr_ rY �returnc C s | |d�}d|_ |S )z�
Return a Redis client from the given connection pool.
The Redis client will take ownership of the connection pool and
close it when the Redis client is closed.
)rY T)rW )r_ rY r` rE rE rI � from_pool� s
�zRedis.from_pool� localhosti� r zutf-8�strict�requiredzredis-py� )#�host�port�db�password�socket_timeout�socket_connect_timeout�socket_keepalive�socket_keepalive_optionsrY �unix_socket_path�encoding�encoding_errors�decode_responses�retry_on_timeout�retry_on_error�ssl� ssl_keyfile� ssl_certfile�
ssl_cert_reqs� ssl_ca_certs� ssl_ca_data�ssl_check_hostname�ssl_min_version�max_connectionsrV �health_check_interval� client_name�lib_name� lib_version�username�retryrW �redis_connect_func�credential_provider�protocolrg rh ri rj rk rl rm rn ro rp rq rr rs rt ru rv rw rx ry rz r{ r| r} r~ r r� r� r� r� r� r� c # % C st | dur t �td�� nd} | s�|sg }|du r |�t� i d|�d| �d|�d|"�d|�d | �d
| �d |
�d |�d
|�dt�| ��d|�d|�d|�d| �d| �d|!�d|#i�}$|
durf|$�|
td�� n|$�|||||d�� |r�|$�t |||||||d�� | | _
t di |$��} nd| _
| | _ || _
d| _tt�| _| j j�d�dv r�| j�t� n| j�t� t�� | _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`.
NrZ Tri r� rj r� rk rp rq rr rs rt r� r} r~ r r� r� r� r� )�path�connection_class)rg rh rl rm rn )r� rv rw rx ry rz r{ r| F)�3� rE )r\ r] r^ �appendr. �copy�deepcopy�updater r rW r rY rV �
connectionr! r rT �connection_kwargs�getr r �asyncior �_single_conn_lock)%rG rg rh ri rj rk rl rm rn rY ro rp rq rr rs rt ru rv rw rx ry rz r{ r| r} rV r~ r r� r� r� r� rW r� r� r� rH rE rE rI �__init__� s� 2��
�������� �
�
� �
����������
��
zRedis.__init__c C s | j j� d| j�d�S )N�<�>)� __class__rM rY �rG rE rE rI �__repr__V s zRedis.__repr__c C � | � � �� S rD )�
initialize� __await__r� rE rE rI r� Y � zRedis.__await__rG c � sf �| j r1| j4 I d H � | jd u r| j�d�I d H | _W d �I d H | S 1 I d H s,w Y | S )N�_)rV r� r� rY �get_connectionr� rE rE rI r� \ s �
��zRedis.initialize�command�callbackc C s || j |< dS )z Set a custom Response CallbackN)rT )rG r� r� rE rE rI �set_response_callbackc s zRedis.set_response_callbackc C s
| j �� S )z!Get the connection pool's encoder)rY � get_encoderr� rE rE rI r� g s
zRedis.get_encoderc C s | j jS )z'Get the connection's key-word arguments)rY r� r� rE rE rI �get_connection_kwargsk s zRedis.get_connection_kwargsr c C s | � � �d�S �Nr� )r� r� r� rE rE rI � get_retryo s zRedis.get_retryc C s" | � � �d|i� | j�|� d S r� )r� r� rY � set_retry)rG r� rE rE rI r� r s zRedis.set_retryc 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)rG �funcname�funcrE rE rI �load_external_modulev s zRedis.load_external_moduleT� transaction�
shard_hint�Pipelinec 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.
)r� rY rT )rG r� r� rE rE rI �pipeline� s
�zRedis.pipeline)r� �value_from_callable� watch_delayr� �watchesr� r� c � s� �| � d|�4 I dH �L} z0|r|j|� I dH ||�}t�|�r&|I dH }|�� I dH }|r1|n|W W d �I dH S tyV |durT|dkrTt�|�I dH Y q w 1 I dH s]w 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.
TNr )r� �watch�inspect� isawaitable�executer/ r� �sleep) rG r� r� r� r� r� �pipeZ
func_valueZ
exec_valuerE rE rI r� � s$ �
�
��zRedis.transaction皙�����?�name�timeoutr� �blocking�blocking_timeout�
lock_class� thread_localc C s" |du rt }|| ||||||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)r� r� r� r� r� r )rG r� r� r� r� r� r� r� rE rE rI �lock� s >�z
Redis.lock�PubSubc 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.
)r� rY )rG rH rE rE rI �pubsub s z Redis.pubsub�Monitorc C �
t | j�S rD )r� rY r� rE rE rI �monitor
�
z
Redis.monitorc C s | j | jdd�S )NTrX )r� rY r� rE rE rI r`
s �z Redis.clientc � s �| � � I d H S rD )r� r� rE rE rI �
__aenter__ s �zRedis.__aenter__c � � �| � � I d H d S rD ��aclose�rG �exc_type� exc_value� tracebackrE rE rI � __aexit__ � �zRedis.__aexit__zUnclosed Redis client�_warn�_grlc C sn t | d�r3| jd ur5|d| ��t| d� z| | jd�}|� �|� W n ty+ Y nw | j�� d S d S d S )Nr� zUnclosed client session )�source)r` �message)�hasattrr� �ResourceWarning� _DEL_MESSAGE�call_exception_handler� RuntimeError�_close)rG r� r� �contextrE rE rI �__del__ s ��z
Redis.__del__�close_connection_poolc � sR �| j }|rd| _ | j�|�I dH |s|du r%| jr'| j�� I dH dS dS dS )aB
Closes Redis client connection
:param close_connection_pool: decides whether to close the connection pool used
by this Redis client, overriding Redis.auto_close_connection_pool. By default,
let Redis.auto_close_connection_pool decide whether to close the connection
pool.
N)r� rY �releaserW �
disconnect)rG r� �connrE rE rI r� * s � �z Redis.aclose�5.0.1�Use aclose() instead�close��version�reasonr� c � s �| � |�I dH dS )zA
Alias for aclose(), for backwards compatibility
Nr� )rG r� rE rE rI r� < s �z Redis.closec � s, �|j |� I dH | j||fi |��I dH S )z7
Send a command and parse the response
N)� send_command�parse_response)rG r� � command_name�args�optionsrE rE rI � _send_command_parse_responseC s �z"Redis._send_command_parse_responser� �errorc � s6 �|� � I dH |jdu st|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)r� rt �
isinstance�tuple�rG r� r� rE rE rI �_disconnect_raiseJ s �
�zRedis._disconnect_raisec � s� ��� � I dH �j}� d ��jp |j�fi ���I dH ��jr)�j�� I dH z,�j�� ����fdd���fdd��I dH W �jrI�j� � �jsU|� ��I dH S S �jr^�j� � �jsj|� ��I dH w w )z.Execute a command and return a parsed responseNr c � �j ��g� �R i ���S rD �r� rE �r� r� r� r� rG rE rI �<lambda>c � ���z'Redis.execute_command.<locals>.<lambda>c � �� � | �S rD )r� �r� �r� rG rE rI r� f � )
r� rY r� r� rV r� �acquirer� �call_with_retryr� )rG r� r� �poolrE r� rI �execute_commandX s, �
�
��
�zRedis.execute_commandr� r� c � s� �z t |v r|jdd�I dH }|�t � n|�� I dH }W n ty/ t|v r.|t Y S � w t|v r9|�t� || jv rZtt|�}| j| |fi |��}t� |�rX|I dH S |S |S )z'Parses a response from the Redis serverT)Zdisable_decodingN)
r �
read_response�popr- r rT r �strr� r� )rG r� r� r� rB �retvalrE rE rI r� n s& � � �
zRedis.parse_response)FN)r� r ra N)TN)Nr� TNNT)ra r� )ra r� )ra r= rD )ArM rN rO �__doc__r r r �bytes�ResponseCallbackT�__annotations__� classmethod�boolr r[ r r rb r6 �int�floatr
�listru �
TLSVersionr r( r� r� r� r< r� r� r� r� r� r� r� r� r r r r2 r� r r� r� r� r` r� r� r� r\ r] r� �get_running_loopr� r� r5 r� r� r � Exceptionr� r� r� rE rE rE rI r= ` s�
��� �D�� ����
���� �
� � �
��������������� � � � � �!�"�$�%
�
���
������
� ������
��
�
J
���
� �
�c @ s> e Zd ZU eed< eed< eed< eed< eed< eed< dS )�MonitorCommandInfo�timeri �client_address� client_port� client_typer� N)rM rN rO r
r r r rE rE rE rI r � s
r c @ sj e Zd ZdZe�d�Ze�d�Zdefdd�Z dd� Z
d d
� Z d d � Z d
e
fdd�Zd
ee
fdd�ZdS )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"(.*?)(?<!\\)"rY c C s || _ d | _d S rD )rY r� )rG rY rE rE rI r� � s
zMonitor.__init__c � s( �| j d u r| j�d�I d H | _ d S d S )N�MONITOR)r� rY r� r� rE rE rI �connect� s �
�zMonitor.connectc � sL �| � � I d H | j�d�I d H | j�� I d H }t|�s$td|� ���| S )Nr zMONITOR failed: )r r� r� r� r r, �rG rB rE rE rI r� � s �zMonitor.__aenter__c � s* �| j �� I d H | j�| j �I d H d S rD )r� r� rY r� )rG r� rE rE rI r� � s �zMonitor.__aexit__ra c � s� �| � � I dH | j�� I dH }t|t�r | jjj|dd�}|�dd�\}}| j� |�}|�
� \}}}d� | j �
|��}|�dd�}|dkrMd}d } d}
n|�d
�r]d
}|d d� } d
}
n
|�d d�\}} d
}
t|�t|�|| |
|d�S )z)Parse the response from a monitor commandNT��force� � z\"�"Zlua� �unix� �:�tcp)r ri r r r r� )r r� r� r� r �encoder�decode�split�
monitor_re�match�groups�join�
command_re�findall�replace�
startswith�rsplitr
r ) rG rB Z command_timeZ command_data�mZdb_idZ client_infor� r r r rE rE rI � next_command� s6 �
�zMonitor.next_commandc C s � | � � I dH V q)z)Listen for commands coming to the server.TN)r. r� rE rE rI �listen� s ��zMonitor.listenN)rM rN rO r �re�compiler$ r( r r� r r� r� r r. r r/ rE rE rE rI r� � s
$r� c
@ s� e Zd ZdZdZdZdZ dQdedee d e
d
ee fd d �Z d
d� Z
dd� Zdd� Zdd� Zedddd�dRdd��Zeddd d�dRd d ��Zd efd d!�Zed"d#� �Zd$efd%d&�Zd'd(� Zd)d*� Zd+d,� Z dSd/e
d0e fd1d2�Z d3d4� Z d5e de fd6d7�Z!d$e"d8e#fd9d:�Z$d$e"de%fd;d<�Z&d$e"d8e fd=d>�Z'de%fd?d@�Z(de)fdAdB�Z* CdTd e
d0ee fdDdE�Z+dUde%fdFdG�Z,dVdHdI�Z-ddJdK�dLedM dNe ddfdOdP�Z.dS )Wr� 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-checkNFrY r� �ignore_subscribe_messages�push_handler_funcc C s� || _ || _|| _d | _|| _|| _| jd u r | j �� | _| jjr+d| jg| jg| _ nd| j�
| j�g| j�
| j�g| _ | jd u rDt � i | _ t
� | _i | _t
� | _t�� | _d S )N�pong� pong)rY r� r5 r� r! r6 r� rr �HEALTH_CHECK_MESSAGE�health_check_response�encoder4 �channels�set� pending_unsubscribe_channels�patterns� pending_unsubscribe_patternsr� r �_lock)rG rY r� r5 r! r6 rE rE rI r� � s,
� �
zPubSub.__init__c � � �| S rD rE r� rE rE rI r� rS zPubSub.__aenter__c � r� rD r� r� rE rE rI r� r� zPubSub.__aexit__c C s | j r | j �| j� d S d S rD )r� �deregister_connect_callback�
on_connectr� rE rE rI r� s �zPubSub.__del__c � s� �t | d�sd S | j4 I d H �9 | jr/| j�� I d H | j�| j� | j�| j�I d H d | _i | _t � | _
i | _ t � | _ W d �I d H d S 1 I d H sNw Y d S )Nr� )
r� rA r� r� rC rD rY r� r< r= r> r? r@ r� rE rE rI r� s �
.�z
PubSub.acloser� r� r� r� ra c � � �| � � I dH dS �z/Alias for aclose(), for backwards compatibilityNr� r� rE rE rI r� ) � �z PubSub.close�resetc � rE rF r� r� rE rE rI rH . rG z PubSub.resetr� c � s� �| j �� | j�� | jr/i }| j�� D ]\}}||| jj|dd�< q| jdi |��I dH | jrUi }| j�� D ]\}}||| jj|dd�< q9| j di |��I dH dS dS )zBRe-subscribe to any channels and patterns previously subscribed toTr NrE )
r> �clearr@ r< �itemsr! r" � subscriber? �
psubscribe)rG r� r< �k�vr? rE rE rI rD 3 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� rE rE rI �
subscribedE s zPubSub.subscribedr� c � sH �| � � I dH | j}d| j i}| j||jg|�R i |��I dH dS )z#Execute a publish/subscribe commandN� check_health)r r� rO �_executer� )rG r� r� rH rE rE rI r� J s
� &zPubSub.execute_commandc � sn �| j du r| j�d| j�I dH | _ | j �| j� n| j �� I dH | jdur3ts5| j j �
| j� dS dS dS )z5
Ensure that the PubSub is connected
Nr� ) r� rY r� r� Zregister_connect_callbackrD r r6 r3 �_parserZset_push_handlerr� rE rE rI r V s �
��zPubSub.connectc � sD �|� � I dH |jdu st|t|j��du r|�|�� I dH 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. Otherwise, try to
reconnect
NF)r� rt r� r� r r� rE rE rI �_disconnect_raise_connectf s �
z PubSub._disconnect_raise_connectc � s, ��j �� ��fdd���fdd��I dH 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 rD rE rE )r� r� rH rE rI r� ~ s z!PubSub._execute.<locals>.<lambda>c r� rD )rS r� r� rE rI r� r� N)r� r� )rG r� r� r� rH rE )r� r� r� rH rG rI rQ u s
�
�zPubSub._executeTr �blockr� c � sz �| j }|du r td��| �� I dH |js |�� I dH |r!dn|}| j||j|ddd�I dH }|jr;|| jv r;dS |S )z3Parse the response from a publish/subscribe commandN�Npubsub connection not set: did you forget to call subscribe() or psubscribe()?FT)r� Zdisconnect_on_errorZ push_request) r� r� rP Z is_connectedr rQ r� r~ r: )rG rT r� r� � read_timeoutrB rE rE rI r� � s( �� �zPubSub.parse_responsec � sT �| j }|d u r td��|jr&t�� �� |jkr(|jd| jdd�I d H d S d S d S )NrU �PINGF)rP ) r� r� r~ r� r
r Znext_health_checkr� r9 )rG r� rE rE rI rP � s �����zPubSub.check_health�datac 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 rE rE )�.0rM rN �r" r; rE rI �
<dictcomp>� s z*PubSub._normalize_keys.<locals>.<dictcomp>)r! r; r" rJ )rG rX rE rZ rI �_normalize_keys� s zPubSub._normalize_keysrH c � sx �|rt |d f|dd� �n|}t�|�}|�|� | jdg|�� �R � I dH }| �|�}| 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 r NZ
PSUBSCRIBE)
r% �dict�fromkeysr� r� �keysr\ r? r@ �difference_update)rG r� rH � parsed_argsZ new_patterns�ret_valrE rE rI rL � � �
zPubSub.psubscribec G sZ |rt |d f|dd� �}| �t�|���� }ng }| j}| j�|� | jdg|�R � S )zj
Unsubscribe from the supplied patterns. If empty, unsubscribe from
all patterns.
r r NZ PUNSUBSCRIBE) r% r\ r] r^ r_ r? r@ r� r� )rG r� ra r? rE rE rI r4 � s zPubSub.punsubscribec � sx �|rt |d f|dd� �nd}t�|�}|�|� | jdg|�� �R � I dH }| �|�}| 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 r NrE � SUBSCRIBE)
r% r] r^ r� r� r_ r\ r< r> r` )rG r� rH ra Z new_channelsrb rE rE rI rK � rc zPubSub.subscribec G sT |rt |d |dd� �}| �t�|��}ng }| j}| j�|� | jdg|�R � S )zi
Unsubscribe from the supplied channels. If empty, unsubscribe from
all channels
r r N� UNSUBSCRIBE)r% r\ r] r^ r< r> r� r� )rG r� ra r< rE rE rI r3 � s zPubSub.unsubscribec C sB �| j r | �| jdd�I dH �I dH }|dur|V | j sdS dS )zBListen for messages on channels this client has been subscribed toT)rT N)rO �handle_messager� r rE rE rI r/ � s � �z
PubSub.listen� c � s4 �| j |du |d�I dH }|r| �||�I dH S dS )a
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 or None to wait indefinitely.
N)rT r� )r� rf )rG r5 r� rB rE rE rI � get_message s
�
zPubSub.get_messagec C s |durd|gndg}| j |� S )z'
Ping the Redis server
NrW �r� )rG r� r� rE rE rI �ping s
z PubSub.pingc � s� �|du rdS t |t�r|dkrd|gnddg}t|d �}|dkr0||d |d |d d
�}n|d kr>|dd|d d
�}n |d|d |d d
�}|| jv r|d kri|d }|| jv rh| j�|� | j�|d� n|d }|| jv r| j�|� | j �|d� || j
v r�|dkr�| j� |d
d�}n | j � |d d�}|r�t �
|�r�||�I dH dS ||� dS |S |d kr�|s�| jr�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.
Ns PONGr8 � r r2 r rf r� )�type�pattern�channelrX r7 r4 rm rn )r� r r8 �UNSUBSCRIBE_MESSAGE_TYPESr@ �remover? r r> r< �PUBLISH_MESSAGE_TYPESr� r� �iscoroutinefunctionr5 )rG rB r5 Z message_typer� rm rn �handlerrE rE rI rf sb �
���
�
��
zPubSub.handle_messageg �?)�exception_handler� poll_timeoutrt �PSWorkerThreadExcHandlerTru c
� s� �| j �� D ]\}}|du rtd|� d���q| j�� D ]\}}|du r,td|� d���q | �� I dH z | jd|d�I dH W n. tjyJ � tyo } z|du rV� ||| �}t �
|�re|I dH W Y d}~nd}~ww t� d�I dH q5)a� Process pub/sub messages using registered callbacks.
This is the equivalent of :py:meth:`redis.PubSub.run_in_thread` in
redis-py, but it is a coroutine. To launch it as a separate task, use
``asyncio.create_task``:
>>> task = asyncio.create_task(pubsub.run())
To shut it down, use asyncio cancellation:
>>> task.cancel()
>>> await task
Nz
Channel: 'z' has no handler registeredz
Pattern: 'T)r5 r� r ) r< rJ r+ r? r rh r� �CancelledError�
BaseExceptionr� r� r� )rG rt ru rn rs rm �e�resrE rE rI �run^ s6 ����
���z
PubSub.run)NFNN�ra N)Tr )Frg rD )F)/rM rN rO r rq ro r9 r r r r r r� r� r� r� r� r5 r� rH r rD �propertyrO r1 r� r rS rQ r
r� rP r> r\ r0 �
PubSubHandlerrL r r4 rK r3 r r/ rh rj rf r{ rE rE rE rI r� � st ����
�$
��
�
E����r� c @ � e Zd Zdedefdd�ZdS )� PubsubWorkerExceptionHandlerry r� c C rC rD rE �rG ry r� rE rE rI rJ � rK z%PubsubWorkerExceptionHandler.__call__N�rM rN rO rx r� rJ rE rE rE rI r� � � r� c @ r )�!AsyncPubsubWorkerExceptionHandlerry r� c � rR rD rE r� rE rE rI rJ � rS z*AsyncPubsubWorkerExceptionHandler.__call__Nr� rE rE rE rI r� � r� r� .c s� e Zd ZdZh d�Zdedeeee f e
f de de e fdd�Z
d ed
efd d �Zd
d� Zdd� ZdZdd� Zdd� Zdd� Zdd� ZdIdd �Zd d � Zd
ed ed f fd d �Zd!d"� Zd#d$� Z d%d&� Z d'e d(e fd)d*�Z d'e d(e d+e fd,d-�Z!d(e d.e"e# fd/d0�Z$d1e%d2e&d3e"e' d
dfd4d5�Z(d'e d6eee f f� fd7d8� Z)d9d:� Z*d;e d<e%fd=d>�Z+dJd+e fd@dA�Z,dBdC� Z-dDe.fdEdF�Z/dGdH� Z0� Z1S )Kr� 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�UNWATCHrY rT r� r� c C s< || _ d | _|| _|| _|| _d| _g | _t� | _d| _ d S )NF)
rY r� rT �is_transactionr� �watching�
command_stackr= �scripts�explicit_transaction)rG rY rT r� r� rE rE rI r� � s
zPipeline.__init__rG ra c � rB rD rE r� rE rE rI r� � rS zPipeline.__aenter__c � r� rD �rH r� rE rE rI r� � r� zPipeline.__aexit__c C r� rD )� _async_selfr� r� rE rE rI r� � r� zPipeline.__await__zUnclosed Pipeline clientc C r� rD )�lenr� r� rE rE rI �__len__� r� zPipeline.__len__c C s dS )z1Pipeline instances should always evaluate to TrueTrE r� rE rE rI �__bool__� s zPipeline.__bool__c � rB rD rE r� rE rE rI r� � rS zPipeline._async_selfc � s� �g | _ t� | _| jr6| jr6z| j�d�I d H | j�� I d H W n ty5 | jr3| j�� I d H Y nw d| _d| _ | jrN| j
� | j�I d H d | _d S d S )Nr� F) r� r= r� r� r� r� r� r) r� r� rY r� r� rE rE rI rH � s$ � ��
�zPipeline.resetNc � rE )z5Alias for reset(), a standard method name for cleanupNr� r� rE rE rI r� � s �zPipeline.aclosec C s& | j rtd��| jrtd��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� rE rE rI �multi� 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)rG r� rH rE rE rI r� s zPipeline.execute_commandc � s^ �|� � I dH | jr| �� I dH td��|jdu s%t|t|j��du r-| �� I dH � dS )z�
Close the connection, reset watching state and
raise an exception if we were watching,
if retry_on_error is not set or the error is not one
of the specified error types.
N�=A ConnectionError occurred on while watching one or more keysF)r� r� r� r/ rt r� r� r� rE rE rI �_disconnect_reset_raise s ��
�z Pipeline._disconnect_reset_raisec � s^ �� d ��j ��s�j���j�I dH ���_ �j�� ����fdd���fdd��I dH 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 Nc r� rD r� rE r� rE rI r� 3 r� z4Pipeline.immediate_execute_command.<locals>.<lambda>c r� rD )r� r� r� rE rI r� 6 r� )r� rY r� r� r� r� �rG r� r� rE r� rI 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� r� r� rE rE rI r� 9 s z!Pipeline.pipeline_execute_commandr� �commandsc � sX �di f}di f}|g|�|�R }|� dd� |D ��}|�|�I d H g }z | �|d�I d H W n tyI } z
|�d| f� W Y d } ~ nd } ~ ww t|�D ]E\}
} t| d v rd|�|
| d t f� qNz | �|d�I d H W qN ty� } z| �| |
d | d � |�|
| f� W Y d } ~ qNd } ~ ww z | �|d�I d H } W n ty� } z
|r�|d d | �� d } ~ ww d| _ | d u r�t
d �d �|D ]
\}
}
| � |
|
� q�t | �t |�kr�| j
r�| j
�� I d H td
�d �|r�| �|| � g }t| |�D ]3\}}t|t��s$|\}}|d }|| jv �r$| j| |fi |��}t�|��r$|I d H }|�|� q�|S ) N)�MULTI)r� c s s � | ] \}}t |vr|V qd S rD )r )rY r� r� rE rE rI � <genexpr>N s � �z0Pipeline._execute_transaction.<locals>.<genexpr>r� r r FzWatched variable changed.z6Wrong number of response items from pipeline execution)�
pack_commands�send_packed_commandr� r- r� � enumerater �annotate_exceptionr* r� r/ �insertr� r� r� �raise_first_error�zipr� r rT r� r� )rG r� r� �raise_on_error�pre�post�cmds�all_cmds�errors�err�ir� rB ry rX �r�cmdr� r� r� rE rE rI �_execute_transactionH sv �
��� ����
��
z Pipeline._execute_transactionr� c � s� �|� dd� |D ��}|�|�I d H g }|D ]/\}}z|�| j||d fi |��I d H � W q tyF } z |�|� W Y d }~qd }~ww |rO| �||� |S )Nc S s g | ]\}}|�qS rE rE )rY r� r� rE rE rI �
<listcomp>� s z.Pipeline._execute_pipeline.<locals>.<listcomp>r )r� r� r� r� r- r� ) rG r� r� r� r� rB r� r� ry rE rE rI �_execute_pipeline� s � ��� zPipeline._execute_pipelinerB c C s> t |�D ]\}}t|t�r | �||d || d � |�qd S )Nr r )r� r� r- r� )rG r� rB r� r� rE rE rI r� � s
��zPipeline.raise_first_error� exception�numberr� c C sB d� tt|��}d|� d|� d|j� �}|f|jdd � |_d S )Nr z
Command # z (z ) of pipeline caused error: r )r' �mapr7 r� )rG r� r� r� r� �msgrE rE rI r� � s zPipeline.annotate_exceptionr� c � sD �t � j||fi |��I d H }|| jv rd| _|S |dkr d| _|S )NFr� T)�superr� �UNWATCH_COMMANDSr� )rG r� r� r� �result�r� rE rI r� � s �
�zPipeline.parse_responsec � sr �t | j�}| j}dd� |D �}|dg|�R � I d H }t|�s5t||�D ]\}}|s4|d|j�I d H |_q$d S d S )Nc S s g | ]}|j �qS rE )�sha)rY �srE rE rI r� � s z)Pipeline.load_scripts.<locals>.<listcomp>z
SCRIPT EXISTSz SCRIPT LOAD)r r� r� �allr� �scriptr� )rG r� Z immediateZshas�existsr� �existrE rE rI � load_scripts� s �
��zPipeline.load_scriptsr� r� c � sP �|� � I dH | jrtd��|jdu s t|t|j��du r&| �� I dH � dS )z�
Close the connection, raise an exception if we were watching,
and raise an exception if retry_on_error is not set or the
error is not one of the specified error types.
Nr� F)r� r� r/ rt r� r� rH r� rE rE rI �_disconnect_raise_reset� s ��
�z Pipeline._disconnect_raise_resetTc � s� ��j ��s �js g S �jr��� I dH �js�jr �j�n�j��j� � s5�j �
d�j �I dH � � �_t t
� �� z � j�� ���fdd�� �fdd��I dH W ��� I dH S ��� I dH w )z0Execute all the commands in the current pipelineNr� c s �� ���S rD rE rE )r� r� r� �stackrE rI r� � r� z"Pipeline.execute.<locals>.<lambda>c r� rD )r� r� r� rE rI r� � r� )r� r� r� r� r� r� r� r� r� rY r� r� r r r� r� rH )rG r� rE )r� r� r� rG r� rI r� � s( �
� zPipeline.executec � s �| � d�I dH dS )z^Flushes all previously queued commands
See: https://redis.io/commands/DISCARD
r� Nri r� rE rE rI �discard� s �zPipeline.discard�namesc � s( �| j rtd��| jdg|�R � I dH S )z$Watches the values at keys ``names``z"Cannot issue a WATCH after a MULTIr� N)r� r, r� )rG r� rE rE rI r� s �zPipeline.watchc � s �| j r | �d�I dH p
dS )z'Unwatches all previously specified keysr� NT)r� r� r� rE rE rI �unwatch s �zPipeline.unwatchr| )T)2rM rN rO r r� r r r r r r r r r� r< r� r� r� r� r� r� r� rH r� r� r r� r� r� r� r �
CommandStackTr� r� r r r� r r �objectr� r� r� r� r� r� r2 r� r� �
__classcell__rE rE r� rI r� � sz ���
�
��
�J��
����
��
�
r� )`r� r� r� r0 ru r\ �typingr r r r r r r r r
r r r
r r r r r Zredis._parsers.helpersr r r r �redis.asyncio.connectionr r r r Zredis.asyncio.lockr Zredis.asyncio.retryr � redis.clientr r r r! Zredis.commandsr" r# r$ r% Z redis.compatr& r' �redis.credentialsr( �redis.exceptionsr) r* r+ r, r- r. r/ Z redis.typingr0 r1 r2 � redis.utilsr3 r4 r5 r6 r7 r8 r r~ r9 r; r< r� r> Zredis.commands.corer? rA rQ r r= � StrictRedisr r� r� r� r� rv r ZCommandTr� r� rE rE rE rI �<module> sd L $
� , I 1�$