Sync updates to generate_requirements.py from scikit-image (#485)

Author: mwtoews

.pre-commit-config.yaml

@@ -41,8 +41,8 @@ repos:
 
   - repo: local
     hooks:
-      - id: pyproject.toml
-        name: pyproject.toml
+      - id: generate_requirements.py
+        name: generate_requirements.py
         language: system
         entry: python tools/generate_requirements.py
-        files: "pyproject.toml|requirements/.*\\.txt|tools/.*generate.*"
+        files: "pyproject.toml|requirements/.*\\.txt|tools/generate_requirements.py"

pyproject.toml

@@ -43,6 +43,10 @@ Homepage = 'https://numpydoc.readthedocs.io'
 Source = 'https://github.com/numpy/numpydoc/'
 
 [project.optional-dependencies]
+developer = [
+    'pre-commit>=3.3',
+    "tomli; python_version < '3.11'",
+]
 doc = [
     'numpy>=1.22',
     'matplotlib>=3.5',

requirements/default.txt

@@ -0,0 +1,6 @@
+# Generated via tools/generate_requirements.py and pre-commit hook.
+# Do not edit this file; modify pyproject.toml instead.
+sphinx>=5
+Jinja2>=2.10
+tabulate>=0.8.10
+tomli>=1.1.0;python_version<'3.11'

requirements/developer.txt

@@ -1,2 +1,4 @@
+# Generated via tools/generate_requirements.py and pre-commit hook.
+# Do not edit this file; modify pyproject.toml instead.
 pre-commit>=3.3
 tomli; python_version < '3.11'

requirements/doc.txt

@@ -1,4 +1,5 @@
-# Generated from pyproject.toml
+# Generated via tools/generate_requirements.py and pre-commit hook.
+# Do not edit this file; modify pyproject.toml instead.
 numpy>=1.22
 matplotlib>=3.5
 pydata-sphinx-theme>=0.13

requirements/test.txt

@@ -1,4 +1,5 @@
-# Generated from pyproject.toml
+# Generated via tools/generate_requirements.py and pre-commit hook.
+# Do not edit this file; modify pyproject.toml instead.
 pytest
 pytest-cov
 matplotlib

tools/generate_requirements.py

@@ -12,11 +12,28 @@
     except ImportError:
         sys.exit("Please install `tomli` first: `pip install tomli`")
 
-repo_dir = (Path(__file__).parent / "..").resolve()
-req_dir = repo_dir / "requirements"
-pyproject = toml.loads((repo_dir / "pyproject.toml").read_text())
-
-for key, opt_list in pyproject["project"]["optional-dependencies"].items():
-    lines = ["# Generated from pyproject.toml"] + opt_list
-    req_fname = req_dir / f"{key}.txt"
-    req_fname.write_text("\n".join(lines) + "\n")
+script_pth = Path(__file__)
+repo_dir = script_pth.parent.parent
+script_relpth = script_pth.relative_to(repo_dir)
+header = [
+    f"# Generated via {script_relpth.as_posix()} and pre-commit hook.",
+    "# Do not edit this file; modify pyproject.toml instead.",
+]
+
+
+def generate_requirement_file(name: str, req_list: list[str]) -> None:
+    req_fname = repo_dir / "requirements" / f"{name}.txt"
+    req_fname.write_text("\n".join(header + req_list) + "\n")
+
+
+def main() -> None:
+    pyproject = toml.loads((repo_dir / "pyproject.toml").read_text())
+
+    generate_requirement_file("default", pyproject["project"]["dependencies"])
+
+    for key, opt_list in pyproject["project"]["optional-dependencies"].items():
+        generate_requirement_file(key, opt_list)
+
+
+if __name__ == "__main__":
+    main()