orionis.http.adapters.request.rsgi.RSGITransportAdapter

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 RSGITransportAdapter(TransportAdapter): (source)

Constructor: RSGITransportAdapter(scope)

View In Hierarchy

Adapt a Granian RSGI scope to the transport adapter contract.

Returns
`None`	This class exposes request data accessors and state overrides.

Method	`__buildHeadersRSGI`	Build headers from the scope and cache them.
Method	`__contains__`	Check whether a state key exists.
Method	`__delitem__`	Remove a state value by key.
Method	`__getitem__`	Return a cached state value by key.
Method	`__init__`	Initialize the adapter with a Granian RSGI scope.
Method	`__setitem__`	Store a state value under a key.
Method	`client`	Return the remote client IP parsed from the scope.
Method	`getScope`	Build and return a dictionary view of the request scope.
Method	`headers`	Return parsed request headers.
Method	`method`	Return the HTTP method.
Method	`path`	Return the request path.
Method	`scheme`	Return the request scheme.
Method	`setClient`	Set the remote client IP in the override state.
Method	`setScheme`	Set the request scheme in the override state.
Method	`setState`	Store a custom value in the override state.
Method	`wantsJson`	Determine whether the request prefers a JSON response.
Class Variable	`__slots__`	Undocumented
Instance Variable	`__client`	Undocumented
Instance Variable	`__headers`	Undocumented
Instance Variable	`__overrides`	Undocumented
Instance Variable	`__scope`	Undocumented
Instance Variable	`__wants_json`	Undocumented

def __buildHeadersRSGI(self) -> Headers: (source) ¶

Build headers from the scope and cache them.

Returns
`Headers`	Return parsed headers as lowercase name/value pairs.

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

Check whether a state key exists.

Parameters
key:`str`	The key to check for existence in the cache.

Returns
`bool`	Return `True` when the key exists, otherwise `False`.

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

Remove a state value by key.

Parameters
key:`str`	The key to remove from the cache.

Returns
`None`	Return `None` after removing the key when present.

def __getitem__(self, key: str) -> object | None: (source) ¶

Return a cached state value by key.

Parameters
key:`str`	The key to look up in the cache.

Returns
`object \| None`	Return the stored value when present, otherwise `None`.

def __init__(self, scope: Scope): (source) ¶

Initialize the adapter with a Granian RSGI scope.

Parameters
scope:`Scope`	The Granian RSGI scope object.

Returns
`None`	Return `None` after preparing internal caches and state.

def __setitem__(self, key: str, value: object): (source) ¶

Store a state value under a key.

Parameters
key:`str`	The key under which to store the value.
value:`object`	The value to store in the cache.

Returns
`None`	Return `None` after writing the value.

def client(self) -> str | None: (source) ¶

overrides orionis.http.adapters.request.contracts.transport.TransportAdapter.client

Return the remote client IP parsed from the scope.

Returns
`str \| None`	Return the client IP without IPv6 brackets, or `None` when unavailable.

def getScope(self) -> dict: (source) ¶

overrides orionis.http.adapters.request.contracts.transport.TransportAdapter.getScope

Build and return a dictionary view of the request scope.

Returns
`dict`	Return base scope fields merged with override values.

def headers(self) -> Headers: (source) ¶

overrides orionis.http.adapters.request.contracts.transport.TransportAdapter.headers

Return parsed request headers.

Returns
`Headers`	Return the cached `Headers` instance built at initialization.

def method(self) -> str | None: (source) ¶

overrides orionis.http.adapters.request.contracts.transport.TransportAdapter.method

Return the HTTP method.

Returns
`str \| None`	Return the override value when set, else the scope method.

def path(self) -> str | None: (source) ¶

overrides orionis.http.adapters.request.contracts.transport.TransportAdapter.path

Return the request path.

Returns
`str \| None`	Return the scope path value, which can be `None`.

def scheme(self) -> str | None: (source) ¶

overrides orionis.http.adapters.request.contracts.transport.TransportAdapter.scheme

Return the request scheme.

Returns
`str \| None`	Return the override value when set, else the scope scheme.

def setClient(self, ip: str): (source) ¶

overrides orionis.http.adapters.request.contracts.transport.TransportAdapter.setClient

Set the remote client IP in the override state.

Parameters
ip:`str`	The client IP address to assign.

Returns
`None`	Return `None` after updating the cached client value.

def setScheme(self, value: str): (source) ¶

overrides orionis.http.adapters.request.contracts.transport.TransportAdapter.setScheme

Set the request scheme in the override state.

Parameters
value:`str`	The scheme to apply (e.g. `'http'`, `'https'`).

Returns
`None`	Return `None` after storing the scheme override.

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

overrides orionis.http.adapters.request.contracts.transport.TransportAdapter.setState

Store a custom value in the override state.

Parameters
key:`str`	The attribute name to set.
value:`Any`	The value to store.

Returns
`None`	Return `None` after writing the state entry.

def wantsJson(self) -> bool: (source) ¶

overrides orionis.http.adapters.request.contracts.transport.TransportAdapter.wantsJson

Determine whether the request prefers a JSON response.

Returns
`bool`	Return `True` when the Accept header indicates JSON support.

__slots__: tuple[str, ...] = (source) ¶

overrides orionis.http.adapters.request.contracts.transport.TransportAdapter.__slots__

Undocumented

__client: Any = (source) ¶

Undocumented

__headers: Headers = (source) ¶

Undocumented

__overrides: dict[str, Any] = (source) ¶

Undocumented

__scope: Scope = (source) ¶

Undocumented

__wants_json: Any = (source) ¶

Undocumented