django.contrib.sessions.backends.signed_cookies.SessionStore

class documentation

class SessionStore(SessionBase):

View In Hierarchy

Undocumented

Class Method clear​_expired Remove expired sessions from the session store.
Method ​_get​_session​_key Instead of generating a random string, generate a secure url-safe base64-encoded string of data as our session key.
Method create To create a new key, set the modified flag so that the cookie is set on the client for the current request.
Method cycle​_key Keep the same data but with a new key. Call save() and it will automatically save a cookie with a new key at the end of the request.
Method delete To delete, clear the session key and the underlying data structure and set the modified flag so that the cookie is set on the client for the current request.
Method exists This method makes sense when you're talking to a shared resource, but it doesn't matter when you're storing the information in the client's cookie.
Method load Load the data from the key itself instead of fetching from some external data store. Opposite of _get_session_key(), raise BadSignature if signature fails.
Method save To save, get the session key as a securely signed string and then set the modified flag so that the cookie is set on the client for the current request.
Instance Variable ​_session​_cache Undocumented
Instance Variable ​_session​_key Undocumented
Instance Variable modified Undocumented

Inherited from SessionBase:

Method __contains__ Undocumented
Method __delitem__ Undocumented
Method __getitem__ Undocumented
Method __setitem__ Undocumented
Method clear Undocumented
Method delete​_test​_cookie Undocumented
Method flush Remove the current session data from the database and regenerate the key.
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 __init__ 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 ​_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 accessed Undocumented
Instance Variable serializer Undocumented
Property key​_salt Undocumented
@classmethod
def clear_expired(cls):
overrides django.contrib.sessions.backends.base.SessionBase.clear_expired

Remove expired sessions from the session store.

If this operation isn't possible on a given backend, it should raise NotImplementedError. If it isn't necessary, because the backend has a built-in expiration mechanism, it should be a no-op.

def _get_session_key(self):
overrides django.contrib.sessions.backends.base.SessionBase._get_session_key
Instead of generating a random string, generate a secure url-safe base64-encoded string of data as our session key.
def create(self):
overrides django.contrib.sessions.backends.base.SessionBase.create
To create a new key, set the modified flag so that the cookie is set on the client for the current request.
def cycle_key(self):
overrides django.contrib.sessions.backends.base.SessionBase.cycle_key
Keep the same data but with a new key. Call save() and it will automatically save a cookie with a new key at the end of the request.
def delete(self, session_key=None):
overrides django.contrib.sessions.backends.base.SessionBase.delete
To delete, clear the session key and the underlying data structure and set the modified flag so that the cookie is set on the client for the current request.
def exists(self, session_key=None):
overrides django.contrib.sessions.backends.base.SessionBase.exists
This method makes sense when you're talking to a shared resource, but it doesn't matter when you're storing the information in the client's cookie.
def load(self):
overrides django.contrib.sessions.backends.base.SessionBase.load
Load the data from the key itself instead of fetching from some external data store. Opposite of _get_session_key(), raise BadSignature if signature fails.
def save(self, must_create=False):
overrides django.contrib.sessions.backends.base.SessionBase.save
To save, get the session key as a securely signed string and then set the modified flag so that the cookie is set on the client for the current request.
_session_cache: dict =
overrides django.contrib.sessions.backends.base.SessionBase._session_cache

Undocumented

_session_key: str =
overrides django.contrib.sessions.backends.base.SessionBase._session_key

Undocumented

modified: bool =
overrides django.contrib.sessions.backends.base.SessionBase.modified

Undocumented