U g @sUddlZddlZddlZddlZddlZddlZddlZddlZddlZddl m Z ddl m Z ddl mZddlmZmZmZmZmZmZmZmZmZmZmZmZmZddlmZmZm Z m!Z!ddl"m#Z#ej$d krdd lm%Z&n dd l&m%Z&dd l'm(Z(dd l)m*Z*dd l+m,Z,ddl-m.Z.m/Z/ddl0m1Z1m2Z2m3Z3m4Z4m5Z5m6Z6m7Z7ddl8m9Z9ddl:m;Z;mm?Z?m@Z@mAZAmBZBmCZCdZDdZEdZFdZGdZHGdddejIZJeJjKZLeeeBeCeAfeMd<e;reAZNneBZNGdddeZOGdddeZPeeOePfZQGdd d ZRGd!d"d"eRZSGd#d$d$eSZTGd%d&d&ZUGd'd(d(eRZVd)ZWeeXd*d+d,ZYeeZe[e[eYeYeZeZeYe[d- Z\ee]ed.e^ffeMd/<Gd0d1d1ed2d3Z_e]e_d4d5d6Z`ed7d8d9ZaGd:d8d8ZbGd;d<dr?csdSrAr:rBr:r:r;rDYr3z%AsyncConnectCallbackProtocol.__call__NrEr:r:r:r;rFXsrFc@s@eZdZdZdZdddddedddedddd edddedd d e e e fe e e e e e ee eefe e eeee e e e e e e e e e e ee eeee ee e d d d ZefedddZddZddZeddZeddZddZ ddZ!eeddddZ"d d!Z#ed"d#Z$ee d$d%d&Z%e&e d'd(d)Z'dd$d*d+Z(dOedd,d-d.Z)d/d0Z*d1d2Z+d3d4Z,e-e.dd5d6d7Z/dPe e.e e-e.fedd9d:d;Z0eedd<d=d>Z1d?d@Z2dQd8ddAee e ee edBdCdDZ3e4e5e.dEdFdGZ6e-e-e4e5e.dHdIdJZ7dKdLZ8dMdNZ9dS)Rr>z0Manages communication to and from a Redis server)dbusername client_namelib_name lib_versioncredential_providerpasswordsocket_timeoutsocket_connect_timeoutredis_connect_funcretry_on_timeoutretry_on_errorhealth_check_intervalnext_health_checkZlast_active_atencoder ssl_contextprotocol_reader_writer_parser_connect_callbacks_buffer_cutoff_lock_socket_read_size__dict__rNFutf-8strictizredis-pyr)rGrMrNrOrQrRencodingencoding_errorsdecode_responses parser_classsocket_read_sizerSrIrJrKrHretryrP encoder_classrLrWcCs|s|r|dk rtd||_| |_||_||_||_||_||_||_|dkrT|}||_ ||_ |t krlg}|r| t | tj| tj ||_|s|r|sttd|_n t||_|j|nttd|_| |_d|_|||| |_||_d|_d|_| |_|| g|_ d|_!zHz t$|}Wn6t%k rLt&}Ynt'k rht"d YnXW5|dks|dkrt"d||_#XdS) Nz'username' and 'password' cannot be passed along with 'credential_provider'. Please provide only one of the following arguments: 1. 'password' and (optional) 'username' 2. 'credential_provider'riprrzprotocol must be either 2 or 3zprotocol must be an integer)(r#rGrIrJrKrLrMrHrNrOrQSENTINELappendr&socketrasynciorRrrrgcopydeepcopyZupdate_supported_errorsrSrTrUrPrXrYr^ set_parserr[r\r"rWint TypeErrorr ValueError)rCrGrMrNrOrQrRrbrcrdrerfrSrIrJrKrHrgrPrhrLrWpr:r:r;__init__s`      zAbstractConnection.__init__) _warningscCsPt|ddrL|jd|t|dzt|Wntk rJYnXdS)NrYzunclosed Connection )source)getattrwarnResourceWarningrnget_running_loop_close RuntimeError)rCrwr:r:r;__del__s  zAbstractConnection.__del__cCs |jr|jd|_|_dS)zR Internal method to silently close the connection without waiting N)rYcloserXrCr:r:r;r}s zAbstractConnection._closecCs8ddd|D}d|jjd|jjd|dS)N,css |]\}}|d|VqdS)=Nr:).0kvr:r:r; sz.AbstractConnection.__repr__..<.()>)join repr_pieces __class__r6r5)rCZ repr_argsr:r:r;__repr__szAbstractConnection.__repr__cCsdSrAr:rr:r:r;rszAbstractConnection.repr_piecescCs|jdk o|jdk SrA)rXrYrr:r:r; is_connectedszAbstractConnection.is_connectedcCs$t|}||jkr |j|dS)a^ Register a callback to be called when the connection is established either initially or reconnected. This allows listeners to issue commands that are ephemeral to the connection, for example pub/sub subscription or key tracking. The callback must be a _method_ and will be kept as a weak reference. N)weakref WeakMethodr[rl)rCcallbackZwmr:r:r;register_connect_callbacks  z,AbstractConnection.register_connect_callbackcCs0z|jt|Wntk r*YnXdS)z De-register a previously registered callback. It will no-longer receive notifications on connection events. Calling this is not required when the listener goes away, since the callbacks are kept as weak methods. N)r[removerrrt)rCrr:r:r;deregister_connect_callbacksz.AbstractConnection.deregister_connect_callback)rereturncCs||jd|_dS)z Creates a new instance of parser_class with socket size: _socket_read_size and assigns it to the parser for the connection :param parser_class: The required parser class )rfN)r^rZ)rCrer:r:r;rq szAbstractConnection.set_parserc s|jr dSz(jfddfddIdHWntjk rJYn|tjtjfk rltdYnZtk r}zt |W5d}~XYn,t k r}zt ||W5d}~XYnXz@j sވ IdHn&tj r IdHn Wn&tk r,IdHYnXddjD_jD]0}|}|}|rFt|rF|IdHqFdS)z5Connects to the Redis server if not already connectedNcsSrA)_connectr:rr:r;r3z,AbstractConnection.connect..csSrA disconnect)errorrr:r;rr3zTimeout connecting to servercSsg|]}|r|qSr:r:)rrefr:r:r; 8sz.AbstractConnection.connect..)rrgcall_with_retryrnZCancelledErrorrmrr&OSErrorr"_error_message ExceptionrP on_connectiscoroutinefunctionr$rr[inspect isawaitable)rCeexcrrZtaskr:rr;connects>    zAbstractConnection.connectcsdSrAr:rr:r:r;r?szAbstractConnection._connectrcCsdSrAr:rr:r:r; _host_errorCszAbstractConnection._host_error) exceptionrcCst||SrA)rr)rCrr:r:r;rGsz!AbstractConnection._error_messagec s|j||j}d}|js(|js(|jrD|jp:t|j|j}|}|r|jdkrt|jt r~| t |j |j_ |j|t |dkrd|dg}|jd|jdf|IdH|IdH}|dt|jkr|d t|jkrtd n|r||jd|d d iIdHz|IdH}Wn>tk rb|jd|d d dIdH|IdH}YnXt|dkrtdn\|jdkrt|jt r| t |j |j_ |j||d|jIdH|IdH}|jr|dd|jIdHt|IdHdkrtd|jr6|ddd|jIdH|jrV|ddd|jIdH|jrr|d|jIdHdd|j|jfDD]0}z|IdHWntk rYnXq|jrt|IdHdkrtddS)z=Initialize the connection, authenticate and select a databaseN)r2ridefaultrZHELLOAUTHsprotoprotozInvalid RESP version check_healthFrjrOKzInvalid Username or PasswordZCLIENTZSETNAMEzError setting client nameZSETINFOzLIB-NAMEzLIB-VERZSELECTcss|]}|r|VqdSrAr:)rsentr:r:r;rsz0AbstractConnection.on_connect..zInvalid Database)r)rZrrLrHrMrZget_credentialsrW isinstancer.rqr/ZEXCEPTION_CLASSESlen send_command read_responsegetrrr"r!r*r rIrJrKrGr%)rCparserZ auth_argsZ cred_providerresponseZ auth_response_r:r:r;rJsr               zAbstractConnection.on_connect)nowaitrc szt|j4IdHx|j|js_s    R    + W )  >.r>c seZdZdZddddddeeeefeee eeee ffedfdd Z d d Z e d d dZ ddZed ddZZS) Connectionz4Manages TCP communication to and from a Redis server localhostiFNr)hostportsocket_keepalivesocket_keepalive_options socket_typec s8||_t||_||_|pi|_||_tjf|dSrA)rrrrrrrsuperrv)rCrrrrrrrr:r;rvs   zConnection.__init__cCs6d|jfd|jfd|jfg}|jr2|d|jf|S)NrrrGrI)rrrGrIrlrCrr:r:r;rszConnection.repr_piecesrcCs|j|jdS)Nrrrrr:r:r;_connection_argumentssz Connection._connection_argumentsc st|j4IdH tjf|IdH\}}W5QIdHRX||_||_|jd}|r| t j t j dz@|j r| t jt jd|jD]\}}| t j||qWn"ttfk r|YnXdS)zCreate a TCP socket connectionNrmri)rrOrnZopen_connectionrrXrY transportZget_extra_info setsockoptrm IPPROTO_TCP TCP_NODELAYr SOL_SOCKET SO_KEEPALIVEritemsSOL_TCPrrsr)rCreaderwritersockrrr:r:r;rs" zConnection._connectcCs|jd|jS)N:rrr:r:r;rszConnection._host_error)r5r6r7rrrrrrr r rrvrrrr __classcell__r:r:rr;rs" rc seZdZdZdeeeeeeeeeeeejeedfdd Z e dfd d Z e d d Z e d dZe ddZe ddZe ddZe ddZe ddZZS) SSLConnectionzManages SSL connections to and from the Redis server(s). This class extends the Connection class, adding SSL functionality, and making use of ssl.SSLContext (https://docs.python.org/3/library/ssl.html#ssl.SSLContext) NrequiredF) ssl_keyfile ssl_certfile ssl_cert_reqs ssl_ca_certs ssl_ca_datassl_check_hostnamessl_min_version ssl_ciphersc s,t||||||||d|_tjf| dS)Nkeyfilecertfile cert_reqsca_certsca_datacheck_hostname min_versionciphers)RedisSSLContextrVrrv) rCrrrrrrrrrrr:r;rvs  zSSLConnection.__init__rcst}|j|d<|S)Nssl)rrrVrrCrrr:r;rs z#SSLConnection._connection_argumentscCs|jjSrA)rVrrr:r:r;rszSSLConnection.keyfilecCs|jjSrA)rVrrr:r:r;rszSSLConnection.certfilecCs|jjSrA)rVrrr:r:r;rszSSLConnection.cert_reqscCs|jjSrA)rVrrr:r:r;rszSSLConnection.ca_certscCs|jjSrA)rVr rr:r:r;r szSSLConnection.ca_datacCs|jjSrA)rVr!rr:r:r;r! szSSLConnection.check_hostnamecCs|jjSrA)rVr"rr:r:r;r" szSSLConnection.min_version)NNrNNFNN)r5r6r7rr rrr% TLSVersionrvr rrrrrrr r!r"rr:r:rr;rsD      rc @s\eZdZdZd eeeeeeeeeeeeejeedddZ ej ddd Z dS) r$) rrrrr contextr!r"r#NFrc Cs||_||_|dkrtj|_nrrr:r:r:r;rFs  rFF)total)urlrc Cst|}i}t|jD]v\}}|rt|dkrt|d}t|}|rz||||<Wqtt fk rt d|dYqXq|||<q|j rt|j |d<|j rt|j |d<|j dkr|j rt|j |d<t|d<n|j d kr||jrt|j|d <|jrt|j|d <|j rfd |krfztt|j d d|d <Wntt fk rdYnX|j dkrt|d<nd}t d|d|S)NrzInvalid value for 'z' in connection URL.rHrMunixr:rG)ZredisredissrrrG/r8rLzredis://, rediss://, unix://z5Redis URL must specify one of the following schemes ())rrqueryr rrrErrsrtrHrMschemer:r7hostnamerrrreplaceAttributeErrorr)rJparsedrnameZ value_listrBrZ valid_schemesr:r:r; parse_urlsJ         rV_CPConnectionPool)boundc@seZdZdZeeeeedddZe dfee e e dddZ d d Zd d Zed ddZddZddZddZddZe dddZe dddZd'eddd Zdd d!d"Zd#dd$d%d&ZdS)(rXa Create a connection pool. ``If max_connections`` is set, then this object raises :py:class:`~redis.ConnectionError` when the pool's limit is reached. By default, TCP connections are created unless ``connection_class`` is specified. Use :py:class:`~redis.UnixDomainSocketConnection` for unix sockets. Any additional keyword arguments are passed to the constructor of ``connection_class``. )clsrJrcKst|}|||f|S)a Return a connection pool 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: - `rediss://` creates a SSL wrapped TCP socket connection. See more at: - ``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. )rVupdate)rZrJrZ url_optionsr:r:r;from_urls+ zConnectionPool.from_urlNrGrDcKsV|pd}t|tr|dkr"td||_||_||_g|_t|_|j dt |_ dS)Nlrz,"max_connections" must be a positive integerrh) rrrrtrGconnection_kwargsrD_available_connectionsset_in_use_connectionsrr,rh)rCrGrDr^r:r:r;rvszConnectionPool.__init__cCs*d|jjd|jjd|jf|jdS)Nrrrr)rr6r5rGr^rr:r:r;rs(zConnectionPool.__repr__cCsg|_t|_dSrA)r_rWeakSetrarr:r:r;resetszConnectionPool.resetrcCs|jpt|j|jkS)z;Return True if a connection can be retrieved from the pool.)r_rrarDrr:r:r;can_get_connectionsz!ConnectionPool.can_get_connectioncsH|}z||IdHWn&tk rB||IdHYnX|S)z(Get a connected connection from the poolN)get_available_connectionensure_connectionrrelease)rC command_namekeysoptionsr@r:r:r;get_connection$szConnectionPool.get_connectioncCsVz|j}Wn6tk rDt|j|jkr8tdd|}YnX|j||S)zCGet a connection from the pool, without making sure it is connectedzToo many connectionsN) r_pop IndexErrorrrarDr"make_connectionaddrBr:r:r;re/s  z'ConnectionPool.get_available_connectioncCs.|j}|j|dd|dd|dddS)z,Return an encoder based on encoding settingsrbr`rcrardF)rbrcrd)r^rhrr&r:r:r; get_encoder:s    zConnectionPool.get_encodercCs|jf|jS)z=Create a new connection. Can be overridden by child classes.)rGr^rr:r:r;rnCszConnectionPool.make_connectionr?c s||IdHz|IdHr(tddWnLttfk rv|IdH|IdH|IdHrrtddYnXdS)z8Ensure that the connection object is connected and validNzConnection has datazConnection not ready)rrr"rrrBr:r:r;rfGsz ConnectionPool.ensure_connectioncs|j||j|dS)z(Releases the connection back to the poolN)rarr_rlrBr:r:r;rgWs zConnectionPool.releaseT)inuse_connectionscsZ|rt|j|j}n|j}tjdd|DddiIdH}tdd|Dd}|rV|dS)z Disconnects connections in the pool If ``inuse_connections`` is True, disconnect connections that are current in use, potentially by other tasks. Otherwise only disconnect connections that are idle in the pool. css|]}|VqdSrAr)rr@r:r:r;rmsz,ConnectionPool.disconnect..Zreturn_exceptionsTNcss|]}t|tr|VqdSrA)rr)rrr:r:r;rps )rr_rarnZgathernext)rCrq connectionsresprr:r:r;r^s  zConnectionPool.disconnectcs|IdHdS)z-Close the pool, disconnecting all connectionsNrrr:r:r;aclosetszConnectionPool.acloser)rgrcCs(|jD] }||_q|jD] }||_qdSrA)r_rgra)rCrgconnr:r:r; set_retryxs  zConnectionPool.set_retry)T)r5r6r7r classmethodrrWrr\rr>r rrrvrrcrrdrkrerprnrfrgrrvrxr:r:r:r;rXs* 0    csdeZdZdZddeejfeeee e e ej dfdd Z fddZ e d fd d ZZS) BlockingConnectionPoola  A blocking connection pool:: >>> from redis.asyncio import Redis, BlockingConnectionPool >>> client = Redis.from_pool(BlockingConnectionPool()) It performs the same function as the default :py:class:`~redis.asyncio.ConnectionPool` implementation, in that, it maintains a pool of reusable connections that can be shared by multiple async redis clients. The difference is that, in the event that a client tries to get a connection from the pool when all of connections are in use, rather than raising a :py:class:`~redis.ConnectionError` (as the default :py:class:`~redis.asyncio.ConnectionPool` implementation does), it blocks the current `Task` for a specified number of seconds until a connection becomes available. Use ``max_connections`` to increase / decrease the pool size:: >>> pool = BlockingConnectionPool(max_connections=10) Use ``timeout`` to tell it either how many seconds to wait for a connection to become available, or to block forever: >>> # Block forever. >>> pool = BlockingConnectionPool(timeout=None) >>> # Raise a ``ConnectionError`` after five seconds if a connection is >>> # not available. >>> pool = BlockingConnectionPool(timeout=5) 2)rDrrG queue_classc s,tjf||d|t|_||_dS)Nr])rrvrn Condition _conditionr)rCrDrrGr}r^rr:r;rvs zBlockingConnectionPool.__init__c szf|j4IdHHt|j4IdH$|j|jIdHt}W5QIdHRXW5QIdHRXWn.tjk r}zt d|W5d}~XYnXz| |IdH|WSt k r| |IdHYnXdS)z@Gets a connection from the pool, blocking until one is availableNzNo connection available.) rrrrrdrrernr&r"rfrrg)rCrhrirjr@errrr:r;rks.z%BlockingConnectionPool.get_connectionr?c s@|j4IdH"t|IdH|jW5QIdHRXdS)z)Releases the connection back to the pool.N)rrrgnotifyrBrr:r;rgszBlockingConnectionPool.release)r5r6r7rrrn LifoQueuerrr rr>Queuervrkrgrr:r:rr;rzs# rz)drnroenumrrmr%sysrrabcr itertoolsrtypesrtypingrrrrr r r r r rrrr urllib.parserrrrutilsr version_inforrZredis.asyncio.retryrZ redis.backoffrZredis.connectionrZredis.credentialsrrZredis.exceptionsr r!r"r#r$r%r&Z redis.typingr'Z redis.utilsr(r)r*_parsersr+r,r-r.r/rrrZSYM_LFrEnumr4r9rkrHr<r=rFrr>rrr$r7rArrCrrrrErr8rFrVrWrXrzr:r:r:r;s   <      $  >9@? 4 <