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

class Argument: (source)

View In Hierarchy

Represent a function or method argument with type and resolution metadata.

Method __post_init__ Validate field types after dataclass initialisation.
Instance Variable class_name The class representing the argument's type.
Instance Variable default The default value of the argument, if any (default is None).
Instance Variable full_class_path The complete dotted path to the argument's type (module.class).
Instance Variable is_keyword_only Indicates if the argument is keyword-only (default is False).
Instance Variable is_schema Indicates if the argument is a schema (default is False).
Instance Variable module_name The module where the argument's type is defined.
Instance Variable name The name of the argument.
Instance Variable resolved Indicates whether the argument has been resolved or processed.
Instance Variable type The Python type object for the argument's type.
def __post_init__(self): (source)

Validate field types after dataclass initialisation.

Returns
NoneNo return value.
Raises
TypeErrorIf module_name, class_name, or full_class_path is not a string.
ValueErrorIf type is None and no default value is provided.
class_name: str = (source)

The class representing the argument's type.

default: typing.Any | None, optional = (source)

The default value of the argument, if any (default is None).

full_class_path: str = (source)

The complete dotted path to the argument's type (module.class).

is_keyword_only: bool, optional = (source)

Indicates if the argument is keyword-only (default is False).

is_schema: bool, optional = (source)

Indicates if the argument is a schema (default is False).

module_name: str = (source)

The module where the argument's type is defined.

The name of the argument.

resolved: bool = (source)

Indicates whether the argument has been resolved or processed.

The Python type object for the argument's type.