Revert "Revert "Improve description layout. Improve coloring and add legend in help.""

gclient.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.
 
 """Meta checkout manager supporting both Subversion and GIT.
 
 Files
   .gclient      : Current client configuration, written by 'config' command.
                   Format is a Python script defining 'solutions', a list whose
@@ skipping 1361 matching lines @@
                           progress=not options.no_progress)
 
 
 @attr('usage', '[args ...]')
 def CMDfetch(parser, args):
   """Fetches upstream commits for all modules.
 
 Completely git-specific. Simply runs 'git fetch [args ...]' for each module.
 """
   (options, args) = parser.parse_args(args)
-  return CMDrecurse(Parser(), [
+  return CMDrecurse(OptionParser(), [
       '--jobs=%d' % options.jobs, '--scm=git', 'git', 'fetch'] + args)
 
 
 def CMDgrep(parser, args):
   """Greps through git repos managed by gclient.
 
 Runs 'git grep [args...]' for each module.
 """
 
   # We can't use optparse because it will try to parse arguments sent
@@ skipping 335 matching lines @@
   obj = Command(command)
   if command == 'help':
     command = '<command>'
   # OptParser.description prefer nicely non-formatted strings.
   parser.description = re.sub('[\r\n ]{2,}', ' ', obj.__doc__)
   usage = getattr(obj, 'usage', '')
   parser.set_usage('%%prog %s [options] %s' % (command, usage))
   parser.epilog = getattr(obj, 'epilog', None)
 
 
-def Parser():
-  """Returns the default parser."""
-  parser = optparse.OptionParser(version='%prog ' + __version__)
-  # some arm boards have issues with parallel sync.
-  if platform.machine().startswith('arm'):
-    jobs = 1
-  else:
-    jobs = max(8, gclient_utils.NumLocalCpus())
-  # cmp: 2013/06/19
-  # Temporary workaround to lower bot-load on SVN server.
-  if os.environ.get('CHROME_HEADLESS') == '1':
-    jobs = 4
+class OptionParser(optparse.OptionParser):
   gclientfile_default = os.environ.get('GCLIENT_FILE', '.gclient')
-  parser.add_option('-j', '--jobs', default=jobs, type='int',
-                    help='Specify how many SCM commands can run in parallel; '
-                          'defaults to number of cpu cores (%default)')
-  parser.add_option('-v', '--verbose', action='count', default=0,
-                    help='Produces additional output for diagnostics. Can be '
-                          'used up to three times for more logging info.')
-  parser.add_option('--gclientfile', dest='config_filename',
-                    default=None,
-                    help='Specify an alternate %s file' % gclientfile_default)
-  parser.add_option('--spec',
-                    default=None,
-                    help='create a gclient file containing the provided '
-                         'string. Due to Cygwin/Python brokenness, it '
-                         'probably can\'t contain any newlines.')
-  parser.add_option('--no-nag-max', default=False, action='store_true',
-                    help='If a subprocess runs for too long without generating'
-                         ' terminal output, generate warnings, but do not kill'
-                         ' the process.')
-  # Integrate standard options processing.
-  old_parser = parser.parse_args
-  def Parse(args):
-    (options, args) = old_parser(args)
-    level = [logging.ERROR, logging.WARNING, logging.INFO, logging.DEBUG][
-        min(options.verbose, 3)]
-    logging.basicConfig(level=level,
+
+  def __init__(self, **kwargs):
+    optparse.OptionParser.__init__(
+        self, version='%prog ' + __version__, **kwargs)
+
+    # Some arm boards have issues with parallel sync.
+    if platform.machine().startswith('arm'):
+      jobs = 1
+    else:
+      jobs = max(8, gclient_utils.NumLocalCpus())
+    # cmp: 2013/06/19
+    # Temporary workaround to lower bot-load on SVN server.
+    if os.environ.get('CHROME_HEADLESS') == '1':
+      jobs = 4
+
+    self.add_option(
+        '-j', '--jobs', default=jobs, type='int',
+        help='Specify how many SCM commands can run in parallel; defaults to '
+             'number of cpu cores (%default)')
+    self.add_option(
+        '-v', '--verbose', action='count', default=0,
+        help='Produces additional output for diagnostics. Can be used up to '
+             'three times for more logging info.')
+    self.add_option(
+        '--gclientfile', dest='config_filename',
+        help='Specify an alternate %s file' % self.gclientfile_default)
+    self.add_option(
+        '--spec',
+        help='create a gclient file containing the provided string. Due to '
+            'Cygwin/Python brokenness, it can\'t contain any newlines.')
+    self.add_option(
+        '--no-nag-max', default=False, action='store_true',
+        help='If a subprocess runs for too long without generating terminal '
+             'output, generate warnings, but do not kill the process.')
+
+  def parse_args(self, args=None, values=None):
+    """Integrates standard options processing."""
+    options, args = optparse.OptionParser.parse_args(self, args, values)
+    levels = [logging.ERROR, logging.WARNING, logging.INFO, logging.DEBUG]
+    logging.basicConfig(
+        level=levels[min(options.verbose, len(levels) - 1)],
         format='%(module)s(%(lineno)d) %(funcName)s:%(message)s')
     if options.config_filename and options.spec:
-      parser.error('Cannot specifiy both --gclientfile and --spec')
+      self.error('Cannot specifiy both --gclientfile and --spec')
     if not options.config_filename:
-      options.config_filename = gclientfile_default
+      options.config_filename = self.gclientfile_default
     options.entries_filename = options.config_filename + '_entries'
     if options.jobs < 1:
-      parser.error('--jobs must be 1 or higher')
+      self.error('--jobs must be 1 or higher')
 
     # These hacks need to die.
     if not hasattr(options, 'revisions'):
       # GClient.RunOnDeps expects it even if not applicable.
       options.revisions = []
     if not hasattr(options, 'head'):
       options.head = None
     if not hasattr(options, 'nohooks'):
       options.nohooks = True
     if not hasattr(options, 'deps_os'):
       options.deps_os = None
     if not hasattr(options, 'manually_grab_svn_rev'):
       options.manually_grab_svn_rev = None
     if not hasattr(options, 'force'):
       options.force = None
     if options.no_nag_max:
       gclient_scm.SCMWrapper.nag_max = None
     return (options, args)
-  parser.parse_args = Parse
-  # We don't want wordwrapping in epilog (usually examples)
-  parser.format_epilog = lambda _: parser.epilog or ''
-  return parser
+
+  def format_epilog(self, _):
+    """Disables wordwrapping in epilog (usually examples)."""
+    return self.epilog or ''
 
 
 def Main(argv):
   """Doesn't parse the arguments here, just find the right subcommand to
   execute."""
   if sys.hexversion < 0x02060000:
     print >> sys.stderr, (
         '\nYour python version %s is unsupported, please upgrade.\n' %
         sys.version.split(' ', 1)[0])
     return 2
@@ skipping 12 matching lines @@
     # Unused variable 'usage'
     # pylint: disable=W0612
     def to_str(fn):
       return (
           '  %s%-10s%s' % (Fore.GREEN, fn[3:], Fore.RESET) +
           ' %s' % Command(fn[3:]).__doc__.split('\n')[0].strip())
     cmds = (
         to_str(fn) for fn in dir(sys.modules[__name__]) if fn.startswith('CMD')
     )
     CMDhelp.usage = '\n\nCommands are:\n' + '\n'.join(cmds)
-    parser = Parser()
+    parser = OptionParser()
     if argv:
       command = Command(argv[0])
       if command:
         # 'fix' the usage and the description now that we know the subcommand.
         GenUsage(parser, argv[0])
         return command(parser, argv[1:])
     # Not a known command. Default to help.
     GenUsage(parser, 'help')
     return CMDhelp(parser, argv)
   except KeyboardInterrupt:
     gclient_utils.GClientChildren.KillAllRemainingChildren()
     raise
   except (gclient_utils.Error, subprocess2.CalledProcessError), e:
     print >> sys.stderr, 'Error: %s' % str(e)
     return 1
 
 
 if '__main__' == __name__:
   fix_encoding.fix_encoding()
   sys.exit(Main(sys.argv[1:]))
 
 # vim: ts=2:sw=2:tw=80:et: