֛hc\SrSSKJr SSKJrJrJr SSKJr SSK J r SSK J r SSK JrJr Sr"S S \5r"S S \5r"S S\5r"SS5r"SS\\ 5r/SQrg)ap Memcache client protocol. Memcached is a caching server, storing data in the form of pairs key/value, and memcache is the protocol to talk with it. To connect to a server, create a factory for L{MemCacheProtocol}:: from twisted.internet import reactor, protocol from twisted.protocols.memcache import MemCacheProtocol, DEFAULT_PORT d = protocol.ClientCreator(reactor, MemCacheProtocol ).connectTCP("localhost", DEFAULT_PORT) def doSomething(proto): # Here you call the memcache operations return proto.set("mykey", "a lot of data") d.addCallback(doSomething) reactor.run() All the operations of the memcache protocol are present, but L{MemCacheProtocol.set} and L{MemCacheProtocol.get} are the more important. See U{http://code.sixapart.com/svn/memcached/trunk/server/doc/protocol.txt} for more information about the protocol. )deque)Deferred TimeoutErrorfail) LineReceiver) TimeoutMixin)log) nativeString networkStringi+c\rSrSrSrSrg) NoSuchCommand(z9 Exception raised when a non existent command is called. N__name__ __module__ __qualname____firstlineno____doc____static_attributes__r^C:\Users\psant\Downloads\Noiseback\school\venv\Lib\site-packages\twisted/protocols/memcache.pyr r (rr c\rSrSrSrSrg) ClientError.z) Error caused by an invalid client call. rNrrrrrr.rrrc\rSrSrSrSrg) ServerError4z" Problem happening on the server. rNrrrrrr4rrrc*\rSrSrSrSrSrSrSrg)Command:a Wrap a client action into an object, that holds the values used in the protocol. @ivar _deferred: the L{Deferred} object that will be fired when the result arrives. @type _deferred: L{Deferred} @ivar command: name of the command sent to the server. @type command: L{bytes} c xXl[5UlUR5Hup4[ XU5 M g)z Create a command. @param command: the name of the command. @type command: L{bytes} @param kwargs: this values will be stored as attributes of the object for future use N)commandr _deferreditemssetattr)selfr$kwargskvs r__init__Command.__init__Gs. !LLNDA DQ #rc:URRU5 g)z2 Shortcut method to fire the underlying deferred. N)r%callback)r(values rsuccessCommand.successVs &rc:URRU5 g)z% Make the underlying deferred fails. N)r%errback)r(errors rr Command.fail\s u%r)r%r$N) rrrrrr,r1rrrrrr!r!:s   ' &rr!c&\rSrSrSrSrSrS,SjrSrSr Sr S r S r S r S rS rSrSrSrSrSrSrSrSrSrSrSrS-SjrS-SjrSrS.SjrS.SjrS.Sjr S.Sjr!S r"S!r#S"r$S/S#jr%S/S$jr&S%r'S0S'jr(S(r)S)r*S*r+S+r,g&)1MemCacheProtocolca MemCache protocol: connect to a memcached server to store/retrieve values. @ivar persistentTimeOut: the timeout period used to wait for a response. @type persistentTimeOut: L{int} @ivar _current: current list of requests waiting for an answer from the server. @type _current: L{deque} of L{Command} @ivar _lenExpected: amount of data expected in raw mode, when reading for a value. @type _lenExpected: L{int} @ivar _getBuffer: current buffer of data, used to store temporary data when reading in raw mode. @type _getBuffer: L{list} @ivar _bufferLength: the total amount of bytes in C{_getBuffer}. @type _bufferLength: L{int} @ivar _disconnected: indicate if the connectionLost has been called or not. @type _disconnected: L{bool} Fch[5UlSUlSUlSUlU=UlUlg)z Create the protocol. @param timeOut: the timeout to wait before detecting that the connection is dead and close it. It's expressed in seconds. @type timeOut: L{int} N)r_current _lenExpected _getBuffer _bufferLengthpersistentTimeOuttimeOut)r(rAs rr,MemCacheProtocol.__init__s3  !077rcUR(a?URR5nURU5 UR(aM>gg)zG Cancel all the outstanding commands, making them fail with C{reason}. N)r<popleftr)r(reasoncmds r_cancelCommands MemCacheProtocol._cancelCommandss4mm--'')C HHV mmmrclUR[S55 URR5 g)z* Close the connection in case of timeout. zConnection timeoutN)rGr transportloseConnectionr(s rtimeoutConnection"MemCacheProtocol.timeoutConnections( \*>?@ %%'rc`SUlURU5 [R"X5 g)z) Cause any outstanding commands to fail. TN) _disconnectedrGrconnectionLost)r(rEs rrQMemCacheProtocol.connectionLosts(" V$##D1rcUR(dURUR5 [R"X5 g)z1 Override sendLine to add a timeout to response. N)r< setTimeoutr@rsendLine)r(lines rrUMemCacheProtocol.sendLines+}} OOD22 3d)rcRUR5 URRU5 U=R[ U5- slURUR S-:aSR UR5nUSUR nXR S-SnUnSUlSUlSUlURSnUR(a7URURupgXgU4URUR'OXEl URU5 gg)z Collect data for a get. rNr) resetTimeoutr>appendr?lenr=joinr<multiplevalues currentKeyr0 setLineMode)r(databufremvalrFflagscass rrawDataReceived MemCacheProtocol.rawDataReceiveds  t$ c$i'   !2!2Q!6 688DOO,D***+C((1,./CC $D "DO!%D --"C|| ZZ7 .3#-> 3>>*   S ! 7rcVURR5RS5 g)z/ Manage a success response to a set operation. TNr<rDr1rLs r cmd_STOREDMemCacheProtocol.cmd_STORED ''-rcVURR5RS5 g)zr Manage a specific 'not stored' response to a set operation: this is not an error, but some condition wasn't met. FNrkrLs rcmd_NOT_STOREDMemCacheProtocol.cmd_NOT_STOREDs ''.rc URR5nURS:XaUR(aFURR 5VVs0sH up#X#SSS2_M nnnUR U5 gUR URUR45 gURS:Xa`UR(aUR UR5 gUR URURUR45 gURS:XaUR UR5 g[SR[UR555es snnf)z2 This the end token to a get or a stat operation. getNrYgetsstatsz%Unexpected END response to {} command) r<rDr$r^r_r&r1rfr0rg RuntimeErrorformatr )r(rFkeyrer_s rcmd_ENDMemCacheProtocol.cmd_ENDsmm##% ;;& ||8; 8H8H8JK8JHC#3Q3x-8JK F# SYY 23 [[G #|| CJJ' SYY;< [[H $ KK #7>> - LsE3cVURR5RS5 g)z- Manage error response for incr/decr/delete. FNrkrLs r cmd_NOT_FOUNDMemCacheProtocol.cmd_NOT_FOUND ''.rcURSnURS:XaUR5up4nSnOUR5up4pV[U5Ul/UlSUlUR(a;X2R;a [S5eX2l [U5U/URU'O1URU:wa [S5e[U5Ul XblUR5 g)z* Prepare the reading a value after a get. rrsrzUnexpected commands answer.N)r<r$splitintr=r>r?r^keysrvr`r_rxrfrg setRawMode)r(rVrFrxrflengthrgs r cmd_VALUEMemCacheProtocol.cmd_VALUEsmmA ;;& !% CC&*jjl #CK <<((""#@AA N"5z3/CJJsOww#~"#@AAE CIG rcfURSnURSS5up4XBRU'g)z Reception of one stat line. r N)r<rr_)r(rVrFrxres rcmd_STATMemCacheProtocol.cmd_STAT s/mmA::dA& 3rcVURR5RU5 g)z Read version token. Nrk)r( versionDatas r cmd_VERSIONMemCacheProtocol.cmd_VERSIONs '' 4rc[R"S5 URR5nUR [ 55 g)z' A non-existent command has been sent. zNon-existent command sent.N)r errr<rDrr )r(rFs r cmd_ERRORMemCacheProtocol.cmd_ERRORs1 ,-mm##% !rc[U5n[R"SU-5 URR 5nUR [ U55 g)z An invalid input as been sent. zInvalid input: N)reprr rr<rDrrr(errTextrFs rcmd_CLIENT_ERROR!MemCacheProtocol.cmd_CLIENT_ERRORsBw- !G+,mm##% W%&rc[U5n[R"SU-5 URR 5nUR [ U55 g)z$ An error has happened server-side. zServer error: N)rr rr<rDrrrs rcmd_SERVER_ERROR!MemCacheProtocol.cmd_SERVER_ERROR(sBw-  7*+mm##% W%&rcVURR5RS5 g)z. A delete command has completed successfully. TNrkrLs r cmd_DELETEDMemCacheProtocol.cmd_DELETED1rnrcVURR5RS5 g)z& The last command has been completed. TNrkrLs rcmd_OKMemCacheProtocol.cmd_OK7rnrcVURR5RS5 g)z% A C{checkAndSet} update has failed. FNrkrLs r cmd_EXISTSMemCacheProtocol.cmd_EXISTS=r~rcUR5 URSS5Sn[US[U5-S5nUb0URSS5SSnU(a U"US5 OtU"5 OlUR SS5n[US[U5-S5nUbU"5 O6UR R 5n[U5nURU5 UR (dURS5 gg)z( Receive line commands from the server. rrrcmd_N_) rZrgetattrr replacer<rDrr1rT)r(rVtokenrFargsres r lineReceivedMemCacheProtocol.lineReceivedCs  4#A&dF\%%88$? ?::dA&qr*DDG <<d+D$d); ;TBCmm++-$i C }} OOD !rc&URSX5$)an Increment the value of C{key} by given value (default to 1). C{key} must be consistent with an int. Return the new value. @param key: the key to modify. @type key: L{bytes} @param val: the value to increment. @type val: L{int} @return: a deferred with will be called back with the new value associated with the key (after the increment). @rtype: L{Deferred} sincr _incrdecrr(rxres r incrementMemCacheProtocol.increment`s~~gs00rc&URSX5$)a Decrement the value of C{key} by given value (default to 1). C{key} must be consistent with an int. Return the new value, coerced to 0 if negative. @param key: the key to modify. @type key: L{bytes} @param val: the value to decrement. @type val: L{int} @return: a deferred with will be called back with the new value associated with the key (after the decrement). @rtype: L{Deferred} sdecrrrs r decrementMemCacheProtocol.decrementqs ~~gs00rcUR(a[[S55$[U[5(d![[ S[ U5S355$[U5UR:a[[ S55$SRXS[U54-/5nURU5 [XS9nURRU5 UR$)z! Internal wrapper for incr/decr. not connectedInvalid type for key: , expecting bytes Key too longrs%drx)rPrrv isinstancebytesrtyper\MAX_KEY_LENGTHr]rrUr!r<r[r%)r(rFrxrefullcmdcmdObjs rrMemCacheProtocol._incrdecrs    _56 6#u%%4T#YK?PQR  s8d)) ) N34 4))SuC{':;< g& V$rc*URSXX4S5$)a- Replace the given C{key}. It must already exist in the server. @param key: the key to replace. @type key: L{bytes} @param val: the new value associated with the key. @type val: L{bytes} @param flags: the flags to store with the key. @type flags: L{int} @param expireTime: if different from 0, the relative time in seconds when the key will be deleted from the store. @type expireTime: L{int} @return: a deferred that will fire with C{True} if the operation has succeeded, and C{False} with the key didn't previously exist. @rtype: L{Deferred} sreplacer_setr(rxrerf expireTimes rrMemCacheProtocol.replaces*yySu#FFrc*URSXX4S5$)a Add the given C{key}. It must not exist in the server. @param key: the key to add. @type key: L{bytes} @param val: the value associated with the key. @type val: L{bytes} @param flags: the flags to store with the key. @type flags: L{int} @param expireTime: if different from 0, the relative time in seconds when the key will be deleted from the store. @type expireTime: L{int} @return: a deferred that will fire with C{True} if the operation has succeeded, and C{False} with the key already exists. @rtype: L{Deferred} saddrrrs raddMemCacheProtocol.add*yy5cBBrc*URSXX4S5$)a Set the given C{key}. @param key: the key to set. @type key: L{bytes} @param val: the value associated with the key. @type val: L{bytes} @param flags: the flags to store with the key. @type flags: L{int} @param expireTime: if different from 0, the relative time in seconds when the key will be deleted from the store. @type expireTime: L{int} @return: a deferred that will fire with C{True} if the operation has succeeded. @rtype: L{Deferred} ssetrrrs rsetMemCacheProtocol.setrrc*URSXXEU5$)a Change the content of C{key} only if the C{cas} value matches the current one associated with the key. Use this to store a value which hasn't been modified since last time you fetched it. @param key: The key to set. @type key: L{bytes} @param val: The value associated with the key. @type val: L{bytes} @param cas: Unique 64-bit value returned by previous call of C{get}. @type cas: L{bytes} @param flags: The flags to store with the key. @type flags: L{int} @param expireTime: If different from 0, the relative time in seconds when the key will be deleted from the store. @type expireTime: L{int} @return: A deferred that will fire with C{True} if the operation has succeeded, C{False} otherwise. @rtype: L{Deferred} scasr)r(rxrergrfrs r checkAndSetMemCacheProtocol.checkAndSets4yy5cBBrc UR(a[[S55$[U[5(d![[ S[ U5S355$[U5UR:a[[ S55$[U[5(d![[ S[ U5S355$U(aSU-n[U5nSRX[SXEU4-5/5U-nURU5 URU5 [XXGS9n URRU 5 U R$) z& Internal wrapper for setting values. rrrrzInvalid type for value: rz%d %d %d)rxrfr)rPrrvrrrrr\rr]r rUr!r<r[r%) r(rFrxrerfrrgrrrs rrMemCacheProtocol._sets0    _56 6#u%%4T#YK?PQR  s8d)) ) N34 4#u%%6tCykARST  *CS II=u&6Q)QRS    g cUB V$rc,URSXSSS5$)aL Append given data to the value of an existing key. @param key: The key to modify. @type key: L{bytes} @param val: The value to append to the current value associated with the key. @type val: L{bytes} @return: A deferred that will fire with C{True} if the operation has succeeded, C{False} otherwise. @rtype: L{Deferred} sappendrrrrs rr[MemCacheProtocol.appends yyCaC88rc,URSXSSS5$)aN Prepend given data to the value of an existing key. @param key: The key to modify. @type key: L{bytes} @param val: The value to prepend to the current value associated with the key. @type val: L{bytes} @return: A deferred that will fire with C{True} if the operation has succeeded, C{False} otherwise. @rtype: L{Deferred} sprependrrrrs rprependMemCacheProtocol.prepend's yySq!S99rc*URU/US5$)a6 Get the given C{key}. It doesn't support multiple keys. If C{withIdentifier} is set to C{True}, the command issued is a C{gets}, that will return the current identifier associated with the value. This identifier has to be used when issuing C{checkAndSet} update later, using the corresponding method. @param key: The key to retrieve. @type key: L{bytes} @param withIdentifier: If set to C{True}, retrieve the current identifier along with the value and the flags. @type withIdentifier: L{bool} @return: A deferred that will fire with the tuple (flags, value) if C{withIdentifier} is C{False}, or (flags, cas identifier, value) if C{True}. If the server indicates there is no value associated with C{key}, the returned value will be L{None} and the returned flags will be C{0}. @rtype: L{Deferred} F_get)r(rxwithIdentifiers rgetMemCacheProtocol.get9s,yy#66rc&URXS5$)at Get the given list of C{keys}. If C{withIdentifier} is set to C{True}, the command issued is a C{gets}, that will return the identifiers associated with each values. This identifier has to be used when issuing C{checkAndSet} update later, using the corresponding method. @param keys: The keys to retrieve. @type keys: L{list} of L{bytes} @param withIdentifier: If set to C{True}, retrieve the identifiers along with the values and the flags. @type withIdentifier: L{bool} @return: A deferred that will fire with a dictionary with the elements of C{keys} as keys and the tuples (flags, value) as values if C{withIdentifier} is C{False}, or (flags, cas identifier, value) if C{True}. If the server indicates there is no value associated with C{key}, the returned values will be L{None} and the returned flags will be C{0}. @rtype: L{Deferred} @since: 9.0 Tr)r(rrs r getMultipleMemCacheProtocol.getMultipleQs0yyt44rc h[U5nUR(a[[S55$UHjn[ U[ 5(d#[[ S[U5S355s $[U5UR:dMV[[ S55s $ U(aSnOSnSRU/U-5nURU5 U(aUVs0sHoDS_M nn[XQUS S 9nO[XQS S S S SS9nURRU5 UR$s snf)z. Helper method for C{get} and C{getMultiple}. rrrrrtrsr)rrNT)rr_r^rNrF)rxr0rfrgr^)listrPrrvrrrrr\rr]rUr!r<r[r%) r(rrr^rxrFrr_rs rrMemCacheProtocol._getksDz    _56 6Cc5))"8c CT UV3x$---K788  CC))SEDL) g 59:Tc>)TF:SFTJFaA3F V$;s D/NcU(aSU-nOSnUR(a[[S55$URU5 [ S0S9nUR R U5 UR$)a Get some stats from the server. It will be available as a dict. @param arg: An optional additional string which will be sent along with the I{stats} command. The interpretation of this value by the server is left undefined by the memcache protocol specification. @type arg: L{None} or L{bytes} @return: a deferred that will fire with a L{dict} of the available statistics. @rtype: L{Deferred} sstats rur)r_rPrrvrUr!r<r[r%)r(argrFrs rstatsMemCacheProtocol.statssd c/CC    _56 6 c"- V$rcUR(a[[S55$URS5 [ S5nUR R U5 UR$)z Get the version of the server. @return: a deferred that will fire with the string value of the version. @rtype: L{Deferred} rsversionrr(rs rversionMemCacheProtocol.versionsQ    _56 6 j!$ V$rcBUR(a[[S55$[U[5(d![[ S[ U5S355$URSU-5 [SUS9nURRU5 UR$)z Delete an existing C{key}. @param key: the key to delete. @type key: L{bytes} @return: a deferred that will be called back with C{True} if the key was successfully deleted, or C{False} if not. @rtype: L{Deferred} rrrsdelete sdeleter) rPrrvrrrrrUr!r<r[r%)r(rxrs rdeleteMemCacheProtocol.deletes    _56 6#u%%4T#YK?PQR  j3&', V$rcUR(a[[S55$URS5 [ S5nUR R U5 UR$)z Flush all cached values. @return: a deferred that will be called back with C{True} when the operation has succeeded. @rtype: L{Deferred} rs flush_allrrs rflushAllMemCacheProtocol.flushAllsQ    _56 6 l#& V$r)r?r<rPr>r=r@rA)<)r)rr)F)N)-rrrrrrrPr,rGrMrQrUrhrlrpryr|rrrrrrrrrrrrrrrrrrr[rrrrrrrrrrrrr8r8cs2NM 8(2*".. /2/ 25 "''. . / ":1"1$ $G.C.C.C8 >9$:$7054 < 2   ,  rr8)r8 DEFAULT_PORTr rrN)r collectionsrtwisted.internet.deferrrrtwisted.protocols.basicrtwisted.protocols.policiesrtwisted.pythonr twisted.python.compatr r r Exceptionr rrr!r8__all__rrrrsm 0??03= I ) ) &&&&Rq  |\q  h r