New cli module

hydraflow.yaml

@@ -0,0 +1,5 @@
+a:
+  b: [1, 2]
+  c.d: 3m
+  c.e/3: 4
+  e: true

pyproject.toml

@@ -19,19 +19,23 @@ classifiers = [
   "Programming Language :: Python :: 3.13",
 ]
 requires-python = ">=3.10"
-dependencies = ["hydra-core>=1.3", "mlflow>=2.15"]
+dependencies = ["hydra-core>=1.3", "mlflow>=2.15", "omegaconf", "rich", "typer"]
 
 [project.urls]
 Documentation = "https://daizutabi.github.io/hydraflow/"
 Source = "https://github.com/daizutabi/hydraflow"
 Issues = "https://github.com/daizutabi/hydraflow/issues"
 
+[project.scripts]
+hydraflow = "hydraflow.cli:app"
+
 [tool.uv]
 dev-dependencies = [
   "markdown-exec[ansi]",
   "mkapi",
   "mkdocs-material",
   "mkdocs>=1.6",
+  "pytest-clarity",
   "pytest-cov",
   "pytest-order",
   "pytest-randomly",
@@ -98,3 +102,4 @@ ignore = [
 ]
 "apps/*.py" = ["D", "G", "INP"]
 "src/hydraflow/main.py" = ["ANN201", "D401", "PLR0913"]
+"src/hydraflow/cli.py" = ["ANN", "D"]

src/hydraflow/cli.py

@@ -0,0 +1,75 @@
+"""Hydraflow CLI."""
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Annotated
+
+import typer
+from omegaconf import DictConfig, OmegaConf
+from rich.console import Console
+from typer import Argument, Option
+
+app = typer.Typer(add_completion=False)
+console = Console()
+
+
+@app.command()
+def run(
+    names: Annotated[
+        list[str] | None,
+        Argument(help="Job names.", show_default=False),
+    ] = None,
+) -> None:
+    """Run jobs."""
+    typer.echo(names)
+
+    cfg = load_config()
+    typer.echo(cfg)
+
+
+@app.command()
+def show() -> None:
+    """Show the config."""
+    from rich.syntax import Syntax
+
+    cfg = load_config()
+    code = OmegaConf.to_yaml(cfg)
+    syntax = Syntax(code, "yaml")
+    console.print(syntax)
+
+
+@app.callback(invoke_without_command=True)
+def callback(
+    *,
+    version: Annotated[
+        bool,
+        Option("--version", help="Show the version and exit."),
+    ] = False,
+) -> None:
+    if version:
+        import importlib.metadata
+
+        typer.echo(f"hydraflow {importlib.metadata.version('hydraflow')}")
+        raise typer.Exit
+
+
+def find_config() -> Path:
+    if Path("hydraflow.yaml").exists():
+        return Path("hydraflow.yaml")
+
+    if Path("hydraflow.yml").exists():
+        return Path("hydraflow.yml")
+
+    typer.echo("No config file found.")
+    raise typer.Exit(code=1)
+
+
+def load_config() -> DictConfig:
+    cfg = OmegaConf.load(find_config())
+
+    if isinstance(cfg, DictConfig):
+        return cfg
+
+    typer.echo("Invalid config file.")
+    raise typer.Exit(code=1)

tests/cli/conftest.py

@@ -0,0 +1,9 @@
+from pathlib import Path
+
+import pytest
+
+
+@pytest.fixture(autouse=True)
+def setup(monkeypatch: pytest.MonkeyPatch, tmp_path: Path):
+    monkeypatch.chdir(tmp_path)
+    yield

tests/cli/test_run.py

@@ -0,0 +1,18 @@
+from pathlib import Path
+
+from typer.testing import CliRunner
+
+from hydraflow.cli import app
+
+runner = CliRunner()
+
+
+def test_invoke_error():
+    result = runner.invoke(app, ["run"])
+    assert result.exit_code == 1
+
+
+def test_invoke():
+    Path("hydraflow.yaml").write_text("a:\n b: [1, 2]")
+    result = runner.invoke(app, ["run"])
+    assert result.exit_code == 0

tests/cli/test_show.py

@@ -0,0 +1,54 @@
+from pathlib import Path
+
+import pytest
+import typer
+from typer.testing import CliRunner
+
+from hydraflow.cli import app
+
+runner = CliRunner()
+
+
+@pytest.mark.parametrize("file", ["hydraflow.yaml", "hydraflow.yml"])
+def test_find_config(file):
+    from hydraflow.cli import find_config
+
+    Path(file).touch()
+    assert find_config() == Path(file)
+
+
+def test_find_config_error():
+    from hydraflow.cli import find_config
+
+    with pytest.raises(typer.Exit):
+        find_config()
+
+
+def test_load_config():
+    from hydraflow.cli import load_config
+
+    Path("hydraflow.yaml").write_text("a:\n b: 1")
+    cfg = load_config()
+    assert cfg["a"]["b"] == 1
+
+
+def test_load_config_error():
+    from hydraflow.cli import load_config
+
+    Path("hydraflow.yml").write_text("- 1\n- 2")
+
+    with pytest.raises(typer.Exit):
+        load_config()
+
+
+def test_invoke_error():
+    result = runner.invoke(app, ["show"])
+    assert result.exit_code == 1
+
+
+def test_invoke():
+    Path("hydraflow.yaml").write_text("a:\n b: [1, 2]")
+    result = runner.invoke(app, ["show"])
+    assert result.exit_code == 0
+    assert "a:" in result.stdout
+    assert "- 1" in result.stdout

tests/cli/test_version.py

@@ -0,0 +1,20 @@
+import subprocess
+
+from typer.testing import CliRunner
+
+from hydraflow.cli import app
+
+runner = CliRunner()
+
+
+def test_invoke():
+    result = runner.invoke(app, ["--version"])
+    assert result.exit_code == 0
+    assert "hydraflow" in result.stdout
+    assert result.stdout.count(".") == 2
+
+
+def test_command():
+    out = subprocess.check_output(["hydraflow", "--version"], text=True)
+    assert "hydraflow" in out
+    assert out.count(".") == 2