Add InputApi.is_committing to be able to return a failure or notification, depending on the check.

presubmit_support.py

 #!/usr/bin/python
 # Copyright (c) 2006-2009 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.2'
+__version__ = '1.3'
 
 # TODO(joi) Add caching where appropriate/needed. The API is designed to allow
 # caching (between all different invocations of presubmit scripts for a given
 # change). We should add it as our presubmit scripts start feeling slow.
 
 import cPickle  # Exposed through the API.
 import cStringIO  # Exposed through the API.
 import exceptions
 import fnmatch
 import glob
 import marshal  # Exposed through the API.
 import optparse
 import os  # Somewhat exposed through the API.
 import pickle  # Exposed through the API.
 import re  # Exposed through the API.
 import subprocess  # Exposed through the API.
 import sys  # Parts exposed through API.
 import tempfile  # Exposed through the API.
+import traceback  # Exposed through the API.
 import types
 import unittest  # Exposed through the API.
 import urllib2  # Exposed through the API.
 import warnings
 
 # Local imports.
 # TODO(joi) Would be cleaner to factor out utils in gcl to separate module, but
 # for now it would only be a couple of functions so hardly worth it.
 import gcl
 import gclient
@@ skipping 11 matching lines @@
 def normpath(path):
   '''Version of os.path.normpath that also changes backward slashes to
   forward slashes when not running on Windows.
   '''
   # This is safe to always do because the Windows version of os.path.normpath
   # will replace forward slashes with backward slashes.
   path = path.replace(os.sep, '/')
   return os.path.normpath(path)
 
 
-def deprecated(func):
-  """This is a decorator which can be used to mark functions as deprecated.
-
-  It will result in a warning being emmitted when the function is used."""
-  def newFunc(*args, **kwargs):
-    warnings.warn("Call to deprecated function %s." % func.__name__,
-                  category=DeprecationWarning,
-                  stacklevel=2)
-    return func(*args, **kwargs)
-  newFunc.__name__ = func.__name__
-  newFunc.__doc__ = func.__doc__
-  newFunc.__dict__.update(func.__dict__)
-  return newFunc
-
-
 class OutputApi(object):
   """This class (more like a module) gets passed to presubmit scripts so that
   they can specify various types of results.
   """
 
   class PresubmitResult(object):
     """Base class for result objects."""
 
     def __init__(self, message, items=None, long_text=''):
       """
@@ skipping 60 matching lines @@
     """A warning that should be included in the review request email."""
     def __init__(self, *args, **kwargs):
       raise NotImplementedException()  # TODO(joi) Implement.
 
 
 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.
   """
 
-  def __init__(self, change, presubmit_path):
+  def __init__(self, change, presubmit_path, is_committing):
     """Builds an InputApi object.
 
     Args:
       change: A presubmit.GclChange object.
       presubmit_path: The path to the presubmit script being processed.
+      is_committing: True if the change is about to be committed.
     """
     # Version number of the presubmit_support script.
     self.version = [int(x) for x in __version__.split('.')]
     self.change = change
+    self.is_committing = is_committing
 
     # We expose various modules and functions as attributes of the input_api
     # so that presubmit scripts don't have to import them.
     self.basename = os.path.basename
     self.cPickle = cPickle
     self.cStringIO = cStringIO
     self.os_path = os.path
     self.pickle = pickle
     self.marshal = marshal
     self.re = re
     self.subprocess = subprocess
     self.tempfile = tempfile
+    self.traceback = traceback
     self.unittest = unittest
     self.urllib2 = urllib2
 
     # InputApi.platform is the platform you're currently running on.
     self.platform = sys.platform
 
     # The local path of the currently-being-processed presubmit script.
     self._current_presubmit_path = os.path.dirname(presubmit_path)
 
     # We carry the canned checks so presubmit scripts can easily use them.
@@ skipping 410 matching lines @@
     """Executes a single presubmit script.
 
     Args:
       script_text: The text of the presubmit script.
       presubmit_path: The path to the presubmit file (this will be reported via
         input_api.PresubmitLocalPath()).
 
     Return:
       A list of result objects, empty if no problems.
     """
-    input_api = InputApi(self.change, presubmit_path)
+    input_api = InputApi(self.change, presubmit_path, self.committing)
     context = {}
     exec script_text in context
 
     # 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:
@@ skipping 128 matching lines @@
   return not DoPresubmitChecks(gcl.ChangeInfo(name='temp', files=files),
                                options.commit,
                                options.verbose,
                                sys.stdout,
                                sys.stdin,
                                default_presubmit=None)
 
 
 if __name__ == '__main__':
   sys.exit(Main(sys.argv))