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

class documentation

class Accepted(Rule): (source)

Constructor: Accepted(message)

View In Hierarchy

Ensure a value expresses an explicit acceptance.

Accepts True, 1 and the strings "yes", "on", "1" and "true", which makes it suitable for terms-of-service fields.

Method enforce Validate a field value as an acceptance flag.
Class Variable __code__ Undocumented
Class Variable __message__ Undocumented
Class Variable __slots__ Undocumented

Inherited from Rule:

Method __init__ Initialize the rule with an optional custom failure message.
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 enforce(self, field: str, value: object, instance: object) -> bool: (source)
overrides orionis.schemas.rule.Rule.enforce

Validate a field value as an acceptance flag.

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 = (source)
overrides orionis.schemas.rule.Rule.__slots__

Undocumented