Fix formatting and linting

Author: badsketch

pylint/checkers/misc.py

@@ -96,17 +96,19 @@ class EncodingChecker(BaseTokenChecker, BaseRawFileChecker):
                 "type": "yn",
                 "metavar": "<y or n>",
                 "default": False,
-                "help": "Whether or not to search for fixme's in docstrings."
-            }
-        )
+                "help": "Whether or not to search for fixme's in docstrings.",
+            },
+        ),
     )
 
     def open(self) -> None:
         super().open()
 
         notes = "|".join(re.escape(note) for note in self.linter.config.notes)
         if self.linter.config.notes_rgx:
-            comment_regex = rf"#\s*({notes}|{self.linter.config.notes_rgx})(?=(:|\s|\Z))"
+            comment_regex = (
+                rf"#\s*({notes}|{self.linter.config.notes_rgx})(?=(:|\s|\Z))"
+            )
             self._comment_fixme_pattern = re.compile(comment_regex, re.I)
             if self.linter.config.check_fixme_in_docstring:
                 docstring_regex = rf"((\"\"\")|(\'\'\'))\s*({notes}|{self.linter.config.notes_rgx})(?=(:|\s|\Z))"
@@ -149,22 +151,27 @@ def process_tokens(self, tokens: list[tokenize.TokenInfo]) -> None:
             return
         for token_info in tokens:
             if token_info.type == tokenize.COMMENT:
-                comment_text = token_info.string[1:].lstrip()  # trim '#' and white-spaces
+                comment_text = token_info.string[
+                    1:
+                ].lstrip()  # trim '#' and white-spaces
                 if self._comment_fixme_pattern.search("#" + comment_text.lower()):
                     self.add_message(
                         "fixme",
                         col_offset=token_info.start[1] + 1,
                         args=comment_text,
                         line=token_info.start[0],
                     )
-            elif self.linter.config.check_fixme_in_docstring and self._is_docstring_comment(token_info):
+            elif (
+                self.linter.config.check_fixme_in_docstring
+                and self._is_docstring_comment(token_info)
+            ):
                 docstring_lines = token_info.string.split("\n")
                 for line_no, line in enumerate(docstring_lines):
                     # trim '"""' at beginning or end and whitespace
-                    if line.startswith('"""') or line.startswith("'''"):
+                    if line.startswith(('"""', "'''")):
                         line = line[3:]
                     line = line.lstrip()
-                    if line.endswith('"""') or line.endswith("'''"):
+                    if line.endswith(('"""', "'''")):
                         line = line[:-3]
                     if self._docstring_fixme_pattern.search(
                         '"""' + line.lower()
@@ -178,8 +185,7 @@ def process_tokens(self, tokens: list[tokenize.TokenInfo]) -> None:
 
     def _is_docstring_comment(self, token_info: tokenize.TokenInfo) -> bool:
         return token_info.type == tokenize.STRING and (
-            token_info.line.lstrip().startswith('"""')
-            or token_info.line.lstrip().startswith("'''")
+            token_info.line.lstrip().startswith(('"""', "'''"))
         )
 
 

tests/checkers/unittest_misc.py

@@ -8,6 +8,7 @@
 from pylint.testutils import CheckerTestCase, MessageTest, _tokenize_str, set_config
 
 
+# pylint: disable=too-many-public-methods
 class TestFixme(CheckerTestCase):
     CHECKER_CLASS = misc.EncodingChecker
 
@@ -124,7 +125,6 @@ def test_docstring_with_message(self) -> None:
         """
         with self.assertAddsMessages(
             MessageTest(msg_id="fixme", line=2, args="FIXME message", col_offset=9)
-            
         ):
             self.checker.process_tokens(_tokenize_str(code))
 
@@ -135,7 +135,6 @@ def test_docstring_with_message_single_quote(self) -> None:
         """
         with self.assertAddsMessages(
             MessageTest(msg_id="fixme", line=2, args="FIXME message", col_offset=9)
-            
         ):
             self.checker.process_tokens(_tokenize_str(code))
 
@@ -173,7 +172,7 @@ def test_docstring_with_nl_message_multi(self) -> None:
         """
         with self.assertAddsMessages(
             MessageTest(msg_id="fixme", line=3, args="FIXME this", col_offset=9),
-            MessageTest(msg_id="fixme", line=4, args="TODO: that", col_offset=9)
+            MessageTest(msg_id="fixme", line=4, args="TODO: that", col_offset=9),
         ):
             self.checker.process_tokens(_tokenize_str(code))
 
@@ -189,7 +188,7 @@ def test_docstring_with_comment(self) -> None:
         with self.assertAddsMessages(
             MessageTest(msg_id="fixme", line=2, args="XXX message1", col_offset=9),
             MessageTest(msg_id="fixme", line=4, args="FIXME message2", col_offset=9),
-            MessageTest(msg_id="fixme", line=5, args="TODO message3", col_offset=9)
+            MessageTest(msg_id="fixme", line=5, args="TODO message3", col_offset=9),
         ):
             self.checker.process_tokens(_tokenize_str(code))
 
@@ -229,29 +228,27 @@ def test_docstring_todo_mult(self) -> None:
         \"\"\"
         """
         with self.assertAddsMessages(
-            MessageTest(msg_id="fixme", line=3, args="FIXME this TODO that", col_offset=9),
+            MessageTest(
+                msg_id="fixme", line=3, args="FIXME this TODO that", col_offset=9
+            ),
         ):
             self.checker.process_tokens(_tokenize_str(code))
-    
-    @set_config(
-            check_fixme_in_docstring=True,
-            notes=["CODETAG"]
-    )
+
+    @set_config(check_fixme_in_docstring=True, notes=["CODETAG"])
     def test_docstring_custom_note(self) -> None:
         code = """
         \"\"\"
         CODETAG implement this
         \"\"\"
         """
         with self.assertAddsMessages(
-            MessageTest(msg_id="fixme", line=3, args="CODETAG implement this", col_offset=9),
+            MessageTest(
+                msg_id="fixme", line=3, args="CODETAG implement this", col_offset=9
+            ),
         ):
             self.checker.process_tokens(_tokenize_str(code))
-    
-    @set_config(
-            check_fixme_in_docstring=True,
-            notes_rgx="FIX.*"
-    )
+
+    @set_config(check_fixme_in_docstring=True, notes_rgx="FIX.*")
     def test_docstring_custom_rgx(self) -> None:
         code = """
         \"\"\"
@@ -260,7 +257,11 @@ def test_docstring_custom_rgx(self) -> None:
         \"\"\"
         """
         with self.assertAddsMessages(
-            MessageTest(msg_id="fixme", line=3, args="FIXME implement this", col_offset=9),
-            MessageTest(msg_id="fixme", line=4, args="FIXTHIS also implement this", col_offset=9),
+            MessageTest(
+                msg_id="fixme", line=3, args="FIXME implement this", col_offset=9
+            ),
+            MessageTest(
+                msg_id="fixme", line=4, args="FIXTHIS also implement this", col_offset=9
+            ),
         ):
             self.checker.process_tokens(_tokenize_str(code))