python · hugovk · Aug 22, 2023 · Mar 5, 2022 · Aug 21, 2023 · May 8, 2023
@@ -5,7 +5,10 @@
 # https://git-scm.com/docs/gitignore#_pattern_format
 
 # GitHub
-.github/**                    @ezio-melotti
+.github/**                    @ezio-melotti @hugovk
+
+# pre-commit
+.pre-commit-config.yaml       @hugovk @AlexWaygood
 
 # asyncio
 **/*asyncio*                  @1st1 @asvetlov

@@ -0,0 +1,22 @@
+name: Lint
+
+on: [push, pull_request, workflow_dispatch]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+      - uses: pre-commit/action@v3.0.0
@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-yaml
+      - id: trailing-whitespace
+        types_or: [c, python, rst]
diff --git a/Lib/email/__init__.py b/Lib/email/__init__.py
@@ -25,7 +25,7 @@
     ]
 
 
-
+
 # Some convenience routines.  Don't import Parser and Message as side-effects
 # of importing email since those cascadingly import most of the rest of the
 # email package.

diff --git a/Lib/email/base64mime.py b/Lib/email/base64mime.py
@@ -45,7 +45,7 @@
 MISC_LEN = 7
 
 
-
+
 # Helpers
 def header_length(bytearray):
     """Return the length of s when it is encoded with base64."""
@@ -57,7 +57,7 @@ def header_length(bytearray):
     return n
 
 
-
+
 def header_encode(header_bytes, charset='iso-8859-1'):
     """Encode a single header line with Base64 encoding in a given charset.
 
@@ -72,7 +72,7 @@ def header_encode(header_bytes, charset='iso-8859-1'):
     return '=?%s?b?%s?=' % (charset, encoded)
 
 
-
+
 def body_encode(s, maxlinelen=76, eol=NL):
     r"""Encode a string with base64.
 
@@ -98,7 +98,7 @@ def body_encode(s, maxlinelen=76, eol=NL):
     return EMPTYSTRING.join(encvec)
 
 
-
+
 def decode(string):
     """Decode a raw base64 string, returning a bytes object.
 

diff --git a/Lib/email/charset.py b/Lib/email/charset.py
@@ -18,7 +18,7 @@
 from email.encoders import encode_7or8bit
 
 
-
+
 # Flags for types of header encodings
 QP          = 1 # Quoted-Printable
 BASE64      = 2 # Base64
@@ -32,7 +32,7 @@
 EMPTYSTRING = ''
 
 
-
+
 # Defaults
 CHARSETS = {
     # input        header enc  body enc output conv
@@ -104,7 +104,7 @@
     }
 
 
-
+
 # Convenience functions for extending the above mappings
 def add_charset(charset, header_enc=None, body_enc=None, output_charset=None):
     """Add character set properties to the global registry.
@@ -153,7 +153,7 @@ def add_codec(charset, codecname):
     CODEC_MAP[charset] = codecname
 
 
-
+
 # Convenience function for encoding strings, taking into account
 # that they might be unknown-8bit (ie: have surrogate-escaped bytes)
 def _encode(string, codec):
@@ -163,7 +163,7 @@ def _encode(string, codec):
         return string.encode(codec)
 
 
-
+
 class Charset:
     """Map character sets to their email properties.
 

diff --git a/Lib/email/encoders.py b/Lib/email/encoders.py
@@ -16,7 +16,7 @@
 from quopri import encodestring as _encodestring
 
 
-
+
 def _qencode(s):
     enc = _encodestring(s, quotetabs=True)
     # Must encode spaces, which quopri.encodestring() doesn't do
@@ -34,7 +34,7 @@ def encode_base64(msg):
     msg['Content-Transfer-Encoding'] = 'base64'
 
 
-
+
 def encode_quopri(msg):
     """Encode the message's payload in quoted-printable.
 
@@ -46,7 +46,7 @@ def encode_quopri(msg):
     msg['Content-Transfer-Encoding'] = 'quoted-printable'
 
 
-
+
 def encode_7or8bit(msg):
     """Set the Content-Transfer-Encoding header to 7bit or 8bit."""
     orig = msg.get_payload(decode=True)
@@ -64,6 +64,6 @@ def encode_7or8bit(msg):
         msg['Content-Transfer-Encoding'] = '7bit'
 
 
-
+
 def encode_noop(msg):
     """Do nothing."""
diff --git a/Lib/email/feedparser.py b/Lib/email/feedparser.py
@@ -41,7 +41,7 @@
 NeedMoreData = object()
 
 
-
+
 class BufferedSubFile(object):
     """A file-ish object that can have new data loaded into it.
 
@@ -132,7 +132,7 @@ def __next__(self):
         return line
 
 
-
+
 class FeedParser:
     """A feed-style parser of email."""
 

diff --git a/Lib/email/generator.py b/Lib/email/generator.py
@@ -22,7 +22,7 @@
 fcre = re.compile(r'^From ', re.MULTILINE)
 
 
-
+
 class Generator:
     """Generates output from a Message object tree.
 
@@ -392,7 +392,7 @@ def _make_boundary(cls, text=None):
     def _compile_re(cls, s, flags):
         return re.compile(s, flags)
 
-
+
 class BytesGenerator(Generator):
     """Generates a bytes version of a Message object tree.
 
@@ -443,7 +443,7 @@ def _compile_re(cls, s, flags):
         return re.compile(s.encode('ascii'), flags)
 
 
-
+
 _FMT = '[Non-text (%(type)s) part of message omitted, filename %(filename)s]'
 
 class DecodedGenerator(Generator):
@@ -503,7 +503,7 @@ def _dispatch(self, msg):
                     }, file=self)
 
 
-
+
 # Helper used by Generator._make_boundary
 _width = len(repr(sys.maxsize-1))
 _fmt = '%%0%dd' % _width

diff --git a/Lib/email/header.py b/Lib/email/header.py
@@ -52,12 +52,12 @@
 _embedded_header = re.compile(r'\n[^ \t]+:')
 
 
-
+
 # Helpers
 _max_append = email.quoprimime._max_append
 
 
-
+
 def decode_header(header):
     """Decode a message header value without converting charset.
 
@@ -152,7 +152,7 @@ def decode_header(header):
     return collapsed
 
 
-
+
 def make_header(decoded_seq, maxlinelen=None, header_name=None,
                 continuation_ws=' '):
     """Create a Header from a sequence of pairs as returned by decode_header()
@@ -175,7 +175,7 @@ def make_header(decoded_seq, maxlinelen=None, header_name=None,
     return h
 
 
-
+
 class Header:
     def __init__(self, s=None, charset=None,
                  maxlinelen=None, header_name=None,
@@ -409,7 +409,7 @@ def _normalize(self):
         self._chunks = chunks
 
 
-
+
 class _ValueFormatter:
     def __init__(self, headerlen, maxlen, continuation_ws, splitchars):
         self._maxlen = maxlen

diff --git a/Lib/email/iterators.py b/Lib/email/iterators.py
@@ -15,7 +15,7 @@
 from io import StringIO
 
 
-
+
 # This function will become a method of the Message class
 def walk(self):
     """Walk over the message tree, yielding each subpart.
@@ -29,7 +29,7 @@ def walk(self):
             yield from subpart.walk()
 
 
-
+
 # These two functions are imported into the Iterators.py interface module.
 def body_line_iterator(msg, decode=False):
     """Iterate over the parts, returning string payloads line-by-line.
@@ -55,7 +55,7 @@ def typed_subpart_iterator(msg, maintype='text', subtype=None):
                 yield subpart
 
 
-
+
 def _structure(msg, fp=None, level=0, include_default=False):
     """A handy debugging aid"""
     if fp is None:

diff --git a/Lib/email/mime/base.py b/Lib/email/mime/base.py
@@ -11,7 +11,7 @@
 from email import message
 
 
-
+
 class MIMEBase(message.Message):
     """Base class for MIME specializations."""
 

diff --git a/Lib/email/mime/message.py b/Lib/email/mime/message.py
@@ -10,7 +10,7 @@
 from email.mime.nonmultipart import MIMENonMultipart
 
 
-
+
 class MIMEMessage(MIMENonMultipart):
     """Class representing message/* MIME documents."""
 

diff --git a/Lib/email/mime/multipart.py b/Lib/email/mime/multipart.py
@@ -9,7 +9,7 @@
 from email.mime.base import MIMEBase
 
 
-
+
 class MIMEMultipart(MIMEBase):
     """Base class for MIME multipart/* type messages."""
 

diff --git a/Lib/email/mime/nonmultipart.py b/Lib/email/mime/nonmultipart.py
@@ -10,7 +10,7 @@
 from email.mime.base import MIMEBase
 
 
-
+
 class MIMENonMultipart(MIMEBase):
     """Base class for MIME non-multipart type messages."""
 

diff --git a/Lib/email/mime/text.py b/Lib/email/mime/text.py
@@ -10,7 +10,7 @@
 from email.mime.nonmultipart import MIMENonMultipart
 
 
-
+
 class MIMEText(MIMENonMultipart):
     """Class for generating text/* type MIME documents."""
 

diff --git a/Lib/email/parser.py b/Lib/email/parser.py
@@ -67,15 +67,15 @@ def parsestr(self, text, headersonly=False):
         return self.parse(StringIO(text), headersonly=headersonly)
 
 
-
+
 class HeaderParser(Parser):
     def parse(self, fp, headersonly=True):
         return Parser.parse(self, fp, True)
 
     def parsestr(self, text, headersonly=True):
         return Parser.parsestr(self, text, True)
 
-
+
 class BytesParser:
 
     def __init__(self, *args, **kw):

@@ -441,7 +441,7 @@ async def coro():
         with asyncio.Runner() as runner:
             with self.assertRaises(asyncio.CancelledError):
                 runner.run(coro())
-    
+
     def test_signal_install_not_supported_ok(self):
         # signal.signal() can throw if the "main thread" doensn't have signals enabled
         assert threading.current_thread() is threading.main_thread()
-Original file line number
+Diff line change
@@ Expand Up / @@ -25,7 +25,7 @@ @@
         ]
     # Some convenience routines.  Don't import Parser and Message as side-effects
     # of importing email since those cascadingly import most of the rest of the
     # email package.
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -11,7 +11,7 @@
		from email import message




Comment thread AlexWaygood marked this conversation as resolved. Outdated
		class MIMEBase(message.Message):
		"""Base class for MIME specializations."""

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -10,7 +10,7 @@
		from email.mime.nonmultipart import MIMENonMultipart




Comment thread AlexWaygood marked this conversation as resolved. Outdated
		class MIMEMessage(MIMENonMultipart):
		"""Class representing message/* MIME documents."""

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -9,7 +9,7 @@
		from email.mime.base import MIMEBase




Comment thread AlexWaygood marked this conversation as resolved. Outdated
		class MIMEMultipart(MIMEBase):
		"""Base class for MIME multipart/* type messages."""

Expand Down