orionis.schemas.rules

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

package documentation

(source)

Undocumented

Module	`accepted`	Undocumented
Module	`active_url`	Undocumented
Module	`after`	Undocumented
Module	`after_or_equal`	Undocumented
Module	`alpha`	Undocumented
Module	`ascii`	Undocumented
Module	`before`	Undocumented
Module	`before_or_equal`	Undocumented
Module	`between`	Undocumented
Module	`confirm_password`	Undocumented
Module	`date_format`	Undocumented
Module	`decimal_places`	Undocumented
Module	`different`	Undocumented
Module	`dimensions`	No module docstring; 1/1 function documented
Module	`doesnt_end_with`	Undocumented
Module	`doesnt_start_with`	Undocumented
Module	`email`	Undocumented
Module	`encoding`	Undocumented
Module	`ends_with`	Undocumented
Module	`file`	Undocumented
Module	`greater_than_or_equal_field`	Undocumented
Module	`image`	Undocumented
Module	`image_probe`	No module docstring; 0/14 constant, 6/6 functions documented
Module	`integer`	Undocumented
Module	`ip_address`	Undocumented
Module	`json_string`	Undocumented
Module	`less_than_or_equal_field`	Undocumented
Module	`lowercase`	Undocumented
Module	`mac_address`	Undocumented
Module	`max_digits`	Undocumented
Module	`measure`	No module docstring; 0/2 constant, 3/3 functions documented
Module	`mime_types`	Undocumented
Module	`size`	Undocumented
Module	`starts_with`	Undocumented
Module	`strong_password`	Undocumented
Module	`temporal`	No module docstring; 3/3 functions documented
Module	`ulid`	Undocumented
Module	`unique`	No module docstring; 1/1 function documented
Module	`uppercase`	Undocumented
Module	`uuid_string`	Undocumented

From __init__.py:

Class	`Accepted`	Ensure a value expresses an explicit acceptance.
Class	`ActiveUrl`	Ensure a URL points at a hostname that currently resolves.
Class	`After`	Ensure a date comes strictly after a reference moment.
Class	`AfterOrEqual`	Ensure a date is equal to or comes after a reference moment.
Class	`Alpha`	Ensure a string contains only alphabetic characters.
Class	`Ascii`	Ensure a string contains only 7-bit ASCII characters.
Class	`Before`	Ensure a date comes strictly before a reference moment.
Class	`BeforeOrEqual`	Ensure a date is equal to or comes before a reference moment.
Class	`Between`	Ensure a value's size falls within an inclusive range.
Class	`ConfirmPassword`	Ensure a value matches the password supplied in a sibling field.
Class	`DateFormat`	Ensure a date string matches one of the accepted formats.
Class	`DecimalPlaces`	Ensure a numeric value carries a given number of decimal places.
Class	`Different`	Ensure a value differs from every value supplied to the rule.
Class	`Dimensions`	Ensure an uploaded image satisfies the given dimension constraints.
Class	`DoesntEndWith`	Ensure a string does not end with any of the given suffixes.
Class	`DoesntStartWith`	Ensure a string does not start with any of the given prefixes.
Class	`Email`	Ensure a string is a valid email address.
Class	`Encoding`	Ensure a value can be represented in a given character encoding.
Class	`EndsWith`	Ensure a string ends with one of the given suffixes.
Class	`File`	Ensure a value is a successfully uploaded file.
Class	`GreaterThanOrEqualField`	Ensure a value is greater than or equal to a sibling field.
Class	`Image`	Ensure an uploaded file is a raster image.
Class	`Integer`	Ensure a value represents a whole number.
Class	`IpAddress`	Ensure a string is a valid IP address.
Class	`Json`	Ensure a string holds a syntactically valid JSON document.
Class	`LessThanOrEqualField`	Ensure a value is less than or equal to a sibling field.
Class	`Lowercase`	Ensure a string contains no uppercase characters.
Class	`MacAddress`	Ensure a string is a valid MAC address.
Class	`MaxDigits`	Ensure an integer is written with at most a given number of digits.
Class	`MimeTypes`	Ensure an uploaded file declares one of the accepted MIME types.
Class	`Size`	Ensure a value has an exact size.
Class	`StartsWith`	Ensure a string starts with one of the given prefixes.
Class	`StrongPassword`	Ensure a string is strong enough to be used as a password.
Class	`Ulid`	Ensure a string is a valid lexicographically sortable identifier.
Class	`Unique`	Ensure a value is not already stored in a database column.
Class	`Uppercase`	Ensure a string contains no lowercase characters.
Class	`Uuid`	Ensure a string is a valid RFC 9562 universally unique identifier.
Function	`__dir__`	List loaded attributes and public schema rules.
Function	`__getattr__`	Resolve and cache a public schema rule.
Constant	`_EXPORTS`	Undocumented

def __dir__() -> list[str]: (source) ¶

List loaded attributes and public schema rules.

Returns
`list[str]`	Sorted names visible on this package.

def __getattr__(name: str) -> object: (source) ¶

Resolve and cache a public schema rule.

Parameters
name:`str`	Name requested from this package.

Returns
`object`	Rule class from its defining module.

Raises
`AttributeError`	If the requested name is not exported.

_EXPORTS: dict = (source) ¶

Undocumented

Value

{'Accepted': ('orionis.schemas.rules.accepted', 'Accepted'),
 'ActiveUrl': ('orionis.schemas.rules.active_url', 'ActiveUrl'),
 'After': ('orionis.schemas.rules.after', 'After'),
 'AfterOrEqual': ('orionis.schemas.rules.after_or_equal', 'AfterOrEqual'),
 'Alpha': ('orionis.schemas.rules.alpha', 'Alpha'),
 'Ascii': ('orionis.schemas.rules.ascii', 'Ascii'),
 'Before': ('orionis.schemas.rules.before', 'Before'),
...