Files
computer-playbook/cli/administration/deploy/development/cli.py
T
kevinveenbirkenbachandClaude Opus 4.7 a26bfc4e94 refactor(cli): reorg admin/contributing tree + per-folder help system
Module moves (with imports, paths, argv literals, scripts, docs, and
parents[N] formulas updated in lockstep):

- cli/deploy             -> cli/administration/deploy
- cli/validate/inventory -> cli/administration/inventory/validate
- cli/vault              -> cli/administration/secrets/vault
- cli/administration/inventory/encrypt -> cli/administration/secrets/seal
- cli/mirror             -> cli/contributing/mirror

The new cli/administration/secrets cluster collocates the whole-file
ansible-vault wrapper next to the inventory-aware per-field sealer.
The user-facing CLI subcommand paths follow the package layout, e.g.
"infinito administration deploy dedicated <inv>" and
"infinito administration inventory validate <inv>".

Help system redesign in cli/core/{discovery,help,app}.py:

- Discovery now distinguishes runnable commands (directories with
  __main__.py) from category folders (directories that only group
  further commands). Empty support packages are filtered out.
- Each category folder MAY carry a README.md; its H1 heading is used
  as the title and its first paragraph as the one-line description in
  the help output.
- "infinito" / "infinito --help" prints only the top-level entries
  (one level deep). "infinito <category>" navigates into a folder and
  shows its sub-folders and commands one level deep, with the README
  title as the page heading and the invocation as a dim subtitle.
- New "--tree [N]" flag walks the tree under the (optional) path
  prefix recursively. N caps the depth (1-based); omit N for an
  unbounded walk. The output uses Unicode tree connectors, an emoji
  per entry (folder for categories, gear for commands), a globally
  aligned description column, and multi-line wrapped descriptions
  with tree-continuity bars on continuation lines.
- Category and command listings use the full invocation
  ("infinito meta callorder") rather than the bare leaf name, so the
  output is copy-pasteable.

Convention doc + 17 CLI READMEs:

- New docs/contributing/artefact/files/cli/readme_md.md describes the
  H1+paragraph layout the help system reads, and how it differs from
  role/docs READMEs.
- README.md added for cli/{administration, build, contributing, meta}
  and their immediate sub-folders, plus cli/meta/roles/applications
  and its resolution sub-folder. Each follows the "title with trailing
  emoji + single descriptive paragraph" convention.

Mirror resolver/sync description strings (the help system reads them
from argparse --help output) added so they no longer surface as
"options:" in the global index. cli/mirror/cleanup already had a
description and is unchanged.

Fixes uncovered by the move:

- import unittest.mock added to four dedicated-deploy tests so
  unittest.mock.patch resolves under stdlib unittest discovery
  (Python 3.13 no longer surfaces unittest.mock through "import
  unittest" alone).
- parents[N] index in the new
  cli/administration/inventory/validate/__init__.py corrected from
  3 to 4 to match the deeper layout.
- test_paths.INVENTORY_VALIDATOR_PATH assertion and test_runner
  substring assertions updated to match the new validator path.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-08 20:17:09 +02:00

82 lines
2.0 KiB
Python

from __future__ import annotations
import argparse
import importlib
import importlib.util
import sys
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from collections.abc import Iterable
def _module_exists(fullname: str) -> bool:
return importlib.util.find_spec(fullname) is not None
def _try_import(fullname: str):
"""
Import module if it exists, else return None.
"""
if not _module_exists(fullname):
return None
return importlib.import_module(fullname)
def _iter_command_modules(base_pkg: str, names: Iterable[str]):
"""
Yield imported command modules that implement add_parser(sub).
"""
for name in names:
m = _try_import(f"{base_pkg}.{name}")
if m is None:
continue
if hasattr(m, "add_parser"):
yield name, m
def _build_parser(base_pkg: str) -> argparse.ArgumentParser:
p = argparse.ArgumentParser(
prog=f"python -m {base_pkg}",
description="Infinito.Nexus development compose stack helper.",
)
sub = p.add_subparsers(dest="command", required=True)
# Keep this list explicit (predictable UX), but tolerate missing modules.
command_names = [
"up",
"down",
"stop",
"restart",
"build",
"init",
"deploy",
"run",
"exec",
"logs",
]
for _, mod in _iter_command_modules(base_pkg, command_names):
mod.add_parser(sub)
return p
def main(argv: list[str] | None = None) -> int:
if argv is None:
argv = sys.argv[1:]
base_pkg = __package__ or "cli.administration.deploy.development"
parser = _build_parser(base_pkg)
args = parser.parse_args(argv)
handler = getattr(args, "_handler", None)
if handler is None:
# This should not happen if each subparser sets _handler, but keep it safe.
raise SystemExit(
f"Command '{getattr(args, 'command', '<unknown>')}' has no handler"
)
return int(handler(args))