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.

class documentation

Ensure a string is a valid IP address.

Version 4 is enforced by default. Pass version=6 to require IPv6, or version=None to accept either family.

Method __init__ Initialize the rule with the required IP version.
Async Method enforce Validate a field value as an IP address.
Class Variable __code__ ip.
Class Variable __message__ Value must be a valid IP address..
Class Variable __slots__ Declare the instance attribute slots reserved by this class.
Instance Variable _version Required IP version, either 4 or 6. Use None to accept both families.

Inherited from Rule:

Method __init_subclass__ Require asynchronous enforcement on every rule subclass.
Async Method validate Validate the field by awaiting its asynchronous enforcement.
Instance Variable _code Machine-readable status or error code.
Instance Variable _message Override message used when validation fails.
def __init__(self, version: int | None = 4, *, message: str | None = None): (source)

Initialize the rule with the required IP version.

Parameters
version:int | None, optionalRequired IP version, either 4 or 6. Use None to accept both families.
message:str | None, optionalOverride message used when validation fails.
Returns
NoneNo return value.
Raises
ValueErrorIf version is neither 4, 6 nor None.
async def enforce(self, field: str, value: object, instance: object) -> bool: (source)

Validate a field value as an IP address.

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)

ip.

__message__: str = (source)

Value must be a valid IP address..

__slots__: tuple[str, ...] = (source)

Declare the instance attribute slots reserved by this class.

_version: int | None = (source)

Required IP version, either 4 or 6. Use None to accept both families.