orionis.schemas.rule.Rule

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

class documentation

class Rule(IRule): (source)

Constructor: Rule(message)

View In Hierarchy

Undocumented

Method	`__init__`	Initialize the rule with an optional custom failure message.
Method	`enforce`	Evaluate whether the current value satisfies this 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.
Class Variable	`__slots__`	Undocumented
Instance Variable	`_code`	Undocumented
Instance Variable	`_message`	Undocumented

def __init__(self, *, message: str | None = None): (source) ¶

overrides orionis.schemas.contracts.constraint.IRule.__init__

overridden in orionis.schemas.rules.After, orionis.schemas.rules.AfterOrEqual, orionis.schemas.rules.Alpha, orionis.schemas.rules.Before, orionis.schemas.rules.BeforeOrEqual, orionis.schemas.rules.Between, orionis.schemas.rules.ConfirmPassword, orionis.schemas.rules.DateFormat, orionis.schemas.rules.DecimalPlaces, orionis.schemas.rules.Different, orionis.schemas.rules.Dimensions, orionis.schemas.rules.DoesntEndWith, orionis.schemas.rules.DoesntStartWith, orionis.schemas.rules.Encoding, orionis.schemas.rules.EndsWith, orionis.schemas.rules.GreaterThanOrEqualField, orionis.schemas.rules.IpAddress, orionis.schemas.rules.LessThanOrEqualField, orionis.schemas.rules.MaxDigits, orionis.schemas.rules.MimeTypes, orionis.schemas.rules.Size, orionis.schemas.rules.StartsWith, orionis.schemas.rules.Unique, orionis.schemas.rules.Uuid

Initialize the rule with an optional custom failure message.

Parameters
message:`str \| None, optional`	Override message used when validation fails.

Returns
`None`	Return `None` after resolving the code and message to report.

def enforce(self, field: str, value: object, instance: object) -> bool: (source) ¶

overrides orionis.schemas.contracts.constraint.IRule.enforce

overridden in orionis.schemas.rules.Accepted, orionis.schemas.rules.ActiveUrl, orionis.schemas.rules.After, orionis.schemas.rules.AfterOrEqual, orionis.schemas.rules.Alpha, orionis.schemas.rules.Ascii, orionis.schemas.rules.Before, orionis.schemas.rules.BeforeOrEqual, orionis.schemas.rules.Between, orionis.schemas.rules.ConfirmPassword, orionis.schemas.rules.DateFormat, orionis.schemas.rules.DecimalPlaces, orionis.schemas.rules.Different, orionis.schemas.rules.Dimensions, orionis.schemas.rules.DoesntEndWith, orionis.schemas.rules.DoesntStartWith, orionis.schemas.rules.Email, orionis.schemas.rules.Encoding, orionis.schemas.rules.EndsWith, orionis.schemas.rules.File, orionis.schemas.rules.GreaterThanOrEqualField, orionis.schemas.rules.Image, orionis.schemas.rules.Integer, orionis.schemas.rules.IpAddress, orionis.schemas.rules.Json, orionis.schemas.rules.LessThanOrEqualField, orionis.schemas.rules.Lowercase, orionis.schemas.rules.MacAddress, orionis.schemas.rules.MaxDigits, orionis.schemas.rules.MimeTypes, orionis.schemas.rules.Size, orionis.schemas.rules.StartsWith, orionis.schemas.rules.StrongPassword, orionis.schemas.rules.Ulid, orionis.schemas.rules.Unique, orionis.schemas.rules.Uppercase, orionis.schemas.rules.Uuid

Evaluate whether the current value satisfies this rule.

Parameters
field:`str`	Field name associated with `value`.
value:`object`	Current field value to validate.
instance:`object`	Schema instance that owns the field value.

Returns
`bool`	Return `True` when the value passes validation.

async def enforceAsync(self, field: str, value: object, instance: object) -> bool: (source) ¶

overridden in orionis.schemas.rules.ActiveUrl, orionis.schemas.rules.Unique

Run an explicitly asynchronous rule check without blocking the loop.

Notes

Rules with native asynchronous I/O should override this method. Schema plans call ordinary synchronous rules directly, without using a worker.

Parameters
field:`str`	Field name associated with the value.
value:`object`	Current field value to validate.
instance:`object`	Schema instance owning the field value.

Returns
`bool`	Whether the synchronous rule accepts the value in a worker thread.

def validate(self, field: str, value: object, instance: object) -> ValidationFailure | None: (source) ¶

overrides orionis.schemas.contracts.constraint.IRule.validate

Validate the field value and return a failure when invalid.

Parameters
field:`str`	Field name associated with `value`.
value:`object`	Current field value to validate.
instance:`object`	Schema instance that owns the field value.

Returns
`ValidationFailure \| None`	Failure details when validation fails; otherwise `None`.

async def validateAsync(self, field: str, value: object, instance: object) -> ValidationFailure | None: (source) ¶

Await the rule and describe an invalid field value.

Parameters
field:`str`	Field name associated with the value.
value:`object`	Current field value to validate.
instance:`object`	Schema instance owning the field value.

Returns
`ValidationFailure \| None`	Failure details when validation fails, otherwise None.

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

overrides orionis.schemas.contracts.constraint.IRule.__slots__

Undocumented

_code: str = (source) ¶

Undocumented

_message: str | None = (source) ¶

Undocumented