pythongh-104683: Add --exclude option to Argument Clinic CLI

Explicitly exclude Lib/test/clinic.test.c when running make clinic.
erlend-aasland · Aug 8, 2023 · bb701b7 · bb701b7
1 parent a9aeb99
commit bb701b7
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 1 deletion.
diff --git a/Doc/howto/clinic.rst b/Doc/howto/clinic.rst
@@ -188,6 +188,11 @@ The CLI supports the following options:
 
    The directory tree to walk in :option:`--make` mode.
 
+.. option:: --exclude FILES
+
+   Comma-separated list of files to exclude in :option:`--make` mode.
+   This option has no effect unless :option:`--make` is also given.
+
 .. option:: FILE ...
 
    The list of files to process.

diff --git a/Makefile.pre.in b/Makefile.pre.in
@@ -775,7 +775,7 @@ coverage-report: regen-token regen-frozen
 # Run "Argument Clinic" over all source files
 .PHONY: clinic
 clinic: check-clean-src $(srcdir)/Modules/_blake2/blake2s_impl.c
-	$(PYTHON_FOR_REGEN) $(srcdir)/Tools/clinic/clinic.py --make --srcdir $(srcdir)
+	$(PYTHON_FOR_REGEN) $(srcdir)/Tools/clinic/clinic.py --make --exclude Lib/test/clinic.test.c --srcdir $(srcdir)
 	$(PYTHON_FOR_REGEN) $(srcdir)/Tools/build/generate_global_objects.py
 
 # Build the interpreter

diff --git a/Misc/NEWS.d/next/Tools-Demos/2023-08-08-12-21-41.gh-issue-104683.DRsAQE.rst b/Misc/NEWS.d/next/Tools-Demos/2023-08-08-12-21-41.gh-issue-104683.DRsAQE.rst
@@ -0,0 +1 @@
+Add ``--exclude`` option to Argument Clinic CLI.
diff --git a/Tools/clinic/clinic.py b/Tools/clinic/clinic.py
@@ -5832,6 +5832,8 @@ def create_cli() -> argparse.ArgumentParser:
                          help="walk --srcdir to run over all relevant files")
     cmdline.add_argument("--srcdir", type=str, default=os.curdir,
                          help="the directory tree to walk in --make mode")
+    cmdline.add_argument("--exclude", type=str,
+                         help="a list of files to exclude --make mode")
     cmdline.add_argument("filename", metavar="FILE", type=str, nargs="*",
                          help="the list of files to process")
     return cmdline
@@ -5903,6 +5905,7 @@ def run_clinic(parser: argparse.ArgumentParser, ns: argparse.Namespace) -> None:
             parser.error("can't use -o or filenames with --make")
         if not ns.srcdir:
             parser.error("--srcdir must not be empty with --make")
+        excludes = [os.path.join(ns.srcdir, f) for f in ns.exclude.split(",")]
         for root, dirs, files in os.walk(ns.srcdir):
             for rcs_dir in ('.svn', '.git', '.hg', 'build', 'externals'):
                 if rcs_dir in dirs:
@@ -5912,6 +5915,8 @@ def run_clinic(parser: argparse.ArgumentParser, ns: argparse.Namespace) -> None:
                 if not filename.endswith(('.c', '.cpp', '.h')):
                     continue
                 path = os.path.join(root, filename)
+                if path in excludes:
+                    continue
                 if ns.verbose:
                     print(path)
                 parse_file(path, verify=not ns.force)