Add convenient 'remove-django-translators' hook

Author: mondeja

.bumpversion.cfg

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

.pre-commit-hooks.yaml

@@ -10,6 +10,12 @@
   description: Checks for untranslated messages in PO files
   files: \.po$
   language: python
+- id: remove-django-translators
+  name: remove-django-translators
+  entry: lreplace-extracted-comments-hook --django-translators
+  description: Removes the "Translator" string prepended by Django extracting messages con xgettext
+  files: \.po$
+  language: python
 - id: lreplace-extracted-comments
   name: lreplace-extracted-comments
   entry: lreplace-extracted-comments-hook

.yamllint

@@ -1,6 +1,7 @@
 ignore: |
   venv
   build
+  .pre-commit-hooks.yaml
 
 rules:
   braces:

README.md

@@ -15,12 +15,7 @@ Hooks for pre-commit useful working with PO files.
   hooks:
     - id: obsolete-messages
     - id: untranslated-messages
-    - id: lreplace-extracted-comments
-      args:
-        - -m
-        - 'Translators: '
-        - -r
-        - ''
+    - id: remove-django-translators
     - id: check-metadata
       args:
         - -h
@@ -41,9 +36,7 @@ Checks for untranslated messages printing their line numbers if found.
 
 ### **`lreplace-extracted-comments`**
 
-Replaces a matching string at the beginning of the extracted comments.
-This can be used to remove the string "Translators: " introduced by Django (see
-more about this problem in [django-rosetta#245][django-rosetta-lstrip]).
+Replaces a matching string at the beginning of extracted comments.
 
 #### Parameters
 
@@ -54,6 +47,13 @@ more about this problem in [django-rosetta#245][django-rosetta-lstrip]).
 - `-d/--dry-run`: Don't do the replacements, only writes to stderr the locations
  of the extracted comments to be replaced.
 
+### **`remove-django-translators`**
+
+Same as [`lreplace-extracted-comments`][lreplace-extracted-comments-link]
+passing `--match "Translators: " --replacement ""`. Useful to remove the string
+prepended by Django extracting messages with gettext (see more about this
+problem in [django-rosetta#245][django-rosetta-lstrip]).
+
 ### **`check-metadata`**
 
 Check that metadata fields matches a set of regular expressions.
@@ -78,4 +78,5 @@ Check that metadata fields matches a set of regular expressions.
 [tests-image]: https://img.shields.io/github/workflow/status/mondeja/pre-commit-po-hooks/CI?logo=github&label=tests
 [tests-link]: https://github.com/mondeja/pre-commit-po-hooks/actions?query=workflow%CI
 
+[lreplace-extracted-comments-link]: https://github.com/mondeja/pre-commit-po-hooks#lreplace-extracted-comments
 [django-rosetta-lstrip]: https://github.com/mbi/django-rosetta/pull/245

hooks/lreplace_extracted_comments.py

@@ -16,7 +16,12 @@
 
 
 def lreplace_extracted_comments(
-    filenames, match, replacement, dry_run=False, quiet=False
+    filenames,
+    match=None,
+    replacement=None,
+    django_translators=False,
+    dry_run=False,
+    quiet=False,
 ):
     """Replace the beginning of the extracted comments which starts with the
     string passed in the argument ``match``.
@@ -28,12 +33,16 @@ def lreplace_extracted_comments(
     filenames : list
       Set of file names to replace.
 
-    match : str
+    match : str, optional
       The start of the extracted comment content to be replaced.
 
-    replacement : str
+    replacement : str, optional
       The replacement for the beginning of the matching extracted comments.
 
+    django_translators : bool, optional
+      Convenient parameter to pass ``Translators: `` as ``-m`` parameter and
+      an empty string as replacement.
+
     dry_run : bool, optional
       Don't do the replacements, just writes to stderr the location of them.
       You can use it with ``quiet=True`` to check if the strings has been
@@ -48,7 +57,14 @@ def lreplace_extracted_comments(
 
     int: 0 if no a extracted comment has been replaced, 1 otherwise.
     """
-    regex = re.compile(rf"^#\.\s{re.escape(match)}")
+    if not django_translators and not match and not replacement:
+        raise ValueError("You need to specify a match and replacement")
+
+    if django_translators:
+        regex = re.compile(r"^#\.\sTranslators:\s")
+        replacement = ""
+    else:
+        regex = re.compile(rf"^#\.\s{re.escape(match)}")
 
     exitcode = 0
     for filename in filenames:
@@ -105,7 +121,7 @@ def main():
         "-m",
         "--match",
         dest="match",
-        required=True,
+        required=False,
         metavar="MATCH",
         help="The string to match at the beginning of the extracted comments to"
         " replace it.",
@@ -114,16 +130,26 @@ def main():
         "-r",
         "--replacement",
         dest="replacement",
-        required=True,
+        required=False,
         metavar="REPL",
         help="The substitution to be used to replace the matching string.",
     )
+    parser.add_argument(
+        "--django-translators",
+        action="store_true",
+        dest="django_translators",
+        required=False,
+        help=(
+            "Pass 'Translators: ' as '-m' argument and an empty string as replacement."
+        ),
+    )
     args = parser.parse_args()
 
     return lreplace_extracted_comments(
         args.filenames,
-        args.match,
-        args.replacement,
+        match=args.match,
+        replacement=args.replacement,
+        django_translators=args.django_translators,
         dry_run=args.dry_run,
         quiet=args.quiet,
     )

setup.cfg

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