clang-format-diff: Reformat script to satisfy PEP8 and pylint

This introduces no functional changes.

Signed-off-by: Philip Withnall <withnall@endlessm.com>
This commit is contained in:
Philip Withnall 2019-12-12 10:08:34 +00:00
parent 2efa399abd
commit 742a7b125e

View File

@ -1,12 +1,12 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
# #
#===- clang-format-diff.py - ClangFormat Diff Reformatter ----*- python -*--===# # === clang-format-diff.py - ClangFormat Diff Reformatter ---*- python -*-=== #
# #
# Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. # Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
# See https://llvm.org/LICENSE.txt for license information. # See https://llvm.org/LICENSE.txt for license information.
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
# #
#===------------------------------------------------------------------------===# # ===---------------------------------------------------------------------=== #
""" """
This script reads input from a unified diff and reformats all the changed This script reads input from a unified diff and reformats all the changed
@ -32,98 +32,102 @@ else:
def main(): def main():
parser = argparse.ArgumentParser(description=__doc__, parser = argparse.ArgumentParser(
formatter_class= description=__doc__,
argparse.RawDescriptionHelpFormatter) formatter_class=argparse.RawDescriptionHelpFormatter)
parser.add_argument('-i', action='store_true', default=False, parser.add_argument('-i', action='store_true', default=False,
help='apply edits to files instead of displaying a diff') help='apply edits to files instead of displaying a '
parser.add_argument('-p', metavar='NUM', default=0, 'diff')
help='strip the smallest prefix containing P slashes') parser.add_argument('-p', metavar='NUM', default=0,
parser.add_argument('-regex', metavar='PATTERN', default=None, help='strip the smallest prefix containing P slashes')
help='custom pattern selecting file paths to reformat ' parser.add_argument('-regex', metavar='PATTERN', default=None,
'(case sensitive, overrides -iregex)') help='custom pattern selecting file paths to reformat '
parser.add_argument('-iregex', metavar='PATTERN', default= '(case sensitive, overrides -iregex)')
r'.*\.(cpp|cc|c\+\+|cxx|c|cl|h|hh|hpp|m|mm|inc|js|ts|proto' parser.add_argument('-iregex', metavar='PATTERN',
r'|protodevel|java|cs)', default=r'.*\.(cpp|cc|c\+\+|cxx|c|cl|h|hh|hpp|m|mm|inc'
help='custom pattern selecting file paths to reformat ' r'|js|ts|proto|protodevel|java|cs)',
'(case insensitive, overridden by -regex)') help='custom pattern selecting file paths to reformat '
parser.add_argument('-sort-includes', action='store_true', default=False, '(case insensitive, overridden by -regex)')
help='let clang-format sort include blocks') parser.add_argument('-sort-includes', action='store_true', default=False,
parser.add_argument('-v', '--verbose', action='store_true', help='let clang-format sort include blocks')
help='be more verbose, ineffective without -i') parser.add_argument('-v', '--verbose', action='store_true',
parser.add_argument('-style', help='be more verbose, ineffective without -i')
help='formatting style to apply (LLVM, Google, Chromium, ' parser.add_argument('-style',
'Mozilla, WebKit)') help='formatting style to apply (LLVM, Google, '
parser.add_argument('-binary', default='clang-format', 'Chromium, Mozilla, WebKit)')
help='location of binary to use for clang-format') parser.add_argument('-binary', default='clang-format',
args = parser.parse_args() help='location of binary to use for clang-format')
args = parser.parse_args()
# Extract changed lines for each file. # Extract changed lines for each file.
filename = None filename = None
lines_by_file = {} lines_by_file = {}
for line in sys.stdin: for line in sys.stdin:
match = re.search(r'^\+\+\+\ (.*?/){%s}(\S*)' % args.p, line) match = re.search(r'^\+\+\+\ (.*?/){%s}(\S*)' % args.p, line)
if match: if match:
filename = match.group(2) filename = match.group(2)
if filename == None: if filename is None:
continue continue
if args.regex is not None: if args.regex is not None:
if not re.match('^%s$' % args.regex, filename): if not re.match('^%s$' % args.regex, filename):
continue continue
else: else:
if not re.match('^%s$' % args.iregex, filename, re.IGNORECASE): if not re.match('^%s$' % args.iregex, filename, re.IGNORECASE):
continue continue
match = re.search(r'^@@.*\+(\d+)(,(\d+))?', line) match = re.search(r'^@@.*\+(\d+)(,(\d+))?', line)
if match: if match:
start_line = int(match.group(1)) start_line = int(match.group(1))
line_count = 1 line_count = 1
if match.group(3): if match.group(3):
line_count = int(match.group(3)) line_count = int(match.group(3))
if line_count == 0: if line_count == 0:
continue continue
end_line = start_line + line_count - 1 end_line = start_line + line_count - 1
lines_by_file.setdefault(filename, []).extend( lines_by_file.setdefault(filename, []).extend(
['-lines', str(start_line) + ':' + str(end_line)]) ['-lines', str(start_line) + ':' + str(end_line)])
# Reformat files containing changes in place. # Reformat files containing changes in place.
# We need to count amount of bytes generated in the output of clang-format-diff # We need to count amount of bytes generated in the output of
# If clang-format-diff doesn't generate any bytes it means there is nothing to format. # clang-format-diff. If clang-format-diff doesn't generate any bytes it
format_line_counter=0 # means there is nothing to format.
for filename, lines in lines_by_file.items(): format_line_counter = 0
if args.i and args.verbose: for filename, lines in lines_by_file.items():
print('Formatting {}'.format(filename)) if args.i and args.verbose:
command = [args.binary, filename] print('Formatting {}'.format(filename))
if args.i: command = [args.binary, filename]
command.append('-i') if args.i:
if args.sort_includes: command.append('-i')
command.append('-sort-includes') if args.sort_includes:
command.extend(lines) command.append('-sort-includes')
if args.style: command.extend(lines)
command.extend(['-style', args.style]) if args.style:
p = subprocess.Popen(command, command.extend(['-style', args.style])
stdout=subprocess.PIPE, p = subprocess.Popen(command,
stderr=None, stdout=subprocess.PIPE,
stdin=subprocess.PIPE, stderr=None,
universal_newlines=True) stdin=subprocess.PIPE,
stdout, stderr = p.communicate() universal_newlines=True)
if p.returncode != 0: stdout, _ = p.communicate()
sys.exit(p.returncode) if p.returncode != 0:
sys.exit(p.returncode)
if not args.i: if not args.i:
with open(filename) as f: with open(filename) as f:
code = f.readlines() code = f.readlines()
formatted_code = StringIO(stdout).readlines() formatted_code = StringIO(stdout).readlines()
diff = difflib.unified_diff(code, formatted_code, diff = difflib.unified_diff(code, formatted_code,
filename, filename, filename, filename,
'(before formatting)', '(after formatting)') '(before formatting)',
diff_string = ''.join(diff) '(after formatting)')
if len(diff_string) > 0: diff_string = ''.join(diff)
format_line_counter += sys.stdout.write(diff_string) if diff_string:
format_line_counter += sys.stdout.write(diff_string)
if format_line_counter > 0:
sys.exit(1)
if format_line_counter > 0:
sys.exit(1)
if __name__ == '__main__': if __name__ == '__main__':
main() main()