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 an explicitly imported factory for an application model.

Method createFiles Create a factory using the configured model and factory directories.
Class Variable __slots__ Declare that this class introduces no additional instance slots.
Class Variable arguments Command-line argument declarations accepted by this command.
Class Variable description Creates a model factory in the database directory..
Class Variable path_key database_factories.
Class Variable postfix Factory.
Class Variable signature make:factory.
Class Variable success_label Model factory.
Class Variable template_name factory.
Class Variable timestamps Timestamps flag used by MakeFactory.

Inherited from MakeStubCommand:

Method createFile Render one stub into its configured application directory.
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 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 factory using the configured model and factory directories.

Parameters
app:orionis.IApplicationApplication that resolves the destination and model paths.
name:strFactory class or file name, with optional nested directories.
Returns
tuple[tuple[str, str], ...]Success label and the generated application-relative path.
Raises
TypeErrorIf the model directory is not configured as a path.
ValueErrorIf the names or model package cannot form valid Python imports.
__slots__: tuple = (source)

Declare that this class introduces no additional instance slots.

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

Command-line argument declarations accepted by this command.

description: str = (source)

Creates a model factory in the database directory..

signature: str = (source)

make:factory.

timestamps: bool = (source)

Timestamps flag used by MakeFactory.