[UptestTestChecks][NFC] Share some common command line options code

[arichardson]

Summary

Add a function common.parse_commandline_args() that adds options common
to all tools (--verbose and --update-only) and returns the parsed
commandline arguments. I plan to use the shared parsing of --verbose in a
follow-up commit to remove most of the if args.verbose: checks in the
scripts.

llvm/utils/UpdateTestChecks/common.py

 from __future__ import print_function
 import re
 import string
 import subprocess
 import sys
 import copy
 
 if sys.version_info[0] > 2:
   class string:
     expandtabs = str.expandtabs
 else:
   import string
 
 ##### Common utilities for update_*test_checks.py
 
+
+def parse_commandline_args(parser):
+  parser.add_argument('-v', '--verbose', action='store_true',
+                      help='Show verbose output')
+  parser.add_argument('-u', '--update-only', action='store_true',
+                      help='Only update test if it was already autogened')
+  return parser.parse_args()
+
 def should_add_line_to_output(input_line, prefix_set):
   # Skip any blank comment lines in the IR.
   if input_line.strip() == ';':
     return False
   # Skip any blank lines in the IR.
   #if input_line.strip() == '':
   #  return False
   # And skip any CHECK lines. We're building our own.

llvm/utils/update_analyze_test_checks.py

 
 # RegEx: this is where the magic happens.
 
 IR_FUNCTION_RE = re.compile('^\s*define\s+(?:internal\s+)?[^@]*@([\w-]+)\s*\(')
 
 def main():
   from argparse import RawTextHelpFormatter
   parser = argparse.ArgumentParser(description=__doc__, formatter_class=RawTextHelpFormatter)
-  parser.add_argument('-v', '--verbose', action='store_true',
-                      help='Show verbose output')
   parser.add_argument('--opt-binary', default='opt',
                       help='The opt binary used to generate the test case')
   parser.add_argument(
       '--function', help='The function in the test file to update')
-  parser.add_argument('-u', '--update-only', action='store_true',
-                      help='Only update test if it was already autogened')
   parser.add_argument('tests', nargs='+')
-  args = parser.parse_args()
+  args = common.parse_commandline_args(parser)
 
   script_name = os.path.basename(__file__)
   autogenerated_note = (ADVERT + 'utils/' + script_name)
 
   opt_basename = os.path.basename(args.opt_binary)
   if (opt_basename != "opt"):
     common.error('Unexpected opt name: ' + opt_basename)
     sys.exit(1)

llvm/utils/update_cc_test_checks.py

if not ret:
     common.warn('Did not find any functions using', ' '.join(json_dump_args))
   return ret
 
 
 def config():
   parser = argparse.ArgumentParser(
       description=__doc__,
       formatter_class=argparse.RawTextHelpFormatter)
-  parser.add_argument('-v', '--verbose', action='store_true')
   parser.add_argument('--llvm-bin', help='llvm $prefix/bin path')
   parser.add_argument('--clang',
                       help='"clang" executable, defaults to $llvm_bin/clang')
   parser.add_argument('--clang-args',
                       help='Space-separated extra args to clang, e.g. --clang-args=-v')
   parser.add_argument('--opt',
                       help='"opt" executable, defaults to $llvm_bin/opt')
   parser.add_argument(
       '--functions', nargs='+', help='A list of function name regexes. '
       'If specified, update CHECK lines for functions matching at least one regex')
   parser.add_argument(
       '--x86_extra_scrub', action='store_true',
       help='Use more regex for x86 matching to reduce diffs between various subtargets')
-  parser.add_argument('-u', '--update-only', action='store_true',
-                      help='Only update test if it was already autogened')
   parser.add_argument('tests', nargs='+')
-  args = parser.parse_args()
+  args = common.parse_commandline_args(parser)
   args.clang_args = shlex.split(args.clang_args or '')
 
   if args.clang is None:
     if args.llvm_bin is None:
       args.clang = 'clang'
     else:
       args.clang = os.path.join(args.llvm_bin, 'clang')
   if not distutils.spawn.find_executable(args.clang):

llvm/utils/update_llc_test_checks.py

 
 from UpdateTestChecks import asm, common
 
 ADVERT = ' NOTE: Assertions have been autogenerated by '
 
 
 def main():
   parser = argparse.ArgumentParser(description=__doc__)
-  parser.add_argument('-v', '--verbose', action='store_true',
-                      help='Show verbose output')
   parser.add_argument('--llc-binary', default='llc',
                       help='The "llc" binary to use to generate the test case')
   parser.add_argument(
       '--function', help='The function in the test file to update')
   parser.add_argument(
       '--extra_scrub', action='store_true',
       help='Always use additional regex to further reduce diffs between various subtargets')
   parser.add_argument(
       '--x86_scrub_rip', action='store_true', default=True,
       help='Use more regex for x86 matching to reduce diffs between various subtargets')
   parser.add_argument(
       '--no_x86_scrub_rip', action='store_false', dest='x86_scrub_rip')
-  parser.add_argument('-u', '--update-only', action='store_true',
-                      help='Only update test if it was already autogened')
   parser.add_argument('tests', nargs='+')
-  args = parser.parse_args()
+  args = common.parse_commandline_args(parser)
 
   script_name = os.path.basename(__file__)
 
   test_paths = [test for pattern in args.tests for test in glob.glob(pattern)]
   for test in test_paths:
     if args.verbose:
       print('Scanning for RUN lines in test file: %s' % (test,), file=sys.stderr)
     with open(test) as f:

llvm/utils/update_mca_test_checks.py

if file is None:
     file = sys.stderr
   if line is None:
     line = ''
   file.write(warnings.formatwarning(message, category, filename, lineno, line))
 
 
 def _parse_args():
   parser = argparse.ArgumentParser(description=__doc__)
-  parser.add_argument('-v', '--verbose',
-                      action='store_true',
-                      help='show verbose output')
   parser.add_argument('-w',
                       action='store_true',
                       help='suppress warnings')
   parser.add_argument('-Werror',
                       action='store_true',
                       help='promote warnings to errors')
   parser.add_argument('--llvm-mca-binary',
                       metavar='<path>',
                       default='llvm-mca',
                       help='the binary to use to generate the test case '
                            '(default: llvm-mca)')
   parser.add_argument('tests',
                       metavar='<test-path>',
                       nargs='+')
-  args = parser.parse_args()
+  args = common.parse_commandline_args(parser)
 
   _configure_warnings(args)
 
   if not args.llvm_mca_binary:
     raise Error('--llvm-mca-binary value cannot be empty string')
 
   if 'llvm-mca' not in os.path.basename(args.llvm_mca_binary):
     _warn('unexpected binary name: {}'.format(args.llvm_mca_binary))

llvm/utils/update_mir_test_checks.py

def update_test_file(args, test):
 
     with open(test, 'wb') as fd:
         fd.writelines(['{}\n'.format(l).encode('utf-8') for l in output_lines])
 
 
 def main():
     parser = argparse.ArgumentParser(
         description=__doc__, formatter_class=argparse.RawTextHelpFormatter)
-    parser.add_argument('-v', '--verbose', action='store_true',
-                        help='Show verbose output')
     parser.add_argument('--llc-binary', dest='llc', default='llc', type=LLC,
                         help='The "llc" binary to generate the test case with')
     parser.add_argument('--remove-common-prefixes', action='store_true',
                         help='Remove existing check lines whose prefixes are '
                              'shared between multiple commands')
-    parser.add_argument('-u', '--update-only', action='store_true',
-                        help='Only update test if it was already autogened')
     parser.add_argument('tests', nargs='+')
-    args = parser.parse_args()
+    args = common.parse_commandline_args(parser)
 
     test_paths = [test for pattern in args.tests for test in glob.glob(pattern)]
     for test in test_paths:
         try:
             update_test_file(args, test)
         except Exception:
             common.warn('Error processing file', test_file=test)
             raise
 
 
 if __name__ == '__main__':
   main()

llvm/utils/update_test_checks.py

 
 
 
 
 
 def main():
   from argparse import RawTextHelpFormatter
   parser = argparse.ArgumentParser(description=__doc__, formatter_class=RawTextHelpFormatter)
-  parser.add_argument('-v', '--verbose', action='store_true',
-                      help='Show verbose output')
   parser.add_argument('--opt-binary', default='opt',
                       help='The opt binary used to generate the test case')
   parser.add_argument(
       '--function', help='The function in the test file to update')
-  parser.add_argument('-u', '--update-only', action='store_true',
-                      help='Only update test if it was already autogened')
   parser.add_argument('-p', '--preserve-names', action='store_true',
                       help='Do not scrub IR names')
   parser.add_argument('--function-signature', action='store_true',
                       help='Keep function signature information around for the check line')
   parser.add_argument('tests', nargs='+')
-  args = parser.parse_args()
+  args = common.parse_commandline_args(parser)
 
   script_name = os.path.basename(__file__)
   autogenerated_note = (ADVERT + 'utils/' + script_name)
 
   opt_basename = os.path.basename(args.opt_binary)
   if not re.match(r'^opt(-\d+)?$', opt_basename):
     common.error('Unexpected opt name: ' + opt_basename)
     sys.exit(1)