o ßñ h3ã@sôddlmZddlmZddlmZddlmZmZm Z m Z er>ddl m Z ddl mZddlmZddlmZdd lmZGd d „d eƒZGd d „d e ƒZeGdd„dƒƒZeGdd„dƒƒZGdd„deƒZGdd„de ƒZGdd„de ƒZdS)é)Ú annotations)Úabstractmethod)Ú dataclass)Ú TYPE_CHECKINGÚCallableÚProtocolÚcast)Ú ForwardMsg)Ú AppSession)Ú ScriptData)Ú ScriptCache)ÚUploadedFileManagerc@óeZdZdZdS)ÚSessionClientDisconnectedErrorz5Raised by operations on a disconnected SessionClient.N©Ú__name__Ú __module__Ú __qualname__Ú__doc__©rrúU/var/www/vscode/kcb/lib/python3.10/site-packages/streamlit/runtime/session_manager.pyrórc@seZdZdZed dd„ƒZdS) Ú SessionClientz1Interface for sending data to a session's client.Úmsgr ÚreturnÚNonecCót‚)z›Deliver a ForwardMsg to the client. If the SessionClient has been disconnected, it should raise a SessionClientDisconnectedError. ©ÚNotImplementedError)ÚselfrrrrÚwrite_forward_msg$szSessionClient.write_forward_msgN)rr rr)rrrrrr rrrrr!src@s.eZdZUdZded<ded<dZded<d S) ÚActiveSessionInfozÆType containing data related to an active session. This type is nearly identical to SessionInfo. The difference is that when using it, we are guaranteed that SessionClient is not None. rÚclientr ÚsessionrÚintÚscript_run_countN)rrrrÚ__annotations__r%rrrrr!.s r!c@sBeZdZUdZded<ded<dZded<dd d „Zddd„ZdS)Ú SessionInfozËType containing data related to an AppSession. For each AppSession, the Runtime tracks that session's script_run_count. This is used to track the age of messages in the ForwardMsgCache. zSessionClient | Noner"r r#rr$r%rÚboolcCs |jduS)N)r"©rrrrÚ is_activeHs zSessionInfo.is_activer!cCs| ¡sJdƒ‚td|ƒS)Nz.A SessionInfo with no client cannot be active!r!)r*rr)rrrÚ to_activeKs zSessionInfo.to_activeN)rr()rr!)rrrrr&r%r*r+rrrrr';s   r'c@r)ÚSessionStorageErrorzßException class for errors raised by SessionStorage. The original error that causes a SessionStorageError to be (re)raised will generally be an I/O error specific to the concrete SessionStorage implementation. Nrrrrrr,Trr,c@sDeZdZeddd„ƒZedd d „ƒZedd d „ƒZeddd„ƒZdS)ÚSessionStorageÚ session_idÚstrrúSessionInfo | NonecCr)a.Return the SessionInfo corresponding to session_id, or None if one does not exist. Parameters ---------- session_id The unique ID of the session being fetched. Returns ------- SessionInfo or None Raises ------ SessionStorageError Raised if an error occurs while attempting to fetch the session. This will generally happen if there is an error with the underlying storage backend (e.g. if we lose our connection to it). r©rr.rrrÚget]ózSessionStorage.getÚ session_infor'rcCr)aSave the given session. Parameters ---------- session_info The SessionInfo being saved. Raises ------ SessionStorageError Raised if an error occurs while saving the given session. r)rr4rrrÚsavetózSessionStorage.savecCr)a½Mark the session corresponding to session_id for deletion and stop tracking it. Note that: - Calling delete on an ID corresponding to a nonexistent session is a no-op. - Calling delete on an ID should cause the given session to no longer be tracked by this SessionStorage, but exactly when and how the session's data is eventually cleaned up is a detail left up to the implementation. Parameters ---------- session_id The unique ID of the session to delete. Raises ------ SessionStorageError Raised if an error occurs while attempting to delete the session. rr1rrrÚdelete„r3zSessionStorage.deleteúlist[SessionInfo]cCr)zùList all sessions tracked by this SessionStorage. Returns ------- List[SessionInfo] Raises ------ SessionStorageError Raised if an error occurs while attempting to list sessions. rr)rrrÚlist›s zSessionStorage.listN©r.r/rr0)r4r'rr©r.r/rr©rr8)rrrrr2r5r7r9rrrrr-\s   r-c@s˜eZdZdZed4d d „ƒZe  d5d6dd„ƒZed7dd„ƒZed8dd „ƒZed9d"d#„ƒZ d:d%d&„Z d7d'd(„Z d;d*d+„Z dÚSessionManagera7SessionManagers are responsible for encapsulating all session lifecycle behavior that the Streamlit Runtime may care about. A SessionManager must define the following required methods: - __init__ - connect_session - close_session - get_session_info - list_sessions SessionManager implementations may also choose to define the notions of active and inactive sessions. The precise definitions of active/inactive are left to the concrete implementation. SessionManagers that wish to differentiate between active and inactive sessions should have the required methods listed above operate on *all* sessions. Additionally, they should define the following methods for working with active sessions: - disconnect_session - get_active_session_info - is_active_session - list_active_sessions When active session-related methods are left undefined, their default implementations are the naturally corresponding required methods. The Runtime, unless there's a good reason to do otherwise, should generally work with the active-session versions of a SessionManager's methods. There isn't currently a need for us to be able to operate on inactive sessions stored in SessionStorage outside of the SessionManager itself. However, it's highly likely that we'll eventually have to do so, which is why the abstractions allow for this now. Notes ----- Threading: All SessionManager methods are *not* threadsafe -- they must be called from the runtime's eventloop thread. Úsession_storager-Úuploaded_file_managerr Ú script_cacher Úmessage_enqueued_callbackúCallable[[], None] | NonerrcCr)aInitialize a SessionManager with the given SessionStorage. Parameters ---------- session_storage The SessionStorage instance backing this SessionManager. uploaded_file_manager Used to manage files uploaded by users via the Streamlit web client. script_cache ScriptCache instance. Caches user script bytecode. message_enqueued_callback A callback invoked after a message is enqueued to be sent to a web client. r)rr>r?r@rArrrÚ__init__ÐszSessionManager.__init__Nr"rÚ script_datar Ú user_infoúdict[str, str | bool | None]Úexisting_session_idú str | NoneÚsession_id_overrider/cCr)a¢Create a new session or connect to an existing one. Parameters ---------- client A concrete SessionClient implementation for communicating with the session's client. script_data Contains parameters related to running a script. user_info A dict that contains information about the session's user. For now, it only (optionally) contains the user's email address. { "email": "example@example.com" } existing_session_id The ID of an existing session to reconnect to. If one is not provided, a new session is created. Note that whether a SessionManager supports reconnecting to an existing session is left up to the concrete SessionManager implementation. Those that do not support reconnection should simply ignore this argument. session_id_override The ID to assign to a new session being created with this method. Setting this can be useful when the service that a Streamlit Runtime is running in wants to tie the lifecycle of a Streamlit session to some other session-like object that it manages. Only one of existing_session_id and session_id_override should be set. Returns ------- str The session's unique string ID. r)rr"rDrErGrIrrrÚconnect_sessionês+zSessionManager.connect_sessionr.cCr)a*Close and completely delete the session with the given id. This function may be called multiple times for the same session, which is not an error. (Subsequent calls just no-op.) Parameters ---------- session_id The session's unique ID. rr1rrrÚ close_sessions zSessionManager.close_sessionr0cCr)zøReturn the SessionInfo for the given id, or None if no such session exists. Parameters ---------- session_id The session's unique ID. Returns ------- SessionInfo or None rr1rrrÚget_session_info%r6zSessionManager.get_session_infor8cCr)z‹Return the SessionInfo for all sessions managed by this SessionManager. Returns ------- List[SessionInfo] rr)rrrÚ list_sessions5szSessionManager.list_sessionsr$cCó t| ¡ƒS)zùReturn the number of sessions tracked by this SessionManager. Subclasses of SessionManager shouldn't provide their own implementation of this method without a *very* good reason. Returns ------- int )ÚlenrMr)rrrÚ num_sessions?ó zSessionManager.num_sessionscCs| |¡dS)z°Disconnect the given session. This method should be idempotent. Parameters ---------- session_id The session's unique ID. N)rKr1rrrÚdisconnect_sessionPs z!SessionManager.disconnect_sessionúActiveSessionInfo | NonecCs&| |¡}|dus | ¡sdS| ¡S)a/Return the ActiveSessionInfo for the given id, or None if either no such session exists or the session is not active. Parameters ---------- session_id The active session's unique ID. Returns ------- ActiveSessionInfo or None N)rLr*r+)rr.r#rrrÚget_active_session_info\s z&SessionManager.get_active_session_infor(cCs| |¡duS)z~Return True if the given session exists and is active, False otherwise. Returns ------- bool N)rTr1rrrÚis_active_sessionnsz SessionManager.is_active_sessionúlist[ActiveSessionInfo]cCsdd„| ¡DƒS)z™Return the session info for all active sessions tracked by this SessionManager. Returns ------- List[ActiveSessionInfo] cSsg|]}| ¡‘qSr)r+)Ú.0ÚsrrrÚ ~sz7SessionManager.list_active_sessions..)rMr)rrrÚlist_active_sessionswsz#SessionManager.list_active_sessionscCrN)aReturn the number of active sessions tracked by this SessionManager. Subclasses of SessionManager shouldn't provide their own implementation of this method without a *very* good reason. Returns ------- int )rOrZr)rrrÚnum_active_sessions€rQz"SessionManager.num_active_sessions) r>r-r?r r@r rArBrr)NN) r"rrDr rErFrGrHrIrHrr/r;r:r<)rr$)r.r/rrS)r.r/rr()rrV)rrrrrrCrJrKrLrMrPrRrTrUrZr[rrrrr=«s($ ú,       r=N)Ú __future__rÚabcrÚ dataclassesrÚtypingrrrrÚstreamlit.proto.ForwardMsg_pb2r Ústreamlit.runtime.app_sessionr Ústreamlit.runtime.script_datar Ú+streamlit.runtime.scriptrunner.script_cacher Ú'streamlit.runtime.uploaded_file_managerr Ú Exceptionrrr!r'r,r-r=rrrrÚs&          O