Replace local release-cycle.json with PEPs repo version (#1685)

Co-authored-by: Adam Turner <[email protected]>

Author: hugovk

.pre-commit-config.yaml

@@ -7,14 +7,12 @@ repos:
         args: [--exit-non-zero-on-fix]
       - id: ruff-format
         name: Run Ruff (format)
-        args: [--check]
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0
     hooks:
       - id: check-case-conflict
       - id: check-merge-conflict
-      - id: check-json
       - id: check-yaml
       - id: debug-statements
       - id: end-of-file-fixer

Makefile

@@ -103,15 +103,20 @@ _ensure-pre-commit:
 lint: _ensure-pre-commit
 	$(VENVDIR)/bin/python3 -m pre_commit run --all-files
 
-# Defined so that "include/release-cycle.json"
-# doesn't fall through to the catch-all target.
-include/release-cycle.json:
-	@exit
-
-$(_RELEASE_CYCLE): include/release-cycle.json
+# Generate all release cycle files together with a single script invocation
+# Use branches.csv as the primary target, others depend on it
+include/branches.csv:
 	$(VENVDIR)/bin/python3 _tools/generate_release_cycle.py
 	@echo Release cycle data generated.
 
+# Other files are generated together with branches.csv
+include/end-of-life.csv: include/branches.csv
+	@:
+include/release-cycle-all.svg: include/branches.csv
+	@:
+include/release-cycle.svg: include/branches.csv
+	@:
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.
 .PHONY: Makefile

_tools/generate_release_cycle.py

@@ -7,6 +7,9 @@
 import csv
 import datetime as dt
 import json
+from functools import cache
+from pathlib import Path
+from urllib.request import urlopen
 
 import jinja2
 
@@ -37,12 +40,17 @@ def parse_version(ver: str) -> list[int]:
     return [int(i) for i in ver["key"].split(".")]
 
 
+@cache
+def get_versions() -> dict[str, dict[str, str | int]]:
+    with urlopen("https://peps.python.org/api/release-cycle.json") as in_file:
+        return json.loads(in_file.read().decode("utf-8"))
+
+
 class Versions:
     """For converting JSON to CSV and SVG."""
 
     def __init__(self, *, limit_to_active=False, special_py27=False) -> None:
-        with open("include/release-cycle.json", encoding="UTF-8") as in_file:
-            self.versions = json.load(in_file)
+        self.versions = get_versions()
 
         # Generate a few additional fields
         for key, version in self.versions.items():
@@ -197,6 +205,8 @@ def main() -> None:
 
     versions = Versions()
     assert len(versions.versions) > 10
+    Path("include").mkdir(exist_ok=True)
+
     versions.write_csv()
     versions.write_svg(args.today, "include/release-cycle-all.svg")
 

conf.py

@@ -1,4 +1,5 @@
 import json
+from urllib.request import urlopen
 
 extensions = [
     'notfound.extension',
@@ -182,8 +183,8 @@
 
 # Dynamically expose the Python version associated with the "main" branch.
 # Exactly one entry in ``release-cycle.json`` should have ``"branch": "main"``.
-with open("include/release-cycle.json", encoding="UTF-8") as _f:
-    _cycle = json.load(_f)
+with urlopen("https://peps.python.org/api/release-cycle.json") as _f:
+    _cycle = json.loads(_f.read().decode("utf-8"))
 
 _main_version = next(
     version for version, data in _cycle.items() if data.get("branch") == "main"