Merge pull request #775 from lbrabec/fix_655

fix: preserve multiple requirements with markers in project_override

Author: mergify[bot]

src/fromager/pyproject.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+import itertools
 import logging
 import pathlib
 import typing
@@ -94,22 +95,28 @@ def _default_build_system(self, doc: tomlkit.TOMLDocument) -> TomlDict:
     def _update_build_requires(self, build_system: TomlDict) -> None:
         old_requires = build_system[BUILD_REQUIRES]
         # always include setuptools
-        req_map: dict[NormalizedName, Requirement] = {
-            canonicalize_name("setuptools"): Requirement("setuptools"),
+        req_map: dict[NormalizedName, list[Requirement]] = {
+            canonicalize_name("setuptools"): [Requirement("setuptools")],
         }
         # parse original build reqirements (if available)
         for reqstr in old_requires:
             req = Requirement(reqstr)
-            req_map[canonicalize_name(req.name)] = req
+            req_map.setdefault(canonicalize_name(req.name), []).append(req)
         # remove unwanted requirements
         for name in self.remove_requirements:
             req_map.pop(canonicalize_name(name), None)
         # add / update requirements
+        update_req_map: dict[NormalizedName, list[Requirement]] = {}
         for reqstr in self.update_requirements:
             req = Requirement(reqstr)
-            req_map[canonicalize_name(req.name)] = req
+            update_req_map.setdefault(canonicalize_name(req.name), []).append(req)
+        req_map.update(update_req_map)
 
-        new_requires = sorted(str(req) for req in req_map.values())
+        new_requires = sorted(
+            itertools.chain.from_iterable(
+                [str(req) for req in reqs] for reqs in req_map.values()
+            )
+        )
         if set(new_requires) != set(old_requires):
             # ignore order of items
             build_system[BUILD_REQUIRES] = new_requires

tests/test_pyproject.py

@@ -101,3 +101,79 @@ def test_pyproject_fix(
             "torch",
         ],
     }
+
+
+PYPROJECT_MULTIPLE_REQUIRES = """
+[build-system]
+    requires = [
+        "numpy<2.0; python_version<'3.9'",
+        "numpy==2.0.2; python_version>='3.9' and python_version<'3.13'",
+        "numpy==2.1.3; python_version=='3.13'",
+        "packaging",
+        "pip",
+        "scikit-build>=0.14.0",
+        "setuptools==59.2.0; python_version<'3.12'",
+        "setuptools<70.0.0; python_version>='3.12'",
+    ]
+"""
+
+
+def test_pyproject_preserve_multiple_requires(tmp_path: pathlib.Path) -> None:
+    tmp_path.joinpath("pyproject.toml").write_text(PYPROJECT_MULTIPLE_REQUIRES)
+    req = Requirement("testproject==1.0.0")
+    fixer = pyproject.PyprojectFix(
+        req,
+        build_dir=tmp_path,
+        update_build_requires=["setuptools"],
+        remove_build_requires=[canonicalize_name("cmake")],
+    )
+    fixer.run()
+    with tmp_path.joinpath("pyproject.toml").open(encoding="utf-8") as f:
+        doc = tomlkit.load(f)
+    assert isinstance(doc["build-system"], typing.Container)
+    # PyprojectFix parses requirements using packaging.requirements.Requirement and then casts
+    # to str, this may change white spaces in markers, let's do it here as well
+    assert dict(doc["build-system"].items())["requires"] == [
+        str(Requirement(req))
+        for req in [
+            "numpy<2.0; python_version<'3.9'",
+            "numpy==2.0.2; python_version>='3.9' and python_version<'3.13'",
+            "numpy==2.1.3; python_version=='3.13'",
+            "packaging",
+            "pip",
+            "scikit-build>=0.14.0",
+            "setuptools",
+        ]
+    ]
+
+
+def test_pyproject_override_multiple_requires(tmp_path: pathlib.Path) -> None:
+    tmp_path.joinpath("pyproject.toml").write_text(PYPROJECT_MULTIPLE_REQUIRES)
+    req = Requirement("testproject==1.0.0")
+    fixer = pyproject.PyprojectFix(
+        req,
+        build_dir=tmp_path,
+        update_build_requires=[
+            "setuptools",
+            "numpy<3.0.0; python_version=='3.12'",
+            "numpy==3.0.0",
+        ],
+        remove_build_requires=[canonicalize_name("cmake")],
+    )
+    fixer.run()
+    with tmp_path.joinpath("pyproject.toml").open(encoding="utf-8") as f:
+        doc = tomlkit.load(f)
+    assert isinstance(doc["build-system"], typing.Container)
+    # PyprojectFix parses requirements using packaging.requirements.Requirement and then casts
+    # to str, this may change white spaces in markers, let's do it here as well
+    assert dict(doc["build-system"].items())["requires"] == [
+        str(Requirement(req))
+        for req in [
+            "numpy<3.0.0; python_version=='3.12'",
+            "numpy==3.0.0",
+            "packaging",
+            "pip",
+            "scikit-build>=0.14.0",
+            "setuptools",
+        ]
+    ]