orionis.schemas.rules.ActiveUrl

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

class documentation

class ActiveUrl(Rule): (source)

Constructor: ActiveUrl(message)

View In Hierarchy

Ensure a URL points at a hostname that currently resolves.

The hostname is extracted from the URL and looked up through the system resolver, so the check succeeds only when an A or AAAA record exists. The lookup blocks the calling thread.

Method	`enforce`	Validate a field value as an active URL.
Async Method	`enforceAsync`	Resolve a URL hostname without blocking the current event loop.
Class Variable	`__code__`	Undocumented
Class Variable	`__message__`	Undocumented
Class Variable	`__slots__`	Undocumented

Inherited from Rule:

Method	`__init__`	Initialize the rule with an optional custom failure message.
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 enforce(self, field: str, value: object, instance: object) -> bool: (source) ¶

overrides orionis.schemas.rule.Rule.enforce

Validate a field value as an active URL.

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.

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

overrides orionis.schemas.rule.Rule.enforceAsync

Resolve a URL hostname without blocking the current event loop.

Parameters
field:`str`	Field name associated with the value.
value:`object`	URL to inspect, or a value left to type validation.
instance:`object`	Schema instance owning the field value.

Returns
`bool`	Whether the hostname resolves or the value is not a string.

__code__: str = (source) ¶

Undocumented

__message__: str = (source) ¶

Undocumented

__slots__: tuple = (source) ¶

overrides orionis.schemas.rule.Rule.__slots__

Undocumented