Print entry file name and lineno with --no-obsolete

src/mdpo/io.py

@@ -130,3 +130,15 @@ def save_file_checking_file_changed(filepath, content, encoding='utf-8'):
         with open(filepath, 'w', encoding=encoding) as f:
             f.write(content)
     return changed
+
+
+def flatten(xss):
+    """Flatten a list of lists.
+
+    Args:
+        xss (list): List of lists to flatten.
+
+    Returns:
+        list: Flattened list.
+    """
+    return [x for xs in xss for x in xs]

src/mdpo/md2po/__init__.py

@@ -14,6 +14,7 @@
 from mdpo.event import add_debug_events, parse_events_kwarg, raise_skip_event
 from mdpo.io import (
     filter_paths,
+    flatten,
     save_file_checking_file_changed,
     to_files_or_content,
 )
@@ -74,7 +75,6 @@ def transform_foo(self, block, text):
         'include_codeblocks',
         'metadata',
         'events',
-        'obsoletes',
 
         'location',
         '_current_top_level_block_number',
@@ -142,11 +142,8 @@ def transform_foo(self, block, text):
     def __init__(self, files_or_content, **kwargs):
         is_glob, files_or_content = to_files_or_content(files_or_content)
         if is_glob:
-            filepaths = []
-            for globpath in files_or_content:
-                filepaths.extend(glob.glob(globpath))
             self.filepaths = filter_paths(
-                filepaths,
+                flatten(glob.glob(globpath) for globpath in files_or_content),
                 ignore_paths=kwargs.get('ignore', []),
             )
         else:
@@ -183,10 +180,6 @@ def __init__(self, files_or_content, **kwargs):
         if kwargs.get('debug'):
             add_debug_events('md2po', self.events)
 
-        #: bool: If there are entries in the PO file that
-        #: are obsolete and not found in the current extraction.
-        self.obsoletes = False
-
         #: str: The msgid being currently built for the next
         #: message entry. Keep in mind that, if you are executing
         #: an event that will be followed by an span one
@@ -992,10 +985,6 @@ def extract(
             wrapwidth=parse_wrapwidth_argument(wrapwidth),
             **pofile_kwargs,
         )
-        for entry in self.pofile:
-            if entry.obsolete:
-                self.obsoletes = True
-                break
 
         parser = md4c.GenericParser(
             0,
@@ -1044,12 +1033,10 @@ def _parse(content):
                 self.found_entries,
             )
         elif self.mark_not_found_as_obsolete:
-            obsoletes = mark_not_found_entries_as_obsoletes(
+            mark_not_found_entries_as_obsoletes(
                 self.pofile,
                 self.found_entries,
             )
-            if not self.obsoletes:
-                self.obsoletes = obsoletes
 
         if self.metadata:
             self.pofile.metadata.update(self.metadata)

src/mdpo/md2po/__main__.py

@@ -31,6 +31,7 @@
 from mdpo.io import environ
 from mdpo.md2po import Md2Po
 from mdpo.md4c import DEFAULT_MD4C_GENERIC_PARSER_EXTENSIONS
+from mdpo.po import check_obsolete_entries_in_filepaths
 
 
 DESCRIPTION = (
@@ -232,17 +233,23 @@ def run(args=frozenset()):
         if opts.check_saved_files_changed and md2po._saved_files_changed:
             exitcode = 2
 
-        if opts.no_obsolete and md2po.obsoletes:
-            if not opts.quiet:
-                sys.stderr.write(
-                    (
-                        f"Obsolete messages found at {opts.po_filepath}"
-                        " and passed '--no-obsolete'\n"
-                    ),
-                )
-            exitcode = 3
-
-        if opts.no_empty_msgstr:
+        if opts.no_obsolete:
+            locations = list(check_obsolete_entries_in_filepaths(
+                (opts.po_filepath,), quiet=opts.quiet,
+            ))
+            if locations:
+                if not opts.quiet and len(locations) > 2:  # noqa PLR2004
+                    sys.stderr.write(
+                        f'Found {len(locations)} obsolete entries:\n',
+                    )
+                    for location in locations:
+                        sys.stderr.write(f'{location}\n')
+                else:
+                    for location in locations:
+                        sys.stderr.write(
+                            f'Found obsolete entry at {location}\n')
+                exitcode = 3
+        elif opts.no_empty_msgstr:
             for entry in pofile:
                 if not entry.msgstr:
                     if not opts.quiet:

src/mdpo/md2po2md/__init__.py

@@ -5,6 +5,7 @@
 
 from mdpo.md2po import Md2Po
 from mdpo.md4c import DEFAULT_MD4C_GENERIC_PARSER_EXTENSIONS
+from mdpo.po import check_obsolete_entries_in_filepaths
 from mdpo.po2md import Po2Md
 
 
@@ -24,6 +25,8 @@ def markdown_to_pofile_to_markdown(
     md2po_kwargs=None,
     po2md_kwargs=None,
     _check_saved_files_changed=False,
+    quiet=False,
+    no_obsolete=False,
 ):
     """Translate a set of Markdown files using PO files.
 
@@ -70,6 +73,8 @@ def markdown_to_pofile_to_markdown(
             ``markdown_to_pofile`` function.
         po2md_kwargs (dict): Additional optional arguments passed to
             ``pofile_to_markdown`` function.
+        quiet (bool): If ``True``, don't print output to STDOUT nor STDERR.
+        no_obsolete (bool): If ``True``, check for obsolete entries in PO files.
     """
     if '{lang}' not in output_paths_schema:
         raise ValueError(
@@ -97,7 +102,7 @@ def markdown_to_pofile_to_markdown(
             )
 
     _saved_files_changed = None if not _check_saved_files_changed else False
-    obsoletes = False
+    obsoletes = []
     empty = False
 
     for filepath in input_paths_glob_:
@@ -156,8 +161,6 @@ def markdown_to_pofile_to_markdown(
             if _check_saved_files_changed and _saved_files_changed is False:
                 _saved_files_changed = md2po._saved_files_changed
 
-            if not obsoletes:
-                obsoletes = md2po.obsoletes
             if not empty:
                 for entry in md2po.pofile:
                     if not entry.msgstr:
@@ -182,15 +185,10 @@ def markdown_to_pofile_to_markdown(
             if _check_saved_files_changed and _saved_files_changed is False:
                 _saved_files_changed = po2md._saved_files_changed
 
-            if not obsoletes:
-                for pofile in po2md.pofiles:
-                    for entry in pofile:
-                        if entry.obsolete:
-                            obsoletes = True
-                            break
-                    if obsoletes:
-                        break
-
+            if no_obsolete:
+                obsoletes.extend(check_obsolete_entries_in_filepaths(
+                    [po_filepath], quiet=quiet,
+                ))
             if not empty:
                 for pofile in po2md.pofiles:
                     for entry in pofile:

src/mdpo/md2po2md/__main__.py

@@ -140,6 +140,8 @@ def run(args=frozenset()):
             'md_encoding': opts.md_encoding,
             'include_codeblocks': opts.include_codeblocks,
             '_check_saved_files_changed': opts.check_saved_files_changed,
+            'quiet': opts.quiet,
+            'no_obsolete': opts.no_obsolete,
         }
 
         (
@@ -155,16 +157,20 @@ def run(args=frozenset()):
         if opts.check_saved_files_changed and _saved_files_changed:
             exitcode = 2
 
-        if opts.no_obsolete and obsoletes:
-            exitcode = 3
-
-            if not opts.quiet:
+        if obsoletes:
+            if not opts.quiet and len(obsoletes) > 2:  # noqa PLR2004
                 sys.stderr.write(
-                    "Obsolete messages found at PO files and"
-                    " passed '--no-obsolete'\n",
+                    f'Found {len(obsoletes)} obsolete entries:\n',
                 )
-
-        if opts.no_empty_msgstr and empty:
+                for location in obsoletes:
+                    sys.stderr.write(f'{location}\n')
+            else:
+                for location in obsoletes:
+                    sys.stderr.write(
+                        f'Found obsolete entry at {location}\n',
+                    )
+            exitcode = 3
+        elif opts.no_empty_msgstr and empty:
             exitcode = 4
 
             if not opts.quiet:

src/mdpo/po.py

@@ -168,3 +168,52 @@ def paths_or_globs_to_unique_pofiles(pofiles_globs, ignore, po_encoding=None):
                 _po_filepaths.append(po_filepath)
 
     return pofiles
+
+
+def check_obsolete_entries_in_filepaths(filenames, quiet=False):
+    """Warns about all obsolete entries found in a set of PO files.
+
+    Args:
+        filenames (list): Set of file names to check.
+        quiet (bool, optional): Enabled, don't print output to stderr when an
+            obsolete entry is found.
+
+    Returns:
+        list(str): error messages produced.
+    """
+    for filename in filenames:
+        with open(filename, 'rb') as f:
+            content_lines = f.readlines()
+
+        yield from parse_obsoletes_from_content_lines(
+            content_lines,
+            quiet=quiet,
+            location_prefix=f'{filename}:',
+        )
+
+
+def parse_obsoletes_from_content_lines(
+    content_lines,
+    quiet=False,
+    location_prefix='line ',
+):
+    """Warns about all obsolete entries found in a set of PO files.
+
+    Args:
+        content_lines (list): Set of content lines to check.
+        quiet (bool, optional): Enabled, don't print output to stderr when an
+            obsolete entry is found.
+        location_prefix (str, optional): Prefix to use in the location message.
+
+    Returns:
+        list(str): error locations found.
+    """
+    inside_obsolete_message = False
+    for i, line in enumerate(content_lines):
+        if not inside_obsolete_message and line[0:3] == b'#~ ':
+            inside_obsolete_message = True
+
+            if not quiet:
+                yield f'{location_prefix}{i + 1}'
+        elif inside_obsolete_message and line[0:3] != b'#~ ':
+            inside_obsolete_message = False

src/mdpo/po2md/__main__.py

@@ -24,6 +24,10 @@
     parse_event_argument,
 )
 from mdpo.io import environ
+from mdpo.po import (
+    check_obsolete_entries_in_filepaths,
+    paths_or_globs_to_unique_pofiles,
+)
 from mdpo.po2md import Po2Md
 
 
@@ -136,15 +140,28 @@ def run(args=frozenset()):
         if opts.check_saved_files_changed and po2md._saved_files_changed:
             return (output, 2)
 
-        if opts.no_obsolete and get_obsoletes(po2md.pofiles):
-            if not opts.quiet:
-                sys.stderr.write(
-
-                    "Obsolete messages found at PO files and passed"
-                    " '--no-obsolete'\n",
-
-                )
-            return (output, 3)
+        if opts.no_obsolete:
+            pofiles = paths_or_globs_to_unique_pofiles(
+                opts.pofiles,
+                opts.ignore or [],
+                po_encoding=opts.po_encoding,
+            )
+            locations = list(check_obsolete_entries_in_filepaths(
+                pofiles, quiet=opts.quiet,
+            ))
+            if locations:
+                if not opts.quiet and len(locations) > 2:  # noqa PLR2004
+                    sys.stderr.write(
+                        f'Found {len(locations)} obsolete entries:\n',
+                    )
+                    for location in locations:
+                        sys.stderr.write(f'{location}\n')
+                else:
+                    for location in locations:
+                        sys.stderr.write(
+                            f'Found obsolete entry at {location}\n',
+                        )
+                return (output, 3)
 
         if opts.no_empty_msgstr:
             for pofile in po2md.pofiles: