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

Ensure a string starts with one of the given prefixes.

Method __init__ Initialize the rule with the accepted prefixes.
Async Method enforce Validate a field value against the accepted prefixes.
Class Variable __code__ starts_with.
Class Variable __message__ Value must start with one of the allowed prefixes..
Class Variable __slots__ Declare the instance attribute slots reserved by this class.
Instance Variable _prefixes Prefixes the value may start with. At least one is required.

Inherited from Rule:

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.
def __init__(self, *prefixes: str, message: str | None = None): (source)

Initialize the rule with the accepted prefixes.

Parameters
*prefixes:strPrefixes the value may start with. At least one is required.
message:str | None, optionalOverride message used when validation fails.
Returns
NoneNo return value.
Raises
ValueErrorIf no prefix is supplied.
async def enforce(self, field: str, value: object, instance: object) -> bool: (source)

Validate a field value against the accepted prefixes.

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)

starts_with.

__message__: str = (source)

Value must start with one of the allowed prefixes..

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

Declare the instance attribute slots reserved by this class.

_prefixes: tuple[str, ...] = (source)

Prefixes the value may start with. At least one is required.