dynamically add supported Python versions to tox matrix, drawing from package metadata (requires-python) (#326)

* dynamically add supported Python versions to tox matrix, drawing from package metadata (`requires-python`)

* Apply suggestion from @Cadair

* Apply suggestion from @Cadair

Co-authored-by: Stuart Mumford <stuart@cadair.com>

* set `persist-credentials: false` in checkout

* ignore line in zimzor

* replace usage of `peppyproject` with simply reading `pyproject.toml`

---------

Co-authored-by: Stuart Mumford <stuart@cadair.com>

Author: zacharyburnett

.github/workflows/test_tox.yml

@@ -68,6 +68,16 @@ jobs:
           posargs: 'PyPy'
       pytest: false
 
+  test_supported_pythons:
+    uses: ./.github/workflows/tox.yml
+    with:
+      envs: |
+        - linux: pep8
+        - linux: py3
+      fill: true
+      fill_platforms: linux,macos
+      pytest: false
+
   test_libraries:
     uses: ./.github/workflows/tox.yml
     with:

.github/workflows/tox.yml

@@ -0,0 +1,123 @@
+# /// script
+# requires-python = ">=3.12"
+# dependencies = [
+#     "click==8.2.1",
+#     "packaging==25.0",
+#     "requests==2.32.5",
+#     "tomli==2.4.0",
+# ]
+# ///
+import os
+import warnings
+from pathlib import Path
+
+import click
+import requests
+import tomli
+from packaging.specifiers import SpecifierSet
+from packaging.version import Version
+
+
+@click.command()
+@click.option("--package-source", default=None)
+@click.option("--factors", default=None)
+@click.option("--no-eoas", is_flag=True, default=False)
+@click.option("--platforms", default=None)
+def supported_python_envs_block(
+    package_source: Path = None,
+    factors: list[str] = None,
+    no_eoas: bool = False,
+    platforms: list[str] = None,
+):
+    """enumerate toxenvs for each Python version supported by package"""
+
+    if platforms is None:
+        platforms = ["linux"]
+    elif isinstance(platforms, str):
+        platforms = platforms.split(",")
+
+    toxenvs = supported_python_toxenvs(package_source, factors, no_eoas)
+    envs_block = "\\n".join(
+        f"- {platform}: {toxenv}" for platform in platforms for toxenv in toxenvs
+    )
+
+    print(envs_block)
+    with open(os.environ["GITHUB_OUTPUT"], "a") as f:
+        f.write(f"envs={envs_block}\n")
+
+
+def supported_python_toxenvs(
+    package_source: Path = None,
+    factors: list[str] = None,
+    no_eoas: bool = False,
+) -> list[str]:
+    if isinstance(factors, str):
+        factors = factors.split(",")
+
+    return [
+        f"py{str(python_version).replace('.', '')}{'-' + '-'.join(factors) if factors is not None and len(factors) > 0 else ''}"
+        for python_version in supported_pythons(package_source, no_eoas=no_eoas)
+    ]
+
+
+def supported_pythons(
+    package_source: Path = None,
+    no_eoas: bool = False,
+) -> list[Version]:
+    current_python_versions = current_pythons(no_eoas=no_eoas)
+
+    if not package_source:
+        supported_versions = current_python_versions
+    else:
+        try:
+            pyproject_toml_filename = Path(package_source) / "pyproject.toml"
+            if pyproject_toml_filename.exists():
+                with open(pyproject_toml_filename, "rb") as pyproject_toml_file:
+                    pyproject_toml = tomli.load(pyproject_toml_file)
+                if "project" in pyproject_toml:
+                    project_metadata = pyproject_toml["table"]
+                    if "requires_python" in project_metadata:
+                        python_version_requirements = SpecifierSet(
+                            project_metadata["requires-python"]
+                        )
+                    else:
+                        raise KeyError(
+                            "`project.requires_python` not found in `pyproject.toml`; ensure your package conforms to PEP621"
+                        )
+                else:
+                    raise KeyError(
+                        "`project` not found in `pyproject.toml`; ensure your package conforms to PEP621"
+                    )
+            else:
+                raise FileNotFoundError(
+                    "could not find `pyproject.toml` in the provided package source; ensure your package conforms to PEP621"
+                )
+
+            supported_versions = [
+                python_version
+                for python_version in current_python_versions
+                if python_version in python_version_requirements
+            ]
+        except (KeyError, TypeError, FileNotFoundError) as error:
+            warnings.warn(str(error))
+            warnings.warn("falling back to current Python versions...")
+            supported_versions = current_python_versions
+
+    return supported_versions
+
+
+def current_pythons(no_eoas: bool = False) -> list[Version]:
+    url = "https://endoflife.date/api/v1/products/python"
+    response = requests.get("https://endoflife.date/api/v1/products/python")
+    if response.status_code == 200:
+        return [
+            Version(python_version["name"])
+            for python_version in response.json()["result"]["releases"]
+            if not python_version["isEoas" if no_eoas else "isEol"]
+        ]
+    else:
+        raise ValueError(f"request to {url} returned status code {response.status_code}")
+
+
+if __name__ == "__main__":
+    supported_python_envs_block()

tools/supported_pythons.py

@@ -61,7 +61,7 @@ def load_tox_targets(
 ):
     """Script to load tox targets for GitHub Actions workflow."""
     # Load envs config
-    envs = yaml.load(envs, Loader=yaml.BaseLoader)
+    envs = yaml.load(envs.replace("\\n", "\n"), Loader=yaml.BaseLoader)
     print(json.dumps(envs, indent=2))
 
     # Load global libraries config

tools/tox_matrix.py

@@ -34,3 +34,4 @@ def base64_encode_into(script, yml_file, env_var):
 base64_encode_into('set_env.py', 'tox.yml', 'SET_ENV_SCRIPT')
 base64_encode_into('set_env.py', 'publish.yml', 'SET_ENV_SCRIPT')
 base64_encode_into('set_env.py', 'publish_pure_python.yml', 'SET_ENV_SCRIPT')
+base64_encode_into('supported_pythons.py', 'tox.yml', 'SUPPORTED_PYTHONS_SCRIPT')