orionis.schemas.rules.IpAddress

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 IpAddress(Rule): (source)

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.
Method	`enforce`	Validate a field value as an IP address.
Class Variable	`__code__`	Undocumented
Class Variable	`__message__`	Undocumented
Class Variable	`__slots__`	Undocumented
Instance Variable	`_version`	Undocumented

Inherited from Rule:

Async Method	`enforceAsync`	Run an explicitly asynchronous rule check without blocking the loop.
Method	`validate`	Validate the field value and return a failure when invalid.
Async Method	`validateAsync`	Await the rule and describe an invalid field value.
Instance Variable	`_code`	Undocumented
Instance Variable	`_message`	Undocumented

def __init__(self, version: int | None = 4, *, message: str | None = None): (source) ¶

overrides orionis.schemas.rule.Rule.__init__

Initialize the rule with the required IP version.

Parameters
version:`int \| None, optional`	Required IP version, either `4` or `6`. Use `None` to accept both families.
message:`str \| None, optional`	Override message used when validation fails.

Returns
`None`	This method initializes the instance and returns None.

Raises
`ValueError`	If `version` is neither `4`, `6` nor `None`.

def enforce(self, field: str, value: object, instance: object) -> bool: (source) ¶

overrides orionis.schemas.rule.Rule.enforce

Validate a field value as an IP address.

Parameters
field:`str`	Field name associated with the value.
value:`object`	Value to validate.
instance:`object`	Owning object instance. This argument is accepted for interface compatibility.

Returns
`bool`	Return `True` when the value passes validation.

Undocumented

Undocumented

overrides orionis.schemas.rule.Rule.__slots__

Undocumented

Undocumented