Readability improvement in apply_issue.

apply_issue.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.
 
 """Applies an issue from Rietveld.
 """
 import getpass
 import json
 import logging
 import optparse
 import os
 import subprocess
 import sys
 import urllib2
 
 import breakpad  # pylint: disable=W0611
 
 import annotated_gclient
 import auth
 import checkout
 import fix_encoding
 import gclient_utils
 import rietveld
 import scm
 
 BASE_DIR = os.path.dirname(os.path.abspath(__file__))
 
 
-RETURN_CODE_ARG_PARSER = 2     # default in python.
-RETURN_CODE_INFRA_FAILURE = 3  # considered as infra failure.
-RETURN_CODE_OTHERWISE = 1      # any other failure, likely patch apply one.
+RETURN_CODE_OK               = 0  # any other failure, likely patch apply one.

[Sergey Berezin, 2015/10/05 19:06:58]

drive-by nit: that's not a failure :-)

+RETURN_CODE_OTHER_FAILURE    = 1  # any other failure, likely patch apply one.
+RETURN_CODE_ARGPARSE_FAILURE = 2  # default in python.
+RETURN_CODE_INFRA_FAILURE    = 3  # considered as infra failure.
 
 
 class Unbuffered(object):
   """Disable buffering on a file object."""
   def __init__(self, stream):
     self.stream = stream
 
   def write(self, data):
     self.stream.write(data)
     self.stream.flush()
@@ skipping 128 matching lines @@
     except rietveld.upload.ClientLoginError as e:
       # Fine, we'll do proper authentication.
       pass
     if properties is None:
       rietveld_obj = rietveld.Rietveld(options.server, auth_config,
                                        options.email)
       try:
         properties = rietveld_obj.get_issue_properties(options.issue, False)
       except rietveld.upload.ClientLoginError as e:
         print('Accessing the issue requires proper credentials.')
-        return RETURN_CODE_OTHERWISE
+        return RETURN_CODE_OTHER_FAILURE
       except urllib2.URLError:
         logging.exception('failed to fetch issue properties')
         return RETURN_CODE_INFRA_FAILURE
 
   if not options.patchset:
     options.patchset = properties['patchsets'][-1]
     print('No patchset specified. Using patchset %d' % options.patchset)
 
   issues_patchsets_to_apply = [(options.issue, options.patchset)]
   try:
@@ skipping 42 matching lines @@
     try:
       patchset = rietveld_obj.get_patch(issue_to_apply, patchset_to_apply)
     except urllib2.HTTPError:
       print(
           'Failed to fetch the patch for issue %d, patchset %d.\n'
           'Try visiting %s/%d') % (
               issue_to_apply, patchset_to_apply,
               options.server, issue_to_apply)
       # If we got this far, then this is likely missing patchset.
       # Thus, it's not infra failure.
-      return RETURN_CODE_OTHERWISE
+      return RETURN_CODE_OTHER_FAILURE
     except urllib2.URLError:
       logging.exception(
           'Failed to fetch the patch for issue %d, patchset %d',
           issue_to_apply, patchset_to_apply)
       return RETURN_CODE_INFRA_FAILURE
     if options.whitelist:
       patchset.patches = [patch for patch in patchset.patches
                           if patch.filename in options.whitelist]
     if options.blacklist:
       patchset.patches = [patch for patch in patchset.patches
@@ skipping 20 matching lines @@
       #    chromium_commands.py?view=markup
       open('.buildbot-patched', 'w').close()
 
     print('\nApplying the patch from %s' % issue_url)
     try:
       scm_obj.apply_patch(patchset, verbose=True)
     except checkout.PatchApplicationFailed as e:
       print(str(e))
       print('CWD=%s' % os.getcwd())
       print('Checkout path=%s' % scm_obj.project_path)
-      return RETURN_CODE_OTHERWISE
+      return RETURN_CODE_OTHER_FAILURE
 
   if ('DEPS' in map(os.path.basename, patchset.filenames)
       and not options.ignore_deps):
     gclient_root = gclient_utils.FindGclientRoot(full_dir)
     if gclient_root and scm_type:
       print(
           'A DEPS file was updated inside a gclient checkout, running gclient '
           'sync.')
       gclient_path = os.path.join(BASE_DIR, 'gclient')
       if sys.platform == 'win32':
@@ skipping 10 matching lines @@
           cmd.extend(['--output-json', f])
 
         retcode = subprocess.call(cmd, cwd=gclient_root)
 
         if retcode == 0 and options.revision_mapping:
           revisions = annotated_gclient.parse_got_revision(
               f, options.revision_mapping)
           annotated_gclient.emit_buildprops(revisions)
 
         return retcode
-  return 0
+  return RETURN_CODE_OK
 
 
 if __name__ == "__main__":
   fix_encoding.fix_encoding()
   try:
     sys.exit(main())
   except KeyboardInterrupt:
     sys.stderr.write('interrupted\n')
-    sys.exit(RETURN_CODE_OTHERWISE)
+    sys.exit(RETURN_CODE_OTHER_FAILURE)