hydraflow 0.10.1__tar.gz → 0.10.2__tar.gz

{hydraflow-0.10.1 → hydraflow-0.10.2}/.gitignore

@@ -1,5 +1,5 @@
 *.db
-.coverage
+.coverage*
 .env
 .venv/
 __pycache__/

{hydraflow-0.10.1 → hydraflow-0.10.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hydraflow
-Version: 0.10.1
+Version: 0.10.2
 Summary: Hydraflow integrates Hydra and MLflow to manage and track machine learning experiments.
 Project-URL: Documentation, https://daizutabi.github.io/hydraflow/
 Project-URL: Source, https://github.com/daizutabi/hydraflow

{hydraflow-0.10.1 → hydraflow-0.10.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "hydraflow"
-version = "0.10.1"
+version = "0.10.2"
 description = "Hydraflow integrates Hydra and MLflow to manage and track machine learning experiments."
 readme = "README.md"
 license = { file = "LICENSE" }

{hydraflow-0.10.1 → hydraflow-0.10.2}/src/hydraflow/cli.py

@@ -2,54 +2,53 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Annotated
+from typing import Annotated
 
 import typer
 from rich.console import Console
 from typer import Argument, Option
 
-from hydraflow.executor.io import load_config
-
-if TYPE_CHECKING:
-    from hydraflow.executor.job import Job
+from hydraflow.executor.io import get_job, load_config
 
 app = typer.Typer(add_completion=False)
 console = Console()
 
 
-def get_job(name: str) -> Job:
-    cfg = load_config()
-    job = cfg.jobs[name]
-
-    if not job.name:
-        job.name = name
-
-    return job
-
-
 @app.command()
 def run(
     name: Annotated[str, Argument(help="Job name.", show_default=False)],
+    *,
+    dry_run: Annotated[
+        bool,
+        Option("--dry-run", help="Perform a dry run"),
+    ] = False,
 ) -> None:
     """Run a job."""
     import mlflow
 
-    from hydraflow.executor.job import multirun
+    from hydraflow.executor.job import multirun, to_text
 
     job = get_job(name)
-    mlflow.set_experiment(job.name)
-    multirun(job)
+    if dry_run:
+        typer.echo(to_text(job))
+    else:
+        mlflow.set_experiment(job.name)
+        multirun(job)
 
 
 @app.command()
 def show(
-    name: Annotated[str, Argument(help="Job name.", show_default=False)],
+    name: Annotated[str, Argument(help="Job name.", show_default=False)] = "",
 ) -> None:
-    """Show a job."""
-    from hydraflow.executor.job import show
+    """Show the hydraflow config."""
+    from omegaconf import OmegaConf
 
-    job = get_job(name)
-    show(job)
+    if name:
+        cfg = get_job(name)
+    else:
+        cfg = load_config()
+
+    typer.echo(OmegaConf.to_yaml(cfg))
 
 
 @app.callback(invoke_without_command=True)

{hydraflow-0.10.1 → hydraflow-0.10.2}/src/hydraflow/executor/io.py

@@ -3,11 +3,15 @@
 from __future__ import annotations
 
 from pathlib import Path
+from typing import TYPE_CHECKING
 
 from omegaconf import OmegaConf
 
 from .conf import HydraflowConf
 
+if TYPE_CHECKING:
+    from .job import Job
+
 
 def find_config_file() -> Path | None:
     """Find the hydraflow config file."""
@@ -32,3 +36,14 @@ def load_config() -> HydraflowConf:
     cfg = OmegaConf.load(path)
 
     return OmegaConf.merge(schema, cfg)  # type: ignore
+
+
+def get_job(name: str) -> Job:
+    """Get a job from the config."""
+    cfg = load_config()
+    job = cfg.jobs[name]
+
+    if not job.name:
+        job.name = name
+
+    return job

{hydraflow-0.10.1 → hydraflow-0.10.2}/src/hydraflow/executor/job.py

@@ -20,6 +20,7 @@ from __future__ import annotations
 import importlib
 import shlex
 import subprocess
+import sys
 from subprocess import CalledProcessError
 from typing import TYPE_CHECKING
 
@@ -99,6 +100,8 @@ def multirun(job: Job) -> None:
 
     if job.run:
         base_cmds = shlex.split(job.run)
+        if base_cmds[0] == "python" and sys.platform == "win32":
+            base_cmds[0] = sys.executable
 
         for args in it:
             cmds = [*base_cmds, *args]
@@ -132,24 +135,31 @@ def multirun(job: Job) -> None:
                 raise RuntimeError(msg) from e
 
 
-def show(job: Job) -> None:
-    """Show the job configuration.
+def to_text(job: Job) -> str:
+    """Convert the job configuration to a string.
 
-    This function shows the job configuration for a given job.
+    This function returns the job configuration for a given job.
 
     Args:
         job (Job): The job configuration to show.
 
+    Returns:
+        str: The job configuration.
+
     """
+    text = ""
+
     it = iter_batches(job)
 
     if job.run:
         base_cmds = shlex.split(job.run)
         for args in it:
             cmds = " ".join([*base_cmds, *args])
-            print(cmds)  # noqa: T201
+            text += f"{cmds}\n"
 
     elif job.call:
-        print(f"call: {job.call}")  # noqa: T201
+        text = f"call: {job.call}\n"
         for args in it:
-            print(f"args: {args}")  # noqa: T201
+            text += f"args: {args}\n"
+
+    return text

hydraflow-0.10.2/tests/cli/test_run.py

@@ -0,0 +1,41 @@
+import pytest
+from typer.testing import CliRunner
+
+import hydraflow
+from hydraflow.cli import app
+
+pytestmark = pytest.mark.xdist_group(name="group1")
+
+runner = CliRunner()
+
+
+def test_run_args():
+    result = runner.invoke(app, ["run", "args"])
+    assert result.exit_code == 0
+    run_ids = hydraflow.list_run_ids("args")
+    assert len(run_ids) == 12
+
+
+def test_run_batch():
+    result = runner.invoke(app, ["run", "batch"])
+    assert result.exit_code == 0
+    run_ids = hydraflow.list_run_ids("batch")
+    assert len(run_ids) == 8
+
+
+def test_run_args_dry_run():
+    result = runner.invoke(app, ["run", "args", "--dry-run"])
+    assert result.exit_code == 0
+    assert "hydra.job.name=args" in result.stdout
+    assert "count=1,2,3 name=a,b" in result.stdout
+    assert "count=4,5,6 name=c,d" in result.stdout
+
+
+def test_run_batch_dry_run():
+    result = runner.invoke(app, ["run", "batch", "--dry-run"])
+    assert result.exit_code == 0
+    assert "hydra.job.name=batch" in result.stdout
+    assert "count=1,2 name=a" in result.stdout
+    assert "count=1,2 name=b" in result.stdout
+    assert "count=100 name=c,d" in result.stdout
+    assert "count=100 name=e,f" in result.stdout

hydraflow-0.10.2/tests/cli/test_show.py

@@ -0,0 +1,18 @@
+from typer.testing import CliRunner
+
+from hydraflow.cli import app
+
+runner = CliRunner()
+
+
+def test_show():
+    result = runner.invoke(app, ["show"])
+    assert result.exit_code == 0
+    assert "jobs:\n" in result.stdout
+    assert "  args:\n" in result.stdout
+
+
+def test_show_job():
+    result = runner.invoke(app, ["show", "args"])
+    assert result.exit_code == 0
+    assert "name: args\n" in result.stdout

{hydraflow-0.10.1 → hydraflow-0.10.2}/tests/executor/test_job.py

@@ -71,17 +71,13 @@ def test_sweep_args(batches, i, x):
     assert batches[i][-2] == x
 
 
-@pytest.mark.skipif(
-    sys.platform == "win32",
-    reason="Windows does not support this test",
-)
 def test_multirun_run(job: Job, tmp_path: Path):
     from hydraflow.executor.job import multirun
 
     path = tmp_path / "output.txt"
     file = Path(__file__).parent / "echo.py"
 
-    job.run = f"{sys.executable} {file.as_posix()} {path.as_posix()}"
+    job.run = f"python {file.as_posix()} {path.as_posix()}"
     multirun(job)
     assert path.read_text() == "a=1,2 b=5 a=1,2 b=6 a=3,4 c=7 a=3,4 c=8"
 
@@ -89,7 +85,7 @@ def test_multirun_run(job: Job, tmp_path: Path):
 def test_multirun_run_error(job: Job):
     from hydraflow.executor.job import multirun
 
-    job.run = "false"
+    job.run = "cmd /c exit 1" if sys.platform == "win32" else "false"
     with pytest.raises(RuntimeError):
         multirun(job)
 
@@ -137,11 +133,10 @@ def test_multirun_call_not_found(job: Job):
         multirun(job)
 
 
-def test_show(job: Job, capsys):
-    from hydraflow.executor.job import show
+def test_to_text(job: Job):
+    from hydraflow.executor.job import to_text
 
     job.call = "typer.echo"
-    show(job)
-    out, _ = capsys.readouterr()
-    assert "call: typer.echo\n" in out
-    assert "'hydra.job.name=test', 'a=3,4', 'c=8']" in out
+    text = to_text(job)
+    assert "call: typer.echo\n" in text
+    assert "'hydra.job.name=test', 'a=3,4', 'c=8']" in text

hydraflow-0.10.1/tests/cli/test_run.py

@@ -1,33 +0,0 @@
-import sys
-
-import pytest
-from typer.testing import CliRunner
-
-import hydraflow
-from hydraflow.cli import app
-
-pytestmark = pytest.mark.xdist_group(name="group1")
-
-runner = CliRunner()
-
-
-@pytest.mark.skipif(
-    sys.platform == "win32",
-    reason="Windows does not support this test",
-)
-def test_run_args():
-    result = runner.invoke(app, ["run", "args"])
-    assert result.exit_code == 0
-    run_ids = hydraflow.list_run_ids("args")
-    assert len(run_ids) == 12
-
-
-@pytest.mark.skipif(
-    sys.platform == "win32",
-    reason="Windows does not support this test",
-)
-def test_run_batch():
-    result = runner.invoke(app, ["run", "batch"])
-    assert result.exit_code == 0
-    run_ids = hydraflow.list_run_ids("batch")
-    assert len(run_ids) == 8

hydraflow-0.10.1/tests/cli/test_show.py

@@ -1,23 +0,0 @@
-from typer.testing import CliRunner
-
-from hydraflow.cli import app
-
-runner = CliRunner()
-
-
-def test_show_args():
-    result = runner.invoke(app, ["show", "args"])
-    assert result.exit_code == 0
-    assert "hydra.job.name=args" in result.stdout
-    assert "count=1,2,3 name=a,b" in result.stdout
-    assert "count=4,5,6 name=c,d" in result.stdout
-
-
-def test_show_batch():
-    result = runner.invoke(app, ["show", "batch"])
-    assert result.exit_code == 0
-    assert "hydra.job.name=batch" in result.stdout
-    assert "count=1,2 name=a" in result.stdout
-    assert "count=1,2 name=b" in result.stdout
-    assert "count=100 name=c,d" in result.stdout
-    assert "count=100 name=e,f" in result.stdout