[clang-tidy] NFC: Cleanup Python scripts

[kbobyrev]

Summary

Silence few PEP8 warnings.

[hokein]

thanks for cleaning up.

clang-tools-extra/clang-tidy/add_new_check.py

1

we should keep using python I think.

[Eugene.Zelenko]

It would be great to also run Flake8 and PyLint.

[kbobyrev]

Remove python3 from shebang.

[kbobyrev]

In D78985#2007669, @Eugene.Zelenko wrote:

It would be great to also run Flake9 and PyLint.

Those were actually from pylint. That's a good idea, but I didn't fix all the warnings there and while I might get back to this in the future I don't think it's in the scope of this patch as this is a pretty trivial NFC cleanup.

clang-tools-extra/clang-tidy/add_new_check.py

1

Oops, a leftover from testing, thanks for noticing!

[Eugene.Zelenko]

In D78985#2007715, @kbobyrev wrote:

In D78985#2007669, @Eugene.Zelenko wrote:

It would be great to also run Flake9 and PyLint.

Those were actually from pylint. That's a good idea, but I didn't fix all the warnings there and while I might get back to this in the future I don't think it's in the scope of this patch as this is a pretty trivial NFC cleanup.

If number of PyLint warnings (excluding identifiers naming) is not too big, it may make sense to clean-up in one commit.

clang-tools-extra/clang-tidy/add_new_check.py

 #!/usr/bin/env python
 #
-#===- add_new_check.py - clang-tidy check generator ----------*- python -*--===#
+#===- add_new_check.py - clang-tidy check generator ---------*- python -*--===#
 #
 # Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 # See https://llvm.org/LICENSE.txt for license information.
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 #
-#===------------------------------------------------------------------------===#
+#===-----------------------------------------------------------------------===#
 
 from __future__ import print_function
 
 import argparse
 import os
 import re
 import sys
 
-# Adapts the module's CMakelist file. Returns 'True' if it could add a new entry
-# and 'False' if the entry already existed.
+
+# Adapts the module's CMakelist file. Returns 'True' if it could add a new
+# entry and 'False' if the entry already existed.
 def adapt_cmake(module_path, check_name_camel):
   filename = os.path.join(module_path, 'CMakeLists.txt')
   with open(filename, 'r') as f:
     lines = f.readlines()
 
   cpp_file = check_name_camel + '.cpp'
 
   # Figure out whether this check already exists.
def add_release_notes(module_path, module, check_name):
   lineMatcher = re.compile('New checks')
   nextSectionMatcher = re.compile('New check aliases')
   checkMatcher = re.compile('- New :doc:`(.*)')
 
   print('Updating %s...' % filename)
   with open(filename, 'w') as f:
     note_added = False
     header_found = False
-    next_header_found = False
     add_note_here = False
 
     for line in lines:
       if not note_added:
         match = lineMatcher.match(line)
         match_next = nextSectionMatcher.match(line)
         match_check = checkMatcher.match(line)
         if match_check:
           last_check = match_check.group(1)
           if last_check > check_name_dashes:
             add_note_here = True
 
         if match_next:
-          next_header_found = True
           add_note_here = True
 
         if match:
           header_found = True
           f.write(line)
           continue
 
         if line.startswith('^^^^'):

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

 #!/usr/bin/env python
 #
-#===- rename_check.py - clang-tidy check renamer -------------*- python -*--===#
+#===- rename_check.py - clang-tidy check renamer ------------*- python -*--===#
 #
 # Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 # See https://llvm.org/LICENSE.txt for license information.
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 #
-#===------------------------------------------------------------------------===#
+#===-----------------------------------------------------------------------===#
 
 import argparse
 import glob
 import os
 import re
 
 
 def replaceInFileRegex(fileName, sFrom, sTo):
   if sFrom == sTo:
     return
   txt = None
   with open(fileName, "r") as f:
     txt = f.read()
 
   txt = re.sub(sFrom, sTo, txt)
   print("Replacing '%s' -> '%s' in '%s'..." % (sFrom, sTo, fileName))
   with open(fileName, "w") as f:
     f.write(txt)
 
+
 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:

 def fileRename(fileName, sFrom, sTo):
   if sFrom not in fileName or sFrom == sTo:
     return fileName
   newFileName = fileName.replace(sFrom, sTo)
   print("Renaming '%s' -> '%s'..." % (fileName, newFileName))
   os.rename(fileName, newFileName)
   return newFileName
 
+
 def deleteMatchingLines(fileName, pattern):
   lines = None
   with open(fileName, "r") as f:
     lines = f.readlines()
 
   not_matching_lines = [l for l in lines if not re.search(pattern, l)]
   if len(not_matching_lines) == len(lines):
     return False
 
   print("Removing lines matching '%s' in '%s'..." % (pattern, fileName))
   print('  ' + '  '.join([l for l in lines if re.search(pattern, l)]))
   with open(fileName, "w") as f:
     f.writelines(not_matching_lines)
 
   return True
 
+
 def getListOfFiles(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', '*'))
   return [filename for filename in files if os.path.isfile(filename)]
 
-# Adapts the module's CMakelist file. Returns 'True' if it could add a new entry
-# and 'False' if the entry already existed.
+
+# Adapts the module's CMakelist file. Returns 'True' if it could add a new
+# entry and 'False' if the entry already existed.
 def adapt_cmake(module_path, check_name_camel):
   filename = os.path.join(module_path, 'CMakeLists.txt')
   with open(filename, 'r') as f:
     lines = f.readlines()
 
   cpp_file = check_name_camel + '.cpp'
 
   # Figure out whether this check already exists.
def add_release_notes(clang_tidy_path, old_check_name, new_check_name):
   lineMatcher = re.compile('Renamed checks')
   nextSectionMatcher = re.compile('Improvements to include-fixer')
   checkMatcher = re.compile('- The \'(.*)')
 
   print('Updating %s...' % filename)
   with open(filename, 'wb') as f:
     note_added = False
     header_found = False
-    next_header_found = False
     add_note_here = False
 
     for line in lines:
       if not note_added:
         match = lineMatcher.match(line)
         match_next = nextSectionMatcher.match(line)
         match_check = checkMatcher.match(line)
         if match_check:
           last_check = match_check.group(1)
           if last_check > old_check_name:
             add_note_here = True
 
         if match_next:
-          next_header_found = True
           add_note_here = True
 
         if match:
           header_found = True
           f.write(line)
           continue
 
         if line.startswith('^^^^'):
def main():
   adapt_cmake(new_module_path, new_check_name_camel)
   adapt_module(new_module_path, new_module, args.new_check_name,
                new_check_name_camel)
 
   os.system(os.path.join(clang_tidy_path, 'add_new_check.py')
             + ' --update-docs')
   add_release_notes(clang_tidy_path, args.old_check_name, args.new_check_name)
 
+
 if __name__ == '__main__':
   main()

clang-tools-extra/clang-tidy/tool/clang-tidy-diff.py

 #!/usr/bin/env python
 #
-#===- clang-tidy-diff.py - ClangTidy Diff Checker ------------*- python -*--===#
+#===- clang-tidy-diff.py - ClangTidy Diff Checker -----------*- python -*--===#
 #
 # Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 # See https://llvm.org/LICENSE.txt for license information.
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 #
-#===------------------------------------------------------------------------===#
+#===-----------------------------------------------------------------------===#
 
 r"""
 ClangTidy Diff Checker
 ======================
 
 This script reads input from a unified diff, runs clang-tidy on all changed
 files and outputs clang-tidy warnings in changed lines only. This is useful to
 detect clang-tidy regressions in the lines touched by a specific patch.
try:
         if stderr:
           sys.stderr.write(stderr.decode('utf-8') + '\n')
           sys.stderr.flush()
     except Exception as e:
       with lock:
         sys.stderr.write('Failed: ' + str(e) + ': '.join(command) + '\n')
     finally:
       with lock:
-        if (not timeout is None) and (not watchdog is None):
+        if not (timeout is None or watchdog is None):
           if not watchdog.is_alive():
               sys.stderr.write('Terminated by timeout: ' +
                                ' '.join(command) + '\n')
           watchdog.cancel()
       task_queue.task_done()
 
 
 def start_workers(max_tasks, tidy_caller, task_queue, lock, timeout):
   for _ in range(max_tasks):
     t = threading.Thread(target=tidy_caller, args=(task_queue, lock, timeout))
     t.daemon = True
     t.start()
 
+
 def merge_replacement_files(tmpdir, mergefile):
   """Merge all replacement files in a directory into a single file"""
   # The fixes suggested by clang-tidy >= 4.0.0 are given under
   # the top level key 'Diagnostics' in the output yaml files
   mergekey = "Diagnostics"
   merged = []
   for replacefile in glob.iglob(os.path.join(tmpdir, '*.yaml')):
     content = yaml.safe_load(open(replacefile, 'r'))
     if not content:
       continue # Skip empty files.
     merged.extend(content.get(mergekey, []))
 
   if merged:
     # MainSourceFile: The key is required by the definition inside
     # include/clang/Tooling/ReplacementsYaml.h, but the value
     # is actually never used inside clang-apply-replacements,
     # so we set it to '' here.
-    output = { 'MainSourceFile': '', mergekey: merged }
+    output = {'MainSourceFile': '', mergekey: merged}
     with open(mergefile, 'w') as out:
       yaml.safe_dump(output, out)
   else:
     # Empty the file:
     open(mergefile, 'w').close()
 
 
 def main():

clang-tools-extra/clang-tidy/tool/run-clang-tidy.py

 #!/usr/bin/env python
 #
-#===- run-clang-tidy.py - Parallel clang-tidy runner ---------*- python -*--===#
+#===- run-clang-tidy.py - Parallel clang-tidy runner --------*- python -*--===#
 #
 # Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 # See https://llvm.org/LICENSE.txt for license information.
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 #
-#===------------------------------------------------------------------------===#
+#===-----------------------------------------------------------------------===#
 # FIXME: Integrate with clang-tidy-diff.py
 
+
 """
 Parallel clang-tidy runner
 ==========================
 
 Runs clang-tidy over all files in a compilation database. Requires clang-tidy
 and clang-apply-replacements in $PATH.
 
 Example invocations.

 
 is_py2 = sys.version[0] == '2'
 
 if is_py2:
     import Queue as queue
 else:
     import queue as queue
 
+
 def find_compilation_database(path):
   """Adjusts the directory until a compilation database is found."""
   result = './'
   while not os.path.isfile(os.path.join(result, path)):
     if os.path.realpath(result) == '/':
       print('Error: could not find compilation database.')
       sys.exit(1)
     result += '../'
def get_tidy_invocation(f, clang_tidy_binary, checks, tmpdir, build_path,
   start.append(f)
   return start
 
 
 def merge_replacement_files(tmpdir, mergefile):
   """Merge all replacement files in a directory into a single file"""
   # The fixes suggested by clang-tidy >= 4.0.0 are given under
   # the top level key 'Diagnostics' in the output yaml files
-  mergekey="Diagnostics"
+  mergekey = "Diagnostics"
   merged=[]
   for replacefile in glob.iglob(os.path.join(tmpdir, '*.yaml')):
     content = yaml.safe_load(open(replacefile, 'r'))
     if not content:
       continue # Skip empty files.
     merged.extend(content.get(mergekey, []))
 
   if merged:
     # MainSourceFile: The key is required by the definition inside
     # include/clang/Tooling/ReplacementsYaml.h, but the value
     # is actually never used inside clang-apply-replacements,
     # so we set it to '' here.
-    output = { 'MainSourceFile': '', mergekey: merged }
+    output = {'MainSourceFile': '', mergekey: merged}
     with open(mergefile, 'w') as out:
       yaml.safe_dump(output, out)
   else:
     # Empty the file:
     open(mergefile, 'w').close()
 
 
 def check_clang_apply_replacements_binary(args):
def main():
 
   if args.fix:
     print('Applying fixes ...')
     try:
       apply_fixes(args, tmpdir)
     except:
       print('Error applying fixes.\n', file=sys.stderr)
       traceback.print_exc()
-      return_code=1
+      return_code = 1
 
   if tmpdir:
     shutil.rmtree(tmpdir)
   sys.exit(return_code)
 
+
 if __name__ == '__main__':
   main()