o i5@s*dZddlZddlZddlmZddlmZmZmZm Z m Z m Z m Z m Z mZmZmZmZGdddeZGdd d eZGd d d eZGd d d ZGdddZeZdaddZddZddZddZd,ddZddZd,ddZ ddZ!d d!Z"d"d#Z#d,d$d%Z$d&d'Z%d(d)Z&d*d+Z'dS)-aL Stash - Global Shared State for Dirty Workers Provides simple key-value tables stored in the arbiter process. All workers can read and write to the same tables. Usage:: from gunicorn.dirty import stash # Basic operations - table is auto-created on first access stash.put("sessions", "user:1", {"name": "Alice", "role": "admin"}) user = stash.get("sessions", "user:1") stash.delete("sessions", "user:1") # Dict-like interface sessions = stash.table("sessions") sessions["user:1"] = {"name": "Alice"} user = sessions["user:1"] del sessions["user:1"] # Query operations keys = stash.keys("sessions") keys = stash.keys("sessions", pattern="user:*") # Table management stash.ensure("cache") # Explicit creation (idempotent) stash.clear("sessions") # Delete all entries stash.delete_table("sessions") # Delete the table itself tables = stash.tables() # List all tables Declarative usage in DirtyApp:: class MyApp(DirtyApp): stashes = ["sessions", "cache"] # Auto-created on arbiter start def __call__(self, action, *args, **kwargs): # Tables are ready to use stash.put("sessions", "key", "value") Note: Tables are stored in the arbiter process and are ephemeral. If the arbiter restarts, all data is lost. N) DirtyError) DirtyProtocol STASH_OP_PUT STASH_OP_GETSTASH_OP_DELETE STASH_OP_KEYSSTASH_OP_CLEAR STASH_OP_INFOSTASH_OP_ENSURESTASH_OP_DELETE_TABLESTASH_OP_TABLESSTASH_OP_EXISTSmake_stash_messagec@seZdZdZdS) StashErrorz$Base exception for stash operations.N)__name__ __module__ __qualname____doc__rrH/home/ubuntu/.local/lib/python3.10/site-packages/gunicorn/dirty/stash.pyrEsrc eZdZdZfddZZS)StashTableNotFoundErrorz#Raised when a table does not exist.cs||_td|dS)NzStash table not found: ) table_namesuper__init__)selfr __class__rrrLsz StashTableNotFoundError.__init__rrrrr __classcell__rrrrrIrcr)StashKeyNotFoundErrorz,Raised when a key does not exist in a table.cs(||_||_td|d|dS)NzKey not found in z: )rkeyrr)rrr#rrrrTszStashKeyNotFoundError.__init__rrrrrr"Qr!r"c@seZdZdZd*ddZddZddZd d Zd+d d ZddZ d,ddZ ddZ d,ddZ ddZ ddZddZd,ddZddZd d!Zd"d#Zd$d%Zd&d'Zd(d)Zd S)- StashClientzl Client for stash operations. Communicates with the arbiter which stores all tables in memory. >@cCs ||_||_d|_t|_dS)z Initialize the stash client. Args: socket_path: Path to the dirty arbiter's Unix socket timeout: Default timeout for operations in seconds N) socket_pathtimeout_sock threadingLock_lock)rr&r'rrrraszStashClient.__init__cCs ttS)zGenerate a unique request ID.)struuiduuid4rrrr_get_request_idn zStashClient._get_request_idc Csddl}|jdur dSz||j|j|_|j|j|j|jWdS|jt fy?}z d|_t d||d}~ww)z Establish connection to arbiter.rNzFailed to connect to arbiter: ) socketr(AF_UNIX SOCK_STREAM settimeoutr'connectr&errorOSErrorr)rr2errr_connectrs zStashClient._connectcCs:|jdurz|jWn tyYnwd|_dSdS)zClose the connection.N)r(close Exceptionr/rrr_closes   zStashClient._closeNc Cs6|j|jdur ||}t||||||d}zWt|j|t|j}|d} | tj kr@|dWWdS| tj krl|di} | dd} | dd } | d kr_t || d krht ||t | t d | ty} z|t| t rt d | | d} ~ ww1swYdS)a6 Execute a stash operation. Args: op: Operation code (STASH_OP_*) table: Table name key: Optional key value: Optional value pattern: Optional pattern for keys operation Returns: Result from the operation N)r#valuepatterntyperesultr7 error_typermessagez Unknown errorrr"zUnexpected response type: zStash operation failed: )r+r(r:r0rr write_message read_messagegetMSG_TYPE_RESPONSEMSG_TYPE_ERRORrr"rr<r= isinstance)roptabler#r>r? request_idrCresponsemsg_type error_inforB error_msgr9rrr_executesB           zStashClient._executecCs|jt|||ddS)z Store a value in a table. The table is automatically created if it doesn't exist. Args: table: Table name key: Key to store under value: Value to store (must be serializable) )r#r>N)rQr)rrKr#r>rrrputs zStashClient.putcCs*z |jt||dWSty|YSw)z Retrieve a value from a table. Args: table: Table name key: Key to retrieve default: Default value if key not found Returns: The stored value, or default if not found r#)rQrr")rrKr#defaultrrrrFs   zStashClient.getcC|jt||dS)z Delete a key from a table. Args: table: Table name key: Key to delete Returns: True if key was deleted, False if it didn't exist rS)rQrrrKr#rrrdelete zStashClient.deletecCrU)z Get all keys in a table, optionally filtered by pattern. Args: table: Table name pattern: Optional glob pattern (e.g., "user:*") Returns: List of keys r?)rQr)rrKr?rrrkeysrXzStashClient.keyscC|t|dS)z] Delete all entries in a table. Args: table: Table name N)rQr rrKrrrclearzStashClient.clearcCs |t|S)z Get information about a table. Args: table: Table name Returns: Dict with table info (size, etc.) )rQr r\rrrinfos zStashClient.infocCr[)z Ensure a table exists (create if not exists). This is idempotent - calling it multiple times is safe. Args: table: Table name N)rQr r\rrrensure s zStashClient.ensurecCrU)z Check if a table or key exists. Args: table: Table name key: Optional key to check within the table Returns: True if exists, False otherwise rS)rQrrVrrrexistsrXzStashClient.existscCr[)zV Delete an entire table. Args: table: Table name N)rQr r\rrr delete_table$r^zStashClient.delete_tablecCs |tdS)zT List all tables. Returns: List of table names )rQr r/rrrtables-s zStashClient.tablescCs t||S)z Get a dict-like interface to a table. Args: name: Table name Returns: StashTable instance ) StashTable)rnamerrrrK6s zStashClient.tablecCs4|j |WddS1swYdS)zClose the client connection.N)r+r=r/rrrr;Bs "zStashClient.closecCs|SNrr/rrr __enter__GszStashClient.__enter__cCs |dSrg)r;)rexc_typeexc_valexc_tbrrr__exit__Js zStashClient.__exit__)r%)NNNrg)rrrrrr0r:r=rQrRrFrWrZr]r_r`rarbrdrKr;rhrlrrrrr$Zs*   6          r$c@seZdZdZddZeddZddZdd Zd d Z d d Z ddZ ddZ dddZ dddZddZddZddZdS)rea2 Dict-like interface to a stash table. Example:: sessions = stash.table("sessions") sessions["user:1"] = {"name": "Alice"} user = sessions["user:1"] del sessions["user:1"] # Iteration for key in sessions: print(key, sessions[key]) cCs||_||_dSrg)_client_name)rclientrfrrrr^s zStashTable.__init__cCs|jS)z Table name.)rnr/rrrrfbszStashTable.namecCs4|j|j|}|dur|j|j|st||Srg)rmrFrnraKeyError)rr#rArrr __getitem__gs zStashTable.__getitem__cCs|j|j||dSrg)rmrRrn)rr#r>rrr __setitem__oszStashTable.__setitem__cCs|j|j|s t|dSrg)rmrWrnrprr#rrr __delitem__rszStashTable.__delitem__cCs|j|j|Srg)rmrarnrsrrr __contains__vszStashTable.__contains__cCst|j|jSrg)iterrmrZrnr/rrr__iter__yszStashTable.__iter__cCs|j|j}|ddS)Nsizer)rmr_rnrF)rr_rrr__len__|s zStashTable.__len__NcCs|j|j||S)zGet value with default.)rmrFrn)rr#rTrrrrFzStashTable.getcCs|jj|j|dS)z-Get all keys, optionally filtered by pattern.rY)rmrZrn)rr?rrrrZrzzStashTable.keyscCs|j|jdS)zDelete all entries.N)rmr]rnr/rrrr]rzzStashTable.clearccs0|j|jD] }||j|j|fVqdS)z Iterate over (key, value) pairs.NrmrZrnrFrsrrritemsszStashTable.itemsccs,|j|jD] }|j|j|VqdS)zIterate over values.Nr{rsrrrvaluesszStashTable.valuesrg)rrrrrpropertyrfrqrrrtrurwryrFrZr]r|r}rrrrreNs     recCs|adS)z@Set the global stash socket path (called during initialization).N)_stash_socket_path)pathrrrset_stash_socket_pathsrcCs0ddl}tdur|jd}|r|StdtS)zGet the stash socket path.rNGUNICORN_DIRTY_SOCKETz\Stash socket path not configured. Make sure dirty_workers > 0 and dirty_apps are configured.)osrenvironrFr)rrrrrget_stash_socket_paths rcCs,ttdd}|durt}t|}|t_|S)z*Get or create a thread-local stash client. stash_clientN)getattr _thread_localrr$r)ror&rrr _get_clients rcCst|||dS)zStore a value in a table.N)rrR)rKr#r>rrrrRsrRcCst|||S)zRetrieve a value from a table.)rrF)rKr#rTrrrrFrFcCt||S)zDelete a key from a table.)rrWrKr#rrrrWrWcCr)zGet all keys in a table.)rrZ)rKr?rrrrZrrZcCt|dS)zDelete all entries in a table.N)rr]rKrrrr]rr]cC t|S)zGet information about a table.)rr_rrrrr_r1r_cCr)zEnsure a table exists.N)rr`rrrrr`rr`cCr)zCheck if a table or key exists.)rrarrrrrarracCr)zDelete an entire table.N)rrbrrrrrbrrbcCs tS)zList all tables.)rrdrrrrrds rdcCr)z%Get a dict-like interface to a table.)rrK)rfrrrrKr1rKrg)(rr)r-errorsrprotocolrrrrrr r r r r rrrrr"r$relocalrrrrrrRrFrWrZr]r_r`rarbrdrKrrrrs6, 8 uN