`duck.http.session.session_storage_connector`¶

Module containing SessionConnector class which can be used to connect to session storage to perform operations like get, set, update, delete, clear, etc.

Module Contents¶

Classes¶

SessionStorageConnector

This class is used to connect to the session storage and perform almost all the operations on the session storage

Functions¶

get_session_storage_connector

Returns the session storage connector object.

API¶

class duck.http.session.session_storage_connector.SessionStorageConnector(session_storage_cls: Callable)[source]¶

This class is used to connect to the session storage and perform almost all the operations on the session storage

Initialization

Initialize SessionStorageConnector

Parameters:: session_storage_cls – Class to initialize the session storage object

CACHED_SESSIONS¶

‘InMemoryCache(…)’

In Memory cache for sessions.

__new__(session_storage_cls: duck.utils.caching.CacheBase)[source]¶

clear_all_sessions()[source]¶: Clear all session data.

close()[source]¶: Close the session storage.

delete_session(session_id: str)[source]¶: Delete session data.

static generate_session_id() → str[source]¶: Retrieve a random generated session ID.

get_session(session_id: str)[source]¶: Get the session data.

save()[source]¶: Saves the current sessions to session storage.

set_session(session_id: str, data: dict, expiry: int | float = None)[source]¶: Set the session data.

update_session(session_id: str, data: dict)[source]¶: Update the session data.

exception duck.http.session.session_storage_connector.SessionStorageConnectorError[source]¶

Bases: Exception

Raised when errors related to the session storage connector arises