class documentation

class SessionStore(DBStore):

View In Hierarchy

Implement cached, database backed sessions.
Method __init__ Undocumented
Method delete Delete the session data under this key. If the key is None, use the current session key value.
Method exists Return True if the given session_key already exists.
Method flush Remove the current session data from the database and regenerate the key.
Method load Load the session data and return a dictionary.
Method save Save the current session data to the database. If 'must_create' is True, raise a database error if the saving operation doesn't create a new entry (as opposed to possibly updating an existing entry).
Instance Variable ​_cache Undocumented
Instance Variable ​_session​_key Undocumented
Property cache​_key Undocumented

Inherited from SessionStore:

Class Method clear​_expired Remove expired sessions from the session store.
Class Method get​_model​_class Undocumented
Method create​_model​_instance Return a new instance of the session model object, which represents the current session state. Intended to be used for saving the session data to the database.
Method ​_get​_session​_from​_db Undocumented
Method create Create a new session instance. Guaranteed to create a new object with a unique key and will have saved the result once (with empty data) before the method returns.
Instance Variable modified Undocumented
Property model Undocumented

Inherited from SessionBase (via SessionStore):

Method __contains__ Undocumented
Method __delitem__ Undocumented
Method __getitem__ Undocumented
Method __setitem__ Undocumented
Method clear Undocumented
Method cycle​_key Create a new session key, while retaining the current session data.
Method delete​_test​_cookie Undocumented
Method get Undocumented
Method get​_expire​_at​_browser​_close No summary
Method get​_expiry​_age Get the number of seconds until the session expires.
Method get​_expiry​_date Get session the expiry date (as a datetime object).
Method get​_session​_cookie​_age Undocumented
Method items Undocumented
Method keys Undocumented
Method pop Undocumented
Method set​_expiry Set a custom expiration for the session. value can be an integer, a Python datetime or timedelta object or None.
Method set​_test​_cookie Undocumented
Method setdefault Undocumented
Method test​_cookie​_worked Undocumented
Constant TEST​_COOKIE​_NAME Undocumented
Constant TEST​_COOKIE​_VALUE Undocumented
Method ​_get​_new​_session​_key Return session key that isn't being used.
Method ​_get​_or​_create​_session​_key Undocumented
Method ​_get​_session Lazily load session from storage (unless "no_load" is True, when only an empty dict is stored) and store it in the current instance.
Method ​_get​_session​_key Undocumented
Method ​_set​_session​_key Validate session key on assignment. Invalid values will set to None.
Method ​_validate​_session​_key Key must be truthy and at least 8 characters long. 8 characters is an arbitrary lower bound for some minimal key security.
Method decode Undocumented
Method encode Return the given session dictionary serialized and encoded as a string.
Method has​_key Undocumented
Method is​_empty Return True when there is no session_key and the session is empty.
Method update Undocumented
Method values Undocumented
Class Variable __not​_given Undocumented
Class Variable ​_session Undocumented
Class Variable session​_key Undocumented
Instance Variable __session​_key Undocumented
Instance Variable ​_session​_cache Undocumented
Instance Variable accessed Undocumented
Instance Variable serializer Undocumented
Property key​_salt Undocumented
def __init__(self, session_key=None):
def delete(self, session_key=None):
Delete the session data under this key. If the key is None, use the current session key value.
def exists(self, session_key):
Return True if the given session_key already exists.
def flush(self):
Remove the current session data from the database and regenerate the key.
def load(self):
Load the session data and return a dictionary.
def save(self, must_create=False):
Save the current session data to the database. If 'must_create' is True, raise a database error if the saving operation doesn't create a new entry (as opposed to possibly updating an existing entry).
_cache =

Undocumented

@property
cache_key =

Undocumented