Add '--no-metadata' option to 'check-metadata' hook to check that files doesn't have metadata

Author: mondeja

.bumpversion.cfg

@@ -1,4 +1,4 @@
 [bumpversion]
-current_version = 1.2.0
+current_version = 1.3.0
 
 [bumpversion:file:setup.cfg]

README.md

@@ -66,6 +66,9 @@ Check that metadata fields matches a set of regular expressions.
 - `-v/--value REGEX`: Can be passed multiple times. Indicates the regular
  expression that the last header passed in the argument `-h/--header` must
  match in the checked PO files.
+- `-n/--no-metadata`: When this option is passed, the hook instead checks that
+ there is no metadata in the files, so it will exit with code 1 if some
+ metadata is found in a file or 0 if there is no metadata in any files.
 
 [pypi-link]: https://pypi.org/project/pre-commit-po-hooks
 [pypi-version-badge-link]: https://img.shields.io/pypi/v/pre-commit-po-hooks

hooks/check_metadata.py

@@ -9,7 +9,7 @@
 import sys
 
 
-def check_metadata(filenames, headers_spec, quiet=False):
+def check_metadata(filenames, headers_spec, no_metadata=False, quiet=False):
     """Check that metadata headers and values match a set of requirements.
 
     Parameters
@@ -22,6 +22,11 @@ def check_metadata(filenames, headers_spec, quiet=False):
       Name of headers as keys and regular expressions as values to match
       in the metadata of each file.
 
+    no_metadata : bool, optional
+      When this option is set to ``True``, the hook instead checks that there
+      is no metadata in the files, so it will return 1 if metadata is found
+      and 0 exitcode otherwise.
+
     quiet : bool, optional
       Enabled, don't print output to stderr when a wrong metadata is found.
 
@@ -44,21 +49,35 @@ def check_metadata(filenames, headers_spec, quiet=False):
             if line.startswith('msgid ""') and content_lines[i + 1].startswith(
                 'msgstr ""'
             ):
-                if content_lines[i + 2].startswith('"'):
+                if (len(content_lines) > i + 2) and content_lines[i + 2].startswith(
+                    '"'
+                ):
                     _first_metadata_line = i + 2
+
+                    if no_metadata:
+                        exitcode = 1
+                        if not quiet:
+                            sys.stderr.write(
+                                f"Found unexpected metadata at {filename}:{i +3}\n"
+                            )
                 else:
-                    sys.stderr.write(f"No metadata found in the file {filename}\n")
-                    exitcode = 1
+                    if not no_metadata:
+                        exitcode = 1
+                        if not quiet:
+                            sys.stderr.write(
+                                f"No metadata found in the file {filename}\n"
+                            )
+
                 break
 
-        if _first_metadata_line is None:
+        if (no_metadata and exitcode) or _first_metadata_line is None:
             continue
 
         for i, line in enumerate(content_lines[_first_metadata_line:]):
             if not line.strip():
                 break
 
-            header, value = line.split(": ")
+            header, value = line.split(": ", maxsplit=1)
             header = header.lstrip('"')
 
             if header in headers_spec_regex:
@@ -99,10 +118,31 @@ def main():
     parser.add_argument(
         "filenames", nargs="*", help="Filenames to check for obsolete messages"
     )
+    parser.add_argument(
+        "-n",
+        "--no-metadata",
+        action="store_true",
+        dest="no_metadata",
+        help=(
+            "The files shouldn't have metadata. If a file has metadata"
+            " information, exits with code 1."
+        ),
+    )
     parser.add_argument("-q", "--quiet", action="store_true", help="Supress output")
     args = parser.parse_args()
 
-    return check_metadata(args.filenames, headers_spec, quiet=args.quiet)
+    if args.no_metadata and len(headers_spec.keys()):
+        raise ValueError(
+            "You must pass either '--no-metadata' or headers regexes specification,"
+            " but both can't be non false."
+        )
+
+    return check_metadata(
+        args.filenames,
+        headers_spec,
+        no_metadata=args.no_metadata,
+        quiet=args.quiet,
+    )
 
 
 if __name__ == "__main__":

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = pre_commit_po_hooks
-version = 1.2.0
+version = 1.3.0
 description = pre-commit hooks for PO files
 long_description = file: README.md
 long_description_content_type = text/markdown

tests/test_check_metadata.py

@@ -15,6 +15,7 @@
     (
         "contents",
         "headers_spec",
+        "no_metadata",
         "n_printed_errors",
         "expected_exitcode",
         "expected_line_numbers",
@@ -32,16 +33,42 @@
                 "Project-Id-Version": r"v\d+\.\d+\.\d+",
                 "Report-Msgid-Bugs-To": "foobar",
             },
+            False,
             1,
             1,
             [5],
         ),
+        (
+            [
+                ('#\nmsgid ""\nmsgstr ""\n'),
+            ],
+            {},
+            True,
+            0,
+            0,
+            None,
+        ),
+        (
+            [
+                (
+                    '#\nmsgid ""\nmsgstr ""\n"Project-Id-Version: v0.240.1\\n"\n'
+                    '"Report-Msgid-Bugs-To: Álvaro Mondéjar'
+                    ' <mondejar1994@gmail.com>\\n"\n'
+                ),
+            ],
+            {},
+            True,
+            1,
+            1,
+            [4],
+        ),
     ),
 )
 def test_check_obsolete_messages(
     quiet,
     contents,
     headers_spec,
+    no_metadata,
     n_printed_errors,
     expected_exitcode,
     expected_line_numbers,
@@ -58,7 +85,15 @@ def test_check_obsolete_messages(
 
     stderr = io.StringIO()
     with contextlib.redirect_stderr(stderr):
-        assert check_metadata(filenames, headers_spec, quiet=quiet) == expected_exitcode
+        assert (
+            check_metadata(
+                filenames,
+                headers_spec,
+                no_metadata=no_metadata,
+                quiet=quiet,
+            )
+            == expected_exitcode
+        )
 
     stderr_lines = stderr.getvalue().splitlines()
     if quiet: