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,19 +32,20 @@ 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 '
'diff')
parser.add_argument('-p', metavar='NUM', default=0, parser.add_argument('-p', metavar='NUM', default=0,
help='strip the smallest prefix containing P slashes') help='strip the smallest prefix containing P slashes')
parser.add_argument('-regex', metavar='PATTERN', default=None, parser.add_argument('-regex', metavar='PATTERN', default=None,
help='custom pattern selecting file paths to reformat ' help='custom pattern selecting file paths to reformat '
'(case sensitive, overrides -iregex)') '(case sensitive, overrides -iregex)')
parser.add_argument('-iregex', metavar='PATTERN', default= parser.add_argument('-iregex', metavar='PATTERN',
r'.*\.(cpp|cc|c\+\+|cxx|c|cl|h|hh|hpp|m|mm|inc|js|ts|proto' default=r'.*\.(cpp|cc|c\+\+|cxx|c|cl|h|hh|hpp|m|mm|inc'
r'|protodevel|java|cs)', r'|js|ts|proto|protodevel|java|cs)',
help='custom pattern selecting file paths to reformat ' help='custom pattern selecting file paths to reformat '
'(case insensitive, overridden by -regex)') '(case insensitive, overridden by -regex)')
parser.add_argument('-sort-includes', action='store_true', default=False, parser.add_argument('-sort-includes', action='store_true', default=False,
@ -52,8 +53,8 @@ def main():
parser.add_argument('-v', '--verbose', action='store_true', parser.add_argument('-v', '--verbose', action='store_true',
help='be more verbose, ineffective without -i') help='be more verbose, ineffective without -i')
parser.add_argument('-style', parser.add_argument('-style',
help='formatting style to apply (LLVM, Google, Chromium, ' help='formatting style to apply (LLVM, Google, '
'Mozilla, WebKit)') 'Chromium, Mozilla, WebKit)')
parser.add_argument('-binary', default='clang-format', parser.add_argument('-binary', default='clang-format',
help='location of binary to use for clang-format') help='location of binary to use for clang-format')
args = parser.parse_args() args = parser.parse_args()
@ -65,7 +66,7 @@ def main():
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:
@ -88,9 +89,10 @@ def main():
['-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.
format_line_counter = 0
for filename, lines in lines_by_file.items(): for filename, lines in lines_by_file.items():
if args.i and args.verbose: if args.i and args.verbose:
print('Formatting {}'.format(filename)) print('Formatting {}'.format(filename))
@ -107,7 +109,7 @@ def main():
stderr=None, stderr=None,
stdin=subprocess.PIPE, stdin=subprocess.PIPE,
universal_newlines=True) universal_newlines=True)
stdout, stderr = p.communicate() stdout, _ = p.communicate()
if p.returncode != 0: if p.returncode != 0:
sys.exit(p.returncode) sys.exit(p.returncode)
@ -117,13 +119,15 @@ def main():
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)',
'(after formatting)')
diff_string = ''.join(diff) diff_string = ''.join(diff)
if len(diff_string) > 0: if diff_string:
format_line_counter += sys.stdout.write(diff_string) format_line_counter += sys.stdout.write(diff_string)
if format_line_counter > 0: if format_line_counter > 0:
sys.exit(1) sys.exit(1)
if __name__ == '__main__': if __name__ == '__main__':
main() main()