hydraflow 0.2.15__tar.gz → 0.2.17__tar.gz

{hydraflow-0.2.15 → hydraflow-0.2.17}/.gitignore

@@ -3,4 +3,5 @@
 .venv/
 __pycache__/
 dist/
-lcov.info
+lcov.info
+uv.lock

{hydraflow-0.2.15 → hydraflow-0.2.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: hydraflow
-Version: 0.2.15
+Version: 0.2.17
 Summary: Hydraflow integrates Hydra and MLflow to manage and track machine learning experiments.
 Project-URL: Documentation, https://github.com/daizutabi/hydraflow
 Project-URL: Source, https://github.com/daizutabi/hydraflow
@@ -14,19 +14,12 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.10
-Requires-Dist: hydra-core>1.3
+Requires-Dist: hydra-core>=1.3
 Requires-Dist: joblib
-Requires-Dist: mlflow>2.15
+Requires-Dist: mlflow>=2.15
 Requires-Dist: rich
-Requires-Dist: setuptools
 Requires-Dist: watchdog
 Requires-Dist: watchfiles
-Provides-Extra: dev
-Requires-Dist: pytest-asyncio; extra == 'dev'
-Requires-Dist: pytest-clarity; extra == 'dev'
-Requires-Dist: pytest-cov; extra == 'dev'
-Requires-Dist: pytest-randomly; extra == 'dev'
-Requires-Dist: pytest-xdist; extra == 'dev'
 Description-Content-Type: text/markdown
 
 # Hydraflow

{hydraflow-0.2.15 → hydraflow-0.2.17}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "hydraflow"
-version = "0.2.15"
+version = "0.2.17"
 description = "Hydraflow integrates Hydra and MLflow to manage and track machine learning experiments."
 readme = "README.md"
 license = "MIT"
@@ -18,29 +18,29 @@ classifiers = [
 ]
 requires-python = ">=3.10"
 dependencies = [
-  "hydra-core>1.3",
+  "hydra-core>=1.3",
   "joblib",
-  "mlflow>2.15",
+  "mlflow>=2.15",
   "rich",
-  "setuptools",
   "watchdog",
   "watchfiles",
 ]
 
-[project.optional-dependencies]
-dev = [
+[project.urls]
+Documentation = "https://github.com/daizutabi/hydraflow"
+Source = "https://github.com/daizutabi/hydraflow"
+Issues = "https://github.com/daizutabi/hydraflow/issues"
+
+[tool.uv]
+dev-dependencies = [
   "pytest-asyncio",
   "pytest-clarity",
   "pytest-cov",
   "pytest-randomly",
   "pytest-xdist",
+  "ruff",
 ]
 
-[project.urls]
-Documentation = "https://github.com/daizutabi/hydraflow"
-Source = "https://github.com/daizutabi/hydraflow"
-Issues = "https://github.com/daizutabi/hydraflow/issues"
-
 [tool.hatch.build.targets.sdist]
 exclude = ["/.github", "/docs"]
 
@@ -62,7 +62,22 @@ exclude_lines = ["no cov", "raise NotImplementedError", "if TYPE_CHECKING:"]
 
 [tool.ruff]
 line-length = 88
-target-version = "py312"
+target-version = "py310"
 
 [tool.ruff.lint]
-unfixable = ["F401", "RUF100"]
+select = ["ALL"]
+unfixable = ["F401"]
+ignore = [
+  "ANN003",
+  "ANN401",
+  "ARG002",
+  "B904",
+  "D",
+  "EM101",
+  "PGH003",
+  "TRY003",
+]
+exclude = ["tests/scripts/*.py"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["A001", "ANN", "ARG", "FBT", "PLR", "PT", "S", "SIM117", "SLF"]

{hydraflow-0.2.15 → hydraflow-0.2.17}/src/hydraflow/asyncio.py

@@ -42,7 +42,10 @@ async def execute_command(
     """
     try:
         process = await asyncio.create_subprocess_exec(
-            program, *args, stdout=PIPE, stderr=PIPE
+            program,
+            *args,
+            stdout=PIPE,
+            stderr=PIPE,
         )
         await asyncio.gather(
             process_stream(process.stdout, stdout),
@@ -51,7 +54,8 @@ async def execute_command(
         returncode = await process.wait()
 
     except Exception as e:
-        logger.error(f"Error running command: {e}")
+        msg = f"Error running command: {e}"
+        logger.exception(msg)
         returncode = 1
 
     finally:
@@ -103,11 +107,15 @@ async def monitor_file_changes(
     str_paths = [str(path) for path in paths]
     try:
         async for changes in watchfiles.awatch(
-            *str_paths, stop_event=stop_event, **awatch_kwargs
+            *str_paths,
+            stop_event=stop_event,
+            **awatch_kwargs,
         ):
             callback(changes)
     except Exception as e:
-        logger.error(f"Error watching files: {e}")
+        msg = f"Error watching files: {e}"
+        logger.exception(msg)
+        raise
 
 
 async def run_and_monitor(
@@ -134,13 +142,16 @@ async def run_and_monitor(
     stop_event = asyncio.Event()
     run_task = asyncio.create_task(
         execute_command(
-            program, *args, stop_event=stop_event, stdout=stdout, stderr=stderr
-        )
+            program,
+            *args,
+            stop_event=stop_event,
+            stdout=stdout,
+            stderr=stderr,
+        ),
     )
     if watch and paths:
-        monitor_task = asyncio.create_task(
-            monitor_file_changes(paths, watch, stop_event, **awatch_kwargs)
-        )
+        coro = monitor_file_changes(paths, watch, stop_event, **awatch_kwargs)
+        monitor_task = asyncio.create_task(coro)
     else:
         monitor_task = None
 
@@ -151,7 +162,10 @@ async def run_and_monitor(
             await run_task
 
     except Exception as e:
-        logger.error(f"Error in run_and_monitor: {e}")
+        msg = f"Error in run_and_monitor: {e}"
+        logger.exception(msg)
+        raise
+
     finally:
         stop_event.set()
         await run_task
@@ -173,18 +187,24 @@ def run(
     """
     Run a command synchronously and optionally watch for file changes.
 
-    This function is a synchronous wrapper around the asynchronous `run_and_monitor` function.
-    It runs a specified command and optionally monitors specified paths for file changes,
-    invoking the provided callbacks for standard output, standard error, and file changes.
+    This function is a synchronous wrapper around the asynchronous
+    `run_and_monitor` function. It runs a specified command and optionally
+    monitors specified paths for file changes, invoking the provided callbacks for
+    standard output, standard error, and file changes.
 
     Args:
         program (str): The program to run.
         *args (str): Arguments for the program.
-        stdout (Callable[[str], None] | None): Callback for handling standard output lines.
-        stderr (Callable[[str], None] | None): Callback for handling standard error lines.
-        watch (Callable[[set[tuple[Change, str]]], None] | None): Callback for handling file changes.
-        paths (list[str | Path] | None): List of paths to monitor for file changes.
-        **awatch_kwargs: Additional keyword arguments to pass to `watchfiles.awatch`.
+        stdout (Callable[[str], None] | None): Callback for handling standard
+            output lines.
+        stderr (Callable[[str], None] | None): Callback for handling standard
+            error lines.
+        watch (Callable[[set[tuple[Change, str]]], None] | None): Callback for
+            handling file changes.
+        paths (list[str | Path] | None): List of paths to monitor for file
+            changes.
+        **awatch_kwargs: Additional keyword arguments to pass to
+            `watchfiles.awatch`.
 
     Returns:
         int: The return code of the process.
@@ -201,5 +221,5 @@ def run(
             watch=watch,
             paths=paths,
             **awatch_kwargs,
-        )
+        ),
     )

{hydraflow-0.2.15 → hydraflow-0.2.17}/src/hydraflow/config.py

@@ -33,7 +33,7 @@ def iter_params(config: object, prefix: str = "") -> Iterator[tuple[str, Any]]:
     if config is None:
         return
 
-    if not isinstance(config, (DictConfig, ListConfig)):
+    if not isinstance(config, DictConfig | ListConfig):
         config = OmegaConf.create(config)  # type: ignore
 
     yield from _iter_params(config, prefix)
@@ -62,8 +62,8 @@ def _is_param(value: object) -> bool:
     if isinstance(value, DictConfig):
         return False
 
-    if isinstance(value, ListConfig):
-        if any(isinstance(v, (DictConfig, ListConfig)) for v in value):
+    if isinstance(value, ListConfig):  # noqa: SIM102
+        if any(isinstance(v, DictConfig | ListConfig) for v in value):
             return False
 
     return True

{hydraflow-0.2.15 → hydraflow-0.2.17}/src/hydraflow/context.py

@@ -75,7 +75,8 @@ def log_run(
             yield
 
     except Exception as e:
-        log.error(f"Error during log_run: {e}")
+        msg = f"Error during log_run: {e}"
+        log.exception(msg)
         raise
 
     finally:
@@ -84,7 +85,7 @@ def log_run(
 
 
 @contextmanager
-def start_run(
+def start_run(  # noqa: PLR0913
     config: object,
     *,
     run_id: str | None = None,
@@ -112,8 +113,10 @@ def start_run(
         parent_run_id (str | None): The parent run ID. Defaults to None.
         tags (dict[str, str] | None): Tags to associate with the run. Defaults to None.
         description (str | None): A description of the run. Defaults to None.
-        log_system_metrics (bool | None): Whether to log system metrics. Defaults to None.
-        synchronous (bool | None): Whether to log parameters synchronously. Defaults to None.
+        log_system_metrics (bool | None): Whether to log system metrics.
+            Defaults to None.
+        synchronous (bool | None): Whether to log parameters synchronously.
+            Defaults to None.
 
     Yields:
         Run: An MLflow Run object representing the started run.
@@ -128,24 +131,27 @@ def start_run(
         - `log_run`: A context manager to log parameters and manage the MLflow
            run context.
     """
-    with mlflow.start_run(
-        run_id=run_id,
-        experiment_id=experiment_id,
-        run_name=run_name,
-        nested=nested,
-        parent_run_id=parent_run_id,
-        tags=tags,
-        description=description,
-        log_system_metrics=log_system_metrics,
-    ) as run:
-        with log_run(config, synchronous=synchronous):
-            yield run
+    with (
+        mlflow.start_run(
+            run_id=run_id,
+            experiment_id=experiment_id,
+            run_name=run_name,
+            nested=nested,
+            parent_run_id=parent_run_id,
+            tags=tags,
+            description=description,
+            log_system_metrics=log_system_metrics,
+        ) as run,
+        log_run(config, synchronous=synchronous),
+    ):
+        yield run
 
 
 @contextmanager
 def watch(
     callback: Callable[[Path], None],
-    dir: Path | str = "",
+    dir: Path | str = "",  # noqa: A002
+    *,
     timeout: int = 60,
     ignore_patterns: list[str] | None = None,
     ignore_log: bool = True,
@@ -178,9 +184,9 @@ def watch(
             pass
         ```
     """
-    dir = dir or get_artifact_dir()
+    dir = dir or get_artifact_dir()  # noqa: A001
     if isinstance(dir, Path):
-        dir = dir.as_posix()
+        dir = dir.as_posix()  # noqa: A001
 
     handler = Handler(callback, ignore_patterns=ignore_patterns, ignore_log=ignore_log)
     observer = Observer()
@@ -191,7 +197,8 @@ def watch(
         yield
 
     except Exception as e:
-        log.error(f"Error during watch: {e}")
+        msg = f"Error during watch: {e}"
+        log.exception(msg)
         raise
 
     finally:
@@ -210,6 +217,7 @@ class Handler(PatternMatchingEventHandler):
     def __init__(
         self,
         func: Callable[[Path], None],
+        *,
         ignore_patterns: list[str] | None = None,
         ignore_log: bool = True,
     ) -> None:

{hydraflow-0.2.15 → hydraflow-0.2.17}/src/hydraflow/info.py

@@ -15,7 +15,7 @@ if TYPE_CHECKING:
 
 
 class RunCollectionInfo:
-    def __init__(self, runs: RunCollection):
+    def __init__(self, runs: RunCollection) -> None:
         self._runs = runs
 
     @property

{hydraflow-0.2.15 → hydraflow-0.2.17}/src/hydraflow/mlflow.py

@@ -81,7 +81,8 @@ def log_params(config: object, *, synchronous: bool | None = None) -> None:
         mlflow.log_param(key, value, synchronous=synchronous)
 
 
-def search_runs(
+def search_runs(  # noqa: PLR0913
+    *,
     experiment_ids: list[str] | None = None,
     filter_string: str = "",
     run_view_type: int = ViewType.ACTIVE_ONLY,
@@ -148,7 +149,8 @@ def search_runs(
 
 
 def list_runs(
-    experiment_names: str | list[str] | None = None, n_jobs: int = 0
+    experiment_names: str | list[str] | None = None,
+    n_jobs: int = 0,
 ) -> RunCollection:
     """
     List all runs for the specified experiments.

hydraflow-0.2.17/src/hydraflow/param.py

@@ -0,0 +1,64 @@
+from __future__ import annotations
+
+from typing import Any
+
+
+def match(param: str, value: Any) -> bool:
+    """Check if the string matches the specified value.
+
+    Args:
+        param (str): The parameter to check.
+        value (Any): The value to check.
+
+    Returns:
+        True if the parameter matches the specified value,
+        False otherwise.
+    """
+    if value in [None, True, False]:
+        return param == str(value)
+
+    if isinstance(value, list) and (m := _match_list(param, value)) is not None:
+        return m
+
+    if isinstance(value, tuple) and (m := _match_tuple(param, value)) is not None:
+        return m
+
+    if isinstance(value, int | float | str):
+        return type(value)(param) == value
+
+    return param == str(value)
+
+
+def _match_list(param: str, value: list) -> bool | None:
+    if not value:
+        return None
+
+    if any(param.startswith(x) for x in ["[", "(", "{"]):
+        return None
+
+    if isinstance(value[0], bool):
+        return None
+
+    if not isinstance(value[0], int | float | str):
+        return None
+
+    return type(value[0])(param) in value
+
+
+def _match_tuple(param: str, value: tuple) -> bool | None:
+    if len(value) != 2:  # noqa: PLR2004
+        return None
+
+    if any(param.startswith(x) for x in ["[", "(", "{"]):
+        return None
+
+    if isinstance(value[0], bool):
+        return None
+
+    if not isinstance(value[0], int | float | str):
+        return None
+
+    if type(value[0]) is not type(value[1]):
+        return None
+
+    return value[0] <= type(value[0])(param) < value[1]  # type: ignore

{hydraflow-0.2.15 → hydraflow-0.2.17}/src/hydraflow/progress.py

@@ -31,7 +31,7 @@ if TYPE_CHECKING:
 
 # https://github.com/jonghwanhyeon/joblib-progress/blob/main/joblib_progress/__init__.py
 @contextmanager
-def JoblibProgress(
+def JoblibProgress(  # noqa: N802
     *columns: ProgressColumn | str,
     description: str | None = None,
     total: int | None = None,
@@ -68,7 +68,7 @@ def JoblibProgress(
     task_id = progress.add_task(description, total=total)
     print_progress = joblib.parallel.Parallel.print_progress
 
-    def update_progress(self: joblib.parallel.Parallel):
+    def update_progress(self: joblib.parallel.Parallel) -> None:
         progress.update(task_id, completed=self.n_completed_tasks, refresh=True)
         return print_progress(self)
 

{hydraflow-0.2.15 → hydraflow-0.2.17}/src/hydraflow/run_collection.py

@@ -23,8 +23,7 @@ from dataclasses import dataclass, field
 from itertools import chain
 from typing import TYPE_CHECKING, Any, Concatenate, ParamSpec, TypeVar, overload
 
-from mlflow.entities.run import Run
-
+import hydraflow.param
 from hydraflow.config import iter_params
 from hydraflow.info import RunCollectionInfo
 
@@ -33,6 +32,7 @@ if TYPE_CHECKING:
     from pathlib import Path
     from typing import Any
 
+    from mlflow.entities.run import Run
     from omegaconf import DictConfig
 
 
@@ -60,7 +60,7 @@ class RunCollection:
     _info: RunCollectionInfo = field(init=False)
     """An instance of `RunCollectionInfo`."""
 
-    def __post_init__(self):
+    def __post_init__(self) -> None:
         self._info = RunCollectionInfo(self)
 
     def __repr__(self) -> str:
@@ -87,9 +87,12 @@ class RunCollection:
     def __contains__(self, run: Run) -> bool:
         return run in self._runs
 
+    def __bool__(self) -> bool:
+        return bool(self._runs)
+
     @classmethod
     def from_list(cls, runs: list[Run]) -> RunCollection:
-        """Create a new `RunCollection` instance from a list of MLflow `Run` instances."""
+        """Create a `RunCollection` instance from a list of MLflow `Run` instances."""
 
         return cls(runs)
 
@@ -120,6 +123,7 @@ class RunCollection:
     def sort(
         self,
         key: Callable[[Run], Any] | None = None,
+        *,
         reverse: bool = False,
     ) -> None:
         self._runs.sort(key=key or (lambda x: x.info.start_time), reverse=reverse)
@@ -393,7 +397,7 @@ class RunCollection:
         param_names = set()
 
         for run in self:
-            for param in run.data.params.keys():
+            for param in run.data.params:
                 param_names.add(param)
 
         return list(param_names)
@@ -537,10 +541,11 @@ class RunCollection:
             Results obtained by applying the function to each artifact directory
             in the collection.
         """
-        return (func(dir, *args, **kwargs) for dir in self.info.artifact_dir)
+        return (func(dir, *args, **kwargs) for dir in self.info.artifact_dir)  # noqa: A001
 
     def group_by(
-        self, *names: str | list[str]
+        self,
+        *names: str | list[str],
     ) -> dict[tuple[str | None, ...], RunCollection]:
         """
         Group runs by specified parameter names.
@@ -568,37 +573,15 @@ class RunCollection:
 
 
 def _param_matches(run: Run, key: str, value: Any) -> bool:
-    """
-    Check if the run's parameter matches the specified key-value pair.
-
-    Check if the run's parameters contain the specified
-    key-value pair. It handles different types of values, including lists
-    and tuples.
-
-    Args:
-        run (Run): The run object to check.
-        key (str): The parameter key to check.
-        value (Any): The parameter value to check.
-
-    Returns:
-        True if the run's parameter matches the specified key-value pair,
-        False otherwise.
-    """
-    param = run.data.params.get(key, value)
-
-    if param is None:
-        return False
+    params = run.data.params
+    if key not in params:
+        return True
 
+    param = params[key]
     if param == "None":
-        return value is None
-
-    if isinstance(value, list) and value:
-        return type(value[0])(param) in value
-
-    if isinstance(value, tuple) and len(value) == 2:
-        return value[0] <= type(value[0])(param) < value[1]
+        return value is None or value == "None"
 
-    return type(value)(param) == value
+    return hydraflow.param.match(param, value)
 
 
 def filter_runs(

{hydraflow-0.2.15 → hydraflow-0.2.17}/tests/scripts/app.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import logging
 import time
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from pathlib import Path
 
 import hydra
@@ -18,6 +18,7 @@ log = logging.getLogger(__name__)
 class MySQLConfig:
     host: str = "localhost"
     port: int = 3306
+    values: list[int] = field(default_factory=lambda: [1, 2, 3])
 
 
 cs = ConfigStore.instance()