Add hook to define maximum number of entries per file

Author: mondeja

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.3.4
+current_version = 1.4.0
 
 [bumpversion:file:setup.cfg]
 

.pre-commit-hooks.yaml

@@ -40,3 +40,9 @@
   description: Checks that your PO don't contain metadata headers
   files: \.po$
   language: python
+- id: max-messages
+  name: max-messages
+  entry: check-entries-hook --max-messages
+  description: Checks that each one of your PO files don't contain more than X messages
+  files: \.po$
+  language: python

README.md

@@ -11,7 +11,7 @@ Hooks for pre-commit useful working with PO files.
 
 ```yaml
 - repo: https://github.com/mondeja/pre-commit-po-hooks
-  rev: v1.3.4
+  rev: v1.4.0
   hooks:
     - id: obsolete-messages
     - id: untranslated-messages
@@ -96,6 +96,21 @@ returning exit code 1.
 
 - `-r/--remove/--remove-metadata`: When this option is passed the metadata will
  be removed from the files instead of being treated as a lint error.
+ 
+### **`max-messages`**
+
+Define a maximum number of entries for each PO file. Pass an interger in the
+first argument:
+
+```yaml
+- id: max-messages
+  args:
+    - 5000
+```
+
+#### Parameters
+
+- Maximum number of messages allowed for each PO file.
 
 
 [pypi-link]: https://pypi.org/project/pre-commit-po-hooks

hooks/check_entries.py

@@ -0,0 +1,79 @@
+"""Script that checks entries of PO files."""
+
+import argparse
+import os
+import sys
+
+
+def maximum_number_of_messages(filenames, max_messages=10000, quiet=False):
+    """Check that the maximum number of messages in each PO file is not
+    greater than the number passed in the parameter ``max_messages``.
+
+    Parameters
+    ----------
+
+    filenames : list
+      Set of file names to check.
+
+    max_messages : int, optional
+      Maximum number of messages in each PO file.
+
+    quiet : bool, optional
+      Enabled, don't print output to stderr when more messages than allowed
+      are found.
+
+    Returns
+    -------
+
+    int: 0 if no more than ``max_messages`` messages found for each file,
+      1 otherwise.
+    """
+    exitcode = 0
+
+    for filename in filenames:
+        with open(filename) as f:
+            content_lines = f.readlines()
+
+        number_of_messages = 0
+        for i, line in enumerate(content_lines):
+            if line.startswith('msgid "'):
+                number_of_messages += 1
+
+        if (number_of_messages - 1) > max_messages:
+            exitcode = 1
+            if not quiet:
+                sys.stderr.write(
+                    f"More messages ({number_of_messages}) than allowed"
+                    f" ({max_messages}) at file {os.path.abspath(filename)}\n"
+                )
+
+    return exitcode
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "filenames", nargs="*", help="Filenames to check for obsolete messages"
+    )
+    parser.add_argument("-q", "--quiet", action="store_true", help="Supress output")
+    parser.add_argument(
+        "-m",
+        "--max-messages",
+        type=int,
+        metavar="NUMBER",
+        required=False,
+        default=None,
+        help=(
+            "Check the maximum number of messages in each PO file "
+            "is not greater than the number passed in this parameter."
+        ),
+    )
+    args = parser.parse_args()
+    if args.max_messages is not None:
+        return maximum_number_of_messages(
+            args.filenames, args.max_messages, quiet=args.quiet
+        )
+
+
+if __name__ == "__main__":
+    exit(main())

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = pre_commit_po_hooks
-version = 1.3.4
+version = 1.4.0
 description = pre-commit hooks for PO files
 long_description = file: README.md
 long_description_content_type = text/markdown
@@ -33,6 +33,7 @@ console_scripts =
     untranslated-messages-hook = hooks.untranslated_messages:main
     lreplace-extracted-comments-hook = hooks.lreplace_extracted_comments:main
     check-metadata-hook = hooks.check_metadata:main
+    check-entries-hook = hooks.check_entries:main
 
 [options.extras_require]
 test =