fix mypy errors in whitelist script

Author: Carsons-Eels

src/ethereum_spec_tools/whitelist/__init__.py

@@ -19,6 +19,7 @@
 
 import argparse
 from pathlib import Path
+from sys import stderr
 
 DESCRIPTION = """
 Add words to the codespell whitelist sanely
@@ -35,8 +36,9 @@
     "-v", "--verbose", action="store_true", help="Enable verbose output"
 )
 
+
 def find_project_root() -> Path:
-    """Locate the root directory of this project"""
+    """Locate the root directory of this project."""
     # Search upwards from script location
     script_dir = Path(__file__).resolve().parent
     for parent in [script_dir, *script_dir.parents]:
@@ -46,60 +48,76 @@ def find_project_root() -> Path:
     raise FileNotFoundError("Unable to locate project root directory!")
 
 
-def main() -> None:
+def main() -> int:
     """
     `whitelist` accepts any number of strings, adds them to the whitelist, then
     sorts the list and maintain visible sections for each leading character.
+
+    Returns:
+      - 0 on success
+      - 1 on error
+
     """
     args = parser.parse_args()
     new_words = args.words
     verbose = args.verbose
 
-    project_root = find_project_root()
-    whitelist_file = project_root / "whitelist.txt"
+    try:
+        project_root = find_project_root()
+        whitelist_file = project_root / "whitelist.txt"
 
-    # Read existing whitelist (create empty list if file doesn't exist)
-    existing_words = []
-    with open(whitelist_file, "r+", encoding="utf-8") as f:
-        content = f.read()
-    existing_words = [w.strip() for w in content.split("\n") if w.strip()]
+        # Read existing whitelist (create empty list if file doesn't exist)
+        existing_words = []
+        with open(whitelist_file, "r+", encoding="utf-8") as f:
+            content = f.read()
+        existing_words = [w.strip() for w in content.split("\n") if w.strip()]
 
-    if verbose:
-        print(f"Adding {len(new_words)} new words: {new_words}")
+        if verbose:
+            print(f"Adding {len(new_words)} new words: {new_words}")
 
-    # Combine and remove duplicates
-    all_words = set(existing_words + new_words)
+        # Combine and remove duplicates
+        all_words = set(existing_words + new_words)
 
-    if verbose:
-        print(f"Total unique entries: {len(all_words)}")
+        if verbose:
+            print(f"Total unique entries: {len(all_words)}")
 
-    # Sort alphabetically
-    sorted_words = sorted(all_words, key=str.casefold)
+        # Sort alphabetically
+        sorted_words = sorted(all_words, key=str.casefold)
 
-    # Add blank lines before each new letter
-    words_with_separators = []
-    previous_letter = ""
+        # Add blank lines before each new letter
+        words_with_separators: list[str] = []
+        previous_letter = ""
 
-    for word in sorted_words:
-        current_letter = word[0].lower()
+        for word in sorted_words:
+            current_letter = word[0].lower()
 
-        if current_letter != previous_letter and words_with_separators:
-            words_with_separators.append("")
+            if current_letter != previous_letter and words_with_separators:
+                words_with_separators.append("")
 
-        words_with_separators.append(word)
-        previous_letter = current_letter
+            words_with_separators.append(word)
+            previous_letter = current_letter
 
-        if verbose:
-            print(f"Added {word}")
+            if verbose:
+                print(f"Added {word}")
+
+        # Create the whitelist content
+        whitelist_content = "\n".join(words_with_separators)
+
+        # Write to whitelist file
+        with open(whitelist_file, "w", encoding="utf-8") as f:
+            f.write(whitelist_content)
+
+        print(f"Successfully updated {whitelist_file}")
 
-    # Create the whitelist content
-    whitelist_content = "\n".join(words_with_separators)
+    except KeyboardInterrupt:
+        print("Aborted manually.", file=stderr)
+        return 1
 
-    # Write to whitelist file
-    with open(whitelist_file, "w", encoding="utf-8") as f:
-        f.write(whitelist_content)
+    except Exception as err:
+        print(f"Unknown error! {err}")
+        return 1
 
-    print(f"\nSuccessfully updated {whitelist_file}")
+    return 0
 
 
 if __name__ == "__main__":