dipo 0.2.0__py3-none-any.whl

dipo/__init__.py

@@ -0,0 +1,22 @@
+"""This module declares the project's CLI surface that lives above any one
+framework:
+
+  - `FRAMEWORKS`: dotted paths of framework modules (e.g. `dipo.rst`).
+     Each framework module exposes `PARSERS`, `PARSER_SCOPED_COMMANDS`,
+     and `GLOBAL_COMMANDS`. The dispatcher (`dipo/__main__.py`) imports
+     each and merges the three.
+  - `GLOBAL_COMMANDS`: `{cmd: module_path}` for project-level commands
+    that aren't owned by any single framework (e.g. `runs`, which walks
+    every framework's parser registry to tag rows by parser kind).
+
+To add a sibling framework, append its dotted path to `FRAMEWORKS` and
+give its `__init__.py` the three required attributes.
+"""
+
+__version__ = "0.2.0"
+
+FRAMEWORKS: list[str] = ["dipo.rst"]
+
+GLOBAL_COMMANDS: dict[str, str] = {
+    "runs": "dipo.runs",
+}

dipo/__main__.py

@@ -0,0 +1,103 @@
+"""dipo CLI dispatcher.
+
+`dipo <parser> <cmd>` or `dipo <cmd>` for globals. Routes by merging the
+registries declared by each framework in `dipo.FRAMEWORKS`. See
+`dipo/__init__.py` for the framework contract.
+"""
+
+import importlib
+import sys
+
+import dipo
+
+
+def _merge_frameworks() -> tuple[dict, dict, dict]:
+    """Merge each framework's three registry dicts atop project-level
+    `dipo.GLOBAL_COMMANDS`. Aborts on a name collision."""
+    parsers: dict = {}
+    parser_scoped: dict = {}
+    global_cmds: dict = dict(dipo.GLOBAL_COMMANDS)
+    for fw_path in dipo.FRAMEWORKS:
+        fw = importlib.import_module(fw_path)
+        _merge_no_collide(parsers, fw.PARSERS, fw_path, "parser name")
+        _merge_no_collide(parser_scoped, fw.PARSER_SCOPED_COMMANDS, fw_path, "parser-scoped command")
+        _merge_no_collide(global_cmds, fw.GLOBAL_COMMANDS, fw_path, "global command")
+    return parsers, parser_scoped, global_cmds
+
+
+def _merge_no_collide(dst: dict, src: dict, fw_path: str, kind: str) -> None:
+    for k, v in src.items():
+        if k in dst and dst[k] is not v:
+            sys.stderr.write(
+                f"dipo: {kind} {k!r} declared by both an earlier framework and {fw_path!r}. Rename one of them.\n"
+            )
+            sys.exit(2)
+        dst[k] = v
+
+
+PARSERS, PARSER_SCOPED_COMMANDS, GLOBAL_COMMANDS = _merge_frameworks()
+
+
+def main():
+    if len(sys.argv) > 1 and sys.argv[1] in ("-h", "--help"):
+        print(__doc__.strip())
+        print(f"\nKnown parsers: {', '.join(sorted(PARSERS))}")
+        print(f"Global commands: {', '.join(sorted(GLOBAL_COMMANDS))}")
+        sys.exit(0)
+
+    if len(sys.argv) < 2:
+        sys.stderr.write(__doc__.strip() + "\n\n")
+        sys.stderr.write(f"Known parsers: {', '.join(sorted(PARSERS))}\n")
+        sys.stderr.write(f"Global commands: {', '.join(sorted(GLOBAL_COMMANDS))}\n")
+        sys.exit(2)
+
+    head = sys.argv[1]
+
+    if head in GLOBAL_COMMANDS:
+        module = importlib.import_module(GLOBAL_COMMANDS[head])
+        sys.argv = [GLOBAL_COMMANDS[head]] + sys.argv[2:]
+        module.main()
+        return
+
+    if len(sys.argv) < 3:
+        sys.stderr.write(__doc__.strip() + "\n\n")
+        sys.stderr.write(f"Known parsers: {', '.join(sorted(PARSERS))}\n")
+        sys.exit(2)
+
+    parser_name = head
+    command = sys.argv[2]
+
+    if parser_name not in PARSERS:
+        sys.stderr.write(f"Unknown parser: {parser_name!r}\n")
+        sys.stderr.write(f"Known parsers: {', '.join(sorted(PARSERS))}\n")
+        sys.stderr.write(f"Global commands: {', '.join(sorted(GLOBAL_COMMANDS))}\n")
+        sys.exit(2)
+
+    if command in PARSER_SCOPED_COMMANDS:
+        shared_path = PARSER_SCOPED_COMMANDS[command]
+        module = importlib.import_module(shared_path)
+        sys.argv = [f"dipo {parser_name} {command}"] + sys.argv[3:]
+        module.main(parser_kind=parser_name)
+        return
+
+    module_path = f"{PARSERS[parser_name].package}.{command}_{parser_name}"
+    try:
+        module = importlib.import_module(module_path)
+    except ImportError as e:
+        sys.stderr.write(f"No such command {command!r} for parser {parser_name!r}\n")
+        sys.stderr.write(f"  (tried to import {module_path}: {e})\n")
+        sys.exit(2)
+
+    sys.argv = [module_path] + sys.argv[3:]
+    module.main()
+
+
+def main_iudex():
+    """Entry point of the deprecated `iudex` command, the old name of this project."""
+    sys.stderr.write("iudex: this command has been renamed to `dipo` and takes the same arguments. "
+                     "`iudex` will be removed in a future release.\n")
+    main()
+
+
+if __name__ == "__main__":
+    main()

dipo/common/log.py

@@ -0,0 +1,65 @@
+"""Rich-based logging and console helpers."""
+
+import logging
+import os
+
+from rich.console import Console
+from rich.logging import RichHandler
+from rich.theme import Theme
+
+theme = Theme(
+    {
+        "info": "cyan",
+        "warning": "yellow",
+        "error": "bold red",
+        "metric": "bold green",
+        "metric.name": "dim",
+        "epoch": "bold magenta",
+        "step": "dim cyan",
+        "lr": "dim yellow",
+        "loss": "bold orange1",
+        "gpu": "bold green",
+        "path": "underline blue",
+    }
+)
+
+console = Console(theme=theme)
+
+
+def success(msg: str) -> None:
+    console.print(f"[bold green]{msg}[/bold green]")
+
+
+def warn(msg: str) -> None:
+    console.print(f"[bold yellow]{msg}[/bold yellow]")
+
+
+def dim(msg: str) -> None:
+    console.print(f"[dim]{msg}[/dim]")
+
+
+def rule(title: str) -> None:
+    console.rule(f"[bold magenta]{title}[/bold magenta]")
+
+
+def wrote(path: str) -> None:
+    """Announce a file the program just wrote, with its absolute path."""
+    console.print(f"[dim]Wrote[/dim] [path]{os.path.abspath(path)}[/path]")
+
+
+def setup_logging(level: int = logging.INFO) -> None:
+    logging.basicConfig(
+        level=level,
+        format="%(message)s",
+        datefmt="[%X]",
+        handlers=[
+            RichHandler(
+                console=console,
+                rich_tracebacks=True,
+                tracebacks_show_locals=True,
+                show_path=False,
+                markup=True,
+            )
+        ],
+        force=True,
+    )