[clang-tidy] Improve rename_check.py

[omtcyfz]

Summary

-Start using argparse instead of mimicking CLI parsing.
-PEPify the code.
-Decrease the number of imports by slightly cleaning up the script.

[alexander-shaposhnikov]

clang-tidy/rename_check.py

81 ↗

(On Diff #72990)

the script always prints the args, is it intentional ?

[omtcyfz]

Remove leftover from debugging.

[omtcyfz]

clang-tidy/rename_check.py

81 ↗

(On Diff #72990)

Aw, a leftover from debugging.

Good catch! Thanks for the note!

[alexfh]

Kirill, if you still have time for this, could you submit reformatting as a separate patch to make semantic changes more visible?

[omtcyfz]

Reversed "tabwidth:2 -> tabwidth:4" change.
Removed unused dependency (re).
Got rid of sys.argv[0] via using Pythonic __file__ and removed (now) redundant dependency (sys).

[alexfh]

One nit. Otherwise looks good. Thank you!

clang-tidy/rename_check.py

89 ↗

(On Diff #76593)

Does PEP8 have any preferences with regard to using a terminating backslash over enclosing an expression that needs to be wrapped in parentheses? If no, I'd better use parentheses.

[omtcyfz]

Addressing comments Alex made about line breaks.

clang-tidy/rename_check.py

89 ↗

(On Diff #76593)

Hm, apparently it does.

The preferred way of wrapping long lines is by using Python's implied line continuation inside parentheses, brackets and braces. Long lines can be broken over multiple lines by wrapping expressions in parentheses. These should be used in preference to using a backslash for line continuation.

Didn't know it, though. Thank you for pointing it out!

clang-tools-extra/trunk/clang-tidy/rename_check.py

 #!/usr/bin/env python
 #
 #===- rename_check.py - clang-tidy check renamer -------------*- python -*--===#
 #
 #                     The LLVM Compiler Infrastructure
 #
 # This file is distributed under the University of Illinois Open Source
 # License. See LICENSE.TXT for details.
 #
 #===------------------------------------------------------------------------===#
 
 import os
-import re
-import sys
 import glob
+import argparse
+
 
 def replaceInFile(fileName, sFrom, sTo):
   if sFrom == sTo:
     return
   txt = None
   with open(fileName, "r") as f:
     txt = f.read()
 
   if sFrom not in txt:
     return
 
   txt = txt.replace(sFrom, sTo)
   print("Replace '%s' -> '%s' in '%s'" % (sFrom, sTo, fileName))
   with open(fileName, "w") as f:
     f.write(txt)
 
+
 def generateCommentLineHeader(filename):
   return ''.join(['//===--- ',
                   os.path.basename(filename),
                   ' - clang-tidy ',
                   '-' * max(0, 42 - len(os.path.basename(filename))),
                   '*- C++ -*-===//'])
 
+
 def generateCommentLineSource(filename):
   return ''.join(['//===--- ',
                   os.path.basename(filename),
                   ' - clang-tidy',
                   '-' * max(0, 52 - len(os.path.basename(filename))),
                   '-===//'])
 
+
 def fileRename(fileName, sFrom, sTo):
   if sFrom not in fileName:
     return fileName
   newFileName = fileName.replace(sFrom, sTo)
   print("Rename '%s' -> '%s'" % (fileName, newFileName))
   os.rename(fileName, newFileName)
   return newFileName
 
+
 def getListOfFiles(clang_tidy_path):
-  files =  glob.glob(os.path.join(clang_tidy_path,'*'))
+  files = glob.glob(os.path.join(clang_tidy_path, '*'))
   for dirname in files:
     if os.path.isdir(dirname):
-      files += glob.glob(os.path.join(dirname,'*'))
-  files += glob.glob(os.path.join(clang_tidy_path,'..', 'test', 'clang-tidy', '*'))
-  files += glob.glob(os.path.join(clang_tidy_path,'..', 'docs', 'clang-tidy', 'checks', '*'))
+      files += glob.glob(os.path.join(dirname, '*'))
+  files += glob.glob(os.path.join(clang_tidy_path, '..', 'test',
+                                  'clang-tidy', '*'))
+  files += glob.glob(os.path.join(clang_tidy_path, '..', 'docs',
+                                  'clang-tidy', 'checks', '*'))
   return [filename for filename in files if os.path.isfile(filename)]
 
+
 def main():
-  if len(sys.argv) != 4:
-    print('Usage: rename_check.py <module> <old-check-name> <new-check-name>\n')
-    print('       example: rename_check.py misc awesome-functions new-awesome-function')
-    return
+  parser = argparse.ArgumentParser(description='Rename clang-tidy check.')
+  parser.add_argument('module', type=str,
+                      help='Module where the renamed check is defined')
+  parser.add_argument('old_check_name', type=str,
+                      help='Old check name.')
+  parser.add_argument('new_check_name', type=str,
+                      help='New check name.')
+  args = parser.parse_args()
 
-  module = sys.argv[1].lower()
-  check_name = sys.argv[2]
+  args.module = args.module.lower()
   check_name_camel = ''.join(map(lambda elem: elem.capitalize(),
-                                 check_name.split('-'))) + 'Check'
-  check_name_new = sys.argv[3]
-  check_name_new_camel = ''.join(map(lambda elem: elem.capitalize(),
-                                 check_name_new.split('-'))) + 'Check'
-
-  clang_tidy_path = os.path.dirname(sys.argv[0])
-
-  header_guard_old = module.upper() + '_' + check_name.upper().replace('-', '_')
-  header_guard_new = module.upper() + '_' + check_name_new.upper().replace('-', '_')
+                                 args.old_check_name.split('-'))) + 'Check'
+  check_name_new_camel = (''.join(map(lambda elem: elem.capitalize(),
+                                      args.new_check_name.split('-'))) +
+                          'Check')
+
+  clang_tidy_path = os.path.dirname(__file__)
+
+  header_guard_old = (args.module.upper() + '_' +
+                      args.old_check_name.upper().replace('-', '_'))
+  header_guard_new = (args.module.upper() + '_' +
+                      args.new_check_name.upper().replace('-', '_'))
 
   for filename in getListOfFiles(clang_tidy_path):
     originalName = filename
-    filename = fileRename(filename, check_name, check_name_new)
+    filename = fileRename(filename, args.old_check_name,
+                          args.new_check_name)
     filename = fileRename(filename, check_name_camel, check_name_new_camel)
-    replaceInFile(filename, generateCommentLineHeader(originalName), generateCommentLineHeader(filename))
-    replaceInFile(filename, generateCommentLineSource(originalName), generateCommentLineSource(filename))
+    replaceInFile(filename, generateCommentLineHeader(originalName),
+                  generateCommentLineHeader(filename))
+    replaceInFile(filename, generateCommentLineSource(originalName),
+                  generateCommentLineSource(filename))
     replaceInFile(filename, header_guard_old, header_guard_new)
-    replaceInFile(filename, check_name, check_name_new)
+    replaceInFile(filename, args.old_check_name, args.new_check_name)
     replaceInFile(filename, check_name_camel, check_name_new_camel)
 
 if __name__ == '__main__':
   main()