[clang-tidy] Handle missing yaml module in run-clang-tidy.py

[zinovy.nis]

Summary

The Yaml module is missing on some systems and on many clang buildbots. But the test for run-clang-tidy.py doesn't fail due to not statement masking the python runtime error.

This patch conditionally imports and enables the yaml module only if it's present in system. If not, then -export-fixes is disabled, the same as for clang-tidy-diff.py.

[zinovy.nis]

test/clang-tidy/run-clang-tidy.cpp

1 ↗

(On Diff #191992)

Just check that python doesn't complain on the script code and imported modules.

[serge-sans-paille]

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

51 ↗

(On Diff #191992)

Could be

try:
    import yaml
except ImportError:
    yaml = None

and later

if yaml:
    ...

[serge-sans-paille]

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

210 ↗

(On Diff #191992)

could be

if yaml:
    parser.add_argument('-export-fixes', metavar='filename', dest='export_fixes',
	​                        help='Create a yaml file to store suggested fixes in, '
	​                        'which can be applied with clang-apply-replacements.')
else:
    parser.export_fixes = False

This would make later condition easier to read.

[zinovy.nis]

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

210 ↗

(On Diff #191992)

Looks strange. Not sure this works.

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

 import re
 import shutil
 import subprocess
 import sys
 import tempfile
 import threading
 import traceback
 
-yaml_imported = True
 try:
   import yaml
 except ImportError:
-  yaml_imported = False
+  yaml = None
 
 is_py2 = sys.version[0] == '2'
 
 if is_py2:
     import Queue as queue
 else:
     import queue as queue
 
def main():
   parser.add_argument('-fix', action='store_true', default=False,
                       help='apply suggested fixes')
   parser.add_argument('-checks',
                       help='checks filter, when not specified, use clang-tidy '
                       'default',
                       default='')
   parser.add_argument('-path', dest='build_path',
                       help='Path used to read a compile command database.')
-  if yaml_imported:
+  if yaml:
     parser.add_argument('-export-fixes', metavar='FILE', dest='export_fixes',
                         help='Create a yaml file to store suggested fixes in, '
                         'which can be applied with clang-apply-replacements.')
   parser.add_argument('-extra-arg', dest='extra_arg',
                       action='append', default=[],
                       help='Additional argument to append to the compiler '
                       'command line.')
   parser.add_argument('-extra-arg-before', dest='extra_arg_before',
if not any(lines_by_file):
     sys.exit(0)
 
   max_task_count = args.j
   if max_task_count == 0:
       max_task_count = multiprocessing.cpu_count()
   max_task_count = min(len(lines_by_file), max_task_count)
 
   tmpdir = None
-  if yaml_imported and args.export_fixes:
+  if yaml and args.export_fixes:
     tmpdir = tempfile.mkdtemp()
 
   # Tasks for clang-tidy.
   task_queue = queue.Queue(max_task_count)
   # A lock for console output.
   lock = threading.Lock()
 
   # Run a pool of clang-tidy workers.
def main():
   for name in lines_by_file:
     line_filter_json = json.dumps(
       [{"name": name, "lines": lines_by_file[name]}],
       separators=(',', ':'))
 
     # Run clang-tidy on files containing changes.
     command = [args.clang_tidy_binary]
     command.append('-line-filter=' + line_filter_json)
-    if yaml_imported and args.export_fixes:
+    if yaml and args.export_fixes:
       # Get a temporary file. We immediately close the handle so clang-tidy can
       # overwrite it.
       (handle, tmp_name) = tempfile.mkstemp(suffix='.yaml', dir=tmpdir)
       os.close(handle)
       command.append('-export-fixes=' + tmp_name)
     command.extend(common_clang_tidy_args)
     command.append(name)
     command.extend(clang_tidy_args)
 
     task_queue.put(command)
 
   # Wait for all threads to be done.
   task_queue.join()
 
-  if yaml_imported and args.export_fixes:
+  if yaml and args.export_fixes:
     print('Writing fixes to ' + args.export_fixes + ' ...')
     try:
       merge_replacement_files(tmpdir, args.export_fixes)
     except:
       sys.stderr.write('Error exporting fixes.\n')
       traceback.print_exc()
 
   if tmpdir:
     shutil.rmtree(tmpdir)
 
 
 if __name__ == '__main__':
   main()

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

 import os
 import re
 import shutil
 import subprocess
 import sys
 import tempfile
 import threading
 import traceback
+
+try:
   import yaml
+except ImportError:
+  yaml = None
 
 is_py2 = sys.version[0] == '2'
 
 if is_py2:
     import Queue as queue
 else:
     import queue as queue
 
parser.add_argument('-config', default=None,
                       'When the value is empty, clang-tidy will '
                       'attempt to find a file named .clang-tidy for '
                       'each source file in its parent directories.')
   parser.add_argument('-header-filter', default=None,
                       help='regular expression matching the names of the '
                       'headers to output diagnostics from. Diagnostics from '
                       'the main file of each translation unit are always '
                       'displayed.')
+  if yaml:
     parser.add_argument('-export-fixes', metavar='filename', dest='export_fixes',
                         help='Create a yaml file to store suggested fixes in, '
                         'which can be applied with clang-apply-replacements.')
   parser.add_argument('-j', type=int, default=0,
                       help='number of tidy instances to be run in parallel.')
   parser.add_argument('files', nargs='*', default=['.*'],
                       help='files to be processed (regex on path)')
   parser.add_argument('-fix', action='store_true', help='apply fix-its')
   parser.add_argument('-format', action='store_true', help='Reformat code '
                       'after applying fixes')
   parser.add_argument('-style', default='file', help='The style of reformat '
def main():
   files = [make_absolute(entry['file'], entry['directory'])
            for entry in database]
 
   max_task = args.j
   if max_task == 0:
     max_task = multiprocessing.cpu_count()
 
   tmpdir = None
-  if args.fix or args.export_fixes:
+  if args.fix or (yaml and args.export_fixes):
     check_clang_apply_replacements_binary(args)
     tmpdir = tempfile.mkdtemp()
 
   # Build up a big regexy filter from all command line arguments.
   file_name_re = re.compile('|'.join(args.files))
 
   return_code = 0
   try:
def main():
   except KeyboardInterrupt:
     # This is a sad hack. Unfortunately subprocess goes
     # bonkers with ctrl-c and we start forking merrily.
     print('\nCtrl-C detected, goodbye.')
     if tmpdir:
       shutil.rmtree(tmpdir)
     os.kill(0, 9)
 
-  if args.export_fixes:
+  if yaml and args.export_fixes:
     print('Writing fixes to ' + args.export_fixes + ' ...')
     try:
       merge_replacement_files(tmpdir, args.export_fixes)
     except:
       print('Error exporting fixes.\n', file=sys.stderr)
       traceback.print_exc()
       return_code=1
 

clang-tools-extra/trunk/test/clang-tidy/run-clang-tidy.cpp

+// RUN: %run_clang_tidy --help
 // RUN: rm -rf %t
 // RUN: mkdir %t
 // RUN: echo "[{\"directory\":\".\",\"command\":\"clang++ -c %/t/test.cpp\",\"file\":\"%/t/test.cpp\"}]" | sed -e 's/\\/\\\\/g' > %t/compile_commands.json
 // RUN: echo "Checks: '-*,modernize-use-auto'" > %t/.clang-tidy
 // RUN: echo "WarningsAsErrors: '*'" >> %t/.clang-tidy
 // RUN: echo "CheckOptions:" >> %t/.clang-tidy
 // RUN: echo "  - key:             modernize-use-auto.MinTypeNameLength" >> %t/.clang-tidy
 // RUN: echo "    value:           '0'" >> %t/.clang-tidy