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.

package documentation

Group the schemas rules components and public imports.

Module accepted Ensure a value expresses an explicit acceptance.
Module active_url Ensure a URL points at a hostname that currently resolves.
Module after Ensure a date comes strictly after a reference moment.
Module after_or_equal Ensure a date is equal to or comes after a reference moment.
Module alpha Ensure a string contains only alphabetic characters.
Module ascii Ensure a string contains only 7-bit ASCII characters.
Module before Ensure a date comes strictly before a reference moment.
Module before_or_equal Ensure a date is equal to or comes before a reference moment.
Module between Ensure a value's size falls within an inclusive range.
Module confirm_password Ensure a value matches the password supplied in a sibling field.
Module date_format Ensure a date string matches one of the accepted formats.
Module decimal_places Ensure a numeric value carries a given number of decimal places.
Module different Ensure a value differs from every value supplied to the rule.
Module dimensions Ensure an uploaded image satisfies the given dimension constraints.
Module doesnt_end_with Ensure a string does not end with any of the given suffixes.
Module doesnt_start_with Ensure a string does not start with any of the given prefixes.
Module email Ensure a string is a valid email address.
Module empty Ensure a field contains an empty value.
Module encoding Ensure a value can be represented in a given character encoding.
Module ends_with Ensure a string ends with one of the given suffixes.
Module file Ensure a value is a successfully uploaded file.
Module greater_than_or_equal_field Ensure a value is greater than or equal to a sibling field.
Module image Ensure an uploaded file has a supported raster image header.
Module image_probe Read supported raster headers without decoding image pixels.
Module integer Ensure a value represents a whole number.
Module ip_address Ensure a string is a valid IP address.
Module json_string Ensure a string holds a syntactically valid JSON document.
Module less_than_or_equal_field Ensure a value is less than or equal to a sibling field.
Module lowercase Ensure a string contains no uppercase characters.
Module mac_address Ensure a string is a valid MAC address.
Module max_digits Ensure an integer is written with at most a given number of digits.
Module measure Measure field values, inspect emptiness and read uploaded file content.
Module mime_types Ensure an uploaded file declares one of the accepted MIME types.
Module no_empty Ensure a field contains a non-empty value.
Module size Ensure a value has an exact size.
Module starts_with Ensure a string starts with one of the given prefixes.
Module strong_password Ensure a string is strong enough to be used as a password.
Module temporal Provide schemas rules operations.
Module ulid Ensure a string is a valid lexicographically sortable identifier.
Module unique Ensure a value is not already stored in a database column.
Module uppercase Ensure a string contains no lowercase characters.
Module uuid_string Ensure a string is a valid RFC 9562 universally unique identifier.

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 Empty Accept None, blank strings, zero, False and zero-length values.
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 has a supported raster image header.
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 NoEmpty Reject exactly the values accepted by Empty.
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 Public export names mapped to their defining modules and attributes.
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:strName requested from this package.
Returns
objectRule class from its defining module.
Raises
AttributeErrorIf the requested name is not exported.
_EXPORTS: dict = (source)

Public export names mapped to their defining modules and attributes.

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'),
...