feat: parse include-groups

finswimmer · finswimmer · commit c0adab78fae8 · 2025-02-10T19:13:58.000+01:00
diff --git a/src/poetry/core/factory.py b/src/poetry/core/factory.py
@@ -350,6 +350,20 @@ def _configure_package_dependencies(
                     dependencies=group_config["dependencies"],
                 )
 
+            for group_name, group_config in tool_poetry["group"].items():
+                if include_groups := group_config.get("include-groups", []):
+                    current_group = package.dependency_group(group_name)
+                    for name in include_groups:
+                        try:
+                            group_to_include = package.dependency_group(name)
+                        except ValueError as e:
+                            raise ValueError(
+                                f"Group '{group_name}' includes group '{name}'"
+                                " which is not defined."
+                            ) from e
+
+                        current_group.include_dependency_group(group_to_include)
+
         if with_groups and "dev-dependencies" in tool_poetry:
             cls._add_package_group_dependencies(
                 package=package,
@@ -614,6 +628,8 @@ def validate(
                 ' Use "poetry.group.dev.dependencies" instead.'
             )
 
+        cls._validate_dependency_groups_includes(toml_data, result)
+
         if strict:
             # Validate relation between [project] and [tool.poetry]
             cls._validate_legacy_vs_project(toml_data, result)
@@ -622,6 +638,33 @@ def validate(
 
         return result
 
+    @classmethod
+    def _validate_dependency_groups_includes(
+        cls, toml_data: dict[str, Any], result: dict[str, list[str]]
+    ) -> None:
+        """Ensure that dependency groups do not include themselves."""
+        config = toml_data.setdefault("tool", {}).setdefault("poetry", {})
+
+        group_includes = {}
+        for group_name, group_config in config.get("group", {}).items():
+            if include_groups := group_config.get("include-groups", []):
+                group_includes[canonicalize_name(group_name)] = [
+                    canonicalize_name(name) for name in include_groups
+                ]
+
+        for group_name in group_includes:
+            visited = set()
+            stack = [group_name]
+            while stack:
+                group = stack.pop()
+                if group in visited:
+                    result["errors"].append(
+                        f"Dependency group '{group}' includes itself."
+                    )
+                    continue
+                visited.add(group)
+                stack.extend(group_includes.get(group, []))
+
     @classmethod
     def _validate_legacy_vs_project(
         cls, toml_data: dict[str, Any], result: dict[str, list[str]]
diff --git a/src/poetry/core/json/schemas/poetry-schema.json b/src/poetry/core/json/schemas/poetry-schema.json
@@ -179,6 +179,13 @@
               "type": "boolean",
               "description": "Whether the dependency group is optional or not"
             },
+            "include-groups": {
+              "type": "array",
+              "description": "List of dependency group names included in this group.",
+              "items": {
+                "type": "string"
+              }
+            },
             "dependencies": {
               "type": "object",
               "description": "The dependencies of this dependency group",
diff --git a/tests/fixtures/project_with_invalid_nested_groups/README.rst b/tests/fixtures/project_with_invalid_nested_groups/README.rst
@@ -0,0 +1,2 @@
+My Package
+==========
diff --git a/tests/fixtures/project_with_invalid_nested_groups/pyproject.toml b/tests/fixtures/project_with_invalid_nested_groups/pyproject.toml
@@ -0,0 +1,41 @@
+[tool.poetry]
+name = "simple-project"
+version = "1.2.3"
+description = "Some description."
+authors = [
+    "Sébastien Eustace <sebastien@eustace.io>"
+]
+license = "MIT"
+
+readme = "README.rst"
+
+homepage = "https://python-poetry.org"
+repository = "https://github.com/python-poetry/poetry"
+documentation = "https://python-poetry.org/docs"
+
+keywords = ["packaging", "dependency", "poetry"]
+
+classifiers = [
+    "Topic :: Software Development :: Build Tools",
+    "Topic :: Software Development :: Libraries :: Python Modules"
+]
+
+# Requirements
+[tool.poetry.dependencies]
+python = "~2.7 || ^3.4"
+
+[tool.poetry.group.testing]
+include-groups = [
+    "dev",
+]
+
+[tool.poetry.group.testing.dependencies]
+pytest = "*"
+pytest-cov ="*"
+
+[tool.poetry.group.dev]
+include-groups = [
+    "testing",
+]
+[tool.poetry.group.dev.dependencies]
+black = "*"
diff --git a/tests/fixtures/project_with_invalid_nested_groups/simple_project/__init__.py b/tests/fixtures/project_with_invalid_nested_groups/simple_project/__init__.py
diff --git a/tests/fixtures/project_with_nested_groups/README.rst b/tests/fixtures/project_with_nested_groups/README.rst
@@ -0,0 +1,2 @@
+My Package
+==========
diff --git a/tests/fixtures/project_with_nested_groups/pyproject.toml b/tests/fixtures/project_with_nested_groups/pyproject.toml
@@ -0,0 +1,36 @@
+[tool.poetry]
+name = "simple-project"
+version = "1.2.3"
+description = "Some description."
+authors = [
+    "Sébastien Eustace <sebastien@eustace.io>"
+]
+license = "MIT"
+
+readme = "README.rst"
+
+homepage = "https://python-poetry.org"
+repository = "https://github.com/python-poetry/poetry"
+documentation = "https://python-poetry.org/docs"
+
+keywords = ["packaging", "dependency", "poetry"]
+
+classifiers = [
+    "Topic :: Software Development :: Build Tools",
+    "Topic :: Software Development :: Libraries :: Python Modules"
+]
+
+# Requirements
+[tool.poetry.dependencies]
+python = "~2.7 || ^3.4"
+
+[tool.poetry.group.testing.dependencies]
+pytest = "*"
+pytest-cov ="*"
+
+[tool.poetry.group.dev]
+include-groups = [
+    "testing",
+]
+[tool.poetry.group.dev.dependencies]
+black = "*"
diff --git a/tests/fixtures/project_with_nested_groups/simple_project/__init__.py b/tests/fixtures/project_with_nested_groups/simple_project/__init__.py
diff --git a/tests/fixtures/project_with_unknown_nested_group/README.rst b/tests/fixtures/project_with_unknown_nested_group/README.rst
@@ -0,0 +1,2 @@
+My Package
+==========
diff --git a/tests/fixtures/project_with_unknown_nested_group/pyproject.toml b/tests/fixtures/project_with_unknown_nested_group/pyproject.toml
@@ -0,0 +1,32 @@
+[tool.poetry]
+name = "simple-project"
+version = "1.2.3"
+description = "Some description."
+authors = [
+    "Sébastien Eustace <sebastien@eustace.io>"
+]
+license = "MIT"
+
+readme = "README.rst"
+
+homepage = "https://python-poetry.org"
+repository = "https://github.com/python-poetry/poetry"
+documentation = "https://python-poetry.org/docs"
+
+keywords = ["packaging", "dependency", "poetry"]
+
+classifiers = [
+    "Topic :: Software Development :: Build Tools",
+    "Topic :: Software Development :: Libraries :: Python Modules"
+]
+
+# Requirements
+[tool.poetry.dependencies]
+python = "~2.7 || ^3.4"
+
+[tool.poetry.group.dev]
+include-groups = [
+    "testing",
+]
+[tool.poetry.group.dev.dependencies]
+black = "*"
diff --git a/tests/fixtures/project_with_unknown_nested_group/simple_project/__init__.py b/tests/fixtures/project_with_unknown_nested_group/simple_project/__init__.py
diff --git a/tests/test_factory.py b/tests/test_factory.py
@@ -1060,3 +1060,37 @@ def test_poetry_build_system_dependencies(
     poetry = Factory().create_poetry(temporary_directory)
 
     assert set(poetry.build_system_dependencies) == expected
+
+
+def test_create_poetry_with_nested_dependency_groups() -> None:
+    poetry = Factory().create_poetry(fixtures_dir / "project_with_nested_groups")
+
+    assert len(poetry.package.all_requires) == 5
+    assert [
+        (dep.name, ",".join(dep.groups)) for dep in poetry.package.all_requires
+    ] == [
+        ("pytest", "testing"),
+        ("pytest-cov", "testing"),
+        ("black", "dev"),
+        ("pytest", "dev"),
+        ("pytest-cov", "dev"),
+    ]
+
+
+def test_create_poetry_with_invalid_nested_dependency_groups() -> None:
+    with pytest.raises(RuntimeError) as error:
+        _ = Factory().create_poetry(fixtures_dir / "project_with_invalid_nested_groups")
+
+    expected = """\
+The Poetry configuration is invalid:
+  - Dependency group 'testing' includes itself.
+  - Dependency group 'dev' includes itself.
+"""
+    assert str(error.value) == expected
+
+
+def test_create_poetry_with_unknown_nested_dependency_groups() -> None:
+    with pytest.raises(
+        ValueError, match="Group 'dev' includes group 'testing' which is not defined"
+    ):
+        _ = Factory().create_poetry(fixtures_dir / "project_with_unknown_nested_group")
