Skip to content

[3.12] gh-109408: Add the docs whitespace check from patchcheck to pre-commit (GH-109854) #110594

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 10, 2023
Merged

[3.12] gh-109408: Add the docs whitespace check from patchcheck to pre-commit (GH-109854) #110594

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
44 changes: 12 additions & 32 deletions Tools/patchcheck/patchcheck.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ def get_python_source_dir():

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):
Expand Down Expand Up @@ -84,7 +85,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:
Expand Down Expand Up @@ -171,9 +172,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)


Expand Down Expand Up @@ -212,27 +213,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."""
Expand All @@ -251,6 +231,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."""
Expand All @@ -259,6 +240,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."""
Expand All @@ -267,6 +249,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')
Expand All @@ -275,19 +258,18 @@ 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)
Expand All @@ -300,8 +282,6 @@ def main():
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.
Expand Down