Allow for multiple files to be passed positionally.

pospell.py

@@ -4,6 +4,7 @@
 import re
 import subprocess
 import tempfile
+from itertools import chain
 from pathlib import Path
 
 import polib
@@ -22,7 +23,11 @@ def strip_rst(line):
             -[A-Za-z]\b           |
             `[^`]*?`_             |
             \*[^*]*?\*
-        """, '', line, flags=re.VERBOSE)
+        """,
+        "",
+        line,
+        flags=re.VERBOSE,
+    )
 
 
 def clear(line):
@@ -31,53 +36,88 @@ def clear(line):
     return re.sub(r"""<a href="[^"]*?">(.*)</a>""", r"\1", line)
 
 
-def po_to_text(po):
+def po_to_text(po_path):
+    """Converts a po file to a text file, by stripping the msgids and all
+    po syntax, but by keeping the kept lines at their same position /
+    line number.
+    """
     buffer = []
     lines = 0
-    entries = polib.pofile(po)
+    entries = polib.pofile(po_path)
     for entry in entries:
         if entry.msgid == entry.msgstr:
             continue
         while lines < entry.linenum:
-            buffer.append('')
+            buffer.append("")
             lines += 1
         buffer.append(clear(strip_rst(entry.msgstr)))
         lines += 1
-    return '\n'.join(buffer)
+    return "\n".join(buffer)
 
 
 def main():
+    """Module entry point.
+    """
     import argparse
+
     parser = argparse.ArgumentParser(
-        description='Check spelling in po files containing restructuredText.')
-    parser.add_argument('-l', '--language', type=str, default='fr')
-    parser.add_argument('--glob', type=str, default='**/*.po')
-    parser.add_argument('--debug', action='store_true')
-    parser.add_argument('-p', '--personal-dict', type=str)
+        description="Check spelling in po files containing restructuredText."
+    )
+    parser.add_argument(
+        "-l",
+        "--language",
+        type=str,
+        default="fr",
+        help="Language to check, you'll have to install the corresponding "
+        "hunspell dictionary, on Debian see apt list 'hunspell-*'.",
+    )
+    parser.add_argument(
+        "--glob",
+        type=str,
+        default="**/*.po",
+        help="Provide a glob pattern, to be interpreted by pospell, to find po files, "
+        "like --glob '**/*.po'.",
+    )
+    parser.add_argument(
+        "po_file",
+        nargs="*",
+        type=str,
+        help="Files to check, can optionally be mixed with --glob, or not, "
+        "use the one that fit your needs.",
+    )
+    parser.add_argument("--debug", action="store_true")
+    parser.add_argument("-p", "--personal-dict", type=str)
     args = parser.parse_args()
-    personal_dict = ['-p', args.personal_dict] if args.personal_dict else []
+    personal_dict = ["-p", args.personal_dict] if args.personal_dict else []
     errors = 0
     with tempfile.TemporaryDirectory() as tmpdirname:
         tmpdir = Path(tmpdirname)
-        for po_file in Path('.').glob(args.glob):
+        for po_file in chain(Path(".").glob(args.glob), args.po_file):
             if args.debug:
                 print(po_to_text(str(po_file)))
                 continue
             (tmpdir / po_file.name).write_text(po_to_text(str(po_file)))
             output = subprocess.check_output(
-                ['hunspell', '-d', args.language] + personal_dict + ['-u3',
-                 str(tmpdir / po_file.name)],
-                universal_newlines=True)
-            for line in output.split('\n'):
-                match = re.match(r'(?P<path>.*):(?P<line>[0-9]+): Locate: (?P<error>.*) \| Try: .*$', line)
+                ["hunspell", "-d", args.language]
+                + personal_dict
+                + ["-u3", str(tmpdir / po_file.name)],
+                universal_newlines=True,
+            )
+            for line in output.split("\n"):
+                match = re.match(
+                    r"(?P<path>.*):(?P<line>[0-9]+): Locate: (?P<error>.*) \| Try: .*$",
+                    line,
+                )
                 if match:
                     errors += 1
-                    print(match.group('path').replace(str(tmpdir), '').lstrip('/'),
-                          match.group('line'),
-                          match.group('error'),
-                          sep=':')
+                    print(
+                        match.group("path").replace(str(tmpdir), "").lstrip("/"),
+                        match.group("line"),
+                        match.group("error"),
+                        sep=":",
+                    )
     exit(0 if errors == 0 else -1)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()