deprecate poetry specific component tools methods, and add support for uv (#555)

temporarily added manual support for uv but want to look for better
options to support any arbitrary packaging tool of the past or future.

Author: ms-lolo

.github/actions/setup-environment/action.yaml

@@ -60,6 +60,7 @@ runs:
       shell: bash
       run: |
         pipx install poetry
+        pipx install uv
         poetry self add poetry-monorepo-dependency-plugin
     - id: "install-devtools"
       if: ${{ inputs.install-devtools }}

rats-apps/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "rats-apps"
 description = "research analysis tools for building applications"
-version = "0.11.2"
+version = "0.12.0"
 readme = "README.md"
 requires-python = ">=3.10,<4.0"
 authors = [

rats-devtools/poetry.lock

@@ -1,7 +1,7 @@
 [project]
 name = "rats-devtools"
 description = "Rats Development Tools"
-version = "0.11.2"
+version = "0.12.0"
 readme = "README.md"
 requires-python = ">=3.10,<4.0"
 authors = [

rats-devtools/pyproject.toml

@@ -20,7 +20,13 @@
 """
 
 from ._component_tools import ComponentId, ComponentTools, UnsetComponentTools
-from ._plugin import PluginConfigs, PluginContainer, PluginServices, find_repo_root
+from ._plugin import (
+    PluginConfigs,
+    PluginContainer,
+    PluginServices,
+    find_nearest_component,
+    find_repo_root,
+)
 from ._project_tools import (
     ComponentNotFoundError,
     ProjectConfig,
@@ -39,5 +45,6 @@
     "ProjectNotFoundError",
     "ProjectTools",
     "UnsetComponentTools",
+    "find_nearest_component",
     "find_repo_root",
 ]

rats-devtools/src/rats/projects/__init__.py

@@ -1,6 +1,7 @@
 import logging
 import subprocess
 import sys
+import warnings
 from collections.abc import Mapping
 from os import symlink
 from pathlib import Path
@@ -110,20 +111,27 @@ def ruff(self, *args: str) -> None:
     def pyright(self) -> None:
         self.run("pyright")
 
-    def run(self, *args: str) -> None:
-        if self.is_poetry_detected():
-            self.poetry("run", *args)
-        else:
-            self.exe(*args)
-
     def poetry(self, *args: str) -> None:
+        warnings.warn(
+            "The ComponentTools.poetry() method is deprecated. Use ComponentTools.run() instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         if not self.is_poetry_detected():
             raise RuntimeError(f"cannot run poetry commands in component: {self.component_name()}")
 
-        # when running a poetry command, we want to ignore any env we might be in.
-        # i'm not sure yet how reliable this is.
         self.exe("env", "-u", "POETRY_ACTIVE", "-u", "VIRTUAL_ENV", "poetry", *args)
 
+    def run(self, *args: str) -> None:
+        """Tries to run a command within the component's venv."""
+        # generally try to unset any package manager venv specific details
+        if self.is_poetry_detected():
+            self.exe("env", "-u", "POETRY_ACTIVE", "-u", "VIRTUAL_ENV", "poetry", "run", *args)
+        elif self._is_uv_detected():
+            self.exe("env", "-u", "UV_ACTIVE", "-u", "VIRTUAL_ENV", "uv", "run", *args)
+        else:
+            self.exe(*args)
+
     def exe(self, *cmd: str) -> None:
         """Run a command from the root of a component."""
         logger.debug(f"executing in {self._path}/: {' '.join(cmd)}")
@@ -142,7 +150,27 @@ def is_poetry_detected(self) -> bool:
         we can fully delete any non PEP 621 code since we initially started as poetry-specific.
         """
         data = self._load_pyproject()
-        return "tool" in data and "poetry" in data["tool"]
+        if "tool" in data and "poetry" in data["tool"]:
+            # we found some poetry values in the toml file
+            return True
+
+        # make double sure by checking if we see a lockfile for poetry
+        return self.find_path("poetry.lock").is_file()
+
+    def _is_uv_detected(self) -> bool:
+        """
+        Returns true if we think this component might be managed by uv.
+
+        Keeping this private because the hope is to remove all coupling to specific packaging
+        tools,
+        """
+        data = self._load_pyproject()
+        if "tool" in data and "uv" in data["tool"]:
+            # we found some uv values in the toml file
+            return True
+
+        # make double sure by checking if we see a lockfile for poetry
+        return self.find_path("uv.lock").is_file()
 
     def _load_pyproject(self) -> Mapping[str, Any]:
         return toml.loads((self.find_path("pyproject.toml")).read_text())

rats-devtools/src/rats/projects/_component_tools.py

@@ -5,7 +5,12 @@
 from rats import apps
 
 from ._component_tools import ComponentTools
-from ._project_tools import ProjectConfig, ProjectNotFoundError, ProjectTools
+from ._project_tools import (
+    ComponentNotFoundError,
+    ProjectConfig,
+    ProjectNotFoundError,
+    ProjectTools,
+)
 
 logger = logging.getLogger(__name__)
 
@@ -44,7 +49,7 @@ def _active_component_tools(self) -> ComponentTools:
             # or we're not in a component and we should use the devtools component by default
             # i'm not sure this is the best and most expected behavior
             # but it lets us run things like the docs tools from the root of a big repo
-            return ptools.get_component(cwd.name)
+            return ptools.get_component(ptools.project_name())
 
         name = relative.split("/")[0]  # the component sits at the root of the project, for now
         return ptools.get_component(name)
@@ -58,10 +63,11 @@ def _project_tools(self) -> ProjectTools:
 
     @apps.fallback_service(PluginServices.CONFIGS.PROJECT)
     def _project_config(self) -> ProjectConfig:
-        repo_root = str(find_repo_root())
+        repo_root = find_repo_root()
         return ProjectConfig(
-            name=os.environ.get("DEVTOOLS_PROJECT_NAME", "default-project"),
-            path=repo_root,
+            # default to assuming the repo root folder name is the project name
+            name=os.environ.get("DEVTOOLS_PROJECT_NAME", repo_root.name),
+            path=repo_root.as_posix(),
             image_registry=os.environ.get("DEVTOOLS_IMAGE_REGISTRY", "default.local"),
             image_push_on_build=bool(os.environ.get("DEVTOOLS_IMAGE_PUSH_ON_BUILD", True)),
             # default tag gets calculated from the project hash
@@ -70,19 +76,25 @@ def _project_config(self) -> ProjectConfig:
         )
 
 
-def find_repo_root() -> Path:
+def find_repo_root(cwd: Path | None = None) -> Path:
     """
     Try to find the path to the root of the repo.
 
     This method traverses up the directory tree, starting from the working directory, and looks for
     the first directory that contains a `.git` directory. This behavior can be overwritten by
     defining a `DEVTOOLS_PROJECT_ROOT` environment variable.
+
+    Args:
+        cwd: optionally provide a starting search directory
     """
     env = os.environ.get("DEVTOOLS_PROJECT_ROOT")
     if env:
         return Path(env)
 
-    guess = Path().resolve()
+    if cwd is None:
+        cwd = Path.cwd()
+
+    guess = cwd.resolve()
     while str(guess) != "/":
         if (guess / ".git").exists():
             return guess
@@ -91,3 +103,25 @@ def find_repo_root() -> Path:
     raise ProjectNotFoundError(
         "repo root not found. devtools must be used on a project in a git repo."
     )
+
+
+def find_nearest_component(cwd: Path | None = None) -> Path:
+    """
+    Try to find the path to the root of the nearest component.
+
+    This method traverses up the directory tree, starting from the working directory, and looks for
+    the first directory that contains a `pyproject.toml` file.
+
+    Args:
+        cwd: optionally provide a starting search directory
+    """
+    if cwd is None:
+        cwd = Path.cwd()
+
+    guess = cwd.resolve()
+    while str(guess) != "/":
+        if (guess / "pyproject.toml").exists() and (guess / "pyproject.toml").is_file():
+            return guess
+        guess = guess.parent
+
+    raise ComponentNotFoundError(f"component root not found from cwd: {cwd.as_posix()}.")

rats-devtools/src/rats/projects/_plugin.py

@@ -1,3 +1,4 @@
+import subprocess
 from pathlib import Path
 
 from rats import projects
@@ -39,3 +40,41 @@ def test_nested(self) -> None:
             "test/rats_test_resources/projects/example-1/nested/example-nested-uv/README.md",
         ).resolve()
         assert str(readme_path) == str(expected)
+
+    def test_executing_uv(self) -> None:
+        tools = projects.ProjectTools(
+            lambda: projects.ProjectConfig(
+                name="example-project",
+                path="test/rats_test_resources/projects/example-1",
+                image_registry="none",
+                image_push_on_build=False,
+            )
+        )
+
+        examples = [
+            "uv",
+            "nested-uv",
+        ]
+        for x in examples:
+            component = tools.get_component(f"example-{x}")
+
+            cmd = [
+                "env",
+                "-u",
+                "UV_ACTIVE",
+                "-u",
+                "VIRTUAL_ENV",
+                "uv",
+                "run",
+                "python",
+                "-m",
+                component.component_name().replace("-", "_"),
+            ]
+
+            result = subprocess.run(
+                cmd,
+                capture_output=True,
+                text=True,
+                cwd=component.find_path("."),
+            )
+            assert result.stdout.strip() == f"hello, world! example-1/{component.component_name()}"