orionis.schemas.contracts.constraint.IRule

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

class IRule(ABC): (source)

Constructor: IRule(message)

Undocumented

Method	`__init__`	Initialize the rule with an optional custom failure message.
Method	`enforce`	Evaluate whether the current value satisfies this rule.
Method	`validate`	Validate the provided value and return a failure or `None`.
Class Variable	`__slots__`	Undocumented

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

overridden in orionis.schemas.rule.Rule

Initialize the rule with an optional custom failure message.

Parameters
message:`str \| None, optional`	Custom message used for validation failures. If `None`, default messages are used.

Returns
`None`	Complete the documented operation without returning a value.

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

overridden in orionis.schemas.rule.Rule

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.

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

overridden in orionis.schemas.rule.Rule

Validate the provided value and return a failure or None.

Parameters
field:`str`	Name of the field being validated.
value:`object`	Current field value to validate.
instance:`object`	Object instance that owns the field.

Returns
`ValidationFailure \| None`	A failure describing the constraint violation, or `None` when the value is valid.

overridden in orionis.schemas.rule.Rule

Undocumented