core.browser_session

Attributes

OnDirtyCallback

Classes

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

Module Contents

type core.browser_session.OnDirtyCallback = Callable[[BrowserSession, str], None]

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

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.

This class also acts as a data manager for transaction, so changes are not committed to Redis, until the transaction is commited.

The on_dirty callback gets invoked when the first change to the session happens, even if it ends up getting rolled back, so use with care!

_cache

_token

_pending_overrides: dict[str, Any]

_pending_deletes: set[str]

_pending_flush = False

_is_dirty = False

_on_dirty

_get(name: str) → Any

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

delete(name: str) → None

has(name: str) → bool

flush() → None

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) → Any

__getattr__(name: str) → Any

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

__delattr__(name: str) → None

__setitem__

__delitem__

__contains__

sortKey() → str

commit(transaction: transaction.interfaces.ITransaction) → None

abort(transaction: transaction.interfaces.ITransaction) → None

_finish() → None

tpc_begin(transaction: transaction.interfaces.ITransaction) → None

tpc_vote(transaction: transaction.interfaces.ITransaction) → None

tpc_abort(transaction: transaction.interfaces.ITransaction) → None

tpc_finish(transaction: transaction.interfaces.ITransaction) → None

savepoint() → BrowserSessionSavepoint

class core.browser_session.BrowserSessionSavepoint(browser_session: BrowserSession)

browser_session

original_state

rollback() → None