[NaCl SDK] Convert python scripts from optparse to argparse.

native_client_sdk/src/tools/create_nmf.py

 #!/usr/bin/env python
 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Tool for automatically creating .nmf files from .nexe/.pexe/.bc executables.
 
 As well as creating the nmf file this tool can also find and stage
 any shared libraries dependencies that the executables might have.
 """
 
 import errno
 import json
-import optparse
+import argparse

[binji, 2014/11/13 23:57:03]

sort

[Sam Clegg, 2014/11/30 17:55:12]

Done.

 import os
 import posixpath
 import shutil
 import sys
 
 import getos
 
 if sys.version_info < (2, 6, 0):
   sys.stderr.write("python 2.6 or later is required run this script\n")
   sys.exit(1)
@@ skipping 126 matching lines @@
     path: Full path to this file on the build system
     arch: Architecture of this file (e.g., x86-32)
     url: Relative path to file in the staged web directory.
         Used for specifying the "url" attribute in the nmf file."""
 
   def __init__(self, name, path, url=None, arch=None):
     self.name = name
     self.path = path
     self.url = url
     self.arch = arch
-    if not arch:
+    if arch is None:
       self.arch = ParseElfHeader(path)[0]
 
   def __repr__(self):
     return '<ArchFile %s>' % self.path
 
   def __str__(self):
     """Return the file path when invoked with the str() function"""
     return self.path
 
 
@@ skipping 223 matching lines @@
           name = MAIN_NEXE
 
       name = self.remap.get(name, name)
       fileinfo = manifest[FILES_KEY].get(name, {})
       fileinfo[archinfo.arch] = urlinfo
       manifest[FILES_KEY][name] = fileinfo
     self.manifest = manifest
 
   def GetManifest(self):
     """Returns a JSON-formatted dict containing the NaCl dependencies"""
-    if not self.manifest:
+    if self.manifest is None:
       if self.pnacl:
         self._GeneratePNaClManifest()
       else:
         self._GenerateManifest()
     return self.manifest
 
   def GetJson(self):
     """Returns the Manifest as a JSON-formatted string"""
     pretty_string = json.dumps(self.GetManifest(), indent=2)
     # json.dumps sometimes returns trailing whitespace and does not put
@@ skipping 42 matching lines @@
         seen_error = True
       else:
         canonicalized.append([unquoted[0], unquoted[2], unquoted[4]])
     else:
       err.write('Bad key:arch:url tuple for --extra-files: ' + kv + '\n')
   if seen_error:
     return None
   return canonicalized
 
 
+def IsValidSDKRoot(directory):
+  if not os.path.exists(os.path.join(directory, 'toolchain')):

[binji, 2014/11/13 23:57:03]

just 

    return os.path.exists(...)

?

[Sam Clegg, 2014/11/30 17:55:12]

Split into seperate CL

+    return False
+
+  return True
+
+
 def GetSDKRoot():
   """Determine current NACL_SDK_ROOT, either via the environment variable
   itself, or by attempting to derive it from the location of this script.
   """
   sdk_root = os.environ.get('NACL_SDK_ROOT')
-  if not sdk_root:
-    sdk_root = os.path.dirname(SCRIPT_DIR)
-    if not os.path.exists(os.path.join(sdk_root, 'toolchain')):
-      return None
+  if sdk_root:

[binji, 2014/11/13 23:57:03]

Is this change necessary?

[Sam Clegg, 2014/11/30 17:55:12]

Separate CL

+    if not IsValidSDKRoot(sdk_root):
+      raise Error('Invalid NACL_SDK_ROOT: %s' % sdk_root)
+    return sdk_root
 
-  return sdk_root
+  # If no $NACL_SDK_ROOT set then use the current script location to
+  # attempt to drive the root.

[binji, 2014/11/13 23:57:03]

sp: derive

[Sam Clegg, 2014/11/30 17:55:12]

Separate CL

+  sdk_root = os.path.dirname(SCRIPT_DIR)
+  if IsValidSDKRoot(sdk_root):
+    return sdk_root
+
+  return None
 
 
 def FindObjdumpExecutable():
   """Derive path to objdump executable to use for determining shared
   object dependencies.
   """
   sdk_root = GetSDKRoot()
-  if not sdk_root:
+  if sdk_root is None:
     return None
 
   osname = getos.GetPlatform()
   toolchain = os.path.join(sdk_root, 'toolchain', '%s_x86_glibc' % osname)
   objdump = os.path.join(toolchain, 'bin', 'x86_64-nacl-objdump')
   if osname == 'win':
     objdump += '.exe'
 
   if not os.path.exists(objdump):
     sys.stderr.write('WARNING: failed to find objdump in default '
                      'location: %s' % objdump)
     return None
 
   return objdump
 
 
 def GetDefaultLibPath(config):
   """Derive default library path to use when searching for shared
   objects.  This currently include the toolchain library folders
   as well as the top level SDK lib folder and the naclports lib
   folder.  We include both 32-bit and 64-bit library paths.
   """
   assert(config in ('Debug', 'Release'))
   sdk_root = GetSDKRoot()
-  if not sdk_root:
+  if sdk_root is None:
     # TOOD(sbc): output a warning here?  We would also need to suppress
     # the warning when run from the chromium build.
     return []
 
   osname = getos.GetPlatform()
   libpath = [
     # Core toolchain libraries
     'toolchain/%s_x86_glibc/x86_64-nacl/lib' % osname,
     'toolchain/%s_x86_glibc/x86_64-nacl/lib32' % osname,
     # naclports installed libraries
@@ skipping 13 matching lines @@
       '%s/arm-nacl/lib' % bionic_dir,
       '%s/arm-nacl/usr/lib' % bionic_dir,
       'lib/bionic_arm/%s' % config,
     ]
   libpath = [os.path.normpath(p) for p in libpath]
   libpath = [os.path.join(sdk_root, p) for p in libpath]
   return libpath
 
 
 def main(argv):
-  parser = optparse.OptionParser(
-      usage='Usage: %prog [options] nexe [extra_libs...]', description=__doc__)
-  parser.add_option('-o', '--output', dest='output',
-                    help='Write manifest file to FILE (default is stdout)',
-                    metavar='FILE')
-  parser.add_option('-D', '--objdump', dest='objdump',
-                    help='Override the default "objdump" tool used to find '
-                         'shared object dependencies',
-                    metavar='TOOL')
-  parser.add_option('--no-default-libpath', action='store_true',
-                    help="Don't include the SDK default library paths")
-  parser.add_option('--debug-libs', action='store_true',
-                    help='Use debug library paths when constructing default '
-                         'library path.')
-  parser.add_option('-L', '--library-path', dest='lib_path',
-                    action='append', default=[],
-                    help='Add DIRECTORY to library search path',
-                    metavar='DIRECTORY')
-  parser.add_option('-P', '--path-prefix', dest='path_prefix', default='',
-                    help='Deprecated. An alias for --lib-prefix.',
-                    metavar='DIRECTORY')
-  parser.add_option('-p', '--lib-prefix', dest='lib_prefix', default='',
-                    help='A path to prepend to shared libraries in the .nmf',
-                    metavar='DIRECTORY')
-  parser.add_option('-N', '--nexe-prefix', dest='nexe_prefix', default='',
-                    help='A path to prepend to nexes in the .nmf',
-                    metavar='DIRECTORY')
-  parser.add_option('-s', '--stage-dependencies', dest='stage_dependencies',
-                    help='Destination directory for staging libraries',
-                    metavar='DIRECTORY')
-  parser.add_option('--no-arch-prefix', action='store_true',
-                    help='Don\'t put shared libraries in the lib32/lib64 '
-                    'directories. Instead, they will be put in the same '
-                    'directory as the .nexe that matches its architecture.')
-  parser.add_option('-t', '--toolchain', help='Legacy option, do not use')
-  parser.add_option('-n', '--name', dest='name',
-                    help='Rename FOO as BAR',
-                    action='append', default=[], metavar='FOO,BAR')
-  parser.add_option('-x', '--extra-files',
-                    help=('Add extra key:file tuple to the "files"' +
-                          ' section of the .nmf'),
-                    action='append', default=[], metavar='FILE')
-  parser.add_option('-O', '--pnacl-optlevel',
-                    help='Set the optimization level to N in PNaCl manifests',
-                    metavar='N')
-  parser.add_option('--pnacl-debug-optlevel',
-                    help='Set the optimization level to N for debugging '
-                         'sections in PNaCl manifests',
-                    metavar='N')
-  parser.add_option('-v', '--verbose',
-                    help='Verbose output', action='store_true')
-  parser.add_option('-d', '--debug-mode',
-                    help='Debug mode', action='store_true')
+  parser = argparse.ArgumentParser(description=__doc__)
+  parser.add_argument('-o', '--output', dest='output',
+                      help='Write manifest file to FILE (default is stdout)',
+                      metavar='FILE')
+  parser.add_argument('-D', '--objdump', dest='objdump',
+                      help='Override the default "objdump" tool used to find '
+                           'shared object dependencies',
+                      metavar='TOOL')
+  parser.add_argument('--no-default-libpath', action='store_true',
+                      help="Don't include the SDK default library paths")
+  parser.add_argument('--debug-libs', action='store_true',
+                      help='Use debug library paths when constructing default '
+                           'library path.')
+  parser.add_argument('-L', '--library-path', dest='lib_path',
+                      action='append', default=[],
+                      help='Add DIRECTORY to library search path',
+                      metavar='DIRECTORY')
+  parser.add_argument('-P', '--path-prefix', dest='path_prefix', default='',
+                      help='Deprecated. An alias for --lib-prefix.',
+                      metavar='DIRECTORY')
+  parser.add_argument('-p', '--lib-prefix', dest='lib_prefix', default='',
+                      help='A path to prepend to shared libraries in the .nmf',
+                      metavar='DIRECTORY')
+  parser.add_argument('-N', '--nexe-prefix', dest='nexe_prefix', default='',
+                      help='A path to prepend to nexes in the .nmf',
+                      metavar='DIRECTORY')
+  parser.add_argument('-s', '--stage-dependencies', dest='stage_dependencies',
+                      help='Destination directory for staging libraries',
+                      metavar='DIRECTORY')
+  parser.add_argument('--no-arch-prefix', action='store_true',
+                      help='Don\'t put shared libraries in the lib32/lib64 '
+                      'directories. Instead, they will be put in the same '
+                      'directory as the .nexe that matches its architecture.')
+  parser.add_argument('-t', '--toolchain', help='Legacy option, do not use')
+  parser.add_argument('-n', '--name', dest='name',
+                      help='Rename FOO as BAR',
+                      action='append', default=[], metavar='FOO,BAR')
+  parser.add_argument('-x', '--extra-files',
+                      help=('Add extra key:file tuple to the "files"' +
+                            ' section of the .nmf'),
+                      action='append', default=[], metavar='FILE')
+  parser.add_argument('-O', '--pnacl-optlevel',
+                      help='Set the optimization level to N in PNaCl manifests',
+                      metavar='N')
+  parser.add_argument('--pnacl-debug-optlevel',
+                      help='Set the optimization level to N for debugging '
+                           'sections in PNaCl manifests',
+                      metavar='N')
+  parser.add_argument('-v', '--verbose',
+                      help='Verbose output', action='store_true')
+  parser.add_argument('-d', '--debug-mode',
+                      help='Debug mode', action='store_true')
+  parser.add_argument('executables', nargs='+')
 
   # To enable bash completion for this command first install optcomplete
   # and then add this line to your .bashrc:
   #  complete -F _optcomplete create_nmf.py
   try:
     import optcomplete
     optcomplete.autocomplete(parser)
   except ImportError:
     pass
 
-  options, args = parser.parse_args(argv)
+  options = parser.parse_args(argv)
   if options.verbose:
     Trace.verbose = True
   if options.debug_mode:
     DebugPrint.debug_mode = True
 
   if options.toolchain is not None:
     sys.stderr.write('warning: option -t/--toolchain is deprecated.\n')
 
-  if len(args) < 1:
-    parser.error('No nexe files specified.  See --help for more info')
-
   canonicalized = ParseExtraFiles(options.extra_files, sys.stderr)
   if canonicalized is None:
     parser.error('Bad --extra-files (-x) argument syntax')
 
   remap = {}
   for ren in options.name:
     parts = ren.split(',')
     if len(parts) != 2:
       parser.error('Expecting --name=<orig_arch.so>,<new_name.so>')
     remap[parts[0]] = parts[1]
@@ skipping 24 matching lines @@
   if options.pnacl_debug_optlevel is not None:
     pnacl_debug_optlevel = int(options.pnacl_debug_optlevel)
   else:
     pnacl_debug_optlevel = pnacl_optlevel
 
   nmf_root = None
   if options.output:
     nmf_root = os.path.dirname(options.output)
 
   nmf = NmfUtils(objdump=options.objdump,
-                 main_files=args,
+                 main_files=options.executables,
                  lib_path=options.lib_path,
                  extra_files=canonicalized,
                  lib_prefix=options.lib_prefix,
                  nexe_prefix=options.nexe_prefix,
                  no_arch_prefix=options.no_arch_prefix,
                  remap=remap,
                  pnacl_optlevel=pnacl_optlevel,
                  pnacl_debug_optlevel=pnacl_debug_optlevel,
                  nmf_root=nmf_root)
 
-  if not options.output:
+  if options.output is None:
     sys.stdout.write(nmf.GetJson())
   else:
     with open(options.output, 'w') as output:
       output.write(nmf.GetJson())
 
   if options.stage_dependencies and not nmf.pnacl:
     Trace('Staging dependencies...')
     nmf.StageDependencies(options.stage_dependencies)
 
   return 0
 
 
 if __name__ == '__main__':
   try:
     rtn = main(sys.argv[1:])
   except Error, e:
     sys.stderr.write('%s: %s\n' % (os.path.basename(__file__), e))
     rtn = 1
   except KeyboardInterrupt:
     sys.stderr.write('%s: interrupted\n' % os.path.basename(__file__))
     rtn = 1
   sys.exit(rtn)