Skip to content

GH-109408: Move the C file whitespace check from patchcheck to pre-commit #109890

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

GH-109408: Move the C file whitespace check from patchcheck to pre-commit #109890

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f7d8e99
Move the C file whitespace check to pre-commit
AA-Turner Sep 26, 2023
25688d9
unused variable
AA-Turner Sep 26, 2023
6e9040c
Exclude vendored code
AA-Turner Sep 26, 2023
0e20e9f
Fix tabs when run locally
AA-Turner Sep 26, 2023
b44f4c2
Exit with the right code
AA-Turner Sep 26, 2023
d4d31ff
zlib is no more
AA-Turner Sep 26, 2023
b70cece
More concise comment
hugovk Oct 10, 2023
986f2a3
Merge branch 'main' into patchcheck/c-file-whitespace
AA-Turner Oct 10, 2023
b15ef27
Remove the now-redundant --ci option
AA-Turner Oct 10, 2023
556978b
Remove unused imports, variables, and functions
AA-Turner Oct 10, 2023
6891bdb
Verbose regular expression
AA-Turner 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
Fix tabs when run locally
  • Loading branch information
@AA-Turner
AA-Turner committed Sep 26, 2023
commit 0e20e9f090ff48dd643d33a14058a69b476fac0f
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ repos:
hooks:
- id: c-file-whitespace
name: "Check C file whitespace"
language: pygrep
entry: '\t'
entry: "python Tools/patchcheck/untabify.py"
language: "system"
types_or: ['c', 'c++']
Copy link
Copy Markdown
Member

@hugovk hugovk Sep 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We were running on .c and .h files before:

c_files = [fn for fn in file_paths if fn.endswith(('.c', '.h'))]

Both of those are matched by the c type, so this would be closer to parity:

Suggested change
types_or: ['c', 'c++']
types_or: [c]

We do have half a dozen .cpp files in the codebase, do we want to expand to include them? Should we also add c++ for trailing-whitespace above?

Copy link
Copy Markdown
Member Author

@AA-Turner AA-Turner Sep 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The test passed with 'c++' included, I imagined that it was a previous oversight that they weren't included. I'll check if the trailing whitespace check also passes.

Copy link
Copy Markdown
Member Author

@AA-Turner AA-Turner Sep 26, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tools/msi/bundle/bootstrap/PythonBootstrapperApplication.cpp fails with 16 lines changed. Other than that all good (@zooba would you be alright with us enabling the trailing whitespace check here? No real views either way, if you'd prefer to keep the whitespace then that's the status quo anyway!)

A

Copy link
Copy Markdown
Member

@hugovk hugovk Oct 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(We can always remove c++ later if needed.)

# Don't check the style of copies directories containing external libraries
Comment thread
hugovk marked this conversation as resolved.
Outdated
exclude: '^Modules/(_decimal/libmpdec|expat|zlib)/.*$'
Comment thread
AA-Turner marked this conversation as resolved.
Outdated
Expand Down
7 changes: 4 additions & 3 deletions Tools/patchcheck/untabify.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ def process(filename, tabsize, verbose=True):
encoding = f.encoding
except IOError as msg:
print("%r: I/O error: %s" % (filename, msg))
return
return 2
newtext = text.expandtabs(tabsize)
if newtext == text:
return
return 0
backup = filename + "~"
try:
os.unlink(backup)
Expand All @@ -49,7 +49,8 @@ def process(filename, tabsize, verbose=True):
f.write(newtext)
if verbose:
print(filename)
return 1


if __name__ == '__main__':
main()
raise SystemExit(main())
Copy link
Copy Markdown
Member

@hugovk hugovk Sep 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

process() now has return values, which go to main(), but main() always returns None so we never get any errors here.

Copy link
Copy Markdown
Member Author

@AA-Turner AA-Turner Sep 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I didn't realise! pre-commit was failing in my local testing when I introduced tabs, perhaps it just fails when a file is changed after the hook has run.