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

Generate a facade and its typing interface.

Method createFiles Create a facade implementation and its .pyi interface.
Method getReplacements Return a Python string literal for the configured accessor.
Class Variable arguments Command-line argument declarations accepted by this command.
Class Variable description Creates a new facade class and interface..
Class Variable path_key app_facades.
Class Variable signature make:facade.
Class Variable success_label Facade.
Class Variable template_name facade.
Class Variable timestamps Timestamps flag used by MakeFacade.

Inherited from MakeStubCommand:

Method createFile Render one stub into its configured application directory.
Method getTemplateName Return the selected template name.
Async Method handle Create configured files without blocking the running event loop.
Class Variable postfix Suffix appended to the generated resource name.
Class Variable prefix Prefix applied when constructing names or storage keys.
Class Variable replacement_arguments Command arguments forwarded to template placeholder replacement.
def createFiles(self, app: IApplication, name: str) -> tuple[tuple[str, str], ...]: (source)

Create a facade implementation and its .pyi interface.

Parameters
app:orionis.IApplicationApplication that resolves the destination path.
name:strFile name and optional nested directory path.
Returns
tuple[tuple[str, str], ...]Success labels and generated application-relative paths.
def getReplacements(self) -> dict[str, str]: (source)

Return a Python string literal for the configured accessor.

Returns
dict[str, str]Accessor literal inserted into the generated facade.
Raises
TypeErrorIf the accessor argument is not a string.
arguments: ClassVar[list[Argument]] = (source)

Command-line argument declarations accepted by this command.

description: str = (source)

Creates a new facade class and interface..

signature: str = (source)

make:facade.

timestamps: bool = (source)

Timestamps flag used by MakeFacade.