orionis.console.commands.support.install.InstallCommand

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

Constructor: InstallCommand()

View In Hierarchy

Install dependencies declared by the application's project manifest.

Static Method	`__dependencyTable`	Validate a manifest table containing dependency declarations.
Static Method	`__requirements`	Validate and deduplicate a list of package requirements.
Static Method	`__resolveOption`	Resolve a catalog number, namespaced key or unambiguous name.
Method	`__init__`	Initialize the command arguments and Rich output.
Async Method	`__installSelection`	Confirm and install all requirements from the selected options.
Method	`__loadOptions`	Read extras and expand dependency groups from a TOML manifest.
Method	`__renderOptions`	Render a compact catalog with one row per installation option.
Method	`__resolveGroup`	Expand included dependency groups and reject recursive references.
Async Method	`__runInstaller`	Run uv against the current Python environment without a shell.
Method	`__selectOptions`	Read explicit options or ask for an interactive selection.
Async Method	`handle`	List and install dependencies in the interpreter running Reactor.
Class Variable	`__slots__`	Undocumented
Class Variable	`arguments`	Undocumented
Class Variable	`description`	Undocumented
Class Variable	`signature`	Undocumented
Class Variable	`timestamps`	Undocumented
Instance Variable	`_console`	Undocumented

@staticmethod

def __dependencyTable(value: object, origin: str) -> dict[str, object]: (source) ¶

Validate a manifest table containing dependency declarations.

Parameters
value:`object`	Parsed TOML value expected to be a table.
origin:`str`	Manifest section used in error messages.

Returns
`dict[str, object]`	Validated dependency table.

Raises
`TypeError`	If the section is not a TOML table.

@staticmethod

def __requirements(entries: object, origin: str) -> tuple[str, ...]: (source) ¶

Validate and deduplicate a list of package requirements.

Parameters
entries:`object`	Parsed dependency list.
origin:`str`	Option used in error messages.

Returns
`tuple[str, ...]`	Nonempty requirement strings in declaration order.

Raises
`ValueError`	If the declaration is not a list of nonempty strings.

@staticmethod

def __resolveOption(token: str, keys: tuple[str, ...]) -> str: (source) ¶

Resolve a catalog number, namespaced key or unambiguous name.

Parameters
token:`str`	Selection supplied by the user.
keys:`tuple[str, ...]`	Available keys in the order displayed by the catalog.

Returns
`str`	Canonical installation option key.

Raises
`ValueError`	If a number is out of range or a name is unknown or ambiguous.

def __init__(self): (source) ¶

Initialize the command arguments and Rich output.

Returns
`None`	Initialize the console used for the installation interface.

async def __installSelection(self, project_root: Path, options: dict[str, tuple[str, ...]], selected: list[str]) -> int: (source) ¶

Confirm and install all requirements from the selected options.

Parameters
project_root:`Path`	Working directory for relative package references.
options:`dict[str, tuple[str, ...]]`	Available dependency requirements.
selected:`list[str]`	Canonical keys chosen by the user.

Returns
`int`	Installer status, zero for cancellation or an empty selection, or one when non-interactive confirmation is missing.

Raises
`EOFError`	If interactive confirmation input is closed.
`KeyboardInterrupt`	If the user interrupts the confirmation prompt.
`OSError`	If the installer process cannot be started.

def __loadOptions(self, project_path: Path) -> dict[str, tuple[str, ...]]: (source) ¶

Read extras and expand dependency groups from a TOML manifest.

Parameters
project_path:`Path`	Application manifest to read.

Returns
`dict[str, tuple[str, ...]]`	Namespaced options and their deduplicated package requirements.

Raises
`OSError`	If the manifest cannot be read.
`TypeError`	If a dependency section has an invalid TOML type.
`ValueError`	If TOML, dependency values or group references are invalid.

def __renderOptions(self, project_path: Path, options: dict[str, tuple[str, ...]]): (source) ¶

Render a compact catalog with one row per installation option.

Parameters
project_path:`Path`	Manifest supplying the catalog.
options:`dict[str, tuple[str, ...]]`	Namespaced installation options.

Returns
`None`	Print project metadata and a compact Rich dependency table.

def __resolveGroup(self, name: str, groups: dict[str, object], chain: tuple[str, ...]) -> tuple[str, ...]: (source) ¶

Expand included dependency groups and reject recursive references.

Parameters
name:`str`	Dependency group to expand.
groups:`dict[str, object]`	All dependency groups declared by the manifest.
chain:`tuple[str, ...]`	Groups already visited in this expansion.

Returns
`tuple[str, ...]`	Deduplicated requirements including referenced groups.

Raises
`TypeError`	If the group does not declare a list of dependencies.
`ValueError`	If a group is missing, cyclic or contains an invalid declaration.

async def __runInstaller(self, project_root: Path, requirements: tuple[str, ...]) -> int: (source) ¶

Run uv against the current Python environment without a shell.

Parameters
project_root:`Path`	Working directory used to resolve local dependency references.
requirements:`tuple[str, ...]`	Requirement strings passed unchanged as individual arguments.

Returns
`int`	Zero on success, one when uv is missing or terminated by a signal, or the positive exit code reported by uv.

Raises
`CancelledError`	If execution is canceled after stopping and waiting for the child.
`OSError`	If uv cannot be started.

def __selectOptions(self, options: dict[str, tuple[str, ...]]) -> list[str]: (source) ¶

Read explicit options or ask for an interactive selection.

Parameters
options:`dict[str, tuple[str, ...]]`	Available namespaced installation options.

Returns
`list[str]`	Unique option keys, or an empty list for a canceled selection.

Raises
`EOFError`	If interactive input is closed.
`KeyboardInterrupt`	If the user interrupts the prompt.
`ValueError`	If an option is unknown or ambiguous.

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

List and install dependencies in the interpreter running Reactor.

Parameters
app:`IApplication`	Application providing the project root.

Returns
`int`	Zero on success or a declined selection, 130 on interruption, or a nonzero status when validation or installation fails.

__slots__: tuple[str, ...] = (source) ¶

Undocumented

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

Undocumented

description: str = (source) ¶

Undocumented

signature: str = (source) ¶

Undocumented

timestamps: bool = (source) ¶

Undocumented

_console = (source) ¶

Undocumented