Skip to content

gh-109408: Add the docs whitespace check from patchcheck to pre-commit #109854

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
hugovk merged 12 commits into from
Oct 10, 2023
Merged

gh-109408: Add the docs whitespace check from patchcheck to pre-commit #109854

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
dff437b
Run pre-commit as part of 'make patchcheck'
hugovk Sep 20, 2023
97c6ccf
Use f-strings
hugovk Sep 20, 2023
029a9a4
Add whitespace
hugovk Sep 20, 2023
d7690a3
Properly pluralise file(s), fix Unix typo
hugovk Sep 20, 2023
5cfcd19
Remove normalize_docs_whitespace from patchcheck, it's covered by pre…
hugovk Sep 20, 2023
1eb8042
Include inc files in pre-commit's trailing-whitespace
hugovk Sep 20, 2023
a85cd1c
Fix string
hugovk Sep 25, 2023
433153d
Use "s" variable for readability
hugovk Sep 25, 2023
a429344
Reinstate docs_modified
hugovk Sep 25, 2023
63c6d17
Reinstate doc_files for docs_modified
hugovk Sep 26, 2023
05a5d35
Revert makefile changes
hugovk Sep 27, 2023
f4b16ec
Merge branch 'main' into patchcheck-docs-whitespace
hugovk Oct 10, 2023
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
Prev Previous commit
Next Next commit
Remove normalize_docs_whitespace from patchcheck, it's covered by pre… 
…-commit's trailing-whitespace
  • Loading branch information
@hugovk
hugovk committed Sep 25, 2023
commit 5cfcd19a69f2f63dcad5e4be31cec478efad3e63
31 changes: 0 additions & 31 deletions Tools/patchcheck/patchcheck.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,28 +205,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(f'Cannot fix {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 Down Expand Up @@ -272,12 +250,9 @@ 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:
Expand All @@ -292,17 +267,11 @@ def main():
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'))]
Comment thread
hugovk marked this conversation as resolved.
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)
Comment thread
hugovk marked this conversation as resolved.
# Misc/ACKS changed.
credit_given(misc_files)
# Misc/NEWS changed.
Expand Down