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 is a valid RFC 9562 universally unique identifier.

Any version is accepted by default; pass version to require one specific layout.

Method __init__ Initialize the rule with the required UUID version.
Async Method enforce Validate a field value as a UUID.
Class Variable __code__ uuid.
Class Variable __message__ Value must be a valid UUID..
Class Variable __slots__ Declare the instance attribute slots reserved by this class.
Instance Variable _version Required version among 1, 3, 4, 5, 6, 7 and 8. Use None to accept any version.

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, version: int | None = None, *, message: str | None = None): (source)

Initialize the rule with the required UUID version.

Parameters
version:int | None, optionalRequired version among 1, 3, 4, 5, 6, 7 and 8. Use None to accept any version.
message:str | None, optionalOverride message used when validation fails.
Returns
NoneNo return value.
Raises
ValueErrorIf version is not one of the versions defined by RFC 9562.
async def enforce(self, field: str, value: object, instance: object) -> bool: (source)

Validate a field value as a UUID.

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)

uuid.

__message__: str = (source)

Value must be a valid UUID..

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

Declare the instance attribute slots reserved by this class.

_version: int | None = (source)

Required version among 1, 3, 4, 5, 6, 7 and 8. Use None to accept any version.