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.Alpha

class documentation

class Alpha(Rule): (source)

Constructor: Alpha(ascii_only, message)

View In Hierarchy

Ensure a string contains only alphabetic characters.

By default every Unicode letter and combining mark is accepted. Set ascii_only to restrict the value to the a-z and A-Z ranges.

Method __init__ Initialize the rule with the accepted character range.
Method enforce Validate a field value as alphabetic content.
Class Variable __code__ Undocumented
Class Variable __message__ Undocumented
Class Variable __slots__ Undocumented
Instance Variable _ascii_only 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, *, ascii_only: bool = False, message: str | None = None): (source)
overrides orionis.schemas.rule.Rule.__init__

Initialize the rule with the accepted character range.

Parameters
ascii_only:bool, optionalWhether to restrict the value to ASCII letters.
message:str | None, optionalOverride message used when validation fails.
Returns
NoneThis method initializes the instance and returns None.
def enforce(self, field: str, value: object, instance: object) -> bool: (source)
overrides orionis.schemas.rule.Rule.enforce

Validate a field value as alphabetic content.

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

_ascii_only: bool = (source)

Undocumented