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.

Explore modules View classes

orionis.schemas.rules.Uuid

class documentation

class Uuid(Rule): (source)

Constructor: Uuid(version, message)

View In Hierarchy

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.
Method enforce Validate a field value as a UUID.
Class Variable __code__ Undocumented
Class Variable __message__ Undocumented
Class Variable __slots__ Undocumented
Instance Variable _version Undocumented

Inherited from Rule:

Async Method enforceAsync Run an explicitly asynchronous rule check without blocking the loop.
Method validate Validate the field value and return a failure when invalid.
Async Method validateAsync Await the rule and describe an invalid field value.
Instance Variable _code Undocumented
Instance Variable _message Undocumented
def __init__(self, version: int | None = None, *, message: str | None = None): (source)
overrides orionis.schemas.rule.Rule.__init__

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
NoneThis method initializes the instance and returns None.
Raises
ValueErrorIf version is not one of the versions defined by RFC 9562.
def enforce(self, field: str, value: object, instance: object) -> bool: (source)
overrides orionis.schemas.rule.Rule.enforce

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)

Undocumented

__message__: str = (source)

Undocumented

__slots__: tuple[str, ...] = (source)
overrides orionis.schemas.rule.Rule.__slots__

Undocumented

_version: int | None = (source)

Undocumented