orionis.container.facades.Facade

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

Known subclasses: orionis.container.facades.facade.ScopedFacade, orionis.support.facades.Auth, orionis.support.facades.Cache, orionis.support.facades.Log, orionis.support.facades.Reactor, orionis.support.facades.Schedule

View In Hierarchy

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.
Class Variable	`_application`	Undocumented
Class Variable	`_pinned_instance`	Undocumented

@classmethod

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

overridden in orionis.support.facades.Auth, orionis.support.facades.Cache, orionis.support.facades.Log, orionis.support.facades.Reactor, orionis.support.facades.Schedule, orionis.support.facades.Session

Return the container accessor key for this facade.

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

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

@classmethod

async def pin(cls): (source) ¶

overridden in orionis.container.facades.facade.ScopedFacade

Pin the resolved instance on this facade class.

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

@classmethod

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

overridden in orionis.container.facades.facade.ScopedFacade

Resolve the service instance bound to this facade.

Parameters
*args:`object`	Forward positional arguments to the container make call.
**kwargs:`object`	Forward keyword arguments to the container make call.

Returns
`object`	Return the resolved service instance from the application.

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

@classmethod

def unpin(cls): (source) ¶

overridden in orionis.container.facades.facade.ScopedFacade

Clear the pinned instance from this facade class.

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

_application: IApplication | None = (source) ¶

Undocumented

_pinned_instance: Any = (source) ¶

Undocumented