Black re-format

Author: dave3d

comment_spell_check/__init__.py

@@ -1,6 +1,8 @@
 """ comment_spell_check """
+
 from comment_spell_check import comment_spell_check
 
+
 def main():
     """Entry point for the application script"""
     comment_spell_check.main()

comment_spell_check/comment_spell_check.py

@@ -113,10 +113,13 @@ def spell_check_words(spell_checker: SpellChecker, words: list[str]):
             return False
     return True
 
-def find_misspellings(spell: SpellChecker, line: str, verbose: bool = False) -> list[str]:
+
+def find_misspellings(
+    spell: SpellChecker, line: str, verbose: bool = False
+) -> list[str]:
     """Find misspellings in a line of text."""
 
-    l2 = re.sub(r'[^a-zA-Z]', ' ', line)
+    l2 = re.sub(r"[^a-zA-Z]", " ", line)
     words = l2.split()
 
     mistakes = []
@@ -128,6 +131,7 @@ def find_misspellings(spell: SpellChecker, line: str, verbose: bool = False) ->
             mistakes.append(word)
     return mistakes
 
+
 def spell_check_comment(
     spell: SpellChecker,
     c: comment_parser.common.Comment,
@@ -191,9 +195,7 @@ def spell_check_comment(
                         if output_lvl > 1:
                             print("Trying splitting camel case word: {wrd}")
                         sub_words = split_camel_case(wrd)
-                        if len(sub_words) > 1 and spell_check_words(
-                            spell, sub_words
-                        ):
+                        if len(sub_words) > 1 and spell_check_words(spell, sub_words):
                             valid = True
                             break
                 except TypeError:
@@ -459,6 +461,7 @@ def add_bibtex_words(spell, bibtex_files, verbose=False):
             print(f"Loading bibtex file: {bibtex_file}")
         bibtex_loader.add_bibtex(spell, bibtex_file, verbose=verbose)
 
+
 def main():
     """comment_spell_check main function."""
     args = parse_args()
@@ -475,7 +478,7 @@ def main():
 
     dict_list = build_dictionary_list(args)
 
-    spell = create_checker.create_checker(dict_list, output_lvl>1)
+    spell = create_checker.create_checker(dict_list, output_lvl > 1)
 
     if args.bibtex:
         add_bibtex_words(spell, args.bibtex, verbose=output_lvl > 1)

comment_spell_check/lib/__init__.py

@@ -0,0 +1 @@
+# he/him/his

comment_spell_check/lib/bibtex_loader.py

@@ -1,10 +1,10 @@
-
 """ Load Bibtex files into a spell checking dictionary. """
 
 import bibtexparser
 import spellchecker
 
-def split_bibtex_name(name:str):
+
+def split_bibtex_name(name: str):
     """
     Split a Bibtex name, which is two words seperated by a number.
     """
@@ -18,8 +18,8 @@ def split_bibtex_name(name:str):
     return words
 
 
-def add_bibtex(spell: spellchecker.SpellChecker, filename:str, verbose:bool=False):
-    """Update ``spell_checker`` spell checking dictionary with names
+def add_bibtex(spell: spellchecker.SpellChecker, filename: str, verbose: bool = False):
+    """Update ``spell`` spell checking dictionary with names
     from ``filename``, a Bibtex file."""
 
     if verbose:

comment_spell_check/lib/create_checker.py

@@ -0,0 +1,67 @@
+#! /usr/bin/env python
+
+""" Create a case sensitive spell checker with the English dictionary and
+    additional dictionaries if provided.
+"""
+
+import sys
+import importlib.resources
+import spellchecker
+
+
+def create_checker(dict_list="", verbose=False):
+    """Create a case sensitive spell checker with the English dictionary and
+    additional dictionaries if provided."""
+
+    # create an empty SpellChecker object, because we want a case
+    # sensitive checker
+    checker = spellchecker.SpellChecker(language=None, case_sensitive=True)
+
+    # load the English dictionary
+    lib_path = importlib.resources.files(spellchecker)
+    english_dict = str(lib_path) + "/resources/en.json.gz"
+    if verbose:
+        print("Loading English dictionary from: ", english_dict)
+    checker.word_frequency.load_dictionary(english_dict)
+
+    # load the additional dictionaries
+    if not isinstance(dict_list, list):
+        return checker
+    if len(dict_list) > 0:
+        for d in dict_list:
+            if verbose:
+                print("Loading additional dictionary from: ", d)
+            checker.word_frequency.load_text_file(d)
+
+    return checker
+
+
+if __name__ == "__main__":
+
+    print(sys.argv[1:])
+    spell = create_checker(sys.argv[1:], True)
+
+    # find those words that may be misspelled
+    misspelled = spell.unknown(["something", "is", "hapenning", "here"])
+
+    for word in misspelled:
+        print("\nMisspelled: ", word)
+        # Get the one `most likely` answer
+        print(spell.correction(word))
+
+        # Get a list of `likely` options
+        print(spell.candidates(word))
+
+    # test if case sensitive checking from the additional dictionaries works
+    my_words = [
+        "Zsize",
+        "Zuerich",
+        "accesor",
+        "accessor",
+        "zsize",
+        "zuerich",
+        "sdfasdfas",
+    ]
+
+    for w in my_words:
+        print(w, w in spell)

tests/test_comment_spell_check.py

@@ -100,5 +100,6 @@ def test_bibtex(self):
         )
         self.assertEqual(runresult.returncode, 0, runresult.stdout)
 
+
 if __name__ == "__main__":
     unittest.main()