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.

module documentation

Undocumented

Class DefaultResponses No class docstring; 0/7 instance variable, 0/1 class variable, 0/14 constant, 15/15 methods, 1/1 static method documented
Function _status_message Return the display label for a validated HTTP status.
Function _validate_status_code Validate an HTTP status before either response format is rendered.
Constant _FRAMEWORK_VERSION Undocumented
Constant _LOCALE_CONFIG_KEY Undocumented
Constant _MAX_STATUS_CODE Undocumented
Constant _MIN_STATUS_CODE Undocumented
Constant _PYTHON_VERSION Undocumented
Constant _STATUS_MESSAGES Undocumented
def _status_message(status_code: int) -> str: (source)

Return the display label for a validated HTTP status.

Parameters
status_code:intValidated HTTP status whose label is needed by the error template.
Returns
strEnum label or a numeric label for an unlisted status.
def _validate_status_code(status_code: int | HTTPStatus) -> int: (source)

Validate an HTTP status before either response format is rendered.

Parameters
status_code:int | HTTPStatusHTTP status supplied to the default error response.
Returns
intValidated status, converting an HTTPStatus member to its value.
Raises
TypeErrorIf status_code is not an integer.
ValueErrorIf status_code is outside the range 100 to 599.
_FRAMEWORK_VERSION: str = (source)

Undocumented

Value
f'v{VERSION}'
_LOCALE_CONFIG_KEY: str = (source)

Undocumented

Value
'app.locale'
_MAX_STATUS_CODE: int = (source)

Undocumented

Value
599
_MIN_STATUS_CODE: int = (source)

Undocumented

Value
100
_PYTHON_VERSION: str = (source)

Undocumented

Value
platform.python_version()
_STATUS_MESSAGES: dict[int, str] = (source)

Undocumented

Value
{}