orionis.console.commands.make._base.MakeStubCommand

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

View In Hierarchy

Create application files from packaged stubs.

Method	`createFile`	Render one stub into its configured application directory.
Method	`createFiles`	Create the files produced by this command.
Method	`getReplacements`	Read string replacements from the parsed command arguments.
Method	`getTemplateName`	Return the selected template name.
Async Method	`handle`	Create configured files without blocking the running event loop.
Class Variable	`arguments`	Undocumented
Class Variable	`path_key`	Undocumented
Class Variable	`postfix`	Undocumented
Class Variable	`prefix`	Undocumented
Class Variable	`replacement_arguments`	Undocumented
Class Variable	`success_label`	Undocumented
Class Variable	`template_name`	Undocumented

def createFile(self, app: IApplication, name: str, *, template_name: str | None = None, extension: str = 'py', replacements: dict[str, str] | None = None) -> str: (source) ¶

Render one stub into its configured application directory.

Parameters
app:`IApplication`	Application that resolves the destination path.
name:`str`	File name and optional nested directory path.
template_name:`str \| None, optional`	Stub override; the command's template is used when omitted.
extension:`str, optional`	Generated source extension. Defaults to `"py"`.
replacements:`dict[str, str] \| None, optional`	Placeholder values; command replacements are used when omitted.

Returns
`str`	Generated path relative to the application base directory.

Raises
`OSError`	If the generated file cannot be created.
`TypeError`	If the application path or replacement values are invalid.
`ValueError`	If the name or extension is invalid.

def createFiles(self, app: IApplication, name: str) -> tuple[tuple[str, str], ...]: (source) ¶

overridden in orionis.console.commands.make.database_migration.MakeDatabaseMigration, orionis.console.commands.make.facade.MakeFacade, orionis.console.commands.make.factory.MakeFactory, orionis.console.commands.make.test.MakeTest

Create the files produced by this command.

Parameters
app:`IApplication`	Application that resolves the destination path.
name:`str`	File 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) ¶

overridden in orionis.console.commands.make.console.MakeConsoleCommand, orionis.console.commands.make.facade.MakeFacade, orionis.console.commands.make.http_controller.MakeHttpController

Read string replacements from the parsed command arguments.

Returns
`dict[str, str]`	Template placeholders mapped to their argument values.

Raises
`TypeError`	If an argument mapped to a placeholder is not a string.

def getTemplateName(self) -> str: (source) ¶

overridden in orionis.console.commands.make.provider.MakeProvider

Return the selected template name.

Returns
`str`	Stub template name without its `.stub` suffix.

async def handle(self, app: IApplication): (source) ¶

overridden in orionis.console.commands.make.console.MakeConsoleCommand

Create configured files without blocking the running event loop.

Parameters
app:`IApplication`	Application that provides destination paths.

Returns
`None`	Write success or error details to the command output.

arguments: ClassVar[list[Argument]] = (source) ¶

overridden in orionis.console.commands.make.console.MakeConsoleCommand, orionis.console.commands.make.facade.MakeFacade, orionis.console.commands.make.factory.MakeFactory, orionis.console.commands.make.http_controller.MakeHttpController, orionis.console.commands.make.provider.MakeProvider

Undocumented

path_key: ClassVar[str] = (source) ¶

overridden in orionis.console.commands.make.console.MakeConsoleCommand, orionis.console.commands.make.console_listener.MakeConsoleListener, orionis.console.commands.make.contract.MakeContract, orionis.console.commands.make.database_migration.MakeDatabaseMigration, orionis.console.commands.make.database_schema.MakeDatabaseSchema, orionis.console.commands.make.database_seeder.MakeDatabaseSeeder, orionis.console.commands.make.facade.MakeFacade, orionis.console.commands.make.factory.MakeFactory, orionis.console.commands.make.http_controller.MakeHttpController, orionis.console.commands.make.http_middleware.MakeHttpMiddleware, orionis.console.commands.make.http_schema.MakeHttpSchema, orionis.console.commands.make.http_schema_rule.MakeHttpSchemaRule, orionis.console.commands.make.job.MakeJob, orionis.console.commands.make.mail.MakeMail, orionis.console.commands.make.mcp.MakeMcpPrompt, orionis.console.commands.make.mcp.MakeMcpResource, orionis.console.commands.make.mcp.MakeMcpServer, orionis.console.commands.make.mcp.MakeMcpTool, orionis.console.commands.make.model.MakeModel, orionis.console.commands.make.provider.MakeProvider, orionis.console.commands.make.service.MakeService, orionis.console.commands.make.test.MakeTest

Undocumented

postfix: ClassVar[str | None] = (source) ¶

overridden in orionis.console.commands.make.console.MakeConsoleCommand, orionis.console.commands.make.console_listener.MakeConsoleListener, orionis.console.commands.make.database_schema.MakeDatabaseSchema, orionis.console.commands.make.database_seeder.MakeDatabaseSeeder, orionis.console.commands.make.factory.MakeFactory, orionis.console.commands.make.http_controller.MakeHttpController, orionis.console.commands.make.http_middleware.MakeHttpMiddleware, orionis.console.commands.make.http_schema.MakeHttpSchema, orionis.console.commands.make.http_schema_rule.MakeHttpSchemaRule, orionis.console.commands.make.job.MakeJob, orionis.console.commands.make.mail.MakeMail, orionis.console.commands.make.mcp.MakeMcpPrompt, orionis.console.commands.make.mcp.MakeMcpResource, orionis.console.commands.make.mcp.MakeMcpServer, orionis.console.commands.make.mcp.MakeMcpTool, orionis.console.commands.make.provider.MakeProvider

Undocumented

prefix: ClassVar[str | None] = (source) ¶

overridden in orionis.console.commands.make.contract.MakeContract

Undocumented

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

overridden in orionis.console.commands.make.console.MakeConsoleCommand

Undocumented

success_label: ClassVar[str] = (source) ¶

Undocumented

template_name: ClassVar[str] = (source) ¶

Undocumented