orionis.schemas.rules.GreaterThanOrEqualField

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 GreaterThanOrEqualField(Rule): (source)

Constructor: GreaterThanOrEqualField(other_field, message)

View In Hierarchy

Ensure a value is greater than or equal to a sibling field.

Both values are compared using the same size semantics: numbers by magnitude, strings and collections by length, and uploaded files by their size in kilobytes.

Method	`__init__`	Initialize the rule with the field to compare against.
Method	`enforce`	Validate a field value against the compared field.
Class Variable	`__code__`	Undocumented
Class Variable	`__message__`	Undocumented
Class Variable	`__slots__`	Undocumented
Instance Variable	`_other_field`	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, other_field: str, *, message: str | None = None): (source) ¶

overrides orionis.schemas.rule.Rule.__init__

Initialize the rule with the field to compare against.

Parameters
other_field:`str`	Name of the sibling field holding the lower bound.
message:`str \| None, optional`	Override message used when validation fails.

Returns
`None`	This 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 against the compared field.

Parameters
field:`str`	Field name associated with the value.
value:`object`	Value to validate.
instance:`object`	Schema instance holding the compared field.

Returns
`bool`	Return `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

_other_field: str = (source) ¶

Undocumented