core.browser_session

Attributes

OnDirtyCallback
_T

Classes

Prefixed
BrowserSession	A session bound to a token (session_id cookie). Used to store data

Module Contents

core.browser_session.OnDirtyCallback

core.browser_session._T

class core.browser_session.Prefixed(prefix: str, cache: core.cache.RedisCacheRegion)

prefix

cache

mangle(key: str) → str

get(key: str) → Any

set(key: str, value: Any) → None

delete(key: str) → None

count() → int

flush() → int

class core.browser_session.BrowserSession(cache: core.cache.RedisCacheRegion, token: str, on_dirty: OnDirtyCallback = lambda session, token: ...)

A session bound to a token (session_id cookie). Used to store data about a client on the server.

Instances should be called browser_session to make sure we don’t confuse this with the orm sessions.

Used by onegov.core.request.CoreRequest.

Example:

browser_session = request.browser_session
browser_session.name = 'Foo'
assert client.session.name == 'Foo'
del client.session.name

This class can act like an object, through attribute access, or like a dict, through square brackets. Whatever you prefer.

_cache

_token

_is_dirty = False

_on_dirty

has(name: str) → bool

flush() → None

count() → int

pop(name: str, default: Any = None) → Any

Returns the value for the given name, removing the value in the process.

mark_as_dirty() → None

get(name: str) → Any | None

get(name: str, default: _T) → Any | _T

__getitem__(name: str, *args: Never) → Any

__getattr__(name: str) → Any

__setattr__(name: str, value: Any) → None

__delattr__(name: str) → None

__setitem__

__delitem__

__contains__