orionis.http.contracts.response.IResponse

ORIONIS API REFERENCE

Modules Classes Names

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 IResponse(ABC): (source)

Known subclasses: orionis.http.Response

View In Hierarchy

Undocumented

Method	`addHeader`	Add a header to the response.
Method	`deleteCookie`	Delete a cookie by setting its expiration to the past.
Method	`getBody`	Return the response body as bytes.
Method	`getFlashData`	Return the data queued by `withFlash()` for the session flash bag.
Method	`getHeader`	Get the values for a header.
Method	`getMediaType`	Return the media type of the response.
Method	`getRawHeaders`	Return the headers as a list of (key, value) byte tuples.
Method	`getStatusCode`	Return the HTTP status code of the response.
Method	`getStream`	Return the response stream if present.
Method	`hasHeader`	Check if a header is present.
Method	`hasStream`	Check if the response has a stream.
Method	`removeHeader`	Remove a header from the response.
Method	`render`	Render the content to bytes.
Async Method	`runBackground`	Run the background task if it exists.
Method	`setCookie`	Set a cookie header in the response.
Method	`setHeader`	Set a header, replacing any existing values.
Method	`withCookie`	Attach a cookie and return the response for chaining.
Method	`withCookies`	Attach several cookies at once and return the response.
Method	`withErrors`	Flash validation errors for the next request.
Method	`withFlash`	Flash a status message into the session and return the response.
Method	`withInput`	Flash the submitted payload so the next request can repopulate it.
Method	`withoutCookie`	Expire a cookie and return the response for chaining.
Class Variable	`__slots__`	Undocumented

@abstractmethod

def addHeader(self, key: str, value: str): (source) ¶

overridden in orionis.http.Response

Add a header to the response.

Parameters
key:`str`	The header name.
value:`str`	The header value.

Returns
`None`	This method does not return a value.

@abstractmethod

def deleteCookie(self, key: str, *, path: str = '/', domain: str | None = None): (source) ¶

overridden in orionis.http.Response

Delete a cookie by setting its expiration to the past.

Parameters
key:`str`	The name of the cookie to delete.
path:`str, default "/"`	The path for which the cookie is valid.
domain:`str \| None, optional`	The domain for which the cookie is valid.

Returns
`None`	This method does not return a value.

@abstractmethod

def getBody(self) -> bytes | None: (source) ¶

overridden in orionis.http.Response

Return the response body as bytes.

Returns
`bytes \| None`	The response body as bytes, or None if not set.

@abstractmethod

def getFlashData(self) -> dict[str, Any] | None: (source) ¶

overridden in orionis.http.Response

Return the data queued by withFlash() for the session flash bag.

Returns
`dict[str, Any] \| None`	The queued key-value pairs, or None when nothing was queued.

@abstractmethod

def getHeader(self, key: str) -> list[str] | None: (source) ¶

overridden in orionis.http.Response

Get the values for a header.

Parameters
key:`str`	The header name.

Returns
`list[str] \| None`	The list of header values, or None if not present.

@abstractmethod

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

overridden in orionis.http.Response

Return the media type of the response.

Returns
`str \| None`	The media type, or None if not set.

@abstractmethod

def getRawHeaders(self) -> list[tuple[bytes, bytes]]: (source) ¶

overridden in orionis.http.Response

Return the headers as a list of (key, value) byte tuples.

Returns
`list of tuple of (bytes, bytes)`	The headers as (key, value) pairs encoded in latin-1.

@abstractmethod

def getStatusCode(self) -> int: (source) ¶

overridden in orionis.http.Response

Return the HTTP status code of the response.

Returns
`int`	The HTTP status code.

@abstractmethod

def getStream(self) -> AsyncIterable[bytes] | None: (source) ¶

overridden in orionis.http.Response

Return the response stream if present.

Returns
`AsyncIterable[bytes] \| None`	The response stream, or None if not set.

@abstractmethod

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

overridden in orionis.http.Response

Check if a header is present.

Parameters
key:`str`	The header name.

Returns
`bool`	True if the header is present, False otherwise.

@abstractmethod

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

overridden in orionis.http.Response

Check if the response has a stream.

Returns
`bool`	True if a stream is present, False otherwise.

@abstractmethod

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

overridden in orionis.http.Response

Remove a header from the response.

Parameters
key:`str`	The header name.

Returns
`None`	This method does not return a value.

@abstractmethod

def render(self, content: Any) -> bytes: (source) ¶

overridden in orionis.http.Response

Render the content to bytes.

Parameters
content:`Any`	The content to render.

Returns
`bytes`	The rendered content as bytes.

@abstractmethod

async def runBackground(self): (source) ¶

overridden in orionis.http.Response

Run the background task if it exists.

Returns
`None`	This method does not return a value.

@abstractmethod

def setCookie(self, key: str, value: str = '', *, max_age: int | None = None, expires: datetime | str | int | None = None, path: str | None = '/', domain: str | None = None, secure: bool = False, http_only: bool = False, same_site: Literal['lax', 'strict', 'none'] | None = 'lax', partitioned: bool = False): (source) ¶

overridden in orionis.http.Response

Set a cookie header in the response.

Parameters
key:`str`	The cookie name.
value:`str, optional`	The cookie value. Defaults to an empty string.
max_age:`int \| None, optional`	The maximum age of the cookie in seconds.
expires:`datetime \| str \| int \| None, optional`	The expiration date of the cookie.
path:`str \| None, optional`	The path for which the cookie is valid.
domain:`str \| None, optional`	The domain for which the cookie is valid.
secure:`bool, optional`	Whether the cookie is secure.
http_only:`bool, optional`	Whether the cookie is HTTP only.
same_site:`str \| None, optional`	The SameSite policy for the cookie.
partitioned:`bool, optional`	Whether the cookie is partitioned.

Returns
`None`	This method does not return a value.

@abstractmethod

def setHeader(self, key: str, value: str): (source) ¶

overridden in orionis.http.Response

Set a header, replacing any existing values.

Parameters
key:`str`	The header name.
value:`str`	The header value.

Returns
`None`	This method does not return a value.

@abstractmethod

def withCookie(self, key: str, value: str = '', *, max_age: int | None = None, expires: datetime | str | int | None = None, path: str | None = '/', domain: str | None = None, secure: bool = False, http_only: bool = False, same_site: Literal['lax', 'strict', 'none'] | None = 'lax', partitioned: bool = False) -> Self: (source) ¶

overridden in orionis.http.Response

Attach a cookie and return the response for chaining.

Parameters
key:`str`	The cookie name.
value:`str, optional`	The cookie value. Defaults to an empty string.
max_age:`int \| None, optional`	The maximum age of the cookie in seconds.
expires:`datetime \| str \| int \| None, optional`	The expiration date of the cookie.
path:`str \| None, optional`	The path for which the cookie is valid.
domain:`str \| None, optional`	The domain for which the cookie is valid.
secure:`bool, optional`	Whether the cookie is secure.
http_only:`bool, optional`	Whether the cookie is HTTP only.
same_site:`str \| None, optional`	The SameSite policy for the cookie.
partitioned:`bool, optional`	Whether the cookie is partitioned.

Returns
`Self`	The same response instance, allowing fluent chaining.

@abstractmethod

def withCookies(self, cookies: Mapping[str, str | Mapping[str, Any]]) -> Self: (source) ¶

overridden in orionis.http.Response

Attach several cookies at once and return the response.

Parameters
cookies:`Mapping[str, str \| Mapping[str, Any]]`	Mapping of cookie names to either a plain value or a mapping of keyword arguments accepted by `setCookie`.

Returns
`Self`	The same response instance, allowing fluent chaining.

@abstractmethod

def withErrors(self, errors: Mapping[str, Any] | Exception) -> Self: (source) ¶

overridden in orionis.http.Response

Flash validation errors for the next request.

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

Returns
`Self`	The same response instance, allowing fluent chaining.

@abstractmethod

def withFlash(self, key: str, value: Any = None) -> Self: (source) ¶

overridden in orionis.http.Response

Flash a status message into the session and return the response.

Parameters
key:`str`	Flash data key.
value:`Any, optional`	Value to flash.

Returns
`Self`	The same response instance, allowing fluent chaining.

@abstractmethod

def withInput(self, values: Mapping[str, Any]) -> Self: (source) ¶

overridden in orionis.http.Response

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

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

Returns
`Self`	The same response instance, allowing fluent chaining.

@abstractmethod

def withoutCookie(self, key: str, *, path: str = '/', domain: str | None = None) -> Self: (source) ¶

overridden in orionis.http.Response

Expire a cookie and return the response for chaining.

Parameters
key:`str`	The name of the cookie to delete.
path:`str, default "/"`	The path for which the cookie is valid.
domain:`str \| None, optional`	The domain for which the cookie is valid.

Returns
`Self`	The same response instance, allowing fluent chaining.

__slots__: tuple = (source) ¶

overridden in orionis.http.Response

Undocumented