U hs @sUddlZddlZddlZddlZddlZddlZddlZddlmZddl m Z ddl m Z m Z mZddlmZmZmZmZmZmZmZmZddlmZmZmZddlmZmZmZm Z m!Z!m"Z"dd l#m$Z$m%Z%m&Z&m'Z'dd l(m)Z)dd l*m+Z+dd l,m-Z-m.Z.dd l/m0Z0m1Z1ddl2m3Z3m4Z4m5Z5m6Z6m7Z7m8Z8m9Z9m:Z:ddl;mZ>m?Z?m@Z@mAZAmBZBmCZCmDZDmEZEmFZFe@rddlGZGndZGe?rddlHZHdZIdZJdZKdZLdZMeNZOeee&e'e%fePd<e?re%ZQne&ZQGdddZRGdddZSGdddZTGdddeTZUGdd d eUZVGd!d"d"eTZWGd#d$d$eVZXGd%d&d&eUZYd'ZZd(d)Z[e\e]e]e[e[e^e\e\e[e]d* Z_d+d,Z`ed-d.d/ZaGd0d.d.ZbGd1d2d2ebZcdS)3N)abstractmethod)chain)EmptyFull LifoQueue)AnyCallableDictListOptionalTypeTypeVarUnion)parse_qsunquoteurlparse) CacheEntryCacheEntryStatus CacheFactoryCacheFactoryInterfaceCacheInterfaceCacheKey)Encoder_HiredisParser _RESP2Parser _RESP3Parser)TokenInterface) NoBackoff)CredentialProvider"UsernamePasswordCredentialProvider)AfterConnectionReleasedEventEventDispatcher)AuthenticationError$AuthenticationWrongNumberOfArgsErrorChildDeadlockedErrorConnectionError DataError RedisError ResponseError TimeoutError)Retry) CRYPTOGRAPHY_AVAILABLEHIREDIS_AVAILABLE SSL_AVAILABLEcompare_versionsdeprecated_args ensure_stringformat_error_messageget_lib_version str_if_bytes*$s  DefaultParserc@seZdZedddZdS)HiredisRespSerializer)argscGsg}t|dtr4t|d|dd}n(d|dkr\t|d|dd}z|t|Wn0tk rt \}}}t | |YnX|S2Pack a series of arguments into the Redis protocolrrN ) isinstancestrtupleencodesplitappendhiredis pack_command TypeErrorsysexc_infor'with_traceback)selfr;output_value tracebackrP4/tmp/pip-unpacked-wheel-4avdqdik/redis/connection.pypackLs" zHiredisRespSerializer.packN)__name__ __module__ __qualname__r rRrPrPrPrQr:Ksr:c@s"eZdZddddZddZdS)PythonRespSerializerNreturncCs||_||_dSN)_buffer_cutoffrB)rK buffer_cutoffrBrPrPrQ__init__^szPythonRespSerializer.__init__c Gsg}t|dtr4t|d|dd}n(d|dkr\t|d|dd}tttt|t f}|j }t |j|D]|}t|}t||ks||kst|t rt|t t|t f}||||t }qt|t t|t |t f}q|||Sr<)r?r@rArBrC SYM_EMPTYjoinSYM_STARlenSYM_CRLFrZmap memoryview SYM_DOLLARrD)rKr;rLZbuffr[argZ arg_lengthrPrPrQrRbs@"      zPythonRespSerializer.pack)rSrTrUr\rRrPrPrPrQrV]srVc@seZdZeddZeddZeddZeddZed d Zed d Z ed dZ eddZ eddZ ed,ddZ eddZed-ddZed.dddddZedd Zed!d"Zeeeeeefeeeffd#d$d%Zeed&d'd(Zed)d*Zd+S)/ConnectionInterfacecCsdSrYrPrKrPrPrQ repr_piecesszConnectionInterface.repr_piecescCsdSrYrPrKcallbackrPrPrQregister_connect_callbacksz-ConnectionInterface.register_connect_callbackcCsdSrYrPrirPrPrQderegister_connect_callbacksz/ConnectionInterface.deregister_connect_callbackcCsdSrYrPrK parser_classrPrPrQ set_parserszConnectionInterface.set_parsercCsdSrYrPrgrPrPrQ get_protocolsz ConnectionInterface.get_protocolcCsdSrYrPrgrPrPrQconnectszConnectionInterface.connectcCsdSrYrPrgrPrPrQ on_connectszConnectionInterface.on_connectcGsdSrYrPrKr;rPrPrQ disconnectszConnectionInterface.disconnectcCsdSrYrPrgrPrPrQ check_healthsz ConnectionInterface.check_healthTcCsdSrYrPrKcommandrurPrPrQsend_packed_commandsz'ConnectionInterface.send_packed_commandcOsdSrYrPrKr;kwargsrPrPrQ send_commandsz ConnectionInterface.send_commandrcCsdSrYrPrKtimeoutrPrPrQcan_readszConnectionInterface.can_readFdisconnect_on_error push_requestcCsdSrYrP)rKdisable_decodingrrrPrPrQ read_responsesz!ConnectionInterface.read_responsecGsdSrYrPrsrPrPrQrFsz ConnectionInterface.pack_commandcCsdSrYrPrKcommandsrPrPrQ pack_commandssz!ConnectionInterface.pack_commandsrWcCsdSrYrPrgrPrPrQhandshake_metadatasz&ConnectionInterface.handshake_metadatatokencCsdSrYrPrKrrPrPrQset_re_auth_tokensz%ConnectionInterface.set_re_auth_tokencCsdSrYrPrgrPrPrQre_authszConnectionInterface.re_authN)T)r)F)rSrTrUrrhrkrlrorprqrrrtrurxr{r~rrFrpropertyrr bytesr@rrrrrPrPrPrQrfsR               *rfc@s(eZdZdZdddddedddeddddeddddd ddfeee ee ee e e e e eeee ee ee ee e e dfeegdfeeeeeegdfeed d d Zd dZeddZddZddZddZddZddZddZdLe ddd Zed!d"Zed#d$Zd%d&Zd'd(ZdMe dd)d*Z d+d,Z!d-d.Z"d/d0Z#d1d2Z$dNd3d4Z%d5d6Z&dOd7d8Z'dPddd9d:d;Z(dd?Z*e ee fd@dAdBZ+e,e e-e.e.fe-e e ffd@dCdDZ/e/j0e e-e.e.fe-e e ffdEdFdDZ/e1dGdHdIZ2dJdKZ3dS)QAbstractConnectionz0Manages communication to and from a Redis serverrNFutf-8strictizredis-pyr8)dbpasswordsocket_timeoutsocket_connect_timeoutretry_on_timeoutencodingencoding_errorsdecode_responsessocket_read_sizehealth_check_interval client_namelib_name lib_versionusernameretryredis_connect_funccredential_providerprotocolcommand_packerevent_dispatchercCs|s|r|dk rtd|dkr*t|_n||_t|_||_| |_||_||_ ||_ ||_ ||_ ||_ |dkrv|}||_||_|tkrg}|r|t||_|s|r|dkrttd|_n t||_|j|nttd|_| |_d|_||_t||| |_d|_d|_ | |_!|"| g|_#d|_$d|_%zHz t(|}Wn6t)k r`t*}Ynt+k r|t&d YnXW5|dks|dkrt&d||_'X|,||_-dS) a2 Initialize a new Connection. 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'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'rripr8zprotocol must be either 2 or 3zprotocol must be an integer).r'r"_event_dispatcherosgetpidpidrrrrrrrrrrSENTINELrDr*retry_on_errorr+rrcopydeepcopyZupdate_supported_errorsrnext_health_checkrrencoderr_sock_socket_read_sizero_connect_callbacksrZ_re_auth_tokenr&rintrGDEFAULT_RESP_VERSION ValueError_construct_command_packer_command_packer)rKrrrrrrrrrrnrrrrrrrrrrrrprPrPrQr\sh       zAbstractConnection.__init__cCs8ddd|D}d|jjd|jjd|dS)N,cSsg|]\}}|d|qS)=rP).0kvrPrPrQ Esz/AbstractConnection.__repr__..<.()>)r^rh __class__rTrS)rKZ repr_argsrPrPrQ__repr__DszAbstractConnection.__repr__cCsdSrYrPrgrPrPrQrhHszAbstractConnection.repr_piecescCs&z |Wntk r YnXdSrY)rt ExceptionrgrPrPrQ__del__Ls zAbstractConnection.__del__cCs*|dk r |StrtSt|j|jjSdSrY)r-r:rVrZrrB)rKpackerrPrPrQrRs z,AbstractConnection._construct_command_packercCs$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 WeakMethodrrD)rKrjZwmrPrPrQrkZs  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)rremoverrrrirPrPrQrlfsz.AbstractConnection.deregister_connect_callbackcCs||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 )rN)r_parserrmrPrPrQroqszAbstractConnection.set_parsercCs|jdddS)z5Connects to the Redis server if not already connectedTruN)connect_check_healthrgrPrPrQrqyszAbstractConnection.connectTrc sjr dSz"jfddfdd}WnLtjk rJtdYn0tk rx}zt|W5d}~XYnX|_z&j dkrj |dn Wnt k r YnXddj D_ j D]}|}|r|qdS)NcsSrY)_connectrPrgrPrQr7z9AbstractConnection.connect_check_health..cs |SrYrterrorrgrPrQrr7zTimeout connecting to serverrcSsg|]}|r|qSrPrP)rrefrPrPrQrsz;AbstractConnection.connect_check_health..)rrcall_with_retrysocketr}r*OSErrorr&_error_messageron_connect_check_healthr(rtr)rKrusockerrjrPrgrQr}s0     z'AbstractConnection.connect_check_healthcCsdSrYrPrgrPrPrQrszAbstractConnection._connectcCsdSrYrPrgrPrPrQ _host_errorszAbstractConnection._host_errorcCst||SrY)r2r)rK exceptionrPrPrQrsz!AbstractConnection._error_messagecCs|jdddS)NTr)rrgrPrPrQrrszAbstractConnection.on_connectcCs|j||j}d}|js(|js(|jrD|jp:t|j|j}|}|r|jdkrt|jt r~| t |j |j_ |j|t |dkrd|dg}|jd|jdf|dd i||_n|r0|jd|dd iz |}Wn2tk r|jd|d d d |}YnXt|d krtd n|jdkrt|jt rj| t |j |j_ |j||jd|j|d ||_|jd|jkr|jd|jkrtd|jr|jdd|j|d t|d krtdz*|jr|jddd|j|d |Wntk r,YnXz*|jrV|jddd|j|d |Wntk rnYnX|jr|jd|j|d t|d krtddS)z=Initialize the connection, authenticate and select a databaseN)r82rdefaultrZHELLOAUTHruFrOKzInvalid Username or PasswordsprotoprotozInvalid RESP versionCLIENTZSETNAMEzError setting client nameZSETINFOzLIB-NAMEzLIB-VERZSELECTzInvalid Database)r)rrrrrrr Zget_credentialsrr?rrorZEXCEPTION_CLASSESr`r{rrr$r4r#getr&rrr)rr)rKruparserZ auth_argsZ cred_providerZ auth_responserPrPrQrs                  z*AbstractConnection.on_connect_check_healthc Gs|j|j}d|_|dkr"dSt|jkrZz|tjWnt t fk rXYnXz | Wnt k rzYnXdS)z!Disconnects from the Redis serverN) rZ on_disconnectrrrrshutdownr SHUT_RDWRrrGclose)rKr;Z conn_sockrPrPrQrts  zAbstractConnection.disconnectcCs*|jdddt|dkr&tddS)z Send PING, expect PONG in returnZPINGFrZPONGz#Bad response from PING health checkN)r{r4rr&rgrPrPrQ _send_ping0szAbstractConnection._send_pingcCs |dS)z Function to call when PING failsNrrKrrPrPrQ _ping_failed6szAbstractConnection._ping_failedcCs*|jr&t|jkr&|j|j|jdS)z3Check the health of the connection with a PING/PONGN)rtime monotonicrrrrrrgrPrPrQru:szAbstractConnection.check_healthc Cs|js|jdd|r|z*t|tr0|g}|D]}|j|q4Wntjk rn|t dYnt k r}zV|t |j dkrd|j d}}n|j d}|j d}t d|d|d W5d }~XYntk r|YnXd S) z2Send an already packed command to the Redis serverFrzTimeout writing to socketrUNKNOWNrzError z while writing to socket. rN)rrrur?r@sendallrr}rtr*rr`r;r& BaseException)rKrwruitemrerrnoerrmsgrPrPrQrx?s,     &z&AbstractConnection.send_packed_commandcOs"|j|jj||ddddS)z+Pack and send a command to the Redis serverruTrN)rxrrRrryrPrPrQr{^s  zAbstractConnection.send_commandc Csn|j}|s||}z|j|WStk rh}z"|td|d|jW5d}~XYnXdS)z8Poll the socket to see if there's data that can be read.Error while reading from z: N) rrqrrr~rrtr&r;)rKr}r host_errorrrPrPrQr~eszAbstractConnection.can_readrc Cs|}z2|jdkr*ts*|jj||d}n|jj|d}Wntjk rj|rX|td|Yndt k r}z&|r|t d|d|j W5d}~XYn"t k r|r|YnX|j rt|j |_t|trz|W5~X|S)z0Read the response from a previously sent command)3r)rr)rzTimeout reading from rz : N)rrr-rrrr}rtr*rr&r;rrrrrr?r))rKrrrrresponserrPrPrQrss6 & z AbstractConnection.read_responsecGs |jj|S)r=)rrRrsrPrPrQrFszAbstractConnection.pack_commandc Csg}g}d}|j}|D]}|jj|D]r}t|}||ksL||ksLt|trh|r`|t|d}g}||kszt|tr||q&||||7}q&q|r|t||S)z.Pack multiple commands into the Redis protocolr) rZrrRr`r?rcrDr]r^) rKrrLpiecesZ buffer_lengthr[cmdchunkZchunklenrPrPrQrs0   z AbstractConnection.pack_commandsrWcCs|jSrY)rrgrPrPrQrpszAbstractConnection.get_protocolcCs|jSrYZ_handshake_metadatargrPrPrQrsz%AbstractConnection.handshake_metadatarNcCs ||_dSrYr)rKrNrPrPrQrsrcCs ||_dSrY)rrrPrPrQrsz$AbstractConnection.set_re_auth_tokencCs8|jdk r4|d|jd|j|d|_dSNroid)rr{try_get get_valuerrgrPrPrQrs  zAbstractConnection.re_auth)T)T)T)r)F)4rSrTrU__doc__rr9r3rr r@floatboolrrrrr"r\rrrhrrrkrlrorqrrrrrrrrtrrrurxr{r~rrFrrprr rrsetterrrrrPrPrPrQrs  `   "  o   ,((rcs:eZdZdZdfdd Zd d Zd d Zd dZZS) Connectionz4Manages TCP communication to and from a Redis server localhostFNrc s8||_t||_||_|pi|_||_tjf|dSrY)hostrportsocket_keepalivesocket_keepalive_options socket_typesuperr\)rKr r r r rrzrrPrQr\s   zConnection.__init__cCs6d|jfd|jfd|jfg}|jr2|d|jf|S)Nr r rr)r r rrrDrKrrPrPrQrhszConnection.repr_piecesc Cs<d}t|j|j|jtjD]}|\}}}}}d}zt|||}|tjtjd|j r|tj tj d|j D]\} } |tj| | qx||j||||j|WStk r} zB| }|dk rz|tjWntk rYnX|W5d} ~ XYqXq|dk r0|tddS)zCreate a TCP socket connectionNrz)socket.getaddrinfo returned an empty list)r getaddrinfor r r SOCK_STREAM setsockopt IPPROTO_TCP TCP_NODELAYr  SOL_SOCKET SO_KEEPALIVEr items settimeoutrrqrrrrr) rKerrresfamilysocktyper canonnameZsocket_addressrrrrMrPrPrQrs>       zConnection._connectcCs|jd|jS)N:)r r rgrPrPrQr szConnection._host_error)rr FNr rSrTrUrr\rhrr __classcell__rPrPrrQrs-rc@s<eZdZdZdZdZeeej dddZ ddZ d d Z d d Z d dZddZddZddZddZd>ddZddZd?ddZd@ddd d!d"Zd#d$Zd%d&Zeeeeefeeeffd'd(d)Zd*d+Zd,d-Z ed.d/d0d1Z!d2d3Z"e#eee$e#efd4d5d6Z%d7d8Z&e'd9d:d;Z(d|j.|ddkr |jn|j|dW5QRXdS)Nr)r,r)r3Zdelete_by_redis_keys)rKrArPrPrQr@s  z.CacheProxyConnection._on_invalidation_callbackcCs |jSrY)r'rprgrPrPrQrpsz!CacheProxyConnection.get_protocolrcCs|j|dSrY)r'rrrPrPrQrsz&CacheProxyConnection.set_re_auth_tokencCs|jdSrY)r'rrgrPrPrQrszCacheProxyConnection.re_auth)T)r)F)*rSrTrUr<r2r1rfrr*Lockr\rhrkrlrorqrrrtrurxr{r~rrFrrrr rr@rrrr.r:r r r@rprrrrPrPrPrQr#$sF  0  -("r#cs6eZdZdZd fdd Zfdd Zd d ZZS) 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) NrequiredTFc sts td||_||_|dkr(tj}n:t|trbtjtjtj d}||krZtd|||}||_ ||_ ||_ ||_ |j tjkr|nd|_||_| |_| |_| |_| |_| |_||_tjf|dS)aConstructor Args: ssl_keyfile: Path to an ssl private key. Defaults to None. ssl_certfile: Path to an ssl certificate. Defaults to None. ssl_cert_reqs: The string value for the SSLContext.verify_mode (none, optional, required), or an ssl.VerifyMode. Defaults to "required". ssl_ca_certs: The path to a file of concatenated CA certificates in PEM format. Defaults to None. ssl_ca_data: Either an ASCII string of one or more PEM-encoded certificates or a bytes-like object of DER-encoded certificates. ssl_check_hostname: If set, match the hostname during the SSL handshake. Defaults to False. ssl_ca_path: The path to a directory containing several CA certificates in PEM format. Defaults to None. ssl_password: Password for unlocking an encrypted private key. Defaults to None. ssl_validate_ocsp: If set, perform a full ocsp validation (i.e not a stapled verification) ssl_validate_ocsp_stapled: If set, perform a validation on a stapled ocsp response ssl_ocsp_context: A fully initialized OpenSSL.SSL.Context object to be used in verifying the ssl_ocsp_expected_cert ssl_ocsp_expected_cert: A PEM armoured string containing the expected certificate to be returned from the ocsp verification service. ssl_min_version: The lowest supported SSL version. It affects the supported SSL versions of the SSLContext. None leaves the default provided by ssl module. ssl_ciphers: A string listing the ciphers that are allowed to be used. Defaults to None, which means that the default ciphers are used. See https://docs.python.org/3/library/ssl.html#ssl.SSLContext.set_ciphers for more information. Raises: RedisError z$Python wasn't built with SSL supportN)noneoptionalrDz+Invalid SSL Certificate Requirements Flag: F)r.r(keyfilecertfilessl CERT_NONEr?r@ CERT_OPTIONAL CERT_REQUIRED cert_reqsca_certsca_dataca_pathcheck_hostnamecertificate_passwordssl_validate_ocspssl_validate_ocsp_stapledssl_ocsp_contextssl_ocsp_expected_certssl_min_version ssl_ciphersrr\)rKZ ssl_keyfileZ ssl_certfileZ ssl_cert_reqsZ ssl_ca_certsZ ssl_ca_datassl_check_hostnameZ ssl_ca_pathZ ssl_passwordrSrTrUrVrWrXrzZ CERT_REQSrrPrQr\s<( zSSLConnection.__init__c s>t}z ||WSttfk r8|YnXdS)zN Wrap the socket with SSL support, handling potential errors. N)rr_wrap_socket_with_sslrr(rrKrrrPrQrJs   zSSLConnection._connectc Cst}|j|_|j|_|js$|jr:|j|j|j|jd|j dk sX|j dk sX|j dk rn|j |j |j |j d|j dk r|j |_|jr||j|jdkrtdkrtd|jr|jrtd|j||jd}|jrvd dl}d d lm}|jdkr"|j|jj}||j||jn|j}| ||j!|j"|t##}|$|%|j|j&f|'|(|S|jdkrtrd d lm)}|||j|j&|j } | *r|St+d |S)z Wraps the socket with SSL support. Args: sock: The plain socket to wrap with SSL. Returns: An SSL wrapped socket. )rHrGrN)cafilecapathcadataTFzcryptography is not installed.zKEither an OCSP staple or pure OCSP connection must be validated - not both.)server_hostnamerr)ocsp_staple_verifier) OCSPVerifierzocsp validation error),rIcreate_default_contextrQrM verify_moderHrGload_cert_chainrRrNrPrOload_verify_locationsrWminimum_versionrX set_ciphersrSr,r(rT wrap_socketr OpenSSLZocspr`rUZSSLContextZ SSLv23_METHODZuse_certificate_fileZuse_privatekey_fileZset_ocsp_client_callbackrVrrZ request_ocsprqr  do_handshakerraZis_validr&) rKrcontextsslsockrir`Z staple_ctxconraorPrPrQrZUsp          z#SSLConnection._wrap_socket_with_ssl)NNrDNNTNNFFNNNN)rSrTrUrr\rrZr"rPrPrrQrCs$J rCcs:eZdZdZd fdd ZddZdd Zd d ZZS) UnixDomainSocketConnectionz4Manages UDS communication to and from a Redis serverNc stjf|||_||_dSrY)rr\pathr)rKrrrrzrrPrQr\sz#UnixDomainSocketConnection.__init__cCs.d|jfd|jfg}|jr*|d|jf|S)Nrrrr)rrrrrDrrPrPrQrhsz&UnixDomainSocketConnection.repr_piecesc Csttjtj}||jz||jWnDtk rpz|tj Wntk r`YnX| YnX||j |S)z&Create a Unix domain socket connection) rAF_UNIXrrrrqrrrrrrrr[rPrPrQrs  z#UnixDomainSocketConnection._connectcCs|jSrY)rrrgrPrPrQrsz&UnixDomainSocketConnection._host_error)rqNr!rPrPrrQrps rp)0FFALSENNOcCs6|dks|dkrdSt|tr.|tkr.dSt|S)NrqF)r?r@upper FALSE_STRINGSrrrPrPrQto_bools r{) rrrr rrmax_connectionsrrYr}c Cs|ds&|ds&|ds&tdt|}i}t|jD]v\}}|r@t|dkr@t|d}t |}|rz||||<Wqt tfk rtd|dYqXq@|||<q@|j rt|j |d<|j rt|j |d <|j d kr |jrt|j|d <t|d <n|jr"t|j|d <|jr8t|j|d<|jrd|krztt|jdd|d<Wnttfk rYnX|j dkrt|d <|S)Nzredis://z rediss://zunix://zRRedis URL must specify one of the following schemes (redis://, rediss://, unix://)rzInvalid value for 'z' in connection URL.rrunixrrconnection_classr r r/rqZrediss) startswithrrrqueryrr`rURL_QUERY_ARGUMENT_PARSERSrrGrrschemerrrphostnamer rreplaceAttributeErrorrC)urlrznamerNrrPrPrQ parse_urlsR      r_CPConnectionPool)boundc@s(eZdZdZeeeeedddZe ddfe e e e dddZ eefd d d Zd d Zdd ddZdd ddZedgdddd2dd ddZed ddZdd ddZddddd Zde dd!d"Zd3edd$d%d&Zdd d'd(Zedd)d*d+Zed,d-d.Ze d/d0d1Z!dS)4ra Create a connection pool. ``If max_connections`` is set, then this object raises :py:class:`~redis.exceptions.ConnectionError` when the pool's limit is reached. By default, TCP connections are created unless ``connection_class`` is specified. Use class:`.UnixDomainSocketConnection` for unix sockets. Any additional keyword arguments are passed to the constructor of ``connection_class``. )clsrrXcKs0t|}d|kr|d|d<|||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. r~)rupdate)rrrzZ url_optionsrPrPrQfrom_url+s )  zConnectionPool.from_urlN)r| cache_factorycKs:|pd}t|tr|dkr"td||_||_||_d|_||_|dsT|dr|ddkrjt d|jd}|dk rt|t std ||_n.|jdk r|j |_nt |jd |_| dd| dd|jd d|_|jdkrt|_t|_|jdkr$t|_n t|_|dS) Nlrz,"max_connections" must be a positive integerZ cache_configr%r)rrz4Client caching is only supported with RESP version 3z#Cache must implement CacheInterfacer)r?rrr~connection_kwargsr|r%Z_cache_factoryrr(rZ get_cacherpoprr"r*r+ _fork_lock_lockrBreset)rKr~r|rrr%rPrPrQr\\s>           zConnectionPool.__init__rWc Cs2dt|jdt|jdt|jf|jdS)Nrrrr)typerTrSreprr~rrgrPrPrQrs0zConnectionPool.__repr__cCs|jddS)z Returns: The RESP protocol version, or ``None`` if the protocol is not specified, in which case the server default will be used. rN)rrrgrPrPrQrpszConnectionPool.get_protocolcCs"d|_g|_t|_t|_dS)Nr)_created_connections_available_connectionsr;_in_use_connectionsrrrrgrPrPrQrs zConnectionPool.resetcCsP|jtkrL|jjdd}|s$tz|jtkr<|W5|jXdS)N)r})rrrracquirer%releaser)rKZacquiredrPrPrQ _checkpids# zConnectionPool._checkpid*)Use get_connection() without args instead5.3.0Z args_to_warnreasonr0rc Os||j>z|j}Wntk r:|}YnX|j|W5QRXzf|z| rx|j dkrxt dWn:t t t fk r||| rt dYnXWn tk r||YnX|S)zGet a connection from the poolNConnection has dataConnection not ready)rrrr IndexErrormake_connectionraddrqr~r%r&r*rrtrrrK command_namer4options connectionrPrPrQget_connections*  zConnectionPool.get_connectioncCs,|j}t|dd|dd|dddS)z,Return an encoder based on encoding settingsrrrrrF)rrr)rrr)rKrzrPrPrQ get_encoders    zConnectionPool.get_encoderrfcCsT|j|jkrtd|jd7_|jdk rFt|jf|j|j|jS|jf|jS)zCreate a new connectionzToo many connectionsrN)rr|r&r%r#r~rrrgrPrPrQrs   zConnectionPool.make_connection)rrXc Cs||jvz|j|Wn tk r@YW5QRdSX||rj|j||j t |n| W5QRdSW5QRXdS)z(Releases the connection back to the poolN) rrrrKeyErrorowns_connectionrrDrdispatchr!rtrKrrPrPrQr%s  zConnectionPool.releasecCs |j|jkSrY)rrrPrPrQr=szConnectionPool.owns_connectionT)inuse_connectionsrXc CsJ||j2|r$t|j|j}n|j}|D] }|q.W5QRXdS)z Disconnects connections in the pool If ``inuse_connections`` is True, disconnect connections that are current in use, potentially by other threads. Otherwise only disconnect connections that are idle in the pool. N)rrrrrrt)rKr connectionsrrPrPrQrt@szConnectionPool.disconnectcCs |dS)z-Close the pool, disconnecting all connectionsNrrgrPrPrQrTszConnectionPool.close)rrXcCs8|jd|i|jD] }||_q|jD] }||_q(dS)Nr)rrrrr)rKrr$rPrPrQ set_retryXs   zConnectionPool.set_retryrc svjfjD]BjfddfddjfddfddqjD]qXW5QRXdS)NcsddSr)r{rrrP)r$rrPrQrcsz1ConnectionPool.re_auth_callback..cs |SrY_mockrrgrPrQrfr7csSrY)rrP)r$rPrQrir7cs |SrYrrrgrPrQrir7)rrrrrrrrP)r$rKrrQre_auth_callback_s     zConnectionPool.re_auth_callbackrcsdS)z Dummy functions, needs to be passed as error callback to retry object. :param error: :return: NrPrrPrPrQrnszConnectionPool._mock)N)T)"rSrTrUr classmethodr rr@rrr rrr\rrprrr0rrrrrrrrtrr+rrrr(rrPrPrPrQrs: 2 ?/"  csdeZdZdZddeeffdd ZddZdd Ze d gd d d dddZ ddZ ddZ Z S)BlockingConnectionPoola Thread-safe blocking connection pool:: >>> from redis.client import Redis >>> client = Redis(connection_pool=BlockingConnectionPool()) It performs the same function as the default :py:class:`~redis.ConnectionPool` implementation, in that, it maintains a pool of reusable connections that can be shared by multiple redis clients (safely across threads if required). 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.ConnectionPool` implementation does), it makes the client wait ("blocks") 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) 2c s(||_||_tjf||d|dS)N)r~r|) queue_classr}rr\)rKr|r}r~rrrrPrQr\szBlockingConnectionPool.__init__cCsN||j|_z|jdWqtk r6Yq:YqXqg|_t|_dSrY) rr|pool put_nowaitr _connectionsrrrrgrPrPrQrs  zBlockingConnectionPool.resetcCsD|jdk r&t|jf|j|j|j}n|jf|j}|j||S)zMake a fresh connection.N)r%r#r~rrrrDrrPrPrQrs   z&BlockingConnectionPool.make_connectionrrrrNc Os|d}z|jjd|jd}Wntk r>tdYnX|dkrP|}z\|z|rltdWn:tt t fk r| ||rtdYnXWn t k r| |YnX|S)a7 Get a connection, blocking for ``self.timeout`` until a connection is available from the pool. If the connection returned is ``None`` then creates a new connection. Because we use a last-in first-out queue, the existing connections (having been returned to the pool after the initial ``None`` values were added) will be returned before ``None`` values. This means we only create new connections when we need to, i.e.: the actual number of connections will only increase in response to demand. NT)blockr}zNo connection available.rr)rrrr}rr&rrqr~r*rrtrrrrPrPrQrs,  z%BlockingConnectionPool.get_connectioncCsT|||s*||jddSz|j|Wntk rNYnXdS)z)Releases the connection back to the pool.N)rrrtrrrrrPrPrQrs  zBlockingConnectionPool.releasecCs ||jD] }|qdS)z(Disconnects all connections in the pool.N)rrrtrrPrPrQrts z!BlockingConnectionPool.disconnect)N)rSrTrUrrrr\rrr0rrrtr"rPrPrrQrws #  4r)drrrrHr*rrabcr itertoolsrqueuerrrtypingrrr r r r r r urllib.parserrrZ redis.cacherrrrrr_parsersrrrrZ auth.tokenrbackoffr credentialsrr eventr!r" exceptionsr#r$r%r&r'r(r)r*rr+utilsr,r-r.r/r0r1r2r3r4rIrEr_rdrar]robjectr__annotations__r9r:rVrfrrr#rCrprzr{rrlistrrrrrrPrPrPrQs  (   ( ,  3Q|JW,# 9 \