python · hugovk · Oct 10, 2023 · Sep 20, 2023 · Sep 20, 2023 · Sep 20, 2023
@@ -17,7 +17,7 @@ repos:
        types: [python]
        exclude: Lib/test/tokenizedata/coding20731.py
      - id: trailing-whitespace
-        types_or: [c, python, rst]
+        types_or: [c, inc, python, rst]

  - repo: https://github.com/sphinx-contrib/sphinx-lint
    rev: v0.6.8

diff --git a/Makefile.pre.in b/Makefile.pre.in
@@ -2772,6 +2772,8 @@ funny:
 .PHONY: patchcheck
 patchcheck: all
 	$(RUNSHARED) ./$(BUILDPYTHON) $(srcdir)/Tools/patchcheck/patchcheck.py
+	@$(RUNSHARED) ./$(BUILDPYTHON) -m pre_commit --version >/dev/null 2>&1 || $(RUNSHARED) ./$(BUILDPYTHON) -m pip install pre-commit >/dev/null 2>&1
+	$(RUNSHARED) ./$(BUILDPYTHON) -m pre_commit run --all-files
-	@$(RUNSHARED) ./$(BUILDPYTHON) -m pre_commit --version >/dev/null 2>&1 || $(RUNSHARED) ./$(BUILDPYTHON) -m pip install pre-commit >/dev/null 2>&1
-	$(RUNSHARED) ./$(BUILDPYTHON) -m pre_commit run --all-files
-	@$(RUNSHARED) ./$(BUILDPYTHON) -m pre_commit --version >/dev/null 2>&1 || $(RUNSHARED) ./$(BUILDPYTHON) -m pip install pre-commit >/dev/null 2>&1
-	$(RUNSHARED) ./$(BUILDPYTHON) -m pre_commit run --all-files

 .PHONY: check-limited-abi
 check-limited-abi: all

diff --git a/Tools/patchcheck/patchcheck.py b/Tools/patchcheck/patchcheck.py
@@ -23,7 +23,8 @@

 def n_files_str(count):
    """Return 'N file(s)' with the proper plurality on 'file'."""
-    return "{} file{}".format(count, "s" if count != 1 else "")
+    s = "s" if count != 1 else ""
+    return f"{count} file{s}"


 def status(message, modal=False, info=None):
@@ -77,7 +78,7 @@ def get_git_remote_default_branch(remote_name):

    It is typically called 'main', but may differ
    """
-    cmd = "git remote show {}".format(remote_name).split()
+    cmd = f"git remote show {remote_name}".split()
    env = os.environ.copy()
    env['LANG'] = 'C'
    try:
@@ -164,9 +165,9 @@ def report_modified_files(file_paths):
    if count == 0:
        return n_files_str(count)
    else:
-        lines = ["{}:".format(n_files_str(count))]
+        lines = [f"{n_files_str(count)}:"]
        for path in file_paths:
-            lines.append("  {}".format(path))
+            lines.append(f"  {path}")
        return "\n".join(lines)


@@ -205,27 +206,6 @@ def normalize_c_whitespace(file_paths):
    return fixed


-ws_re = re.compile(br'\s+(\r?\n)$')
-
-@status("Fixing docs whitespace", info=report_modified_files)
-def normalize_docs_whitespace(file_paths):
-    fixed = []
-    for path in file_paths:
-        abspath = os.path.join(SRCDIR, path)
-        try:
-            with open(abspath, 'rb') as f:
-                lines = f.readlines()
-            new_lines = [ws_re.sub(br'\1', line) for line in lines]
-            if new_lines != lines:
-                shutil.copyfile(abspath, abspath + '.bak')
-                with open(abspath, 'wb') as f:
-                    f.writelines(new_lines)
-                fixed.append(path)
-        except Exception as err:
-            print('Cannot fix %s: %s' % (path, err))
-    return fixed
-
-
 @status("Docs modified", modal=True)
 def docs_modified(file_paths):
    """Report if any file in the Doc directory has been changed."""
@@ -244,6 +224,7 @@ def reported_news(file_paths):
    return any(p.startswith(os.path.join('Misc', 'NEWS.d', 'next'))
               for p in file_paths)

+
 @status("configure regenerated", modal=True, info=str)
 def regenerated_configure(file_paths):
    """Check if configure has been regenerated."""
@@ -252,6 +233,7 @@ def regenerated_configure(file_paths):
    else:
        return "not needed"

+
 @status("pyconfig.h.in regenerated", modal=True, info=str)
 def regenerated_pyconfig_h_in(file_paths):
    """Check if pyconfig.h.in has been regenerated."""
@@ -260,6 +242,7 @@ def regenerated_pyconfig_h_in(file_paths):
    else:
        return "not needed"

+
 def ci(pull_request):
    if pull_request == 'false':
        print('Not a pull request; skipping')
@@ -268,33 +251,28 @@ def ci(pull_request):
    file_paths = changed_files(base_branch)
    python_files = [fn for fn in file_paths if fn.endswith('.py')]
    c_files = [fn for fn in file_paths if fn.endswith(('.c', '.h'))]
-    doc_files = [fn for fn in file_paths if fn.startswith('Doc') and
-                 fn.endswith(('.rst', '.inc'))]
    fixed = []
    fixed.extend(normalize_whitespace(python_files))
    fixed.extend(normalize_c_whitespace(c_files))
-    fixed.extend(normalize_docs_whitespace(doc_files))
    if not fixed:
        print('No whitespace issues found')
    else:
-        print(f'Please fix the {len(fixed)} file(s) with whitespace issues')
-        print('(on UNIX you can run `make patchcheck` to make the fixes)')
+        count = len(fixed)
+        print(f'Please fix the {n_files_str(count)} with whitespace issues')
+        print('(on Unix you can run `make patchcheck` to make the fixes)')
        sys.exit(1)

+
 def main():
    base_branch = get_base_branch()
    file_paths = changed_files(base_branch)
    python_files = [fn for fn in file_paths if fn.endswith('.py')]
    c_files = [fn for fn in file_paths if fn.endswith(('.c', '.h'))]
-    doc_files = [fn for fn in file_paths if fn.startswith('Doc') and
-                 fn.endswith(('.rst', '.inc'))]
    misc_files = {p for p in file_paths if p.startswith('Misc')}
    # PEP 8 whitespace rules enforcement.
    normalize_whitespace(python_files)
    # C rules enforcement.
    normalize_c_whitespace(c_files)
-    # Doc whitespace enforcement.
-    normalize_docs_whitespace(doc_files)
    # Docs updated.
    docs_modified(doc_files)
    # Misc/ACKS changed.