Lint: Update headers and checks per current guidance & provide helpful feedback

.pre-commit-config.yaml

@@ -17,8 +17,6 @@ repos:
  - id: mixed-line-ending
  name: "Normalize mixed line endings"
  args: [--fix=lf]
- - id: fix-byte-order-marker
- name: "Remove Unicode BOM"
  - id: file-contents-sorter
  name: "Sort codespell ignore list"
  files: '.codespell/ignore-words.txt'
@@ -35,8 +33,8 @@ repos:
  - id: check-vcs-permalinks
  name: "Check that VCS links are permalinks"
 
- - id: check-ast
- name: "Check Python AST"
+# - id: check-ast
+#  name: "Check Python AST"
  - id: check-json
  name: "Check JSON"
  - id: check-toml
@@ -76,70 +74,136 @@ repos:
  entry: '\t'
  files: '^pep-\d+\.(rst|txt)$'
  types: [text]
+
  - id: check-required-fields
- name: "Check PEPs have all required fields"
+ name: "Check PEPs have all required headers"
  language: pygrep
  entry: '(?-m:^PEP:(?=[\s\S]*\nTitle:)(?=[\s\S]*\nAuthor:)(?=[\s\S]*\nStatus:)(?=[\s\S]*\nType:)(?=[\s\S]*\nContent-Type:)(?=[\s\S]*\nCreated:))'
  args: ['--negate', '--multiline']
  files: '^pep-\d+\.(rst|txt)$'
  types: [text]
+
  - id: validate-pep-number
- name: "Validate PEPnumber field"
+ name: "'PEP' header must be a number 1-9999"
  language: pygrep
  entry: '(?-m:^PEP:(?:(?! +(0|[1-9][0-9]{0,3})\n)))'
  args: ['--multiline']
  files: '^pep-\d+\.(rst|txt)$'
  types: [text]
+
+ - id: validate-title
+ name: "'Title' must be 1-79 characters"
+ language: pygrep
+ entry: '(?<=\n)Title:(?:(?! +\S.{1,78}\n(?=[A-Z])))'
+ args: ['--multiline']
+ files: '^pep-\d+\.(rst|txt)$'
+ exclude: '^pep-(0499)\.(rst|txt)$'
+ types: [text]
+
+ - id: validate-author
+ name: "'Author' must be list of 'Name <email@example.com>, ...'"
+ language: pygrep
+ entry: '(?<=\n)Author:(?:(?!((( +|\n {1,8})[^!#$%&()*+,/:;<=>?@\[\\\]\^_`{|}~]+( <[\w!#$%&''*+\-/=?^_{|}~.]+(@| at )[\w\-.]+\.[A-Za-z0-9]+>)?)(,|(?=\n[^ ])))+\n(?=[A-Z])))'
+ args: [--multiline]
+ files: '^pep-\d+\.rst$'
+ types: [text]
+
+ - id: validate-author-legacy
+ name: "Legacy 'Author' must be a list of names/emails"
+ language: pygrep
+ entry: '(?<=\n)Author:(?:(?!((((( +|\n {1,8})[^!#$%&()*+,/:;<=>?@\[\\\]\^_`{|}~]+( <[\w!#$%&''*+\-/=?^_{|}~.]+(@| at )[\w\-.]+\.[A-Za-z0-9]+>)?)(,|(?=\n[^ ])))+)|(((( +|\n {1,8})[\w!#$%&''*+\-/=?^_{|}~.]+(@| at )[\w\-.]+\.[A-Za-z0-9]+) \(([^!#$%&()*+,/:;<=>?@\[\\\]\^_`{|}~]+)\)(,|(?=\n[^ ])))+))\n(?=[A-Z])))'
+ args: [--multiline]
+ files: '^pep-\d+\.(rst|txt)$'
+ types: [text]
+
+ - id: validate-sponsor
+ name: "'Sponsor' must have format 'Name <email@example.com>'"
+ language: pygrep
+ entry: '^Sponsor:(?: (?! *[^!#$%&()*+,/:;<=>?@\[\\\]\^_`{|}~]+( <[\w!#$%&''*+\-/=?^_{|}~.]+(@| at )[\w\-.]+\.[A-Za-z0-9]+>)?$))'
+ files: '^pep-\d+\.(rst|txt)$'
+ types: [text]
+
+ - id: validate-delegate
+ name: "'Delegate' must have format 'Name <email@example.com>'"
+ language: pygrep
+ entry: '^(PEP|BDFL)-Delegate: (?:(?! *[^!#$%&()*+,/:;<=>?@\[\\\]\^_`{|}~]+( <[\w!#$%&''*+\-/=?^_{|}~.]+(@| at )[\w\-.]+\.[A-Za-z0-9]+>)?$))'
+ files: '^pep-\d+\.(rst|txt)$'
+ exclude: '^pep-(0451)\.(rst|txt)$'
+ types: [text]
+
+ - id: validate-discussions-to
+ name: "'Discussions-To' must be a thread URL"
+ language: pygrep
+ entry: '^Discussions-To: (?:(?!([\w\-]+@(python\.org|googlegroups\.com))|https://((discuss\.python\.org/t/([\w\-]+/)?\d+/?)|(mail\.python\.org/pipermail/[\w\-]+/\d{4}-[A-Za-z]+/[A-Za-z0-9]+\.html)|(mail\.python\.org/archives/list/[\w\-]+@python\.org/thread/[A-Za-z0-9]+/?))$))'
+ files: '^pep-\d+\.(rst|txt)$'
+ types: [text]
+
  - id: validate-status
- name: "Validate PEP 'Status' field"
+ name: "'Status' must be a valid PEP status"
  language: pygrep
  entry: '^Status:(?:(?! +(Draft|Withdrawn|Rejected|Accepted|Final|Active|Provisional|Deferred|Superseded|April Fool!)$))'
  files: '^pep-\d+\.(rst|txt)$'
  types: [text]
+
  - id: validate-type
- name: "Validate PEP 'Type' field"
+ name: "'Type' must be a valid PEP type"
  language: pygrep
  entry: '^Type:(?:(?! +(Standards Track|Informational|Process)$))'
  files: '^pep-\d+\.(rst|txt)$'
  types: [text]
+
  - id: validate-content-type
- name: "Validate PEP 'Content-Type' field"
+ name: "'Content-Type' must be 'text/x-rst'"
  language: pygrep
- entry: '^Content-Type:(?:(?! +text\/x-rst$))'
+ entry: '^Content-Type:(?:(?! +text/x-rst$))'
  files: '^pep-\d+\.(rst|txt)$'
  types: [text]
+
  - id: validate-pep-references
- name: "Validate PEP reference fields"
+ name: "`Requires`/`Replaces`/`Superseded-By` must be 'NNN' PEP IDs"
  language: pygrep
- entry: '^(Requires|Replaces|Superseded-By):(?:(?! +( ?(0|[1-9][0-9]{0,3}),?)+$))'
+ entry: '^(Requires|Replaces|Superseded-By):(?:(?! *( (0|[1-9][0-9]{0,3})(,|$))+$))'
  files: '^pep-\d+\.(rst|txt)$'
  types: [text]
+
  - id: validate-created
- name: "Validate PEP 'Created' field"
+ name: "'Created' must be a 'DD-mmm-YYYY' date"
  language: pygrep
- entry: '^Created:(?:(?! +([0-2][0-9]|(3[01]))-(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)-(199[0-9]|20[0-9][0-9])( \([^()]+\))?$))'
+ entry: '^Created:(?:(?! +([0-2][0-9]|(3[01]))-(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)-(199[0-9]|20[0-9][0-9])$))'
  files: '^pep-\d+\.(rst|txt)$'
  types: [text]
+
  - id: validate-python-version
- name: "Validate PEP 'Python-Version' field"
+ name: "'Python-Version' must be a 'X.Y[.Z]` version"
  language: pygrep
- entry: '^Python-Version:(?:(?! +( ?[1-9]\.([0-9][0-9]?|x)(\.[1-9][0-9]?)?\??,?)+( \([^()]+\))?$))'
+ entry: '^Python-Version:(?:(?! *( [1-9]\.([0-9][0-9]?|x)(\.[1-9][0-9]?)?(,|$))+$))'
  files: '^pep-\d+\.(rst|txt)$'
  types: [text]
+
+ - id: validate-post-history
+ name: "'Post-History' must be '`DD-mmm-YYYY <Thread URL>`__, ...'"
+ language: pygrep
+ entry: '(?<=\n)Post-History:(?:(?! ?\n|((( +|\n {1,14})(([0-2][0-9]|(3[01]))-(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)-(199[0-9]|20[0-9][0-9])|`([0-2][0-9]|(3[01]))-(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)-(199[0-9]|20[0-9][0-9]) <https://((discuss\.python\.org/t/([\w\-]+/)?\d+/?)|(mail\.python\.org/pipermail/[\w\-]+/\d{4}-[A-Za-z]+/[A-Za-z0-9]+\.html)|(mail\.python\.org/archives/list/[\w\-]+@python\.org/thread/[A-Za-z0-9]+/?(#[A-Za-z0-9]+)?))>`__)(,|(?=\n[^ ])))+\n(?=[A-Z\n]))))'
+ args: [--multiline]
+ files: '^pep-\d+\.(rst|txt)$'
+ types: [text]
+
  - id: validate-resolution
- name: "Validate PEP 'Resolution' field"
+ name: "'Resolution' must be a direct thread/message URL"
  language: pygrep
- entry: '(?<!\n\n)^Resolution: (?:(?!(https:\/\/\S*|:pep:`[a-zA-Z\d \-<>#]*?`)\n))'
+ entry: '(?<!\n\n)(?<=\n)Resolution: (?:(?!https://((discuss\.python\.org/t/([\w\-]+/)?\d+(/\d+)?/?)|(mail\.python\.org/pipermail/[\w\-]+/\d{4}-[A-Za-z]+/[A-Za-z0-9]+\.html)|(mail\.python\.org/archives/list/[\w\-]+@python\.org/(message|thread)/[A-Za-z0-9]+/?(#[A-Za-z0-9]+)?))\n(?=\n)))'
  args: ['--multiline']
  files: '^pep-\d+\.(rst|txt)$'
  types: [text]
+
  - id: check-direct-pep-links
  name: "Check that PEPs aren't linked directly"
  language: pygrep
  entry: '(dev/peps|peps\.python\.org)/pep-\d+'
  files: '^pep-\d+\.(rst|txt)$'
  exclude: '^pep-(0009|0287|0676|8001)\.(rst|txt)$'
  types: [text]
+
  - id: check-direct-rfc-links
  name: "Check that RFCs aren't linked directly"
  language: pygrep

pep-0042.txt

@@ -3,15 +3,14 @@ Title: Feature Requests
 Version: $Revision$
 Last-Modified: $Date$
 Author: Jeremy Hylton <jeremy@alum.mit.edu>
-Status: Rejected
+Status: Withdrawn
 Type: Process
 Content-Type: text/x-rst
 Created: 12-Sep-2000
 Post-History:
-Resolution: https://github.com/python/peps/pull/108#issuecomment-249603204
 
 
-.. note:: This PEP has been rejected as obsolete.
+.. note:: This PEP has been `withdrawn as obsolete`_.
  All new feature requests should either go to the `Python bug tracker`_
  for very simple requests or the `python-ideas`_ mailing list for
  everything else. The rest of this document is retained for historical
@@ -335,6 +334,8 @@ Building and Installing
 
 .. _`Python bug tracker`: https://bugs.python.org
 .. _`python-ideas`: https://mail.python.org/mailman/listinfo/python-ideas
+.. _`withdrawn as obsolete`: https://github.com/python/peps/pull/108#issuecomment-249603204
+
 
 ..
  Local Variables:

pep-0102.txt

@@ -8,7 +8,7 @@ Author: anthony@interlink.com.au (Anthony Baxter),
 Status: Superseded
 Type: Informational
 Content-Type: text/x-rst
-Created: 22-Aug-2001 (edited down on 9-Jan-2002 to become :pep:`102`)
+Created: 09-Jan-2002
 Post-History:
 Superseded-By: 101
 

pep-0211.txt

@@ -9,7 +9,14 @@ Content-Type: text/x-rst
 Created: 15-Jul-2000
 Python-Version: 2.1
 Post-History:
-Resolution: :pep:`PEP 465 -- Rejected alternatives to adding a new operator <465#rejected-alternatives-to-adding-a-new-operator>`
+
+
+.. note::
+
+ The approach in the later :pep:`465` was eventually accepted
+ in lieu of this PEP. The :pep:`Rejected Ideas
+ <465#rejected-alternatives-to-adding-a-new-operator>`
+ of that PEP explains the rationale in more detail.
 
 
 Introduction

pep-0225.txt

@@ -10,7 +10,14 @@ Content-Type: text/x-rst
 Created: 19-Sep-2000
 Python-Version: 2.1
 Post-History:
-Resolution: :pep:`PEP 465 -- Rejected alternatives to adding a new operator <465#rejected-alternatives-to-adding-a-new-operator>`
+
+
+.. note::
+
+ The approach in the later :pep:`465` was eventually accepted
+ in lieu of this PEP. The :pep:`Rejected Ideas
+ <465#rejected-alternatives-to-adding-a-new-operator>`
+ of that PEP explains the rationale in more detail.
 
 
 Introduction

pep-0245.txt

@@ -3,7 +3,6 @@ Title: Python Interface Syntax
 Version: $Revision$
 Last-Modified: $Date$
 Author: Michel Pelletier <michel@users.sourceforge.net>
-Discussions-To: http://www.zope.org/Wikis/Interfaces
 Status: Rejected
 Type: Standards Track
 Content-Type: text/x-rst
@@ -12,6 +11,18 @@ Python-Version: 2.2
 Post-History: 21-Mar-2001
 
 
+.. note::
+
+ The no-longer-available Zope interfaces wiki page
+ (``https://www.zope.org/Wikis/Interfaces``) originally linked here,
+ containing links to further resources for this PEP,
+ can be `found on the Wayback Machine archive
+ <https://web.archive.org/web/20050327013919/http://www.zope.org/Wikis/Interfaces/FrontPage>`__.
+ Also, the Interface-Dev Zope mailing list on which this PEP was discussed
+ was shut down, but `its archives remain available
+ <https://mail.zope.dev/pipermail/interface-dev/>`__.
+
+
 Rejection Notice
 ================
 

pep-0246.txt

@@ -3,7 +3,7 @@ Title: Object Adaptation
 Version: $Revision$
 Last-Modified: $Date$
 Author: aleaxit@gmail.com (Alex Martelli),
- cce@clarkevans.com (Clark C. Evans)
+cce@clarkevans.com (Clark C. Evans)
 Status: Rejected
 Type: Standards Track
 Content-Type: text/x-rst

pep-0255.txt

@@ -5,7 +5,6 @@ Last-Modified: $Date$
 Author: nas@arctrix.com (Neil Schemenauer),
  tim.peters@gmail.com (Tim Peters),
  magnus@hetland.org (Magnus Lie Hetland)
-Discussions-To: python-iterators@lists.sourceforge.net
 Status: Final
 Type: Standards Track
 Content-Type: text/x-rst

pep-0263.txt

@@ -3,7 +3,7 @@ Title: Defining Python Source Code Encodings
 Version: $Revision$
 Last-Modified: $Date$
 Author: mal@lemburg.com (Marc-André Lemburg),
- martin@v.loewis.de (Martin von Löwis)
+martin@v.loewis.de (Martin von Löwis)
 Status: Final
 Type: Standards Track
 Content-Type: text/x-rst

pep-0274.txt

@@ -7,7 +7,7 @@ Status: Final
 Type: Standards Track
 Content-Type: text/x-rst
 Created: 25-Oct-2001
-Python-Version: 2.7, 3.0 (originally 2.3)
+Python-Version: 2.7, 3.0
 Post-History: 29-Oct-2001
 
 

pep-0282.txt

@@ -2,7 +2,8 @@ PEP: 282
 Title: A Logging System
 Version: $Revision$
 Last-Modified: $Date$
-Author: vinay_sajip at red-dove.com (Vinay Sajip), trentm@activestate.com (Trent Mick)
+Author: vinay_sajip at red-dove.com (Vinay Sajip),
+ trentm@activestate.com (Trent Mick)
 Status: Final
 Type: Standards Track
 Content-Type: text/x-rst

pep-0310.txt

@@ -3,7 +3,7 @@ Title: Reliable Acquisition/Release Pairs
 Version: $Revision$
 Last-Modified: $Date$
 Author: Michael Hudson <mwh@python.net>,
- Paul Moore <p.f.moore@gmail.com>
+Paul Moore <p.f.moore@gmail.com>
 Status: Rejected
 Type: Standards Track
 Content-Type: text/x-rst

pep-0319.txt

@@ -7,7 +7,7 @@ Status: Rejected
 Type: Standards Track
 Content-Type: text/x-rst
 Created: 24-Feb-2003
-Python-Version: 2.4?
+Python-Version: 2.4
 Post-History:
 
 

pep-0330.txt

@@ -7,7 +7,7 @@ Status: Rejected
 Type: Standards Track
 Content-Type: text/x-rst
 Created: 17-Jun-2004
-Python-Version: 2.6?
+Python-Version: 2.6
 Post-History:
 
 

pep-0372.txt

@@ -2,7 +2,7 @@ PEP: 372
 Title: Adding an ordered dictionary to collections
 Version: $Revision$
 Last-Modified: $Date$
-Author: Armin Ronacher <armin.ronacher@active-4.com>
+Author: Armin Ronacher <armin.ronacher@active-4.com>,
  Raymond Hettinger <python@rcn.com>
 Status: Final
 Type: Standards Track

pep-0387.txt

@@ -3,8 +3,8 @@ Title: Backwards Compatibility Policy
 Version: $Revision$
 Last-Modified: $Date$
 Author: Benjamin Peterson <benjamin@python.org>
-BDFL-Delegate: Brett Cannon (on behalf of the steering council)
-Discussions-To: https://discuss.python.org/t/pep-387-backwards-compatibilty-policy/
+PEP-Delegate: Brett Cannon <brett@python.org>
+Discussions-To: https://discuss.python.org/t/pep-387-backwards-compatibilty-policy/4421
 Status: Active
 Type: Process
 Content-Type: text/x-rst

pep-0465.txt

@@ -9,6 +9,8 @@ Content-Type: text/x-rst
 Created: 20-Feb-2014
 Python-Version: 3.5
 Post-History: 13-Mar-2014
+Resolution: https://mail.python.org/archives/list/python-dev@python.org/message/D63NDWHPF7OC2Z455MPHOW6QLLSNQUJ5/
+
 
 Abstract
 ========

pep-0477.txt

@@ -2,7 +2,7 @@ PEP: 477
 Title: Backport ensurepip (PEP 453) to Python 2.7
 Version: $Revision$
 Last-Modified: $Date$
-Author: Donald Stufft <donald@stufft.io>
+Author: Donald Stufft <donald@stufft.io>,
  Nick Coghlan <ncoghlan@gmail.com>
 BDFL-Delegate: Benjamin Peterson <benjamin@python.org>
 Status: Final

pep-0480.txt

@@ -6,7 +6,7 @@ Author: Trishank Karthik Kuppusamy <karthik@trishank.com>,
  Vladimir Diaz <vladimir.diaz@nyu.edu>,
  Justin Cappos <jcappos@nyu.edu>, Marina Moore <mm9693@nyu.edu>
 BDFL-Delegate: Donald Stufft <donald@stufft.io>
-Discussions-To: https://discuss.python.org/c/packaging
+Discussions-To: https://discuss.python.org/t/5666
 Status: Draft
 Type: Standards Track
 Content-Type: text/x-rst

pep-0484.txt

@@ -10,7 +10,7 @@ Type: Standards Track
 Content-Type: text/x-rst
 Created: 29-Sep-2014
 Python-Version: 3.5
-Post-History: 16-Jan-2015,20-Mar-2015,17-Apr-2015,20-May-2015,22-May-2015
+Post-History: 16-Jan-2015,20-Mar-2015,17-Apr-2015,20-May-2015,22-May-2015
 Resolution: https://mail.python.org/pipermail/python-dev/2015-May/140104.html