session3.store.SessionStore.SessionStore

class documentation

class SessionStore:

Known subclasses: session3.store.DirectorySessionStore.DirectorySessionStore, session3.store.DurusSessionStore.DurusSessionStore, session3.store.MySQLSessionStore.MySQLSessionStore, session3.store.PostgresSessionStore.PostgresSessionStore, session3.store.ShelveSessionStore.ShelveSessionStore

View In Hierarchy

Persistent Session storage API for session3's SessionManager.

Subclass this class & provide implementations of load_session, save_session, and delete_session, and voila, persistent sessions!

Method	`delete_old_sessions`	Delete all sessions that have not been modified for N minutes. The default implementation does nothing, meaning the store cannot delete old sessions.
Method	`delete_session`	Delete the session in the store.
Method	`has_session`	Return true if the session exists in the store, else false.
Method	`iter_sessions`	Return an iterable of (id, session) for all sessions in the store.
Method	`load_session`	Return the session if it exists, else return 'default'.
Method	`save_session`	Save the session in the store.
Method	`setup`	Initialize the session store; e.g., create required database tables. If a previous store exists, overwrite it or raise an error. The default implmenetation does nothing, meaning no setup is necessary.
Class Variable	`is_multiprocess_safe`	Undocumented
Class Variable	`is_thread_safe`	Undocumented

def delete_old_sessions(self, minutes): ¶

overridden in session3.store.DirectorySessionStore.DirectorySessionStore, session3.store.MySQLSessionStore.MySQLSessionStore

Delete all sessions that have not been modified for N minutes. The default implementation does nothing, meaning the store cannot delete old sessions.

This method is never called by the session manager. It's for your application maintenance program; e.g., a daily cron job.

def delete_session(self, session): ¶

overridden in session3.store.DirectorySessionStore.DirectorySessionStore, session3.store.DurusSessionStore.DurusSessionStore, session3.store.MySQLSessionStore.MySQLSessionStore, session3.store.PostgresSessionStore.PostgresSessionStore, session3.store.ShelveSessionStore.ShelveSessionStore

Delete the session in the store.

def has_session(self, id): ¶

Return true if the session exists in the store, else false.

def iter_sessions(self): ¶

overridden in session3.store.MySQLSessionStore.MySQLSessionStore

Return an iterable of (id, session) for all sessions in the store.

This method is never called by the session manager; it's for admin applications that want to browse the sessions.

def load_session(self, id, default=None): ¶

Return the session if it exists, else return 'default'.

def save_session(self, session): ¶

Save the session in the store.

def setup(self): ¶

overridden in session3.store.MySQLSessionStore.MySQLSessionStore, session3.store.PostgresSessionStore.PostgresSessionStore

Initialize the session store; e.g., create required database tables. If a previous store exists, overwrite it or raise an error. The default implmenetation does nothing, meaning no setup is necessary.

This method is never called by the session manager; it's for your application setup program.

is_multiprocess_safe: bool = ¶

Undocumented

is_thread_safe: bool = ¶

Undocumented