django.contrib.sessions.backends.file.SessionStore

class documentation

class SessionStore(SessionBase): (source)

View In Hierarchy

Implement a file based session store.

Class Method clear_expired Remove expired sessions from the session store.
Method __init__ Undocumented
Method clean 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.
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 load Load the session data and return a dictionary.
Method save Save the session data. If 'must_create' is True, create a new session object (or raise CreateError). Otherwise, only update an existing object and don't create one (raise UpdateError if needed).
Instance Variable file_prefix Undocumented
Instance Variable modified Undocumented
Instance Variable storage_path Undocumented
Class Method _get_storage_path Undocumented
Method _expiry_date Return the expiry time of the file storing the session's content.
Method _key_to_file Get the file associated with this session key.
Method _last_modification Return the modification time of the file storing the session's content.
Instance Variable _session_key Undocumented

Inherited from SessionBase:

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 decode Undocumented
Method delete_test_cookie Undocumented
Method encode Return the given session dictionary serialized and encoded as a string.
Method flush Remove the current session data from the database and regenerate the key.
Method get Undocumented
Method get_expire_at_browser_close Return ``True`` if the session is set to expire when the browser closes, and ``False`` if there's an expiry date. Use ``get_expiry_date()`` or ``get_expiry_age()`` to find the actual expiry date/age, if there is one.
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 has_key Undocumented
Method is_empty Return True when there is no session_key and the session is empty.
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
Method update Undocumented
Method values Undocumented
Constant TEST_COOKIE_NAME Undocumented
Constant TEST_COOKIE_VALUE Undocumented
Class Variable session_key Undocumented
Instance Variable accessed Undocumented
Instance Variable serializer Undocumented
Property key_salt 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.
Class Variable __not_given Undocumented
Class Variable _session Undocumented
Instance Variable __session_key Undocumented
Instance Variable _session_cache Undocumented
@classmethod
def clear_expired(cls): (source)
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 __init__(self, session_key=None): (source)
overrides django.contrib.sessions.backends.base.SessionBase.__init__

Undocumented

def clean(self): (source)

Undocumented

def create(self): (source)
overrides django.contrib.sessions.backends.base.SessionBase.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.

def delete(self, session_key=None): (source)
overrides django.contrib.sessions.backends.base.SessionBase.delete

Delete the session data under this key. If the key is None, use the current session key value.

def exists(self, session_key): (source)
overrides django.contrib.sessions.backends.base.SessionBase.exists

Return True if the given session_key already exists.

def load(self): (source)
overrides django.contrib.sessions.backends.base.SessionBase.load

Load the session data and return a dictionary.

def save(self, must_create=False): (source)
overrides django.contrib.sessions.backends.base.SessionBase.save

Save the session data. If 'must_create' is True, create a new session object (or raise CreateError). Otherwise, only update an existing object and don't create one (raise UpdateError if needed).

file_prefix = (source)

Undocumented

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

Undocumented

storage_path = (source)

Undocumented

@classmethod
def _get_storage_path(cls): (source)

Undocumented

def _expiry_date(self, session_data): (source)

Return the expiry time of the file storing the session's content.

def _key_to_file(self, session_key=None): (source)

Get the file associated with this session key.

def _last_modification(self): (source)

Return the modification time of the file storing the session's content.

_session_key = (source)
overrides django.contrib.sessions.backends.base.SessionBase._session_key

Undocumented