Hugo's review

Author: AA-Turner

pytest.ini

@@ -5,12 +5,12 @@ addopts =
     --strict-config
     --strict-markers
     --import-mode=importlib
-    --cov check_peps --cov pep_sphinx_extensions
+    --cov check_peps --cov pep_sphinx_extensions --cov release_management
     --cov-report html --cov-report xml
 empty_parameter_set_mark = fail_at_collect
 filterwarnings =
     error
 minversion = 6.0
-testpaths = pep_sphinx_extensions
+testpaths = pep_sphinx_extensions release_management
 xfail_strict = True
 disable_test_id_escaping_and_forfeit_all_rights_to_community_support = True

release_management/serialize.py

@@ -8,12 +8,20 @@
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
-    from release_management import VersionMetadata
+    from release_management import ReleaseInfo, VersionMetadata
 
 # Seven years captures the full lifecycle from prereleases to end-of-life
 TODAY = dt.date.today()
 SEVEN_YEARS_AGO = TODAY.replace(year=TODAY.year - 7)
 
+# https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.11
+CALENDAR_ESCAPE_TEXT = str.maketrans({
+    '\\': r'\\',
+    ';': r'\;',
+    ',': r'\,',
+    '\n': r'\n',
+})
+
 
 def create_release_json() -> str:
     python_releases = dataclasses.asdict(load_python_releases())
@@ -57,26 +65,37 @@ def version_info(metadata: VersionMetadata, /) -> dict[str, str | int]:
 
 def create_release_schedule_calendar() -> str:
     python_releases = load_python_releases()
-    all_releases = [
-        (version, release)
-        for version, releases in python_releases.releases.items()
-        for release in releases
-        # Keep size reasonable by omitting releases older than 7 years
-        if release.date >= SEVEN_YEARS_AGO
-    ]
-    all_releases.sort(key=lambda r: r[1].date)
+    releases = []
+    for version, all_releases in python_releases.releases.items():
+        pep_number = python_releases.metadata[version].pep
+        for release in all_releases:
+            # Keep size reasonable by omitting releases older than 7 years
+            if release.date < SEVEN_YEARS_AGO:
+                continue
+            releases.append((pep_number, release))
+    releases.sort(key=lambda r: r[1].date)
+    lines = release_schedule_calendar_lines(releases)
+    return '\r\n'.join(lines)
 
+
+def release_schedule_calendar_lines(
+    releases: list[tuple[int, ReleaseInfo]], /
+) -> list[str]:
     lines = [
         'BEGIN:VCALENDAR',
         'VERSION:2.0',
         'PRODID:-//Python Software Foundation//Python release schedule//EN',
         'X-WR-CALDESC:Python releases schedule from https://peps.python.org',
         'X-WR-CALNAME:Python releases schedule',
     ]
-    for version, release in all_releases:
+    for pep_number, release in releases:
         normalised_stage = release.stage.casefold().replace(' ', '')
-        note = (f'DESCRIPTION:Note: {release.note}',) if release.note else ()
-        pep_number = python_releases.metadata[version].pep
+        normalised_stage = normalised_stage.translate(CALENDAR_ESCAPE_TEXT)
+        if release.note:
+            normalised_note = release.note.translate(CALENDAR_ESCAPE_TEXT)
+            note = (f'DESCRIPTION:Note: {normalised_note}',)
+        else:
+            note = ()
         lines += (
             'BEGIN:VEVENT',
             f'SUMMARY:Python {release.stage}',
@@ -90,4 +109,4 @@ def create_release_schedule_calendar() -> str:
         'END:VCALENDAR',
         '',
     )
-    return '\n'.join(lines)
+    return lines

release_management/tests/test_release_schedule_calendar.py

@@ -1,24 +1,18 @@
-import pytest
+import datetime as dt
 
-from release_management import serialize
+from release_management import ReleaseInfo, serialize
 
-
-@pytest.mark.parametrize(
-    ('test_input', 'expected'),
-    [
-        ('3.14.0 alpha 1', 'python-3.14.0alpha1@releases.python.org'),
-        ('3.14.0 beta 2', 'python-3.14.0beta2@releases.python.org'),
-        ('3.14.0 candidate 3', 'python-3.14.0candidate3@releases.python.org'),
-        ('3.14.1', 'python-3.14.1@releases.python.org'),
-    ],
+FAKE_RELEASE = ReleaseInfo(
+    stage='X.Y.Z final',
+    state='actual',
+    date=dt.date(2000, 1, 1),
+    note='These characters need escaping: \\ , ; \n',
 )
-def test_ical_uid(test_input, expected):
-    assert serialize.ical_uid(test_input) == expected
 
 
-def test_create_release_calendar_has_calendar_metadata():
+def test_create_release_calendar_has_calendar_metadata() -> None:
     # Act
-    cal_lines = serialize.create_release_schedule_calendar().split('\n')
+    cal_lines = serialize.create_release_schedule_calendar().split('\r\n')
 
     # Assert
 
@@ -36,15 +30,18 @@ def test_create_release_calendar_has_calendar_metadata():
     ]
 
 
-def test_create_release_calendar_first_event():
+def test_create_release_calendar_first_event() -> None:
     # Act
-    cal_lines = serialize.create_release_schedule_calendar().split('\n')
+    releases = [(9999, FAKE_RELEASE)]
+    cal_lines = serialize.release_schedule_calendar_lines(releases)
 
     # Assert
     assert cal_lines[5] == 'BEGIN:VEVENT'
-    assert cal_lines[6].startswith('SUMMARY:Python ')
-    assert cal_lines[7].startswith('DTSTART;VALUE=DATE:')
-    assert cal_lines[8].startswith('UID:python-')
-    assert cal_lines[8].endswith('@release.python.org')
-    assert cal_lines[9].startswith('URL:https://peps.python.org/pep-')
-    assert cal_lines[10].startswith('END:VEVENT')
+    assert cal_lines[6] == 'SUMMARY:Python X.Y.Z final'
+    assert cal_lines[7] == 'DTSTART;VALUE=DATE:20000101'
+    assert cal_lines[8] == 'UID:python-x.y.zfinal@releases.python.org'
+    assert cal_lines[9] == (
+        'DESCRIPTION:Note: These characters need escaping: \\\\ \\, \\; \\n'
+    )
+    assert cal_lines[10] == 'URL:https://peps.python.org/pep-9999/'
+    assert cal_lines[11] == 'END:VEVENT'