Add PresubmitPromptOrNotify helper.

presubmit_support.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.
 
 """Enables directory-specific presubmit checks to run at upload and/or commit.
 """
 
 __version__ = '1.6.1'
 
@@ skipping 86 matching lines @@
   def write(self, s):
     self.written_output.append(s)
     if self.output_stream:
       self.output_stream.write(s)
 
   def getvalue(self):
     return ''.join(self.written_output)
 
 
 class OutputApi(object):
-  """This class (more like a module) gets passed to presubmit scripts so that
-  they can specify various types of results.
+  """An instance of OutputApi gets passed to presubmit scripts so that they
+  can output various types of results.
   """
+  def __init__(self, is_committing):
+    self.is_committing = is_committing
+
   class PresubmitResult(object):
     """Base class for result objects."""
     fatal = False
     should_prompt = False
 
     def __init__(self, message, items=None, long_text=''):
       """
       message: A short one-line message to indicate errors.
       items: A list of short strings to indicate where errors occurred.
       long_text: multi-line text output, e.g. from another tool
@@ skipping 36 matching lines @@
     fatal = True
 
   class PresubmitPromptWarning(PresubmitResult):
     """An warning that prompts the user if they want to continue."""
     should_prompt = True
 
   class PresubmitNotifyResult(PresubmitResult):
     """Just print something to the screen -- but it's not even a warning."""
     pass
 
+  def PresubmitPromptOrNotify(self, *args, **kwargs):
+    """Warn the user when uploading, but only notify if committing."""
+    if self.is_committing:
+      return self.PresubmitNotifyResult(*args, **kwargs)
+    return self.PresubmitPromptWarning(*args, **kwargs)
+
   class MailTextResult(PresubmitResult):
     """A warning that should be included in the review request email."""
     def __init__(self, *args, **kwargs):
       super(OutputApi.MailTextResult, self).__init__()
       raise NotImplementedError()
 
 
 class InputApi(object):
   """An instance of this object is passed to presubmit scripts so they can
   know stuff about the change they're looking at.
@@ skipping 837 matching lines @@
     except Exception, e:
       raise PresubmitFailure('"%s" had an exception.\n%s' % (presubmit_path, e))
 
     # These function names must change if we make substantial changes to
     # the presubmit API that are not backwards compatible.
     if self.committing:
       function_name = 'CheckChangeOnCommit'
     else:
       function_name = 'CheckChangeOnUpload'
     if function_name in context:
-      context['__args'] = (input_api, OutputApi())
+      context['__args'] = (input_api, OutputApi(self.committing))
       logging.debug('Running %s in %s' % (function_name, presubmit_path))
       result = eval(function_name + '(*__args)', context)
       logging.debug('Running %s done.' % function_name)
       if not (isinstance(result, types.TupleType) or
               isinstance(result, types.ListType)):
         raise PresubmitFailure(
           'Presubmit functions must return a tuple or list')
       for item in result:
         if not isinstance(item, OutputApi.PresubmitResult):
           raise PresubmitFailure(
@@ skipping 256 matching lines @@
   except PresubmitFailure, e:
     print >> sys.stderr, e
     print >> sys.stderr, 'Maybe your depot_tools is out of date?'
     print >> sys.stderr, 'If all fails, contact maruel@'
     return 2
 
 
 if __name__ == '__main__':
   fix_encoding.fix_encoding()
   sys.exit(Main(None))