Skip to main content

NullSession

Class used to generate nicer error messages if sessions are not available. Will still allow read-only access to the empty session but fail on setting.

Methods


__setitem__()

def __setitem__(
key: t.Any,
value: t.Any
) - > t.NoReturn

Raises a RuntimeError when attempting to set a session value, indicating that sessions are unavailable without a secret key.

Parameters

NameTypeDescription
keyt.AnyThe session key to be set.
valuet.AnyThe value to be assigned to the session key.

Returns

TypeDescription
t.NoReturnThis method never returns as it always raises a RuntimeError.

__delitem__()

def __delitem__(
key: t.Any
) - > t.NoReturn

Raises a RuntimeError when attempting to delete a session value, indicating that sessions are unavailable without a secret key.

Parameters

NameTypeDescription
keyt.AnyThe session key to be deleted.

Returns

TypeDescription
t.NoReturnThis method never returns as it always raises a RuntimeError.

clear()

def clear() - > t.NoReturn

Raises a RuntimeError when attempting to clear the session, indicating that sessions are unavailable without a secret key.

Returns

TypeDescription
t.NoReturnThis method never returns as it always raises a RuntimeError.

pop()

def pop(
key: t.Any,
default: t.Any
) - > t.NoReturn

Raises a RuntimeError when attempting to pop a value from the session, indicating that sessions are unavailable without a secret key.

Parameters

NameTypeDescription
keyt.AnyThe session key to remove and return.
defaultt.AnyThe value to return if the key is not found.

Returns

TypeDescription
t.NoReturnThis method never returns as it always raises a RuntimeError.

popitem()

def popitem() - > t.NoReturn

Raises a RuntimeError when attempting to pop an item from the session, indicating that sessions are unavailable without a secret key.

Returns

TypeDescription
t.NoReturnThis method never returns as it always raises a RuntimeError.

update()

def update(
*args: t.Any,
**kwargs: t.Any
) - > t.NoReturn

Raises a RuntimeError when attempting to update the session with multiple values, indicating that sessions are unavailable without a secret key.

Parameters

NameTypeDescription
*argst.AnyPositional arguments containing key-value pairs for the update.
**kwargst.AnyKeyword arguments containing key-value pairs for the update.

Returns

TypeDescription
t.NoReturnThis method never returns as it always raises a RuntimeError.

setdefault()

def setdefault(
key: t.Any,
default: t.Any
) - > t.NoReturn

Raises a RuntimeError when attempting to set a default session value, indicating that sessions are unavailable without a secret key.

Parameters

NameTypeDescription
keyt.AnyThe session key to check or set.
defaultt.AnyThe default value to set if the key does not exist.

Returns

TypeDescription
t.NoReturnThis method never returns as it always raises a RuntimeError.