U dc.@sddlZddlZddlZddlZddlZddlZddlmZddlm Z ddl m Z m Z m Z mZddlmZmZmZddlmZddlmZmZmZmZmZmZmZmZddlmZdd l m!Z!dd l"m#Z#m$Z$d Z%d Z&d Z'ddZ(ddZ)Gddde*Z+ddZ,ddZ-ddZ.ddZ/e0e0e0e0e0e0e0e0e0e0e0e0e0e0e0e0e0e0e0e0e0e0e0dZ1ddZ2dd Z3d!d"Z4d#d$Z5d%d&Z6dd(d)Z7d*d+Z8d,d-Z9d.d/Z:d0d1Z;d2d3Zd8d9Z?d:d;Z@dd?ZBd@dAZCdBdCZDdDdEZEdFdGZFdHdIZGdJdKZHdLdMZIdNdOZJdPdQZKdRdSZLdTdUZMdVdWZNdXdYZOdZd[ZPd\d]ZQd^d_ZRd`daZSdbdcZTdddeZUdfdgZVdhdiZWdjdkZXdldmZYdndoZZdpdqZ[drdsZ\GdtduduZ]Gdvdwdwe]e e e Z^e^Z_GdxdydyZ`Gdzd{d{ZaGd|d}d}ejbZcGd~dde^ZddS)N)chain)Optional) CoreCommandsRedisModuleCommandsSentinelCommands list_or_args)ConnectionPool SSLConnectionUnixDomainSocketConnection)CredentialProvider)ConnectionErrorExecAbortError ModuleError PubSubError RedisError ResponseError TimeoutError WatchErrorLock)Retry)safe_str str_if_bytesEMPTY_RESPONSE NEVER_DECODEcCs8|sdSz t|}Wntk r*YdSXtj|S)z5Converts a unix timestamp to a Python datetime objectN)int ValueErrordatetime fromtimestampresponser"0/tmp/pip-unpacked-wheel-xj5sloo9/redis/client.pytimestamp_to_datetime's r$cCst||SN)dictfromkeyssplit)Z key_stringcallbackr"r"r#string_keys_to_dict2sr*csfeZdZdZddZfddZfddZfdd Zdfd d Zfd dZ fddZ Z S)CaseInsensitiveDictz?Case insensitive dict implementation. Assumes string keys only.cCs"|D]\}}|||<qdSr%)itemsupper)selfdatakvr"r"r#__init__9szCaseInsensitiveDict.__init__cst|Sr%)super __contains__r-r.r0 __class__r"r#r4=sz CaseInsensitiveDict.__contains__cst|dSr%)r3 __delitem__r-r5r6r"r#r8@szCaseInsensitiveDict.__delitem__cst|Sr%)r3 __getitem__r-r5r6r"r#r9CszCaseInsensitiveDict.__getitem__Ncst||Sr%)r3getr-)r.r0defaultr6r"r#r:FszCaseInsensitiveDict.getcst||dSr%)r3 __setitem__r-)r.r0r1r6r"r#r<IszCaseInsensitiveDict.__setitem__cst|}t|dSr%)r+r3updater.r/r6r"r#r=LszCaseInsensitiveDict.update)N) __name__ __module__ __qualname____doc__r2r4r8r9r:r<r= __classcell__r"r"r6r#r+6s    r+cCsPt|}d|}tdd|D}d}|D]}||kr.t||||<q.|S)zDParse the results of Redis's DEBUG OBJECT command into a Python dictztype:css|]}|dVqdS:Nr().0kvr"r"r# Wsz%parse_debug_object..)refcountZserializedlengthZlruZlru_seconds_idle)rr&r(r)r!Z int_fieldsfieldr"r"r#parse_debug_objectQsrLcCs|dkrt|S|S)z&Parse the results of an OBJECT command)ZidletimerJ) int_or_none)r!Zinfotyper"r"r# parse_objectcsrNcsi}t|}fdd|D]}|r |ds |ddkr|dd\}}|dkrh|dd\}}|dkr|d g|q|||<q |d g|q |S) z;Parse the result of Redis's INFO command into a Python dictcsd|ksd|krLz d|kr$t|WSt|WSWqtk rH|YSXn4i}|dD] }|dd\}}|||<qZ|SdS)N,=.)floatrrr(rsplit)valueZsub_dictitemr0r1 get_valuer"r#rXos  zparse_info..get_value#rErRZ cmdstat_hostmodulemodulesZ__raw__)r splitlines startswithfindr(rT setdefaultappend)r!infolinekeyrUr"rWr# parse_infojs  recKs@t|ddd}|D]$\}}|drt|ddd||<q|S)z!Parse the results of MEMORY STATST) decode_keysdecode_string_valueszdb.) pairs_to_dictr,r^)r!kwargsstatsrdrUr"r"r#parse_memory_statss  rk)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-syncsportZquorumzrole-reported-timez s-down-timezslave-priorityzslave-repl-offsetzvoted-leader-epochcCs:t|t}t|dd}dD]\}}||k||<q |S)NflagsrO))Z is_masterZmaster)Zis_slaveZslave)Zis_sdownZs_down)Zis_odownZo_down)Z is_sentinelsentinel)Zis_disconnectedZ disconnected)Zis_master_downZ master_down)pairs_to_dict_typedSENTINEL_STATE_TYPESsetr()rVresultrmnameflagr"r"r#parse_sentinel_states   rucCsttt|Sr%rumaprr r"r"r#parse_sentinel_mastersrxcCs,i}|D]}ttt|}|||d<q|S)Nrsrv)r!rrrVstater"r"r#parse_sentinel_masterss rzcCsdd|DS)NcSsg|]}ttt|qSr"rvrGrVr"r"r# sz7parse_sentinel_slaves_and_sentinels..r"r r"r"r##parse_sentinel_slaves_and_sentinelssr}cCs|r|dt|dfpdSNrrRrr r"r"r#parse_sentinel_get_mastersrFcCst|dkr iS|s|rZ|ddd}|r0tt|}|ddd}|rLtt|}tt||St|}tt||SdS)z-Create a dict given a list of key/value pairsNrR)rwrr&zipiter)r!rfrgkeysvaluesitr"r"r#rhs  rhc CsZt|}i}t||D]>\}}||krLz|||}Wntk rJYnX|||<q|Sr%)rr Exception)r!Z type_inforrrrdrUr"r"r#ros rocKs:|r|ds|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 withscoresscore_cast_func)r:rSrlistrrw)r!optionsrrr"r"r#zset_score_pairss  rc s:r|dsS|dttfddtDS)z If ``groups`` is specified, return the response as a list of n-element tuples with n being the value found in options['groups'] groupscsg|]}|dqSr%r"rGinr!r"r#r|sz&sort_return_tuples..)r:rrranger!rr"rr#sort_return_tuplessrcCs|dkr dSt|Sr%rr r"r"r#rMsrMcCsL|dkr dSg}|D]2}|dk r<||dt|dfq|dq|S)NrrR)NN)rarh)r!r/rr"r"r#parse_stream_lists rcCs t|ddS)NTrfrhr r"r"r#pairs_to_dict_with_str_keys+srcCsttt|Sr%)rrwrr r"r"r#parse_list_of_dicts/srcKs|ddr|St|S)N parse_justidFr:rrr"r"r# parse_xclaim3s rcKs(|ddr|dSt|d|d<|S)NrFrRrrr"r"r#parse_xautoclaim9s rcKst|dd}|ddsj|d}|dk r@|dt|df|d<|d}|dk r|dt|df|d<n,d d |d D|d <d d |dD|d<|S)NTrfullFz first-entryrrRz last-entrycSsi|]\}}|t|qSr"r)rGZ_identryr"r"r# Jsz&parse_xinfo_stream..entriescSsg|]}t|ddqS)Trr)rGgroupr"r"r#r|Ksz&parse_xinfo_stream..r)rhr:)r!rr/firstlastr"r"r#parse_xinfo_stream@s   rcCs|dkr gSdd|DS)NcSs g|]}|dt|dgqS)rrR)rrGrr"r"r#r|Tszparse_xread..r"r r"r"r# parse_xreadQsrcKsD|ddrt|Sdd|dp$gD}|d|d|d|d S) NZ parse_detailFcSsg|]\}}|t|dqS))rspendingr)rGrpr"r"r#r|Zsz"parse_xpending..rrRr)rminmax consumers)r:parse_xpending_range)r!rrr"r"r#parse_xpendingWs rcsdfdd|DS)N)Z message_idZconsumerZtime_since_deliveredZtimes_deliveredcsg|]}tt|qSr")r&rrr0r"r#r|esz(parse_xpending_range..r"r r"rr#rcsrcCs|dkr dSt|Sr%rSr r"r"r# float_or_nonehsrcCs t|dkSNOKrr r"r"r#bool_oknsrcKs&|dkr dS|drt|St|S)NZas_score)r:rSrrr"r"r# parse_zaddrs  rcKs8g}t|D]"}|tdd|dDq|S)Ncss|]}|ddVqdS)rPrRNrF)rGpairr"r"r#rI~sz$parse_client_list.. )rr]rar&r()r!rZclientscr"r"r#parse_client_listzs rcKsdd|D}|rt|piS)NcSs g|]}|dk rt|ndqSr%rrr"r"r#r|sz$parse_config_get..rrr"r"r#parse_config_getsrcKs|\}}t||fSr%rr!rcursorrr"r"r# parse_scansrcKs |\}}t||rt|pifSr%)rrhrr"r"r# parse_hscansrcKs8|dt}|\}}t|}t|tt|t||fS)Nr)r:rSrrrrrw)r!rrrrrr"r"r# parse_zscans rcKsdd|DS)NcSs g|]}|dk rt|ndqSr%r)rGZscorer"r"r#r|sz!parse_zmscore..r"rr"r"r# parse_zmscoresrc s2|ddrdndfddfdd|DS) Ndecode_responsesFr csd|dt|dt|dd}t|dtrB|d|d<n|d|d<|d|d<|S) NrrRr)id start_timedurationrcommandZ complexity)r isinstancerjoin)rVrr)spacer"r# parse_items   z%parse_slowlog_get..parse_itemcsg|] }|qSr"r"r{)rr"r#r|sz%parse_slowlog_get..)r:rr")rrr#parse_slowlog_gets rcKs~|ddrt|S|ddrv|ddr@dd|dD}ndd|dD}t|d |t|d t|d iSt|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. lenFidxZ withmatchlenc Ss0g|](}t|dgttt|ddqS)rZN)rrrwtuplerGmatchr"r"r#r|sz!parse_stralgo..rRcSsg|]}ttt|qSr")rrwrrr"r"r#r|srrr)r:rr)r!rmatchesr"r"r# parse_stralgos     rcKst|}tdd|DS)Ncss|]}|r|dVqdSrDrF)rGrcr"r"r#rIsz%parse_cluster_info..)rr&r]rr"r"r#parse_cluster_infosrc Cs|d}|ddd\}}}}}}}} |dd}||||||gg| dkrVdndd } t|d krt|dd\} } | | | d <| d <|| fS) Nr@r connectedTF) node_idrm master_idZlast_ping_sentZlast_pong_rcvdepochslots migrationsr rr)r(r _parse_slots) rcZ line_itemsraddrrmrpingpongrrZ node_dictrrr"r"r#_parse_node_lines" " rcCsgg}}|D]}d|krF|dddd\}}|||ddqd|krz|dddd\}}|||ddqdd |d D}||q||fS) Nz->-rRrZZ migrating)Zslotrryz-<-Z importingcSsg|]}|qSr"r")rGslr"r"r#r|sz _parse_slots..-)r(ra)Z slot_rangesrrZs_rangeZslot_idZ dst_node_idZ src_node_idr"r"r#rs    rcKs(t|ttfr|}tdd|DS)z @see: https://redis.io/commands/cluster-nodes # string / bytes @see: https://redis.io/commands/cluster-replicas # list of string / bytes css|]}tt|VqdSr%)rr)rGnoder"r"r#rIsz&parse_cluster_nodes..)rstrbytesr]r&rr"r"r#parse_cluster_nodessrc sdsdr|St|tkr(|g}n|}dsHdsHdsH|Stddtdd dgfd d d D7fd d |DS)z Parse the response of 'GEOSEARCH', GEORADIUS' and 'GEORADIUSBYMEMBER' commands according to 'withdist', 'withhash' and 'withcoord' labels. storeZ store_distwithdist withcoordwithhashcSst|dt|dfSr~rZllr"r"r#rz)parse_geosearch_generic..)rrrcSs|Sr%r"xr"r"r#r rcsg|]}|r|qSr"r")rGo)castrr"r#r|!sz+parse_geosearch_generic..)rrrcs$g|]}ttddt|qS)cSs|d|dSr~r")Zfvr"r"r#r"rz4parse_geosearch_generic...)rrwrr)fr"r#r|"s)typerrSr)r!rZ response_listr")rrrr#parse_geosearch_generics  rcKsi}|D]}i}t|d}||d<t|d|d<dd|dD|d<|d |d <|d |d <|d |d<t|dkr|d|d<|d|d<|d|d<|||<q|S)NrrsrRaritycSsg|] }t|qSr"r)rGrtr"r"r#r|,sz!parse_command..rrmrZ first_key_posrZ last_key_posZ step_countZtipsrZkey_specificationsr subcommands)rrr)r!rcommandsrZcmd_dictcmd_namer"r"r# parse_command%s          rcKs"tt|ddd|dddS)NrrrR)rrrr"r"r#parse_pubsub_numsub8srcKst|tr|St|dkSrrrrrr"r"r#parse_client_kill<s rcKsx|dkr dSt|dd}ttt|d|d<ttt|d|d<t|d|d<t|dtspt|dtrtt|dd|d<|ddgkrg|d<d |krt|d tst|d trtt|d d|d <|d dgkrg|d <d |krd d |d D|d <gg}}|ddD]&}d |krF||n ||q,||d<||d<d|dk|d<|S)NTrrm passwordsrrrchannels selectorscSsg|]}ttt|qSr"rrwr)rGselectorr"r"r#r|Usz%parse_acl_getuser..r categoriesonZenabled) rhrrwrrrrr(ra)r!rr/rrrr"r"r#parse_acl_getuserBs8      r cKsp|dkr dSt|trdg}|D]B}t|dd}|dd}t||d<t|d|d<||qnt|}|S)NTz client-inforz age-seconds)rrrhr:parse_client_inforSrar)r!rr/logZlog_data client_infor"r"r# parse_acl_loggs    rcCsPi}t|d}|D]}|d\}}|||<qdD]}t||||<q6|S)zg Parsing client-info in ACL Log in following format. "key1=value1 key2=value2 key3=value3" rrP>rtot-memobl qbuf-freedbpsubagemultiollidleomemargv-memsubqbuf)rr(r)rUr ZinfosrbrdZint_keyr"r"r#r ys r cCst|tr|dSNT)rrr r"r"r#parse_module_results rcKs|dr|S|ot|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 r:r)r:rrr"r"r#parse_set_results rc~@seZdZedeedeedeedddedeedeed e ed d ded d dede edddede ede ede edddddeeedddde ee e ddeeeeeee dde edde e dddde e e e ddedde eee e e e e eeed dee e ee e e d!dd"deeed#deeee ee eed$ded%de e e!d&dee"d'de e ee e e e#e$e%e e e e&e e&e'e(ee e"d(de)e*e eee e+e+e,e-e.e/e0d)nZ1d*S)+ AbstractRediszyAUTH COPY EXPIRE EXPIREAT PEXPIRE PEXPIREAT HEXISTS HMSET MOVE MSETNX PERSIST PSETEX RENAMENX SISMEMBER SMOVE SETEX SETNXaBITCOUNT 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 RPUSHcCst|tr|pt|dkSrrrr"r"r#rrzAbstractRedis.ZSORTzZSCORE ZINCRBY GEODISTz|FLUSHALL FLUSHDB LSET LTRIM MSET PFMERGE ASKING READONLY READWRITE RENAME SAVE SELECT SHUTDOWN SLAVEOF SWAPDB WATCH UNWATCH z BLPOP BRPOPcCs|r t|pdSr%)rr r"r"r#rrzSDIFF SINTER SMEMBERS SUNIONcCs|r t|ptSr%)rqr r"r"r#rrzSZPOPMAX ZPOPMIN ZINTER ZDIFF ZUNION ZRANGE ZRANGEBYSCORE ZREVRANGE ZREVRANGEBYSCOREzBZPOPMIN BZPOPMAXcCs"|r|d|dt|dfp dS)NrrRrrr r"r"r#rrzZRANK ZREVRANKzXREVRANGE XRANGEzXREAD XREADGROUPzBGREWRITEAOF BGSAVEcCsdSrr"r r"r"r#rrcCsttt|Sr%rr r"r"r#rrcCsttt|Sr%rr r"r"r#rrcCsttt|Sr%rr r"r"r#rrcCsttt|Sr%rr r"r"r#rrcCs|rt|dkpdS)NrRFrr r"r"r#rrcCsttt|Sr%rr r"r"r#rrcCst|Sr%rrr"r"r#rrcCst|Sr%rrr"r"r#rrcCsttt|Sr%rr r"r"r#rrcCst|Sr%rrr"r"r#rrcCsttt|Sr%rr r"r"r#rrcCsttt|Sr%rr r"r"r#rrcCsttdd|S)NcSs$|dk r t|dt|dfSdSr~rrr"r"r#rrz(AbstractRedis...)rrwr r"r"r#rs cCs|r t|piSr%rr r"r"r#rrcCsdd|DS)NcSsg|] }t|qSr"r)rGmr"r"r#r|sz*AbstractRedis...r"r r"r"r#rrcCs t|dkS)NZPONGrr r"r"r#r rcCs |r|p dSr%r"r r"r"r#r$rcCsttt|Sr%)rrwboolr r"r"r#r'rcCst|dt|dfSr~rrr"r"r#r<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 ADDSLOTSRANGEzCLUSTER 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 GEORADIUSZGEORADIUSBYMEMBERZHGETALLZHSCANINFOZLASTSAVEz MEMORY PURGEz MEMORY STATSz MEMORY USAGEz MODULE LOADz MODULE UNLOADz MODULE LISTZOBJECTPINGZQUITZSTRALGOz PUBSUB NUMSUBZ RANDOMKEYRESETZSCAN 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@rAr*r"rrSrrrrrMrrrr rrrr rrrrrLrrrer$rkrrNrrrrrxrzr}rrrrrrrrrrRESPONSE_CALLBACKSr"r"r"r#rs(  rc&@seZdZdZeddZd>eed d dZddZ ddZ ddZ eddddZ dddddZ ddZddZd?d!d"Zd#d$Zd@d&d'Zd(d)Zd*d+Zd,d-Zd.d/Zd0d1Zd2d3Zd4d5Zd6d7Zd8d9Zd:d;Zd - `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. )connection_pool)rfrom_url)clsurlrir*r"r"r#r+\s*zRedis.from_url localhostrNutf-8strictFrequired)credential_providerc'(Cs| s| dk rttd| } |dk r8ttd|} |s@g}|dkrR|t||#||| | ||t|$||!|"|%|&d}'| dk r|'| tdn@|'|||||d|r|'t ||||||||||||d t f|'} | |_ d|_ | r|j d |_ t|jj|_dS) a 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`. Args: single_connection_client: if `True`, connection pool is not used. In that case `Redis` instance use is not thread safe. Nz/"charset" is deprecated. Use "encoding" insteadz5"errors" is deprecated. Use "encoding_errors" insteadT)rusernamepasswordsocket_timeoutencodingencoding_errorsrretry_on_errorretrymax_connectionshealth_check_interval client_nameredis_connect_funcr3)pathconnection_class)hostrlsocket_connect_timeoutsocket_keepalivesocket_keepalive_options) r@ ssl_keyfile ssl_certfile ssl_cert_reqs ssl_ca_certs ssl_ca_datassl_check_hostname ssl_password ssl_ca_pathssl_validate_ocsp_stapledssl_validate_ocspssl_ocsp_contextssl_ocsp_expected_cert_)warningswarnDeprecationWarningrarcopydeepcopyr=r r rr* connectionget_connectionr+r7r(response_callbacks)(r.rArlrr5r6rBrCrDr*Zunix_socket_pathr7r8charseterrorsrretry_on_timeoutr9sslrErFrGrHrLrIrJrKrNrMrOrPr;single_connection_clientr<r=r4r:r>r3rir"r"r#r2s6   zRedis.__init__cCst|jdt|jdS)N<>)rr?reprr*r.r"r"r#__repr__szRedis.__repr__cCs |jS)z!Get the connection pool's encoder)r* get_encoderrbr"r"r#rdszRedis.get_encodercCs|jjS)z'Get the connection's key-word arguments)r*Zconnection_kwargsrbr"r"r#get_connection_kwargsszRedis.get_connection_kwargsr)returncCs|dSNr:)rer:rbr"r"r# get_retryszRedis.get_retry)r:rfcCs"|d|i|j|dSrg)rer=r* set_retry)r.r:r"r"r#riszRedis.set_retrycCs||j|<dS)zSet a custom Response CallbackN)rY)r.rr)r"r"r#set_response_callback"szRedis.set_response_callbackcCst|||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.funcnamefuncr"r"r#load_external_module&szRedis.load_external_moduleTcCst|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*rY)r. transaction shard_hintr"r"r#pipeline=s zRedis.pipelinec Os|dd}|dd}|dd}|d|t}z8|rB|j|||}|} |rZ|n| WW5QRStk r|dk r|dkrt|Yq2Yq2Xq2W5QRXdS)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. rqNvalue_from_callableF watch_delayTr)poprrwatchexecutertimesleep) r.rmZwatchesrirqrsrtpipeZ func_valueZ exec_valuer"r"r#rpIs     zRedis.transaction皙?c Cs"|dkr t}||||||||dS)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)timeoutryblockingblocking_timeout thread_localr)r.rsr|ryr}r~ lock_classrr"r"r#lock_s>z Redis.lockcKst|jf|S)z Return a Publish/Subscribe object. With this object, you can subscribe to channels and listen for messages that get published to them. )PubSubr*)r.rir"r"r#pubsubsz Redis.pubsubcCs t|jSr%)Monitorr*rbr"r"r#monitorsz Redis.monitorcCs|j|jddS)NT)r*r^)r7r*rbr"r"r#clientsz Redis.clientcCs|Sr%r"rbr"r"r# __enter__szRedis.__enter__cCs |dSr%closer.exc_type exc_value tracebackr"r"r#__exit__szRedis.__exit__cCs |dSr%rrbr"r"r#__del__sz Redis.__del__cCs.t|dsdS|j}|r*d|_|j|dS)NrW)hasattrrWr*releaser.connr"r"r#rs  z Redis.closecOs|j||j||f|S)z7 Send a command and parse the response ) send_commandparse_response)r.r command_nameargsrr"r"r#_send_command_parse_responses z"Redis._send_command_parse_responsecCs.||jdks&t|t|jdkr*|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) disconnectr9rrr.rerrorr"r"r#_disconnect_raises zRedis._disconnect_raisec sfj}djp |jfz,jfddfddWSjs`|XdS)z.Execute a command and return a parsed responsercsjfSr%rr"rrrrr.r"r#rsz'Redis.execute_command..cs |Sr%)rrrr.r"r#rrN)r*rWrXrr:call_with_retry)r.rrpoolr"rr#execute_commands zRedis.execute_commandcKsz,t|kr"|jdd}|tn|}Wn*tk rVt|krP|tYSYnXt|krj|t||jkr|j||f|S|S)z'Parses a response from the Redis serverT)Zdisable_decoding)r read_responserurrrY)r.rWrrr!r"r"r#rs      zRedis.parse_response)&r.r/rNNNNNNNr0r1NNFFNFNNr2NNNFNFFNNNFrNNNNN)TN)Nr{TNNT)r?r@rArB classmethodr+rr r2rcrdrerhrirjrnrrrprrrrrrrrrrrrr"r"r"r#r)Ms .'   J r)c@sLeZdZdZedZedZddZddZ dd Z d d Z d d Z dS)rz 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"(.*?)(?d4d5Zd?d6d7Zd@d8d9ZdAd:d;Z dS)Bra* 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. )messagepmessage) unsubscribe punsubscribezredis-py-health-checkNFcCs|||_||_||_d|_t|_||_|jdkr>|j|_|j |j |_ |jj rdd|j g|_ n d|j g|_ |dS)Nrspong)r*rqignore_subscribe_messagesrW threadingEventsubscribed_eventrrdencodeHEALTH_CHECK_MESSAGEhealth_check_response_brhealth_check_responsereset)r.r*rqrrr"r"r#r2\s    zPubSub.__init__cCs|Sr%r"rbr"r"r#rtszPubSub.__enter__cCs |dSr%rrr"r"r#rwszPubSub.__exit__cCs&z |Wntk r YnXdSr%rrrbr"r"r#rzs zPubSub.__del__cCs^|jr.|j|j|j|jd|_i|_d|_t|_i|_ t|_ |j dS)Nr) rWrZclear_connect_callbacksr*rrhealth_check_response_counterrqpending_unsubscribe_channelspatternspending_unsubscribe_patternsrclearrbr"r"r#rs  z PubSub.resetcCs |dSr%rrbr"r"r#rsz PubSub.closecCs|j|j|jrRi}|jD]\}}|||jj|dd<q(|jf||jri}|jD]\}}|||jj|dd<qf|j f|dS)zBRe-subscribe to any channels and patterns previously subscribed toTrN) rrrrr,rr subscriber psubscribe)r.rWrr0r1rr"r"r# on_connects   zPubSub.on_connectcCs |jS)z@Indicates if there are subscriptions to any channels or patterns)ris_setrbr"r"r# subscribedszPubSub.subscribedcGsd|jdkr*|jd|j|_|j|j|j}d|j i}|jsJ||j||j f||dS)z#Execute a publish/subscribe commandNr check_health) rWr*rXrqZregister_connect_callbackrrclean_health_check_responses_executer)r.rrWrir"r"r#rs  zPubSub.execute_commandcCstd}|j}|jdkrp|dkrp|j||j|jdrf|||j}||rX|jd8_ntd||d8}q dS)zG If any health check responses are present, clean them rr|rRz?A non health check response was cleaned by execute_command: {0}N) rWrrcan_readr6ris_health_check_responserformat)r.Zttlrr!r"r"r#rs z#PubSub.clean_health_check_responsescCs(||jrt|ts||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\rrconnectrr"r"r#_disconnect_raise_connectsz PubSub._disconnect_raise_connectcs$jfddfddS)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 cs Sr%r"r")rrrir"r#rrz!PubSub._execute..cs |Sr%)rrrr"r#rr)r:r)r.rrrrir")rrrrir.r#rs zPubSub._executeTrcsZ|jdkrtd|fdd}||}||rV|jd8_dS|S)z3Parse the response from a publish/subscribe commandNNpubsub connection not set: did you forget to call subscribe() or psubscribe()?cs&sjdsdSnS)Nr)rrrr"blockrr|r"r#try_reads  z'PubSub.parse_response..try_readrR)rW RuntimeErrorrrrr)r.rr|rr!r"rr#rs  zPubSub.parse_responsecCs||j|jfkS)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. )rrrr"r"r#rszPubSub.is_health_check_responsecCsN|j}|dkrtd|jrJt|jkrJ|jd|jdd|jd7_dS)Nrr$F)rrR)rWrr<rxZnext_health_checkrrrrr"r"r#rszPubSub.check_healthcs(|jj|jjfdd|DS)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. csi|]\}}||qSr"r")rGr0r1rrr"r#r"s z*PubSub._normalize_keys..)rrrr,r>r"rr#_normalize_keysszPubSub._normalize_keyscOs||rt|d|dd}t|}|||jd|}||}|j||jsl|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()``. rrRN PSUBSCRIBE)r)rr&r'r=rrrrrrrqrrdifference_update)r.rriZ new_patternsret_valr"r"r#r$s      zPubSub.psubscribecGsL|r,t|d|dd}|t|}n|j}|j||jd|S)zj Unsubscribe from the supplied patterns. If empty, unsubscribe from all patterns. rrRN PUNSUBSCRIBE)r)rrr&r'rrr=r)r.rrr"r"r#r>s  zPubSub.punsubscribecOs||rt|d|dd}t|}|||jd|}||}|j||jsl|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()``. rrRN SUBSCRIBE)r)rr&r'r=rrrrrrrqrrr)r.rriZ new_channelsrr"r"r#rKs      zPubSub.subscribecGsL|r,t|d|dd}|t|}n|j}|j||jd|S)zi Unsubscribe from the supplied channels. If empty, unsubscribe from all channels rrRN UNSUBSCRIBE)r)rrr&r'rrr=r)r.rrr"r"r#res  zPubSub.unsubscribeccs,|jr(||jdd}|dk r|VqdS)zBListen for messages on channels this client has been subscribed toT)rN)rhandle_messagerrr"r"r#rrsz PubSub.listencCsd|js>t}|j|dkr:t|}td||}ndS|j|dk|d}|r`|||SdS)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. TrN)rr|)rrxrwaitrrr)r.rr|rZ time_spentr!r"r"r# get_messageys  zPubSub.get_messagecCs|dkr dn|}|d|S)z' Ping the Redis server Nrr$r)r.rr"r"r#rsz PubSub.pingcCs`|dkr dSt|d}|dkr<||d|d|dd}n2|dkrX|dd|dd}n|d|d|dd}||jkr|d kr|d}||jkr|j||j|dn,|d}||jkr|j||j|d|js|js|j ||j kr@|dkr|j |d d}n|j |d d}|r\||dSn|dkr\|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. NrrrRrr)rpatternchannelr/rrrr) rUNSUBSCRIBE_MESSAGE_TYPESrremoverrurrrrPUBLISH_MESSAGE_TYPESr:r)r.r!rZ message_typerrrhandlerr"r"r#rsV           zPubSub.handle_messagecCst|jD] \}}|dkr td|dq |jD] \}}|dkr6td|dq6t||||d}||S)Nz Channel: 'z' has no handler registeredz Pattern: ')daemonexception_handler)rr,rrPubSubWorkerThreadstart)r. sleep_timerrrrrthreadr"r"r# run_in_threadszPubSub.run_in_thread)NFN)Tr)Fr)N)F)rFN)!r?r@rArBrrrr2rrrrrrpropertyrrrrrrrrrrrrrrrrrrr"r"r"r#rOsB              Arcs.eZdZd fdd ZddZddZZS) rFNcs0t||_||_||_||_t|_dSr%) r3r2rrrrrr_running)r.rrrrr6r"r#r2s  zPubSubWorkerThread.__init__c Cs|jrdS|j|j}|j}|jrz|jd|dWq$tk r|}z|jdkr^||||W5d}~XYq$Xq$|dS)NT)rr|) rrrqrrr BaseExceptionrr)r.rrer"r"r#runs    "zPubSubWorkerThread.runcCs|jdSr%)rrrbr"r"r#stopszPubSubWorkerThread.stop)FN)r?r@rAr2rrrCr"r"r6r#rsrc@seZdZdZdddhZddZddZd d Zd d Zd dZ ddZ ddZ ddZ ddZ ddZddZddZddZdd Zd!d"Zd#d$Zd%d&Zd'd(Zd)d*Zd5d,d-Zd.d/Zd0d1Zd2d3Zd4S)6roa_ 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. DISCARDEXECUNWATCHcCs0||_d|_||_||_||_d|_|dS)NF)r*rWrYrprqwatchingr)r.r*rYrprqr"r"r#r2szPipeline.__init__cCs|Sr%r"rbr"r"r#r)szPipeline.__enter__cCs |dSr%rrr"r"r#r,szPipeline.__exit__cCs&z |Wntk r YnXdSr%rrbr"r"r#r/s zPipeline.__del__cCs t|jSr%)r command_stackrbr"r"r#__len__5szPipeline.__len__cCsdS)z1Pipeline instances should always evaluate to TrueTr"rbr"r"r#__bool__8szPipeline.__bool__cCs~g|_t|_|jrT|jrTz|jd|jWntk rR|jYnXd|_d|_ |jrz|j |jd|_dS)NrF) rrqscriptsrrWrrr rexplicit_transactionr*rrbr"r"r#r<s  zPipeline.resetcCs&|jrtd|jrtdd|_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 rrrbr"r"r#rSszPipeline.multicOs0|js|ddkr$|js$|j||S|j||S)NrWATCH)rr immediate_execute_commandpipeline_execute_command)r.rrir"r"r#r`s zPipeline.execute_commandcCs<||jr|td|jr.t|ts8|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)rrrrr\rrrr"r"r#_disconnect_reset_raiseesz Pipeline._disconnect_reset_raisecsPdjs(jj_jfddfddS)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. rcsjfSr%rr"rr"r#rsz4Pipeline.immediate_execute_command..cs |Sr%)rrrr"r#rr)rWr*rXrqr:rr.rrr"rr#r {s z"Pipeline.immediate_execute_commandcOs|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. )rrarr"r"r#r s z!Pipeline.pipeline_execute_commandc Cstdifg|difg}|dd|D}||g}z||dWn0tk rz}z|d|fW5d}~XYnXt|D]\}} t| dkr||| dtfqz||dWqtk r}z(|||d| d|||fW5d}~XYqXqz||d} Wn*t k rF|r@|ddYnXd|_ | dkr`t d |D]\}}| ||qdt | t |kr|jtd |r||| g} t| |D]N\} } t| ts| \}}|d}||jkr|j|| f|} | | q| S) N)MULTI)rcSsg|]\}}t|kr|qSr")r)rGrrr"r"r#r|sz1Pipeline._execute_transaction..rQrrRFzWatched variable changed.z6Wrong number of response items from pipeline execution)r pack_commandssend_packed_commandrrra enumeraterannotate_exceptionr rrinsertrrWrraise_first_errorrrrrY)r.rWrraise_on_errorZcmdsall_cmdsr[rrrr!r/rcmdrrrr"r"r#_execute_transactionsZ    "       zPipeline._execute_transactionc Cs|dd|D}||g}|D]T\}}z||j||df|Wq&tk rx}z||W5d}~XYq&Xq&|r||||S)NcSsg|] \}}|qSr"r")rGrrQr"r"r#r|sz.Pipeline._execute_pipeline..r)rrrarrr) r.rWrrrr!rrrr"r"r#_execute_pipelines   zPipeline._execute_pipelinecCs>t|D]0\}}t|tr|||d||d|qdS)NrRr)rrrr)r.rr!rrr"r"r#rs zPipeline.raise_first_errorcCsFdtt|}d|d|d|jd}|f|jdd|_dS)Nrz Command # z (z) of pipeline caused error: rrR)rrwrr)r. exceptionnumberrrmsgr"r"r#rszPipeline.annotate_exceptioncKs6tj|||f|}||jkr$d|_n|dkr2d|_|S)NFr T)r)rUNWATCH_COMMANDSr)r.rWrrrrr"r"r#rs  zPipeline.parse_responsecCs\t|j}|j}dd|D}|d|}t|sXt||D]\}}|s<|d|j|_q.r&r')r&)rrr allrscriptr )r.rZ immediateZshasexistsr!existr"r"r# load_scriptss  zPipeline.load_scriptscCs4||jrtd|jr&t|ts0|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)rrrr\rrrrr"r"r#_disconnect_raise_resetsz Pipeline._disconnect_raise_resetTcsjsjsgSjr"js.jr6jnjjs\j dj _z*j fddfddWS XdS)z0Execute all the commands in the current pipelinercs Sr%r"r")rrwrstackr"r#r>rz"Pipeline.execute..cs |Sr%)r'rrr"r#r?rN)rrrr&rpr rrrWr*rXrqrr:r)r.rr")rrwrr.r(r#rw)s$   zPipeline.executecCs|ddS)zg Flushes all previously queued commands See: https://redis.io/commands/DISCARD rNrrbr"r"r#discardDszPipeline.discardcGs|jrtd|jd|S)z$Watches the values at keys ``names``z"Cannot issue a WATCH after a MULTIr )r )r rr)r.namesr"r"r#rvKszPipeline.watchcCs|jr|dpdS)z'Unwatches all previously specified keysrT)rrrbr"r"r#unwatchQszPipeline.unwatchN)T)r?r@rArBrr2rrrrrrrrrr r rrrrrr&r'rwr)rvr+r"r"r"r#ro s2   C  ro)FF)erUrrrrxrR itertoolsrtypingrZredis.commandsrrrrZredis.connectionrr r Zredis.credentialsr Zredis.exceptionsr r rrrrrrZ redis.lockrZ redis.retryrZ redis.utilsrrZ SYM_EMPTYrrr$r*r&r+rLrNrerkrrprurxrzr}rrhrorrrMrrrrrrrrrrrrrrrrrrrrrrrrrrrrr rr rrrr)Z StrictRedisrrThreadrror"r"r"r#s   (   ,       !% !?C