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

class MakeConsoleCommand(MakeStubCommand): (source)

View In Hierarchy

Generate a custom command for the Orionis CLI.

Method getReplacements Return the signature and description placeholders.
Async Method handle Validate a command signature and create its file on a worker thread.
Class Variable arguments Command-line argument declarations accepted by this command.
Class Variable description Creates a new custom console command..
Class Variable path_key app_console_commands.
Class Variable postfix Command.
Class Variable replacement_arguments Command arguments forwarded to template placeholder replacement.
Class Variable signature make:console-command.
Class Variable success_label Console command.
Class Variable template_name console_command.
Class Variable timestamps Timestamps flag used by MakeConsoleCommand.

Inherited from MakeStubCommand:

Method createFile Render one stub into its configured application directory.
Method createFiles Create the files produced by this command.
Method getTemplateName Return the selected template name.
Class Variable prefix Prefix applied when constructing names or storage keys.
def getReplacements(self) -> dict[str, str]: (source)

Return the signature and description placeholders.

Returns
dict[str, str]Placeholder values for the console command stub.
async def handle(self, app: IApplication, reactor: IReactor) -> int | None: (source)

Validate a command signature and create its file on a worker thread.

Parameters
app:orionis.IApplicationApplication that resolves the destination path.
reactor:orionis.console.core.contracts.reactor.IReactorRegistered command collection used to reject duplicate signatures.
Returns
int or NoneReturn 1 after reporting a generation error, or None on success.
arguments: ClassVar[list[Argument]] = (source)

Command-line argument declarations accepted by this command.

description: str = (source)

Creates a new custom console command..

replacement_arguments: ClassVar[dict[str, str]] = (source)

Command arguments forwarded to template placeholder replacement.

signature: str = (source)

make:console-command.

timestamps: bool = (source)

Timestamps flag used by MakeConsoleCommand.