orionis.http.JSONResponse

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 JSONResponse(Response): (source)

Constructor: JSONResponse(content, status_code, headers, background, ...)

View In Hierarchy

Undocumented

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`	Undocumented
Class Variable	`__slots__`	Undocumented
Instance Variable	`_json_default`	Undocumented
Instance Variable	`_json_ensure_ascii`	Undocumented
Instance Variable	`_json_indent`	Undocumented
Instance Variable	`_json_separators`	Undocumented

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	`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	`charset`	Undocumented
Instance Variable	`_body`	Undocumented
Instance Variable	`_flash`	Undocumented
Instance Variable	`_headers`	Undocumented
Instance Variable	`_raw_headers`	Undocumented
Instance Variable	`_stream`	Undocumented
Instance Variable	`background`	Undocumented
Instance Variable	`media_type`	Undocumented
Instance Variable	`status_code`	Undocumented

@staticmethod

def _defaultEncoder(obj: Any) -> Any: (source) ¶

Encode unsupported types for JSON serialization.

Parameters
obj:`Any`	The object to encode.

Returns
`Any`	The encoded object suitable for JSON serialization.

Raises
`TypeError`	If the object cannot be encoded for JSON serialization.

def __init__(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) ¶

overrides orionis.http.Response.__init__

Initialize a JSONResponse with serialized JSON content.

Parameters
content:`Any`	Content to serialize as JSON.
status_code:`HTTPStatus \| int, optional`	HTTP status code for the response.
headers:`Mapping[str, str] \| None, optional`	Response headers to include.
background:`BackgroundTask \| None, optional`	Background task to run after response.
indent:`int \| None, optional`	Indentation level for pretty-printing JSON.
ensure_ascii:`bool, optional`	Whether to escape non-ASCII characters.
separators:`tuple[str, str] \| None, optional`	Item and key separators for JSON output.
default:`Any \| None, optional`	Custom encoder for unsupported types.

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

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

overrides orionis.http.Response.render

Serialize content to JSON bytes.

Parameters
content:`Any`	The content to serialize as JSON.

Returns
`bytes`	The serialized JSON content as UTF-8 encoded bytes.

Raises
`TypeError`	If the content cannot be serialized to JSON.

_CONTENT_TYPE: ClassVar[str] = (source) ¶

Undocumented

Value

'application/json; charset=utf-8'

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

overrides orionis.http.Response.__slots__

Undocumented

_json_default = (source) ¶

Undocumented

_json_ensure_ascii = (source) ¶

Undocumented

_json_indent = (source) ¶

Undocumented

_json_separators = (source) ¶

Undocumented