orionis.http.adapters.request.asgi.ASGITransportAdapter

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

Constructor: ASGITransportAdapter(scope)

View In Hierarchy

Adapt an ASGI scope dictionary to the transport adapter contract.

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

Method	`__buildHeadersASGI`	Build a `Headers` object from ASGI raw headers.
Method	`__contains__`	Check whether an override key exists.
Method	`__delitem__`	Delete an override value by key.
Method	`__getitem__`	Get a cached override value by key.
Method	`__init__`	Initialize the adapter with an ASGI scope dictionary.
Method	`__setitem__`	Set a cached override value by key.
Method	`client`	Get the remote client IP from the ASGI scope.
Method	`getScope`	Get the adjusted ASGI scope dictionary.
Method	`headers`	Get request headers.
Method	`method`	Get the HTTP method.
Method	`path`	Get the request path.
Method	`scheme`	Get the URL scheme.
Method	`setClient`	Set the remote client address.
Method	`setScheme`	Set the URL scheme.
Method	`setState`	Set an arbitrary override state value.
Method	`wantsJson`	Determine whether the client prefers JSON.
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 __buildHeadersASGI(self) -> Headers: (source) ¶

Build a Headers object from ASGI raw headers.

Returns
`Headers`	Return decoded and indexed request headers.

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

Check whether an override key exists.

Parameters
key:`str`	Specify the override key.

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

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

Delete an override value by key.

Parameters
key:`str`	Specify the override key.

Returns
`None`	Return `None`.

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

Get a cached override value by key.

Parameters
key:`str`	Specify the override key.

Returns
`object \| None`	Return the stored value, or `None` when absent.

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

Initialize the adapter with an ASGI scope dictionary.

Parameters
scope:`dict`	Provide the ASGI scope mapping.

Returns
`None`	Return `None`.

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

Set a cached override value by key.

Parameters
key:`str`	Specify the override key.
value:`object`	Provide the value to store.

Returns
`None`	Return `None`.

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

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

Get the remote client IP from the ASGI scope.

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

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

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

Get the adjusted ASGI scope dictionary.

Returns
`dict`	Return original scope merged with overrides.

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

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

Get request headers.

Returns
`Headers`	Return the prebuilt `Headers` instance.

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

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

Get the HTTP method.

Returns
`str \| None`	Return the HTTP method, or `None` when missing.

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

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

Get the request path.

Returns
`str \| None`	Return the request path, or `None` when missing.

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

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

Get the URL scheme.

Returns
`str \| None`	Return the scheme, or `None` when missing.

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

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

Set the remote client address.

Parameters
ip:`str`	Provide the client IP value.

Returns
`None`	Return `None`.

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

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

Set the URL scheme.

Parameters
value:`str`	Provide the scheme, such as `"http"` or `"https"`.

Returns
`None`	Return `None`.

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

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

Set an arbitrary override state value.

Parameters
key:`str`	Specify the key to set.
value:`Any`	Provide the value to store.

Returns
`None`	Return `None`.

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

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

Determine whether the client prefers JSON.

Returns
`bool`	Return `True` when Accept includes JSON media types.

__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: dict = (source) ¶

Undocumented

__wants_json: Any = (source) ¶

Undocumented