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.

Explore modules View classes

orionis.introspection.dependencies.entities.signature.Signature

class documentation

class Signature(BaseEntity): (source)

View In Hierarchy

Represent the categorized dependency signature of a callable.

Groups parameter dependencies into resolved, unresolved, and ordered buckets that downstream IoC logic can consume directly.

Parameters
resolvedParameters whose types or defaults are fully known.
unresolvedParameters that lack sufficient type or default information.
orderedAll parameters in their original declaration order.
Method __post_init__ Validate that all three bucket fields are dictionaries.
Method arguments Return an iterable view of all parameters in declaration order.
Method getAllOrdered Return all parameters in their original declaration order.
Method getKeywordOnly Return parameters that are keyword-only.
Method getPositionalOnly Return parameters that are not keyword-only.
Method getResolved Return the resolved parameter dictionary.
Method getUnresolved Return the unresolved parameter dictionary.
Method hasParameters Determine whether the callable defines any parameters.
Method hasUnresolvedArguments Determine whether any unresolved parameters exist.
Method noArgumentsRequired Determine whether the callable requires no arguments.
Method resolvedToDict Return the resolved parameters as a plain dictionary.
Method toDict Return the ordered parameters as a plain dictionary.
Method unresolvedToDict Return the unresolved parameters as a plain dictionary.
Class Variable ordered Undocumented
Class Variable resolved Undocumented
Class Variable unresolved Undocumented

Inherited from BaseEntity:

Class Method _cachedFieldMetadata Retrieve field definitions and normalized types cached by class.
Method getFields Describe field names, normalized types, defaults, and metadata.
Class Variable __slots__ Undocumented
def __post_init__(self): (source)
overrides orionis.support.entities.BaseEntity.__post_init__

Validate that all three bucket fields are dictionaries.

Returns
NoneComplete the documented operation without returning a value.
Raises
TypeErrorIf resolved, unresolved, or ordered is not a dict.
def arguments(self) -> dict_items[str, Argument]: (source)

Return an iterable view of all parameters in declaration order.

Returns
dict_items[str, Argument]Iterable of (name, Argument) pairs from ordered.
def getAllOrdered(self) -> dict[str, Argument]: (source)

Return all parameters in their original declaration order.

Returns
dict[str, Argument]Mapping of all parameter names to their Argument objects.
def getKeywordOnly(self) -> dict[str, Argument]: (source)

Return parameters that are keyword-only.

Returns
dict[str, Argument]Subset of ordered containing only keyword-only arguments.
def getPositionalOnly(self) -> dict[str, Argument]: (source)

Return parameters that are not keyword-only.

Returns
dict[str, Argument]Subset of ordered containing only positional arguments.
def getResolved(self) -> dict[str, Argument]: (source)

Return the resolved parameter dictionary.

Returns
dict[str, Argument]Mapping of parameter names to resolved Argument objects.
def getUnresolved(self) -> dict[str, Argument]: (source)

Return the unresolved parameter dictionary.

Returns
dict[str, Argument]Mapping of parameter names to unresolved Argument objects.
def hasParameters(self) -> bool: (source)

Determine whether the callable defines any parameters.

Returns
boolTrue if at least one parameter is defined; otherwise False.
def hasUnresolvedArguments(self) -> bool: (source)

Determine whether any unresolved parameters exist.

Returns
boolTrue when the unresolved map is non-empty.
def noArgumentsRequired(self) -> bool: (source)

Determine whether the callable requires no arguments.

Returns
boolTrue when the ordered parameter map is empty.
def resolvedToDict(self) -> dict[str, Argument]: (source)

Return the resolved parameters as a plain dictionary.

Returns
dict[str, Argument]A new dict with the same contents as resolved.
def toDict(self) -> dict[str, Argument]: (source)
overrides orionis.support.entities.BaseEntity.toDict

Return the ordered parameters as a plain dictionary.

Returns
dict[str, Argument]A new dict with the same contents as ordered.
def unresolvedToDict(self) -> dict[str, Argument]: (source)

Return the unresolved parameters as a plain dictionary.

Returns
dict[str, Argument]A new dict with the same contents as unresolved.
ordered: dict[str, Argument] = (source)

Undocumented

resolved: dict[str, Argument] = (source)

Undocumented

unresolved: dict[str, Argument] = (source)

Undocumented