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

class Json(Rule): (source)

Constructor: Json(message)

View In Hierarchy

Ensure a string holds a syntactically valid JSON document.

Async Method enforce Validate a field value as a JSON document.
Class Variable __code__ json.
Class Variable __message__ Value must be a valid JSON string..
Class Variable __slots__ Declare that this class introduces no additional instance slots.

Inherited from Rule:

Method __init__ Initialize the rule with an optional custom failure message.
Method __init_subclass__ Require asynchronous enforcement on every rule subclass.
Async Method validate Validate the field by awaiting its asynchronous enforcement.
Instance Variable _code Machine-readable status or error code.
Instance Variable _message Override message used when validation fails.
async def enforce(self, field: str, value: object, instance: object) -> bool: (source)

Validate a field value as a JSON document.

Parameters
field:strField name associated with the value.
value:objectValue to validate.
instance:objectOwning object instance. This argument is accepted for interface compatibility.
Returns
boolReturn True when the value passes validation.
__code__: str = (source)

json.

__message__: str = (source)

Value must be a valid JSON string..

__slots__: tuple = (source)

Declare that this class introduces no additional instance slots.