orionis.container.contracts.IFacade

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 IFacade(ABC): (source)

Undocumented

Class Method	`getFacadeAccessor`	Return the container accessor key for this facade.
Async Class Method	`pin`	Pin the resolved instance on this facade class.
Async Class Method	`resolve`	Resolve the service instance bound to this facade.
Class Method	`unpin`	Clear the pinned instance from this facade class.

@classmethod
@abstractmethod

def getFacadeAccessor(cls) -> str | type: (source) ¶

Return the container accessor key for this facade.

Returns
`str \| type`	The alias or contract class used to resolve the container binding.

Raises
`NotImplementedError`	Raised when the subclass does not implement this method.

@classmethod
@abstractmethod

Pin the resolved instance on this facade class.

Returns
`None`	Returns `None` after storing the currently resolved instance.

@classmethod
@abstractmethod

async def resolve(cls, *args: object, **kwargs: object) -> object: (source) ¶

Resolve the service instance bound to this facade.

Parameters
*args:`object`	Positional arguments forwarded to the container make call.
**kwargs:`object`	Keyword arguments forwarded to the container make call.

Returns
`object`	The resolved service instance from the application container.

Raises
`RuntimeError`	Raised when the application has not been booted.

@classmethod
@abstractmethod

Clear the pinned instance from this facade class.

Returns
`None`	Returns `None` after clearing the cached pinned instance.