Merge pull request #236 from bouweandela/install-dev-versions

Add option to install a development version of a metrics package

Author: bouweandela

changelog/236.feature.md

@@ -0,0 +1 @@
+Added the option to install development versions of metrics packages.

packages/ref-core/src/cmip_ref_core/providers.py

@@ -233,10 +233,13 @@ def __init__(
         name: str,
         version: str,
         slug: str | None = None,
+        repo: str | None = None,
+        tag_or_commit: str | None = None,
     ) -> None:
         super().__init__(name, version, slug)
         self._conda_exe: Path | None = None
         self._prefix: Path | None = None
+        self.url = f"git+{repo}@{tag_or_commit}" if repo and tag_or_commit else None
 
     @property
     def prefix(self) -> Path:
@@ -321,8 +324,10 @@ def env_path(self) -> Path:
         A unique path for storing the conda environment.
         """
         with self.get_environment_file() as file:
-            suffix = hashlib.sha1(file.read_bytes(), usedforsecurity=False).hexdigest()
-        return self.prefix / f"{self.slug}-{suffix}"
+            suffix = hashlib.sha1(file.read_bytes(), usedforsecurity=False)
+            if self.url is not None:
+                suffix.update(bytes(self.url, encoding="utf-8"))
+        return self.prefix / f"{self.slug}-{suffix.hexdigest()}"
 
     def create_env(self) -> None:
         """
@@ -333,9 +338,10 @@ def create_env(self) -> None:
             logger.info(f"Environment at {self.env_path} already exists, skipping.")
             return
 
+        conda_exe = f"{self.get_conda_exe(update=True)}"
         with self.get_environment_file() as file:
             cmd = [
-                f"{self.get_conda_exe(update=True)}",
+                conda_exe,
                 "create",
                 "--yes",
                 "--file",
@@ -346,6 +352,21 @@ def create_env(self) -> None:
             logger.debug(f"Running {' '.join(cmd)}")
             subprocess.run(cmd, check=True)  # noqa: S603
 
+            if self.url is not None:
+                logger.info(f"Installing development version of {self.slug} from {self.url}")
+                cmd = [
+                    conda_exe,
+                    "run",
+                    "--prefix",
+                    f"{self.env_path}",
+                    "pip",
+                    "install",
+                    "--no-deps",
+                    self.url,
+                ]
+                logger.debug(f"Running {' '.join(cmd)}")
+                subprocess.run(cmd, check=True)  # noqa: S603
+
     def run(self, cmd: Iterable[str]) -> None:
         """
         Run a command.

packages/ref-metrics-esmvaltool/src/cmip_ref_metrics_esmvaltool/__init__.py

@@ -5,9 +5,17 @@
 import cmip_ref_metrics_esmvaltool.metrics
 from cmip_ref_core.providers import CondaMetricsProvider
 from cmip_ref_metrics_esmvaltool._version import __version__
+from cmip_ref_metrics_esmvaltool.recipe import _ESMVALTOOL_COMMIT
 
-# Initialise the metrics manager and register the metrics
-provider = CondaMetricsProvider("ESMValTool", __version__)
+# Initialise the metrics manager.
+provider = CondaMetricsProvider(
+    "ESMValTool",
+    __version__,
+    repo="https://github.com/ESMValGroup/ESMValTool.git",
+    tag_or_commit=_ESMVALTOOL_COMMIT,
+)
+
+# Register the metrics.
 for _metric_cls_name in cmip_ref_metrics_esmvaltool.metrics.__all__:
     _metric_cls = getattr(cmip_ref_metrics_esmvaltool.metrics, _metric_cls_name)
     provider.register(_metric_cls())

packages/ref-metrics-esmvaltool/src/cmip_ref_metrics_esmvaltool/recipe.py

@@ -113,8 +113,8 @@ def dataframe_to_recipe(files: pd.DataFrame) -> dict[str, Any]:
     return variables
 
 
-_ESMVALTOOL_VERSION = "2.13.0.dev10+g7883d411e"
-_ESMVALTOOL_COMMIT = _ESMVALTOOL_VERSION.split("+")[1][1:]
+_ESMVALTOOL_COMMIT = "864a0b9328e6d29d0591ffb593fdfcc88b22f1b8"
+_ESMVALTOOL_VERSION = f"2.13.0.dev21+{_ESMVALTOOL_COMMIT[:10]}"
 
 _RECIPES = pooch.create(
     path=pooch.os_cache("cmip_ref_metrics_esmvaltool"),

packages/ref/src/cmip_ref/cli/providers.py

@@ -2,6 +2,8 @@
 Manage the REF providers.
 """
 
+from typing import Annotated
+
 import pandas as pd
 import typer
 from loguru import logger
@@ -47,7 +49,13 @@ def get_env(provider: MetricsProvider) -> str:
 
 
 @app.command()
-def create_env(ctx: typer.Context, provider: str | None = None) -> None:
+def create_env(
+    ctx: typer.Context,
+    provider: Annotated[
+        str | None,
+        typer.Option(help="Only install the environment for the named provider."),
+    ] = None,
+) -> None:
     """
     Create a virtual environment containing the provider software.
     """