ORIONIS API REFERENCE

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.

class documentation

Encode a JSON response while preserving response metadata.

Static Method _defaultEncoder Encode unsupported types for JSON serialization.
Method __init__ Initialize a JSONResponse with serialized JSON content.
Method render Serialize content to JSON bytes.
Constant _CONTENT_TYPE Content type advertised by this response.
Class Variable __slots__ Declare the instance attribute slots reserved by this class.
Instance Variable _json_default Select the custom encoder or the default type handler.
Instance Variable _json_ensure_ascii Whether to escape non-ASCII characters.
Instance Variable _json_indent Indentation level for pretty-printing JSON.
Instance Variable _json_separators Item and key separators for JSON output.

Inherited from Response:

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 getStringHeaders Return the headers as a list of (key, value) string tuples.
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.
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 withBackground Set the background task and return the response.
Method withCookie Attach a cookie and return the response for chaining.
Method withCookies Attach several cookies at once and return the response.
Method withHeaders Merge response headers and return the response.
Method withoutCookie Expire a cookie and return the response for chaining.
Method withStatusCode Set the HTTP status code and return the response.
Class Variable charset Encode text responses using UTF-8.
Instance Variable _body HTTP response body or encoded payload returned to the client.
Instance Variable _flash Initialize flash data when it is first queued.
Instance Variable _headers The headers to include in the response.
Instance Variable _raw_headers Protocol-ready header pairs emitted with the response.
Instance Variable _stream Iterator supplying response body chunks.
Instance Variable background The background task to run after response.
Instance Variable media_type The media type of the response.
Instance Variable status_code The HTTP status code for the response.

Inherited from _FlashData (via Response):

Method withErrors Flash validation errors for the next request.
Method withFlash Queue a status message for the owning response or pending view.
Method withInput Flash the submitted payload so the next request can repopulate it.
def _defaultEncoder(obj: Any) -> Any: (source)

Encode unsupported types for JSON serialization.

Parameters
obj:typing.AnyThe object to encode.
Returns
typing.AnyThe encoded object suitable for JSON serialization.
Raises
TypeErrorIf the object cannot be encoded for JSON serialization.
def __init__(self: Self, content: Any, status_code: HTTPStatus | int = 200, headers: Mapping[str, str] | None = None, background: BackgroundTask | None = None, *, indent: int | None = None, ensure_ascii: bool = False, separators: tuple[str, str] | None = None, default: Any | None = None): (source)

Initialize a JSONResponse with serialized JSON content.

Parameters
content:typing.AnyContent to serialize as JSON.
status_code:orionis.http.enums.HTTPStatus | int, optionalHTTP status code for the response.
headers:collections.abc.Mapping[str, str] | None, optionalResponse headers to include.
background:orionis.background.BackgroundTask | None, optionalBackground task to run after response.
indent:int | None, optionalIndentation level for pretty-printing JSON.
ensure_ascii:bool, optionalWhether to escape non-ASCII characters.
separators:tuple[str, str] | None, optionalItem and key separators for JSON output.
default:typing.Any | None, optionalCustom encoder for unsupported types.
Returns
NoneThis constructor does not return a value.
def render(self: Self, content: Any) -> bytes: (source)

Serialize content to JSON bytes.

Parameters
content:typing.AnyThe content to serialize as JSON.
Returns
bytesThe serialized JSON content as UTF-8 encoded bytes.
Raises
TypeErrorIf the content cannot be serialized to JSON.
_CONTENT_TYPE: ClassVar[str] = (source)

Content type advertised by this response.

Value
'application/json; charset=utf-8'
__slots__: tuple[str, ...] = (source)

Declare the instance attribute slots reserved by this class.

_json_default = (source)

Select the custom encoder or the default type handler.

_json_ensure_ascii = (source)

Whether to escape non-ASCII characters.

_json_indent = (source)

Indentation level for pretty-printing JSON.

_json_separators = (source)

Item and key separators for JSON output.