-
Notifications
You must be signed in to change notification settings - Fork 49
Implement Git hook for clang-formatting #2022
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.
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
Draft
dorde-antic
wants to merge
2
commits into
develop
Choose a base branch
from
clang-format-githook
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+122
−4
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
##################################################################################### | ||
# The MIT License (MIT) | ||
# | ||
# Copyright (c) 2015-2025 Advanced Micro Devices, Inc. All rights reserved. | ||
# | ||
# Permission is hereby granted, free of charge, to any person obtaining a copy | ||
# of this software and associated documentation files (the "Software"), to deal | ||
# in the Software without restriction, including without limitation the rights | ||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
# copies of the Software, and to permit persons to whom the Software is | ||
# furnished to do so, subject to the following conditions: | ||
# | ||
# The above copyright notice and this permission notice shall be included in | ||
# all copies or substantial portions of the Software. | ||
# | ||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
# THE SOFTWARE. | ||
##################################################################################### | ||
import os | ||
import argparse | ||
import subprocess | ||
|
||
CLANG_FORMAT_PATH = '/opt/rocm/llvm/bin' | ||
EXCLUDE_FILES = ['requirements.in', 'onnx.proto'] | ||
CLANG_EXTENSIONS = ('.c', '.cpp', '.hpp', '.h', '.cl', '.hip', '.in') | ||
|
||
|
||
def is_excluded(f): | ||
base = os.path.basename(f) | ||
return base in EXCLUDE_FILES | ||
|
||
|
||
def get_top(): | ||
return subprocess.check_output(['git', 'rev-parse', '--show-toplevel'], | ||
text=True).strip() | ||
Comment on lines
+39
to
+40
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Git commands lack error handling. If git is not available or not in a git repository, subprocess.check_output will raise CalledProcessError with unclear error messages for users. Copilot uses AI. Check for mistakes. Positive FeedbackNegative Feedback |
||
|
||
|
||
def get_merge_base(against): | ||
return subprocess.check_output(['git', 'merge-base', against, 'HEAD'], | ||
text=True).strip() | ||
|
||
|
||
def get_changed_files(base): | ||
output = subprocess.check_output(['git', 'diff', '--name-only', base], | ||
text=True) | ||
return [f.strip() for f in output.splitlines() if f.strip()] | ||
|
||
|
||
def run(cmd, cwd=None, verbose=False): | ||
if verbose: | ||
print("Running:", " ".join(cmd)) | ||
subprocess.run(cmd, cwd=cwd, check=True) | ||
|
||
|
||
def clang_format(against, apply=False, path=CLANG_FORMAT_PATH): | ||
base = get_merge_base(against) | ||
clang_format = os.path.join(path, 'clang-format') | ||
if not os.path.exists(clang_format): | ||
print(f"{clang_format} not installed. Skipping format.") | ||
return | ||
git_clang_format = os.path.join(path, 'git-clang-format') | ||
if not os.path.exists(git_clang_format): | ||
print(f"{git_clang_format} not installed. Skipping format.") | ||
return | ||
diff_flag = [] if apply else ["--diff"] | ||
files = get_changed_files(base) | ||
files = [ | ||
f for f in files if f.endswith(CLANG_EXTENSIONS) and not is_excluded(f) | ||
] | ||
if not files: | ||
print("No files to format.") | ||
return | ||
run([git_clang_format, '--binary', clang_format] + diff_flag + [base] + | ||
files, | ||
cwd=get_top(), | ||
verbose=True) | ||
|
||
|
||
def main(): | ||
parser = argparse.ArgumentParser() | ||
parser.add_argument('against', default='develop', nargs='?') | ||
parser.add_argument('-i', '--in-place', action='store_true') | ||
parser.add_argument('-q', '--quiet', action='store_true') | ||
args = parser.parse_args() | ||
try: | ||
clang_format(args.against, apply=args.in_place) | ||
except subprocess.CalledProcessError as ex: | ||
if ex.stdout: | ||
print(ex.stdout) | ||
if ex.stderr: | ||
print(ex.stderr) | ||
if not args.quiet: | ||
print(f"Command '{ex.cmd}' returned {ex.returncode}") | ||
raise | ||
return 0 | ||
|
||
|
||
if __name__ == "__main__": | ||
import sys | ||
sys.exit(main()) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The hardcoded path '/opt/rocm/llvm/bin' makes this code non-portable across different environments. Consider making this configurable through environment variables or command-line arguments, with this as a fallback default.
Copilot uses AI. Check for mistakes.