Add metadata to ci scripts

Author: mdellweg

.ci/gen_certs.py

@@ -1,3 +1,10 @@
+# /// script
+# requires-python = ">=3.10"
+# dependencies = [
+#     "trustme>=1.2.1,<1.3.0",
+# ]
+# ///
+
 import argparse
 import os
 import sys

.ci/scripts/calc_constraints.py

@@ -1,4 +1,11 @@
 #!/bin/python3
+# /// script
+# requires-python = ">=3.10"
+# dependencies = [
+#     "packaging>=25.0,<25.1",
+#     "tomli>=2.3.0,<2.4.0;python_version<'3.11'",
+# ]
+# ///
 
 import argparse
 import fileinput

.ci/scripts/check_click_for_mypy.py

@@ -1,4 +1,10 @@
 #!/bin/env python3
+# /// script
+# requires-python = ">=3.11"
+# dependencies = [
+#     "packaging>=25.0,<25.1",
+# ]
+# ///
 
 from importlib import metadata
 

.ci/scripts/collect_changes.py

@@ -1,4 +1,11 @@
 #!/bin/env python3
+# /// script
+# requires-python = ">=3.11"
+# dependencies = [
+#     "gitpython>=3.1.46,<3.2.0",
+#     "packaging>=25.0,<25.1",
+# ]
+# ///
 
 import itertools
 import os

.ci/scripts/pr_labels.py

@@ -1,4 +1,10 @@
 #!/bin/env python3
+# /// script
+# requires-python = ">=3.11"
+# dependencies = [
+#     "gitpython>=3.1.46,<3.2.0",
+# ]
+# ///
 
 # This script is running with elevated privileges from the main branch against pull requests.
 

.ci/scripts/validate_commit_message.py

@@ -1,3 +1,10 @@
+# /// script
+# requires-python = ">=3.11"
+# dependencies = [
+#     "gitpython>=3.1.46,<3.2.0",
+# ]
+# ///
+
 import os
 import re
 import subprocess

cookiecutter/apply_templates.py

@@ -1,12 +1,20 @@
 #!/bin/env python3
+# /// script
+# requires-python = ">=3.11"
+# dependencies = [
+#     "click>=8.3.1,<8.4",
+#     "cookiecutter>=2.6.0,<2.7",
+#     "pyyaml>=6.0.3,<6.1",
+#     "tomlkit>=0.13.3,<0.14",
+# ]
+# ///
 
-# This script requires click, cookiecutter, tomlkit and pyyaml
 
 import os
 from pathlib import Path
+import tomllib
 
 import click
-import tomllib
 import yaml
 
 from cookiecutter.main import cookiecutter

cookiecutter/ci/{{ cookiecutter.__project_name }}/.ci/gen_certs.py

@@ -1,3 +1,10 @@
+# /// script
+# requires-python = ">=3.10"
+# dependencies = [
+#     "trustme>=1.2.1,<1.3.0",
+# ]
+# ///
+
 import argparse
 import os
 import sys

cookiecutter/ci/{{ cookiecutter.__project_name }}/.ci/scripts/calc_constraints.py

@@ -0,0 +1,119 @@
+#!/bin/python3
+# /// script
+# requires-python = ">=3.10"
+# dependencies = [
+#     "packaging>=25.0,<25.1",
+#     "tomli>=2.3.0,<2.4.0;python_version<'3.11'",
+# ]
+# ///
+
+import argparse
+import fileinput
+import sys
+
+from packaging.requirements import Requirement
+from packaging.version import Version
+
+try:
+    import tomllib
+except ImportError:
+    import tomli as tomllib
+
+
+def split_comment(line):
+    split_line = line.split("#", maxsplit=1)
+    try:
+        comment = "  # " + split_line[1].strip()
+    except IndexError:
+        comment = ""
+    return split_line[0].strip(), comment
+
+
+def to_upper_bound(req):
+    try:
+        requirement = Requirement(req)
+    except ValueError:
+        return f"# UNPARSABLE: {req}"
+    else:
+        for spec in requirement.specifier:
+            if spec.operator == "~=":
+                return f"# NO BETTER CONSTRAINT: {req}"
+            if spec.operator == "<=":
+                operator = "=="
+                max_version = spec.version
+                return f"{requirement.name}{operator}{max_version}"
+            if spec.operator == "<":
+                operator = "~="
+                version = Version(spec.version)
+                if version.micro != 0:
+                    max_version = f"{version.major}.{version.minor}.{version.micro - 1}"
+                elif version.minor != 0:
+                    max_version = f"{version.major}.{version.minor - 1}"
+                elif version.major != 0:
+                    max_version = f"{version.major - 1}.0"
+                else:
+                    return f"# NO BETTER CONSTRAINT: {req}"
+                return f"{requirement.name}{operator}{max_version}"
+        return f"# NO UPPER BOUND: {req}"
+
+
+def to_lower_bound(req):
+    try:
+        requirement = Requirement(req)
+    except ValueError:
+        return f"# UNPARSABLE: {req}"
+    else:
+        for spec in requirement.specifier:
+            if spec.operator == ">=":
+                if requirement.name == "pulpcore":
+                    # Currently an exception to allow for pulpcore bugfix releases.
+                    # TODO Semver libraries should be allowed too.
+                    operator = "~="
+                else:
+                    operator = "=="
+                min_version = spec.version
+                return f"{requirement.name}{operator}{min_version}"
+        return f"# NO LOWER BOUND: {req}"
+
+
+def main():
+    """Calculate constraints for the lower bound of dependencies where possible."""
+    parser = argparse.ArgumentParser(
+        prog=sys.argv[0],
+        description="Calculate constraints for the lower or upper bound of dependencies where "
+        "possible.",
+    )
+    parser.add_argument("-u", "--upper", action="store_true")
+    parser.add_argument("filename", nargs="*")
+    args = parser.parse_args()
+
+    modifier = to_upper_bound if args.upper else to_lower_bound
+
+    req_files = [filename for filename in args.filename if not filename.endswith("pyproject.toml")]
+    pyp_files = [filename for filename in args.filename if filename.endswith("pyproject.toml")]
+    if req_files:
+        with fileinput.input(files=req_files) as req_file:
+            for line in req_file:
+                if line.strip().startswith("#"):
+                    # Shortcut comment only lines
+                    print(line.strip())
+                else:
+                    req, comment = split_comment(line)
+                    new_req = modifier(req)
+                    print(new_req + comment)
+    for filename in pyp_files:
+        with open(filename, "rb") as fp:
+            pyproject = tomllib.load(fp)
+            for req in pyproject["project"]["dependencies"]:
+                new_req = modifier(req)
+                print(new_req)
+            optional_dependencies = pyproject["project"].get("optional-dependencies")
+            if optional_dependencies:
+                for opt in optional_dependencies.values():
+                    for req in opt:
+                        new_req = modifier(req)
+                        print(new_req)
+
+
+if __name__ == "__main__":
+    main()

cookiecutter/ci/{{ cookiecutter.__project_name }}/.ci/scripts/check_cli_dependencies.py

@@ -1,8 +1,15 @@
 #!/bin/env python3
-import tomllib
+# /// script
+# requires-python = ">=3.11"
+# dependencies = [
+#     "packaging>=25.0,<25.1",
+# ]
+# ///
+
 import typing as t
 from pathlib import Path
 
+import tomllib
 from packaging.requirements import Requirement
 
 GLUE_DIR = "pulp-glue{{ cookiecutter.__app_label_suffix }}"