CLI: replace min dependencies also in pyproject. toml (#414)

* replace min dependencies also in `pyproject. toml`
* add tests
* chlog

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: Borda

.github/workflows/ci-scripts.yml

@@ -56,7 +56,7 @@ jobs:
         timeout-minutes: 20
         run: |
           set -e
-          pip install -e . -U -r requirements/_tests.txt -f $TORCH_URL
+          pip install -e ".[cli]" -U -r requirements/_tests.txt -f $TORCH_URL
           pip --version
           pip list
 

.github/workflows/ci-testing.yml

@@ -50,7 +50,7 @@ jobs:
         timeout-minutes: 20
         run: |
           set -e
-          pip install -e . -U -r requirements/_tests.txt -f $TORCH_URL
+          pip install -e ".[cli]" -U -r requirements/_tests.txt -f $TORCH_URL
           pip --version
           pip list
 

CHANGELOG.md

@@ -14,6 +14,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - CI: add `force-check-all` input to MD link check workflow ([#408](https://github.com/Lightning-AI/utilities/pull/408))
 
 
+- CLI: replace min dependencies also in `pyproject.toml` ([#414](https://github.com/Lightning-AI/utilities/pull/414))
+
+
 ### Changed
 
 - CLI: switch from `fire` to `jsonargparse` ([#371](https://github.com/Lightning-AI/utilities/pull/371))

pyproject.toml

@@ -70,7 +70,7 @@ lint.per-file-ignores."src/**" = [
 lint.per-file-ignores."tests/**" = [
   "ANN001", # Missing type annotation for function argument
   "ANN101", # Missing type annotation for `self` in method
-  "ANN201", #  Missing return type annotation for public function
+  "ANN201", # Missing return type annotation for public function
   "ANN202", # Missing return type annotation for private function
   "ANN204", # Missing return type annotation for special method
   "ANN401", # Dynamically typed expressions (typing.Any)

requirements/cli.txt

@@ -1 +1,2 @@
 jsonargparse[signatures] >=4.38.0
+tomlkit

src/lightning_utilities/cli/dependencies.py

@@ -5,13 +5,15 @@
 import glob
 import os.path
 import re
+import warnings
 from collections.abc import Sequence
 from pprint import pprint
 from typing import Union
 
 REQUIREMENT_ROOT = "requirements.txt"
 REQUIREMENT_FILES_ALL: list = glob.glob(os.path.join("requirements", "*.txt"))
 REQUIREMENT_FILES_ALL += glob.glob(os.path.join("requirements", "**", "*.txt"), recursive=True)
+REQUIREMENT_FILES_ALL += glob.glob(os.path.join("**", "pyproject.toml"))
 if os.path.isfile(REQUIREMENT_ROOT):
     REQUIREMENT_FILES_ALL += [REQUIREMENT_ROOT]
 
@@ -43,23 +45,57 @@ def _prune_packages(req_file: str, packages: Sequence[str]) -> None:
         fp.writelines(lines)
 
 
-def _replace_min(fname: str) -> None:
+def _replace_min_txt(fname: str) -> None:
     with open(fname) as fopen:
         req = fopen.read().replace(">=", "==")
     with open(fname, "w") as fw:
         fw.write(req)
 
 
+def _replace_min_pyproject_toml(fname: str) -> None:
+    """Replace all `>=` with `==` in the standard pyproject.toml file in [project.dependencies]."""
+    import tomlkit
+
+    # Load and parse the existing pyproject.toml
+    with open(fname, encoding="utf-8") as f:
+        content = f.read()
+    doc = tomlkit.parse(content)
+
+    # todo: consider also replace extras in [dependency-groups] -> extras = [...]
+    deps = doc.get("project", {}).get("dependencies")
+    if not deps:
+        return
+
+    # Replace '>=version' with '==version' in each dependency
+    for i, req in enumerate(deps):
+        # Simple string value
+        deps[i] = req.replace(">=", "==")
+
+    # Dump back out, preserving layout
+    with open(fname, "w", encoding="utf-8") as f:
+        f.write(tomlkit.dumps(doc))
+
+
 def replace_oldest_version(req_files: Union[str, Sequence[str]] = REQUIREMENT_FILES_ALL) -> None:
     """Replace the min package version by fixed one."""
     if isinstance(req_files, str):
         req_files = [req_files]
     for fname in req_files:
-        _replace_min(fname)
+        if fname.endswith(".txt"):
+            _replace_min_txt(fname)
+        elif os.path.basename(fname) == "pyproject.toml":
+            _replace_min_pyproject_toml(fname)
+        else:
+            warnings.warn(
+                "Only *.txt with plain list of requirements or standard pyproject.toml are supported."
+                f" File '{fname}' is not supported.",
+                UserWarning,
+                stacklevel=2,
+            )
 
 
 def _replace_package_name(requirements: list[str], old_package: str, new_package: str) -> list[str]:
-    """Replace one package by another with same version in given requirement file.
+    """Replace one package by another with the same version in a given requirement file.
 
     >>> _replace_package_name(["torch>=1.0 # comment", "torchvision>=0.2", "torchtext <0.3"], "torch", "pytorch")
     ['pytorch>=1.0 # comment', 'torchvision>=0.2', 'torchtext <0.3']

tests/unittests/cli/test_dependencies.py

@@ -9,7 +9,7 @@
 _PATH_ROOT = Path(__file__).parent.parent.parent
 
 
-def test_prune_packages(tmpdir):
+def test_prune_packages_txt(tmpdir):
     req_file = tmpdir / "requirements.txt"
     with open(req_file, "w") as fp:
         fp.writelines(["fire\n", "abc>=0.1\n"])
@@ -19,7 +19,7 @@ def test_prune_packages(tmpdir):
     assert lines == ["fire\n"]
 
 
-def test_oldest_packages(tmpdir):
+def test_oldest_packages_txt(tmpdir):
     req_file = tmpdir / "requirements.txt"
     with open(req_file, "w") as fp:
         fp.writelines(["fire>0.2\n", "abc>=0.1\n"])
@@ -29,11 +29,33 @@ def test_oldest_packages(tmpdir):
     assert lines == ["fire>0.2\n", "abc==0.1\n"]
 
 
-def test_replace_packages(tmpdir):
+def test_replace_packages_txt(tmpdir):
     req_file = tmpdir / "requirements.txt"
     with open(req_file, "w") as fp:
         fp.writelines(["torchvision>=0.2\n", "torch>=1.0 # comment\n", "torchtext <0.3\n"])
     replace_package_in_requirements(old_package="torch", new_package="pytorch", req_files=[str(req_file)])
     with open(req_file) as fp:
         lines = fp.readlines()
     assert lines == ["torchvision>=0.2\n", "pytorch>=1.0 # comment\n", "torchtext <0.3\n"]
+
+
+def test_oldest_packages_pyproject_toml(tmpdir):
+    req_file = tmpdir / "pyproject.toml"
+    with open(req_file, "w") as fp:
+        fp.writelines([
+            "[project]\n",
+            "dependencies = [\n",
+            '    "fire>0.2",\n',
+            '    "abc>=0.1",\n',
+            "]\n",
+        ])
+    replace_oldest_version(req_files=[str(req_file)])
+    with open(req_file) as fp:
+        lines = fp.readlines()
+    assert lines == [
+        "[project]\n",
+        "dependencies = [\n",
+        '    "fire>0.2",\n',
+        '    "abc==0.1",\n',
+        "]\n",
+    ]