commit

Author: StanFromIreland

Lib/test/test_tools/i18n_data/messages.pot

@@ -33,8 +33,8 @@ msgid ""
 "    multiline!\n"
 msgstr ""
 
-#: messages.py:46 messages.py:89 messages.py:90 messages.py:93 messages.py:94
-#: messages.py:99 messages.py:100 messages.py:101
+#: messages.py:46 messages.py:92 messages.py:93 messages.py:96 messages.py:97
+#: messages.py:102 messages.py:103 messages.py:104
 msgid "foo"
 msgid_plural "foos"
 msgstr[0] ""
@@ -80,18 +80,18 @@ msgstr ""
 msgid "default value"
 msgstr ""
 
-#: messages.py:91 messages.py:92 messages.py:95 messages.py:96
+#: messages.py:94 messages.py:95 messages.py:98 messages.py:99
 msgctxt "context"
 msgid "foo"
 msgid_plural "foos"
 msgstr[0] ""
 msgstr[1] ""
 
-#: messages.py:102
+#: messages.py:105
 msgid "domain foo"
 msgstr ""
 
-#: messages.py:118 messages.py:119
+#: messages.py:121 messages.py:122
 msgid "world"
 msgid_plural "worlds"
 msgstr[0] ""

Lib/test/test_tools/i18n_data/messages.py

@@ -85,6 +85,9 @@ def _(x="don't extract me"):
     pass
 
 
+def func():
+    """Docstring..."""
+
 # Other gettext functions
 gettext("foo")
 ngettext("foo", "foos", 1)

Lib/test/test_tools/i18n_data/skipdocstrings.py

@@ -0,0 +1,9 @@
+def test(x):
+    """'I think he’s had a heart attack!'
+       'IF THERE’S ONE THING I CAN’T STAND IS PEOPLE HAVING HEART ATTACKS!!!'
+       'I’m fine, now!'
+       'Good. Now we’re getting somewhere.'
+    """
+
+class Foo:
+    """Docstring"""

Lib/test/test_tools/i18n_data/skipdocstrings.txt

@@ -0,0 +1,5 @@
+fileloc.py
+
+skipdocstrings.py
+messages.py
+messages.py

Lib/test/test_tools/test_i18n.py

@@ -589,6 +589,7 @@ def extract_from_snapshots():
         'messages.py': (),
         'fileloc.py': ('--docstrings',),
         'docstrings.py': ('--docstrings',),
+        ('docstrings.py', 'skipdocstrings.py', 'docstrings.pot'): ('--docstrings', f'--no-docstrings={DATA_DIR}{os.path.sep}skipdocstrings.txt'),
         'comments.py': ('--add-comments=i18n:',),
         'custom_keywords.py': ('--keyword=foo', '--keyword=nfoo:1,2',
                                '--keyword=pfoo:1c,2',
@@ -606,18 +607,20 @@ def extract_from_snapshots():
 
     for filename, args in snapshots.items():
         if isinstance(filename, tuple):
-            filename, output_file = filename
+            *filenames, output_file = filename
             output_file = DATA_DIR / output_file
-            input_file = DATA_DIR / filename
+            input_files = [DATA_DIR / file for file in filenames]
         else:
-            input_file = DATA_DIR / filename
-            output_file = input_file.with_suffix('.pot')
-        contents = input_file.read_bytes()
+            input_files = [DATA_DIR / filename]
+            output_file = input_files[0].with_suffix('.pot')
+
         with temp_cwd(None):
-            Path(input_file.name).write_bytes(contents)
+            for input_file in input_files:
+                contents = input_file.read_bytes()
+                Path(input_file.name).write_bytes(contents)
             assert_python_ok('-Xutf8', Test_pygettext.script, *args,
-                             input_file.name)
-            yield (input_file, output_file,
+                             *[file.name for file in input_files])
+            yield (input_files, output_file,
                    Path('messages.pot').read_text(encoding='utf-8'))
 
 

Misc/NEWS.d/next/Library/2025-04-26-19-26-00.gh-issues-130197.sjdhsja.rst

@@ -0,0 +1 @@
+Fix and test the ``--no-docstrings`` option in :program:`pygettext`.

Tools/i18n/pygettext.py

@@ -483,7 +483,7 @@ def visit_Call(self, node):
 
     def _extract_docstring(self, node):
         if (not self.options.docstrings or
-            self.options.nodocstrings.get(self.filename)):
+            os.path.basename(self.filename) in self.options.nodocstrings):
             return
 
         docstring = ast.get_docstring(node)
@@ -692,7 +692,7 @@ def main():
              'help', 'keyword=', 'no-default-keywords',
              'add-location', 'no-location', 'output=', 'output-dir=',
              'style=', 'verbose', 'version', 'width=', 'exclude-file=',
-             'docstrings', 'no-docstrings',
+             'docstrings', 'no-docstrings=',
              ])
     except getopt.error as msg:
         usage(1, msg)
@@ -714,7 +714,7 @@ class Options:
         width = 78
         excludefilename = ''
         docstrings = 0
-        nodocstrings = {}
+        nodocstrings = []
         comment_tags = set()
 
     options = Options()
@@ -767,15 +767,11 @@ class Options:
         elif opt in ('-x', '--exclude-file'):
             options.excludefilename = arg
         elif opt in ('-X', '--no-docstrings'):
-            fp = open(arg)
-            try:
-                while 1:
-                    line = fp.readline()
-                    if not line:
-                        break
-                    options.nodocstrings[line[:-1]] = 1
-            finally:
-                fp.close()
+            with open(arg, 'r') as nodocstrings_file:
+                for line in nodocstrings_file:
+                    filename = os.path.basename(line.strip())
+                    if filename not in options.nodocstrings:
+                        options.nodocstrings.append(filename)
 
     options.comment_tags = tuple(options.comment_tags)