Get groups for direct dependencies from pyproject.toml

Author: ArBridgeman

exasol/toolbox/util/dependencies.py

@@ -0,0 +1,69 @@
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Optional, Tuple
+
+import tomlkit
+from pydantic import BaseModel, model_validator
+from tomlkit import TOMLDocument
+
+
+class PoetryGroup(BaseModel):
+    name: str
+    toml_section: str
+
+
+class PoetryToml(BaseModel):
+    file_path: Path = Path("pyproject.toml")
+    _content: Optional[TOMLDocument] = None
+
+    @model_validator(mode="before")
+    def read_content(cls, values):
+        file_path = values["file_path"]
+        if not file_path.exists():
+            raise ValueError(f"File not found: {file_path}")
+
+        try:
+            text = file_path.read_text()
+            cls._content = tomlkit.loads(text)
+        except Exception as e:
+            raise ValueError(f"Error reading file: {str(e)}")
+        return values
+
+    def get_section_dict(self, section: str) -> dict | None:
+        current = self._content.copy()
+        for section in section.split('.'):
+            if section not in current:
+                return None
+            current = current[section]
+        return current
+
+    @property
+    def groups(self) -> Tuple[PoetryGroup, ...]:
+        groups = []
+
+        main_key = "project.dependencies"
+        if self.get_section_dict(main_key):
+            groups.append(PoetryGroup(name="main", toml_section=main_key))
+
+        # present in some Poetry 2.x pyproject.tomls
+        main_dynamic_key = "tool.poetry.dependencies"
+        if self.get_section_dict(main_dynamic_key):
+            groups.append(
+                PoetryGroup(name="main", toml_section=main_dynamic_key)
+            )
+
+        group_key = "tool.poetry.group"
+        if group_dict := self.get_section_dict(group_key):
+            for group, content in group_dict.items():
+                if "dependencies" in content:
+                    groups.append(
+                        PoetryGroup(
+                            name=group,
+                            toml_section=f"{group_key}.{group}.dependencies",
+                        )
+                    )
+        return tuple(groups)
+
+    # @property
+    # def dependencies(self) -> Tuple[Group, ...]:

test/unit/util/dependencies_test.py

@@ -0,0 +1,46 @@
+import subprocess
+from pathlib import Path
+
+import pytest
+
+from toolbox.util.dependencies import PoetryToml, PoetryGroup
+
+MAIN_GROUP = PoetryGroup(name="main", toml_section="project.dependencies")
+DEV_GROUP = PoetryGroup(name="dev", toml_section="tool.poetry.group.dev.dependencies")
+ANALYSIS_GROUP =  PoetryGroup(name="analysis",
+                            toml_section="tool.poetry.group.analysis.dependencies")
+
+
+@pytest.fixture(scope="module")
+def pyproject_toml_path(tmp_path_factory) -> Path:
+    project_name = "project"
+    path = tmp_path_factory.mktemp("test")
+    subprocess.run(["poetry", "new", project_name], cwd=path)
+
+    project_path = path / project_name
+    subprocess.run(["poetry", "add", "numpy"], cwd=project_path)
+    subprocess.run(["poetry", "add", "pylint"], cwd=project_path)
+    subprocess.run(["poetry", "add", "--group", "dev", "isort"], cwd=project_path)
+    subprocess.run(["poetry", "add", "--group", "analysis", "black"], cwd=project_path)
+    return project_path / "pyproject.toml"
+
+
+@pytest.fixture(scope="module")
+def pyproject_toml(pyproject_toml_path):
+    return PoetryToml(file_path=pyproject_toml_path)
+
+
+class TestPoetryToml:
+    @staticmethod
+    def test_get_section_dict_exists(pyproject_toml):
+        result = pyproject_toml.get_section_dict("project")
+        assert result is not None
+
+    @staticmethod
+    def test_get_section_dict_does_not_exist(pyproject_toml):
+        result = pyproject_toml.get_section_dict("test")
+        assert result is None
+
+    @staticmethod
+    def test_groups(pyproject_toml):
+        assert pyproject_toml.groups == (MAIN_GROUP, DEV_GROUP, ANALYSIS_GROUP)