orionis.session.contracts.ISession

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

Explore modules View classes

class documentation

class ISession(ABC): (source)

Known subclasses: orionis.session.session.Session

View In Hierarchy

Contract for a single HTTP session runtime object.

Implementors manage an in-memory key-value payload, flash data for one-request-lifetime values, and state flags consumed by the SessionManager (started, dirty, invalidated).

Notes

Implementors must never interact directly with Request, Response, or any ISessionStore. All I/O is the responsibility of the SessionManager.

Method	`all`	Return a shallow copy of the current session data.
Method	`clear`	Remove all data from this session.
Method	`flash`	Store value under key for exactly one subsequent request.
Method	`flashErrors`	Flash validation errors for the next request.
Method	`flashInput`	Flash a submitted form payload so the next request can repopulate it.
Method	`forget`	Remove key from session data (no-op when absent).
Method	`get`	Return the value for key, or default when absent.
Method	`getErrors`	Return the validation errors flashed for this request.
Method	`getFlash`	Return the flash value for key.
Method	`getOldInput`	Return the value submitted for key in the previous request.
Method	`getPreviousUrl`	Return the last page the user navigated to.
Method	`has`	Return `True` when key exists in the session data.
Method	`invalidate`	Mark the session for full deletion and clear in-memory data.
Method	`put`	Store value under key, activating the session on the first call.
Method	`regenerate`	Request a session ID rotation (e.g. immediately after login).
Method	`setPreviousUrl`	Remember the page the user is currently viewing.
Class Variable	`__slots__`	Undocumented
Property	`dirty`	`True` if pending changes must be written to the backing store.
Property	`id`	Current session identifier, or `None` before the first write.
Property	`invalidated`	`True` when the session has been marked for full deletion.
Property	`isNew`	`True` for sessions not loaded from a backing store.
Property	`started`	`True` once the session has been activated by a write.
Property	`wantsRegenerate`	`True` when the session ID should be rotated before saving.

@abstractmethod

def all(self) -> dict[str, Any]: (source) ¶

overridden in orionis.session.session.Session

Return a shallow copy of the current session data.

Returns
`dict[str, Any]`	Copy of all session key-value pairs including internal flash bags.

@abstractmethod

def clear(self): (source) ¶

overridden in orionis.session.session.Session

Remove all data from this session.

Returns
`None`	Undocumented

@abstractmethod

def flash(self, key: str, value: Any): (source) ¶

overridden in orionis.session.session.Session

Store value under key for exactly one subsequent request.

Parameters
key:`str`	Flash data key.
value:`Any`	Flash data value.

Returns
`None`	Undocumented

@abstractmethod

def flashErrors(self, errors: Mapping[str, Any] | Exception): (source) ¶

overridden in orionis.session.session.Session

Flash validation errors for the next request.

Parameters
errors:`Mapping[str, Any] \| Exception`	Mapping of field to message(s), or a validation exception.

Returns
`None`	Undocumented

@abstractmethod

def flashInput(self, values: Mapping[str, Any]): (source) ¶

overridden in orionis.session.session.Session

Flash a submitted form payload so the next request can repopulate it.

Parameters
values:`Mapping[str, Any]`	Submitted payload to remember. Credential-like fields are stripped before storing.

Returns
`None`	Undocumented

@abstractmethod

def forget(self, key: str): (source) ¶

overridden in orionis.session.session.Session

Remove key from session data (no-op when absent).

Parameters
key:`str`	Session data key to remove.

Returns
`None`	Undocumented

@abstractmethod

def get(self, key: str, default: Any = None) -> Any: (source) ¶

overridden in orionis.session.session.Session

Return the value for key, or default when absent.

Parameters
key:`str`	Session data key.
default:`Any, optional`	Fallback value returned when key is not found.

Returns
`Any`	The stored value, or default.

@abstractmethod

def getErrors(self) -> dict[str, list[str]]: (source) ¶

overridden in orionis.session.session.Session

Return the validation errors flashed for this request.

Returns
`dict[str, list[str]]`	Field-indexed error messages, empty when none were flashed.

@abstractmethod

def getFlash(self, key: str, default: Any = None) -> Any: (source) ¶

overridden in orionis.session.session.Session

Return the flash value for key.

Values flashed during the current request take precedence over the ones inherited from the previous one.

Parameters
key:`str`	Flash data key.
default:`Any, optional`	Fallback value when the key is absent from both bags.

Returns
`Any`	The flash value, or default.

@abstractmethod

def getOldInput(self, key: str, default: Any = None) -> Any: (source) ¶

overridden in orionis.session.session.Session

Return the value submitted for key in the previous request.

Parameters
key:`str`	Form field name.
default:`Any, optional`	Fallback value when the field was not submitted.

Returns
`Any`	The previously submitted value, or default.

@abstractmethod

def getPreviousUrl(self, default: str | None = None) -> str | None: (source) ¶

overridden in orionis.session.session.Session

Return the last page the user navigated to.

Parameters
default:`str \| None, optional`	Fallback returned when no page has been recorded yet.

Returns
`str \| None`	The stored URL, or default.

@abstractmethod

def has(self, key: str) -> bool: (source) ¶

overridden in orionis.session.session.Session

Return True when key exists in the session data.

Parameters
key:`str`	Session data key.

Returns
`bool`	`True` if the key is present.

@abstractmethod

def invalidate(self): (source) ¶

overridden in orionis.session.session.Session

Mark the session for full deletion and clear in-memory data.

Returns
`None`	Undocumented

@abstractmethod

def put(self, key: str, value: Any): (source) ¶

overridden in orionis.session.session.Session

Store value under key, activating the session on the first call.

Parameters
key:`str`	Session data key.
value:`Any`	Value to store.

Returns
`None`	Undocumented

@abstractmethod

def regenerate(self): (source) ¶

overridden in orionis.session.session.Session

Request a session ID rotation (e.g. immediately after login).

Returns
`None`	Undocumented

@abstractmethod

def setPreviousUrl(self, url: str): (source) ¶

overridden in orionis.session.session.Session

Remember the page the user is currently viewing.

Parameters
url:`str`	Absolute URL of the current page.

Returns
`None`	Undocumented

__slots__: tuple = (source) ¶

overridden in orionis.session.session.Session

Undocumented

@property
@abstractmethod

dirty: bool = (source) ¶

overridden in orionis.session.session.Session

True if pending changes must be written to the backing store.

Returns
`bool`	Result of the operation described above.

@property
@abstractmethod

id: str | None = (source) ¶

overridden in orionis.session.session.Session

Current session identifier, or None before the first write.

Returns
`str \| None`	Result of the operation described above.

@property
@abstractmethod

invalidated: bool = (source) ¶

overridden in orionis.session.session.Session

True when the session has been marked for full deletion.

Returns
`bool`	Result of the operation described above.

@property
@abstractmethod

isNew: bool = (source) ¶

overridden in orionis.session.session.Session

True for sessions not loaded from a backing store.

Returns
`bool`	Result of the operation described above.

@property
@abstractmethod

started: bool = (source) ¶

overridden in orionis.session.session.Session

True once the session has been activated by a write.

Returns
`bool`	Result of the operation described above.

@property
@abstractmethod

wantsRegenerate: bool = (source) ¶

overridden in orionis.session.session.Session

True when the session ID should be rotated before saving.

Returns
`bool`	Result of the operation described above.