Allow comment in dictionary

codespell_lib/_spellchecker.py

@@ -15,6 +15,7 @@
 Copyright (C) 2010-2011  Lucas De Marchi <lucas.de.marchi@gmail.com>
 Copyright (C) 2011  ProFUSION embedded systems
 """
+import sys
 
 # Pass all misspellings through this translation table to generate
 # alternative misspellings and fixes.
@@ -54,7 +55,21 @@ def build_dict(
     with open(filename, encoding="utf-8") as f:
         translate_tables = [(x, str.maketrans(x, y)) for x, y in alt_chars]
         for line in f:
-            [key, data] = line.split("->")
+            left, pound, _ = line.partition("#")
+            if pound and left and left[-1] not in (' ', '\t'):
+                print(
+                    f"WARNING: {filename}: missing spaces before #: {line.rstrip()!r}",
+                    file=sys.stderr,
+                )
+                continue
+
+            line = left.strip()
+            if not line:
+                continue
+            try:
+                [key, data] = line.split("->")
+            except ValueError:
+                continue
             # TODO: For now, convert both to lower.
             #       Someday we can maybe add support for fixing caps.
             key = key.lower()

codespell_lib/tests/test_basic.py

@@ -1524,3 +1524,35 @@ def test_args_from_file(
     print("Testing with direct call to cs_.main()")
     r = cs_.main(*args[1:])
     print(f"{r=}")
+
+
+def test_dict_comments(
+    tmp_path: Path,
+    capsys: pytest.CaptureFixture[str],
+) -> None:
+    """Test dictionary comments and blank lines."""
+    fname = tmp_path / "bad.txt"
+    fname.write_text("abandonned\noccured\n")
+
+    dictionary = tmp_path / "test.txt"
+    dictionary.write_text(
+        "#comment\n"
+        "# comment\n"
+        " #comment\n"
+        "\n"
+        "\r\n"
+        "abandonned->abandoned # inline comment\n"
+        "occured->occurred# invalid inline comment\n"
+        "abil#ity->ability # hash in illegal position\n",
+        encoding="utf-8",
+    )
+
+    # Allow valid inline comments.
+    # Skip entries where '#' is not preceded by whitespace.
+    result = cs.main("-D", dictionary, fname, std=True)
+    assert isinstance(result, tuple)
+    code, stdout, stderr = result
+    assert code == 1
+    assert "abandonned ==> abandoned" in stdout
+    assert "occured ==> occurred" not in stdout
+    assert "missing spaces before #" in stderr