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.

module documentation

Describe the immutable metadata needed to invoke one callable.

Class InvocationPlan Describe the immutable metadata needed to invoke one callable.
Function _callable_plan Validate a callable and retain its parameter and coroutine metadata.
Function _clear_invocation_plans Discard plans derived from explicitly invalidated reflection metadata.
Function _positional_only_names Read positional-only names from the shared signature cache.
Function _resolve_constructor_annotation Resolve one class-local constructor hint without rejecting other parameters.
Function callable_plan Select a plan using the callable's function and receiver mode.
Function constructor_plan Validate a concrete class and prepare its constructor metadata.
Function warm_controller_plan Prepare ordinary controller descriptors without creating an instance.
@lru_cache(maxsize=1024)
def _callable_plan(target: Callable, *, bound: bool = False) -> InvocationPlan: (source)

Validate a callable and retain its parameter and coroutine metadata.

Parameters
target:collections.abc.CallableFunction underlying the callable.
bound:bool, optionalWhether a receiver is supplied by Python's descriptor binding.
Returns
orionis.container.entities.invocation.InvocationPlanMetadata reusable across different instances of the same controller.
def _clear_invocation_plans(): (source)

Discard plans derived from explicitly invalidated reflection metadata.

Returns
NoneNo return value.
def _positional_only_names(target: object) -> frozenset[str]: (source)

Read positional-only names from the shared signature cache.

Parameters
target:objectCallable whose parameter kinds are being compiled into a plan.
Returns
frozenset[str]Parameter names which Python does not bind from keyword arguments.
def _resolve_constructor_annotation(annotation: str, globalns: dict[str, object], localns: dict[str, object]) -> object: (source)

Resolve one class-local constructor hint without rejecting other parameters.

Parameters
annotation:strDeferred annotation from the constructor signature.
globalns:dict[str, object]Defining module namespace.
localns:dict[str, object]Class namespace including its own name.
Returns
objectResolved annotation, or None when its references remain unavailable.
def callable_plan(target: Callable) -> InvocationPlan: (source)

Select a plan using the callable's function and receiver mode.

Parameters
target:collections.abc.CallableFunction or bound method invoked by the container.
Returns
orionis.container.entities.invocation.InvocationPlanParameter plan that does not retain a bound receiver.
@lru_cache(maxsize=1024)
def constructor_plan(target: type, constructor: object) -> InvocationPlan: (source)

Validate a concrete class and prepare its constructor metadata.

Parameters
target:typeConcrete class instantiated by the container.
constructor:objectCurrent __init__ descriptor, included in the cache identity.
Returns
orionis.container.entities.invocation.InvocationPlanShared constructor parameters with resolvable class-local types restored.
def warm_controller_plan(target: type, method_name: str): (source)

Prepare ordinary controller descriptors without creating an instance.

Notes

Static lookup does not execute custom descriptor getters. Only ordinary Python functions and built-in constructor descriptors are inspected. Dependencies and controller instances are always resolved at request time. Plans remain subject to the bounded LRU capacity.

Parameters
target:typeController whose constructor and action will run during requests.
method_name:strInstance, static, or class method selected by the route.
Returns
NoneThis function does not return a value.