Merge branch 'main' into PythonBackend

Author: dave3d

comment_spell_check/comment_spell_check.py

@@ -20,6 +20,7 @@
 
 """spell check the comments in code."""
 
+
 import sys
 import os
 import fnmatch
@@ -45,6 +46,7 @@
 from comment_spell_check.utils import create_checker  # noqa: E402
 from comment_spell_check.utils import url_remove  # noqa: E402
 
+
 __version__ = "unknown"
 
 try:
@@ -238,6 +240,7 @@ def spell_check_comment(
             continue
 
         msg = f"'{error_word}', " + f"suggestions: {spell.candidates(error_word)}"
+
         mistakes.append(msg)
 
     return mistakes
@@ -248,6 +251,7 @@ def spell_check_file(
     spell_checker: SpellChecker,
     mime_type: str = "",
     prefixes=None,
+
 ):
     """Check spelling in ``filename``."""
 
@@ -265,6 +269,7 @@ def spell_check_file(
             clist = comment_parser.extract_comments(filename, mime=mime_type)
         except TypeError:
             logger.error("Parser failed, skipping file %s", filename)
+
             return []
 
     bad_words = []
@@ -275,6 +280,7 @@ def spell_check_file(
         if len(mistakes) > 0:
             logger.info("\nLine number %s", c.line_number())
             logger.info(c.text())
+
             for m in mistakes:
                 logger.info("    %s", m)
                 bad_words.append([m, filename, c.line_number()])
@@ -365,6 +371,7 @@ def output_results(args, bad_words):
         if args.vim:
             print(f"vim +{line_num} {found_file}", file=sys.stderr)
         else:
+
             print(
                 f"file: {found_file:30}  line: {line_num:3d}  word: {misspelled_word}",
                 file=sys.stderr,
@@ -393,6 +400,7 @@ def setup_logger(args):
     if level in (logging.INFO, logging.DEBUG):
         # info and debug messages will be printed to the console
 
+
         # Create a console handler
         ch = logging.StreamHandler()
         ch.setLevel(level)
@@ -411,6 +419,7 @@ def setup_logger(args):
     return logger
 
 
+
 def comment_spell_check(args):
     """comment_spell_check main function."""
     logger = setup_logger(args)

comment_spell_check/lib/bibtex_loader.py

@@ -1,3 +1,5 @@
+""" Load Bibtex files into a spell checking dictionary. """
+
 import bibtexparser
 
 

tests/test_comment_spell_check.py

@@ -37,6 +37,7 @@ def test_basic(self):
                 sys.executable,
                 "comment_spell_check.py",
                 "--miss",
+
                 "--dict",
                 "../tests/dict.txt",
                 "--prefix",
@@ -53,6 +54,7 @@ def test_codebase(self):
         runresult = subprocess.run(
             [
                 sys.executable,
+
                 "comment_spell_check.py",
                 "--verbose",
                 "--prefix",
@@ -73,6 +75,7 @@ def test_version(self):
         runresult = subprocess.run(
             [
                 sys.executable,
+
                 "comment_spell_check.py",
                 "--version",
             ],
@@ -92,6 +95,7 @@ def test_bibtex(self):
             [
                 sys.executable,
                 "comment_spell_check.py",
+
                 "--bibtex",
                 "../tests/itk.bib",
                 "../tests/bibtest.py",