Lint: Normalise whitespace, remove the Emacs stanza, remove unneeded headers

.github/PULL_REQUEST_TEMPLATE/Mark a PEP Final.md

@@ -9,6 +9,6 @@ If you're unsure about something, just leave it blank and we'll take a look.
 * [ ] Any substantial changes since the accepted version approved by the SC/PEP delegate
 * [ ] Pull request title in appropriate format (``PEP 123: Mark Final``)
 * [ ] ``Status`` changed to ``Final`` (and ``Python-Version`` is correct)
-* [ ] Canonical docs/spec linked with a ``canonical-doc`` directive 
+* [ ] Canonical docs/spec linked with a ``canonical-doc`` directive
       (or ``canonical-pypa-spec`` for packaging PEPs,
        or ``canonical-typing-spec`` for typing PEPs)

.pre-commit-config.yaml

@@ -14,9 +14,14 @@ repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
     hooks:
+      - id: end-of-file-fixer
+        name: "Ensure files end with a single newline"
       - id: mixed-line-ending
         name: "Normalize mixed line endings"
         args: [--fix=lf]
+      - id: trailing-whitespace
+        name: "Remove trailing whitespace"
+
       - id: file-contents-sorter
         name: "Sort codespell ignore list"
         files: '.codespell/ignore-words.txt'

check-peps.py

@@ -39,16 +39,13 @@
 ALL_HEADERS = (
     "PEP",
     "Title",
-    "Version",
-    "Last-Modified",
     "Author",
     "Sponsor",
     "BDFL-Delegate", "PEP-Delegate",
     "Discussions-To",
     "Status",
     "Type",
     "Topic",
-    "Content-Type",
     "Requires",
     "Created",
     "Python-Version",
@@ -132,16 +129,18 @@ def check_headers(lines: Sequence[str], /) -> MessageIterator:
     yield from _validate_pep_number(next(iter(lines), ""))
 
     found_headers = {}
+    found_header_lines: list[tuple[str, int]] = []
     line_num = 0
     for line_num, line in enumerate(lines, start=1):
         if line.strip() == "":
             headers_end_line_num = line_num
             break
         if match := HEADER_PATTERN.match(line):
             header = match[1]
+            found_header_lines.append((header, line_num))
             if header in ALL_HEADERS:
                 if header not in found_headers:
-                    found_headers[match[1]] = line_num
+                    found_headers[header] = None
                 else:
                     yield line_num, f"Must not have duplicate header: {header} "
             else:
@@ -151,11 +150,11 @@ def check_headers(lines: Sequence[str], /) -> MessageIterator:
 
     yield from _validate_required_headers(found_headers.keys())
 
-    shifted_line_nums = list(found_headers.values())[1:]
-    for i, (header, line_num) in enumerate(found_headers.items()):
+    shifted_line_nums = [line for _, line in found_header_lines[1:]]
+    for i, (header, line_num) in enumerate(found_header_lines):
         start = line_num - 1
         end = headers_end_line_num - 1
-        if i < len(found_headers) - 1:
+        if i < len(found_header_lines) - 1:
             end = shifted_line_nums[i] - 1
         remainder = "\n".join(lines[start:end]).removeprefix(f"{header}:")
         if remainder != "":
@@ -182,8 +181,6 @@ def _validate_header(header: str, line_num: int, content: str) -> MessageIterato
         yield from _validate_type(line_num, content)
     elif header == "Topic":
         yield from _validate_topic(line_num, content)
-    elif header == "Content-Type":
-        yield from _validate_content_type(line_num, content)
     elif header in {"Requires", "Replaces", "Superseded-By"}:
         yield from _validate_pep_references(line_num, content)
     elif header == "Created":
@@ -348,13 +345,6 @@ def _validate_topic(line_num: int, line: str) -> MessageIterator:
         yield line_num, "Topic must be sorted lexicographically"
 
 
-def _validate_content_type(line_num: int, line: str) -> MessageIterator:
-    """'Content-Type' must be 'text/x-rst'"""
-
-    if line != "text/x-rst":
-        yield line_num, "Content-Type must be 'text/x-rst'"
-
-
 def _validate_pep_references(line_num: int, line: str) -> MessageIterator:
     """`Requires`/`Replaces`/`Superseded-By` must be 'NNN' PEP IDs"""
 

pep_sphinx_extensions/tests/pep_lint/test_headers.py

@@ -253,30 +253,6 @@ def test_validate_topic(line: str, expected_warnings: set):
     assert found_warnings == expected_warnings
 
 
-def test_validate_content_type_valid():
-    warnings = [
-        warning for (_, warning) in check_peps._validate_content_type(1, "text/x-rst")
-    ]
-    assert warnings == [], warnings
-
-
-@pytest.mark.parametrize(
-    "line",
-    [
-        "text/plain",
-        "text/markdown",
-        "text/csv",
-        "text/rtf",
-        "text/javascript",
-        "text/html",
-        "text/xml",
-    ],
-)
-def test_validate_content_type_invalid(line: str):
-    warnings = [warning for (_, warning) in check_peps._validate_content_type(1, line)]
-    assert warnings == ["Content-Type must be 'text/x-rst'"], warnings
-
-
 @pytest.mark.parametrize(
     "line",
     [

pep_sphinx_extensions/tests/pep_lint/test_pep_lint.py

@@ -12,33 +12,30 @@ def test_with_fake_pep():
     warnings = list(check_peps.check_peps(PEP_9002, content))
     assert warnings == [
         (1, "PEP must begin with the 'PEP:' header"),
+        (6, "Must not have invalid header: Version"),
         (9, "Must not have duplicate header: Sponsor "),
         (10, "Must not have invalid header: Horse-Guards"),
+        (15, "Must not have invalid header: Content-Type"),
         (1, "Must have required header: PEP"),
         (1, "Must have required header: Type"),
         (
             1,
-            "Headers must be in PEP 12 order. Correct order: Title, Version, "
-            "Author, Sponsor, BDFL-Delegate, Discussions-To, Status, Topic, "
-            "Content-Type, Requires, Created, Python-Version, Post-History, "
-            "Resolution",
+            "Headers must be in PEP 12 order. Correct order: Title, Author, "
+            "Sponsor, BDFL-Delegate, Discussions-To, Status, Topic, Requires, "
+            "Created, Python-Version, Post-History, Resolution",
         ),
         (4, "Author continuation lines must end with a comma"),
         (5, "Author line must not be over-indented"),
         (7, "Python-Version major part must be 1, 2, or 3: 4.0"),
-        (
-            8,
-            "Sponsor entries must begin with a valid 'Name': "
-            r"'Sponsor:\nHorse-Guards: Parade'",
-        ),
+        (8, "Sponsor entries must begin with a valid 'Name': ''"),
+        (9, "Sponsor entries must begin with a valid 'Name': ''"),
         (11, "Created must be a 'DD-mmm-YYYY' date: '1-Jan-1989'"),
         (12, "Delegate entries must begin with a valid 'Name': 'Barry!'"),
         (13, "Status must be a valid PEP status"),
         (14, "Topic must not contain duplicates"),
         (14, "Topic must be properly capitalised (Title Case)"),
         (14, "Topic must be for a valid sub-index"),
         (14, "Topic must be sorted lexicographically"),
-        (15, "Content-Type must be 'text/x-rst'"),
         (16, "PEP references must be separated by comma-spaces (', ')"),
         (17, "Discussions-To must be a valid thread URL or mailing list"),
         (18, "Post-History must be a 'DD-mmm-YYYY' date: '2-Feb-2000'"),

pep_sphinx_extensions/tests/peps/pep-9000.rst

@@ -1,6 +1,6 @@
 PEP: 9000
 Title: Test with authors with email addresses
-Author: Francis Fussyreverend <[email protected]>, 
+Author: Francis Fussyreverend <[email protected]>,
         Javier Soulfulcommodore <[email protected]>
 Created: 20-Apr-2022
 Status: Draft

peps/pep-0002.rst

@@ -1,12 +1,9 @@
 PEP: 2
 Title: Procedure for Adding New Modules
-Version: $Revision$
-Last-Modified: $Date$
 Author: Brett Cannon <[email protected]>,
         Martijn Faassen <[email protected]>
 Status: Active
 Type: Process
-Content-Type: text/x-rst
 Created: 07-Jul-2001
 Post-History: 07-Jul-2001, 09-Mar-2002
 

peps/pep-0004.rst

@@ -1,11 +1,8 @@
 PEP: 4
 Title: Deprecation of Standard Modules
-Version: $Revision$
-Last-Modified: $Date$
 Author: Brett Cannon <[email protected]>, Martin von Löwis <[email protected]>
 Status: Active
 Type: Process
-Content-Type: text/x-rst
 Created: 01-Oct-2000
 Post-History:
 

peps/pep-0005.rst

@@ -3,7 +3,6 @@ Title: Guidelines for Language Evolution
 Author: Paul Prescod <[email protected]>
 Status: Superseded
 Type: Process
-Content-Type: text/x-rst
 Created: 26-Oct-2000
 Post-History:
 Superseded-By: 387

peps/pep-0006.rst

@@ -3,7 +3,6 @@ Title: Bug Fix Releases
 Author: Aahz <[email protected]>, Anthony Baxter <[email protected]>
 Status: Superseded
 Type: Process
-Content-Type: text/x-rst
 Created: 15-Mar-2001
 Post-History: 15-Mar-2001, 18-Apr-2001, 19-Aug-2004
 

peps/pep-0008.rst

@@ -820,7 +820,7 @@ complete sentences, with each sentence ending in a period.
 You should use one or two spaces after a sentence-ending period in
 multi-sentence comments, except after the final sentence.
 
-Ensure that your comments are clear and easily understandable to other 
+Ensure that your comments are clear and easily understandable to other
 speakers of the language you are writing in.
 
 Python coders from non-English speaking countries: please write your

peps/pep-0010.rst

@@ -3,7 +3,6 @@ Title: Voting Guidelines
 Author: Barry Warsaw <[email protected]>
 Status: Active
 Type: Process
-Content-Type: text/x-rst
 Created: 07-Mar-2002
 Post-History: 07-Mar-2002
 

peps/pep-0011.rst

@@ -4,7 +4,6 @@ Author: Martin von Löwis <[email protected]>,
         Brett Cannon <[email protected]>
 Status: Active
 Type: Process
-Content-Type: text/x-rst
 Created: 07-Jul-2002
 Post-History: `18-Aug-2007 <https://mail.python.org/archives/list/[email protected]/thread/DSSGXU5LBCMKYMZBRVB6RF3YAB6ST5AV/>`__,
               `14-May-2014 <https://mail.python.org/archives/list/[email protected]/thread/T7WTUJ6TD3IGYGWV3M4PHJWNLM2WPZAW/>`__,

peps/pep-0013.rst

@@ -4,7 +4,6 @@ Author: The Python core team and community
 Status: Active
 Type: Process
 Topic: Governance
-Content-Type: text/x-rst
 Created: 16-Dec-2018
 
 

peps/pep-0020.rst

@@ -3,7 +3,6 @@ Title: The Zen of Python
 Author: Tim Peters <[email protected]>
 Status: Active
 Type: Informational
-Content-Type: text/x-rst
 Created: 19-Aug-2004
 Post-History: 22-Aug-2004
 

peps/pep-0100.rst

@@ -3,7 +3,6 @@ Title: Python Unicode Integration
 Author: Marc-André Lemburg <[email protected]>
 Status: Final
 Type: Standards Track
-Content-Type: text/x-rst
 Created: 10-Mar-2000
 Python-Version: 2.0
 Post-History:

peps/pep-0102.rst

@@ -5,7 +5,6 @@ Author: Anthony Baxter <[email protected]>,
         Guido van Rossum <[email protected]>
 Status: Superseded
 Type: Informational
-Content-Type: text/x-rst
 Created: 09-Jan-2002
 Post-History:
 Superseded-By: 101

peps/pep-0160.rst

@@ -1,12 +1,9 @@
 PEP: 160
 Title: Python 1.6 Release Schedule
-Version: $Revision$
-Last-Modified: $Date$
 Author: Fred L. Drake, Jr. <[email protected]>
 Status: Final
 Type: Informational
 Topic: Release
-Content-Type: text/x-rst
 Created: 25-Jul-2000
 Python-Version: 1.6
 Post-History:
@@ -74,11 +71,3 @@ Copyright
 =========
 
 This document has been placed in the public domain.
-
-
-
-..
-  Local Variables:
-  mode: indented-text
-  indent-tabs-mode: nil
-  End:

peps/pep-0200.rst

@@ -1,12 +1,9 @@
 PEP: 200
 Title: Python 2.0 Release Schedule
-Version: $Revision$
-Last-Modified: $Date$
 Author: Jeremy Hylton <[email protected]>
 Status: Final
 Type: Informational
 Topic: Release
-Content-Type: text/x-rst
 Created: 12-Jul-2000
 Python-Version: 2.0
 Post-History:
@@ -379,10 +376,3 @@ Rejected
 * 'indexing-for' - Thomas Wouters Special syntax to give Python code
   access to the loop-counter in 'for' loops. (Without adding a new
   keyword.)
-
-
-..
-   Local Variables:
-   mode: indented-text
-   indent-tabs-mode: nil
-   End:

peps/pep-0201.rst

@@ -3,7 +3,6 @@ Title: Lockstep Iteration
 Author: Barry Warsaw <[email protected]>
 Status: Final
 Type: Standards Track
-Content-Type: text/x-rst
 Created: 13-Jul-2000
 Python-Version: 2.0
 Post-History: 27-Jul-2000

peps/pep-0202.rst

@@ -3,7 +3,6 @@ Title: List Comprehensions
 Author: Barry Warsaw <[email protected]>
 Status: Final
 Type: Standards Track
-Content-Type: text/x-rst
 Created: 13-Jul-2000
 Python-Version: 2.0
 Post-History:

peps/pep-0203.rst

@@ -3,7 +3,6 @@ Title: Augmented Assignments
 Author: Thomas Wouters <[email protected]>
 Status: Final
 Type: Standards Track
-Content-Type: text/x-rst
 Created: 13-Jul-2000
 Python-Version: 2.0
 Post-History: 14-Aug-2000

peps/pep-0205.rst

@@ -1,11 +1,8 @@
 PEP: 205
 Title: Weak References
-Version: $Revision$
-Last-Modified: $Date$
 Author: Fred L. Drake, Jr. <[email protected]>
 Status: Final
 Type: Standards Track
-Content-Type: text/x-rst
 Created: 14-Jul-2000
 Python-Version: 2.1
 Post-History: 11-Jan-2001
@@ -453,13 +450,3 @@ Copyright
 =========
 
 This document has been placed in the public domain.
-
-
-..
-   Local Variables:
-   mode: indented-text
-   indent-tabs-mode: nil
-   sentence-end-double-space: t
-   fill-column: 70
-   coding: utf-8
-   End:

peps/pep-0207.rst

@@ -3,7 +3,6 @@ Title: Rich Comparisons
 Author: Guido van Rossum <[email protected]>, David Ascher <[email protected]>
 Status: Final
 Type: Standards Track
-Content-Type: text/x-rst
 Created: 25-Jul-2000
 Python-Version: 2.1
 Post-History:

peps/pep-0208.rst

@@ -3,7 +3,6 @@ Title: Reworking the Coercion Model
 Author: Neil Schemenauer <[email protected]>, Marc-André Lemburg <[email protected]>
 Status: Final
 Type: Standards Track
-Content-Type: text/x-rst
 Created: 04-Dec-2000
 Python-Version: 2.1
 Post-History:

peps/pep-0212.rst

@@ -3,7 +3,6 @@ Title: Loop Counter Iteration
 Author: Peter Schneider-Kamp <[email protected]>
 Status: Rejected
 Type: Standards Track
-Content-Type: text/x-rst
 Created: 22-Aug-2000
 Python-Version: 2.1
 Post-History: