mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-06 19:01:54 +00:00
97 lines
2.6 KiB
Python
97 lines
2.6 KiB
Python
from __future__ import annotations
|
|
|
|
import os
|
|
from dataclasses import dataclass
|
|
from pathlib import Path
|
|
from typing import List, Tuple
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class Command:
|
|
"""
|
|
A CLI command is a Python package directory under cli/ that contains __main__.py.
|
|
|
|
Example:
|
|
cli/build/tree/__main__.py -> parts=("build","tree"), module="cli.build.tree"
|
|
"""
|
|
|
|
parts: Tuple[str, ...] # relative path parts under cli/
|
|
module: str # python -m module
|
|
main_path: Path # filesystem path to __main__.py
|
|
|
|
@property
|
|
def folder(self) -> str | None:
|
|
if len(self.parts) <= 1:
|
|
return None
|
|
return "/".join(self.parts[:-1])
|
|
|
|
@property
|
|
def name(self) -> str:
|
|
return self.parts[-1]
|
|
|
|
@property
|
|
def subcommand(self) -> str:
|
|
return " ".join(self.parts)
|
|
|
|
|
|
def _is_valid_package_dir(path: Path) -> bool:
|
|
if not path.is_dir():
|
|
return False
|
|
if path.name == "__pycache__":
|
|
return False
|
|
return True
|
|
|
|
|
|
def discover_commands(cli_dir: Path) -> List[Command]:
|
|
"""
|
|
Recursively find all packages under cli_dir that contain __main__.py.
|
|
"""
|
|
commands: List[Command] = []
|
|
|
|
for root, dirnames, filenames in os.walk(cli_dir):
|
|
# prune __pycache__ eagerly
|
|
dirnames[:] = [d for d in dirnames if d != "__pycache__"]
|
|
|
|
if "__main__.py" not in filenames:
|
|
continue
|
|
|
|
root_path = Path(root)
|
|
if not _is_valid_package_dir(root_path):
|
|
continue
|
|
|
|
rel = root_path.relative_to(cli_dir)
|
|
if rel.parts == ():
|
|
# cli/ itself is NOT a command; cli/__main__.py is the dispatcher
|
|
continue
|
|
|
|
parts = tuple(rel.parts)
|
|
module = "cli." + ".".join(parts)
|
|
commands.append(
|
|
Command(parts=parts, module=module, main_path=root_path / "__main__.py")
|
|
)
|
|
|
|
commands.sort(key=lambda c: (c.folder or "", c.name))
|
|
return commands
|
|
|
|
|
|
def resolve_command_module(
|
|
cli_dir: Path, argv_parts: List[str]
|
|
) -> tuple[str | None, List[str]]:
|
|
"""
|
|
Resolve the longest argv prefix that matches a discovered command module.
|
|
|
|
Returns:
|
|
(module, remaining_args)
|
|
|
|
Example:
|
|
argv_parts=["deploy","container","--foo","bar"]
|
|
-> ("cli.deploy.container", ["--foo","bar"])
|
|
"""
|
|
# We resolve by checking for cli/<prefix>/__main__.py existing.
|
|
for n in range(len(argv_parts), 0, -1):
|
|
candidate_dir = cli_dir.joinpath(*argv_parts[:n])
|
|
if candidate_dir.is_dir() and (candidate_dir / "__main__.py").is_file():
|
|
module = "cli." + ".".join(argv_parts[:n])
|
|
return module, argv_parts[n:]
|
|
return None, argv_parts
|