feat: add autogen header to the generated requirements.txt

Signed-off-by: Frost Ming <[email protected]>
pdm-project · Mar 22, 2023 · 495e17c · 495e17c
1 parent dd4101d
commit 495e17c
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/src/pdm/formats/requirements.py b/src/pdm/formats/requirements.py
@@ -172,7 +172,7 @@ def export(
     candidates: list[Candidate] | list[Requirement],
     options: Namespace,
 ) -> str:
-    lines = []
+    lines = ["# This file is @generated by PDM.\n# Please do not edit it manually.\n\n"]
     for candidate in sorted(candidates, key=lambda x: x.identify()):
         if isinstance(candidate, Candidate):
             req = dataclasses.replace(candidate.req, specifier=f"=={candidate.version}", marker=None)

diff --git a/tests/fixtures/projects/demo-package-has-dep-with-extras/requirements.txt b/tests/fixtures/projects/demo-package-has-dep-with-extras/requirements.txt
@@ -1,3 +1,6 @@
+# This file is @generated by PDM.
+# Please do not edit it manually.
+
 certifi==2021.10.8
 charset-normalizer==2.0.7
 idna==3.3

diff --git a/tests/fixtures/projects/demo-package/requirements.txt b/tests/fixtures/projects/demo-package/requirements.txt
@@ -1,3 +1,6 @@
+# This file is @generated by PDM.
+# Please do not edit it manually.
+
 click==7.1.2 \
     --hash=sha256:d2b5255c7c6349bc1bd1e59e08cd12acbbd63ce649f2588755783aa94dfb6b1a \
     --hash=sha256:dacca89f4bfadd5de3d7489b7c8a566eee0d3676333fbb50030263894c38c0dc