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.
Known subclasses: 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.Empty, 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.NoEmpty, 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
Constructor: Rule(message)
Define a reusable validation rule and its failure message.
| Method | __init__ |
Initialize the rule with an optional custom failure message. |
| Method | __init |
Require asynchronous enforcement on every rule subclass. |
| Async Method | enforce |
Asynchronously evaluate whether the current value satisfies this rule. |
| Async Method | validate |
Validate the field by awaiting its asynchronous enforcement. |
| Class Variable | __slots__ |
Restrict rule instances to their declared attributes. |
| Instance Variable | _code |
Machine-readable status or error code. |
| Instance Variable | _message |
Override message used when validation fails. |
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.UuidInitialize the rule with an optional custom failure message.
| Parameters | |
message:str | None, optional | Override message used when validation fails. |
| Returns | |
None | No return value. |
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.Empty, 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.NoEmpty, 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.UuidAsynchronously 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. |
| Raises | |
NotImplementedError | If a subclass does not provide its own enforcement implementation. |
str, value: object, instance: object) -> ValidationFailure | None:
(source)
¶
Validate the field by awaiting its asynchronous enforcement.
| 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 | |
orionis.schemas.entities.failure.ValidationFailure | None | Failure details when validation fails; otherwise None. |
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.Empty, 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.NoEmpty, 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.UuidRestrict rule instances to their declared attributes.