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 DecimalPlaces(Rule): (source)
Constructor: DecimalPlaces(minimum, maximum, message)
Ensure a numeric value carries a given number of decimal places.
A single bound requires an exact number of places, while supplying maximum accepts any count within the inclusive range.
| Method | __init__ |
Initialize the rule with the accepted number of decimal places. |
| Method | enforce |
Validate a field value against the accepted decimal places. |
| Class Variable | __code__ |
Undocumented |
| Class Variable | __message__ |
Undocumented |
| Class Variable | __slots__ |
Undocumented |
| Instance Variable | _maximum |
Undocumented |
| Instance Variable | _minimum |
Undocumented |
Inherited from Rule:
| Async Method | enforce |
Run an explicitly asynchronous rule check without blocking the loop. |
| Method | validate |
Validate the field value and return a failure when invalid. |
| Async Method | validate |
Await the rule and describe an invalid field value. |
| Instance Variable | _code |
Undocumented |
| Instance Variable | _message |
Undocumented |
def __init__(self, minimum:
int, maximum: int | None = None, *, message: str | None = None):
(source)
¶
overrides
orionis.schemas.rule.Rule.__init__Initialize the rule with the accepted number of decimal places.
| Parameters | |
minimum:int | Lowest accepted number of decimal places. |
maximum:int | None, optional | Highest accepted number of decimal places. Defaults to minimum, which requires an exact count. |
message:str | None, optional | Override message used when validation fails. |
| Returns | |
None | This method initializes the instance and returns None. |
| Raises | |
ValueError | If the bounds are negative or produce an empty range. |