pylint fixes

Author: dave3d

comment_spell_check/comment_spell_check.py

@@ -183,7 +183,9 @@ def remove_contractions(word: str):
     logger = logging.getLogger("comment_spell_check")
     for contraction in CONTRACTIONS:
         if word.endswith(contraction):
-            logger.info("Contraction: %s -> %s", word, word[: -len(contraction)])
+            logger.info(
+                "Contraction: %s -> %s", word, word[: -len(contraction)]
+            )
             return word[: -len(contraction)]
     return word
 
@@ -192,7 +194,7 @@ def remove_prefix(word: str, prefixes: list[str]):
     """Remove the prefix from the word."""
     for prefix in prefixes:
         if word.startswith(prefix):
-            return word[len(prefix) :]
+            return word[len(prefix):]
     return word
 
 
@@ -222,7 +224,9 @@ def spell_check_comment(
         prefixes = prefixes or []
         error_word = remove_prefix(error_word, prefixes)
 
-        if len(error_word) == 0 or error_word in spell or error_word.lower() in spell:
+        if len(error_word) == 0:
+            continue
+        if error_word in spell or error_word.lower() in spell:
             continue
 
         # Try splitting camel case words and checking each sub-word
@@ -233,7 +237,10 @@ def spell_check_comment(
         if len(sub_words) > 1 and spell_check_words(spell, sub_words):
             continue
 
-        msg = f"'{error_word}', " + f"suggestions: {spell.candidates(error_word)}"
+        msg = (
+            f"'{error_word}', "
+            + f"suggestions: {spell.candidates(error_word)}"
+        )
         mistakes.append(msg)
 
     return mistakes
@@ -359,7 +366,8 @@ def output_results(args, bad_words):
             print(f"vim +{line_num} {found_file}", file=sys.stderr)
         else:
             print(
-                f"file: {found_file:30}  line: {line_num:3d}  word: {misspelled_word}",
+                f"file: {found_file:30}  line: {line_num:3d}  ",
+                f"word: {misspelled_word}",
                 file=sys.stderr,
             )
 
@@ -441,7 +449,9 @@ def comment_spell_check(args):
             # f is a directory, so search for files inside
             dir_entries = []
             for s in suffixes:
-                dir_entries = dir_entries + glob.glob(f + "/**/*" + s, recursive=True)
+                dir_entries = dir_entries + glob.glob(
+                    f + "/**/*" + s, recursive=True
+                )
 
             logger.info(dir_entries)
 
@@ -487,6 +497,7 @@ def comment_spell_check(args):
 
 
 def main():
+    """Main function to run the spell checker."""
     args = parseargs.parse_args()
     comment_spell_check(args)
 

comment_spell_check/utils/parseargs.py

@@ -1,3 +1,5 @@
+"""command line argument parser for comment_spell_check."""
+
 import argparse
 from importlib.metadata import version, PackageNotFoundError
 
@@ -11,6 +13,7 @@
 
 
 def create_parser():
+    """Create an argument parser for the command-line interface."""
     parser = argparse.ArgumentParser()
 
     parser.add_argument("filenames", nargs="*")

tests/test_comment_spell_check.py

@@ -1,3 +1,6 @@
+
+""" Test suite for the comment_spell_check command line tool. """
+
 # ==========================================================================
 #
 #   Copyright NumFOCUS
@@ -21,9 +24,11 @@
 
 
 class TestCommentSpellCheck(unittest.TestCase):
+    """Test class for comment_spell_check command line tool."""
     @classmethod
-    def setUpClass(self):
+    def setUpClass(cls):
         """Setting up comment_spell_check tests"""
+        return cls()
 
     @classmethod
     def tearDownClass(cls):
@@ -43,6 +48,7 @@ def test_basic(self):
             ],
             cwd="comment_spell_check",
             stdout=subprocess.PIPE,
+            check=False,
         )
         self.assertEqual(runresult.returncode, 0, runresult.stdout)
 
@@ -62,6 +68,7 @@ def test_codebase(self):
             ],
             cwd="comment_spell_check",
             stdout=subprocess.PIPE,
+            check=False,
         )
         self.assertEqual(runresult.returncode, 0, runresult.stdout)
 
@@ -74,6 +81,7 @@ def test_version(self):
             ],
             cwd="comment_spell_check",
             stdout=subprocess.PIPE,
+            check=False,
         )
         self.assertEqual(runresult.returncode, 0)
 
@@ -93,6 +101,7 @@ def test_bibtex(self):
             ],
             cwd="comment_spell_check",
             stdout=subprocess.PIPE,
+            check=False,
         )
         self.assertEqual(runresult.returncode, 0, runresult.stdout)
 
@@ -111,6 +120,7 @@ def test_url(self):
             ],
             cwd="comment_spell_check",
             stdout=subprocess.PIPE,
+            check=False,
         )
         self.assertEqual(runresult.returncode, 0, runresult.stdout)