Starts converting GclChange to a method-less class.

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.1'
 
@@ skipping 18 matching lines @@
 import urllib2  # Exposed through the API.
 
 # 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
 import presubmit_canned_checks
 
 
-# Matches key/value (or "tag") lines in changelist descriptions.
-_tag_line_re = re.compile(
-    '^\s*(?P<key>[A-Z][A-Z_0-9]*)\s*=\s*(?P<value>.*?)\s*$')
-
-
 class NotImplementedException(Exception):
   """We're leaving placeholders in a bunch of places to remind us of the
   design of the API, but we have not implemented all of it yet. Implement as
   the need arises.
   """
   pass
 
 
 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)
 
 
-
 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 333 matching lines @@
     return self.is_directory
 
   def Property(self, property_name):
     if not property_name in self.properties:
       self.properties[property_name] = gcl.GetSVNFileProperty(
           self.AbsoluteLocalPath(), property_name)
     return self.properties[property_name]
 
 
 class GclChange(object):
-  """A gcl change. See gcl.ChangeInfo for more info."""
+  """Describe a change.
+
+  Used directly by the presubmit scripts to query the current change being
+  tested.
+  
+  Instance members:
+    tags: Dictionnary of KEY=VALUE pairs found in the change description.
+    self.KEY: equivalent to tags['KEY']
+  """
+
+  # Matches key/value (or "tag") lines in changelist descriptions.
+  _tag_line_re = re.compile(
+      '^\s*(?P<key>[A-Z][A-Z_0-9]*)\s*=\s*(?P<value>.*?)\s*$')
 
   def __init__(self, change_info, repository_root=''):
-    self.name = change_info.name
-    self.full_description = change_info.description
-    self.repository_root = repository_root
+    #  Do not keep a reference to the original change_info.
+    self._name = change_info.name
+    self._full_description = change_info.description
+    self._repository_root = repository_root
 
     # From the description text, build up a dictionary of key/value pairs
     # plus the description minus all key/value or "tag" lines.
-    self.description_without_tags = []
+    self._description_without_tags = []
     self.tags = {}
     for line in change_info.description.splitlines():
-      m = _tag_line_re.match(line)
+      m = self._tag_line_re.match(line)
       if m:
         self.tags[m.group('key')] = m.group('value')
       else:
-        self.description_without_tags.append(line)
+        self._description_without_tags.append(line)
 
     # Change back to text and remove whitespace at end.
-    self.description_without_tags = '\n'.join(self.description_without_tags)
-    self.description_without_tags = self.description_without_tags.rstrip()
+    self._description_without_tags = '\n'.join(self._description_without_tags)
+    self._description_without_tags = self._description_without_tags.rstrip()
 
-    self.affected_files = [
+    self._affected_files = [
         SvnAffectedFile(info[1], info[0].strip(), repository_root)
         for info in change_info.files
     ]
 
   def Change(self):
     """Returns the change name."""
-    return self.name
+    return self._name
 
   def DescriptionText(self):
     """Returns the user-entered changelist description, minus tags.
 
     Any line in the user-provided description starting with e.g. "FOO="
     (whitespace permitted before and around) is considered a tag line.  Such
     lines are stripped out of the description this function returns.
     """
-    return self.description_without_tags
+    return self._description_without_tags
 
   def FullDescriptionText(self):
     """Returns the complete changelist description including tags."""
-    return self.full_description
+    return self._full_description
 
   def RepositoryRoot(self):
     """Returns the repository root for this change, as an absolute path."""
-    return self.repository_root
+    return self._repository_root
 
   def __getattr__(self, attr):
     """Return keys directly as attributes on the object.
 
     You may use a friendly name (from SPECIAL_KEYS) or the actual name of
     the key.
     """
     return self.tags.get(attr)
 
   def AffectedFiles(self, include_dirs=False, include_deletes=True):
     """Returns a list of AffectedFile instances for all files in the change.
 
     Args:
       include_deletes: If false, deleted files will be filtered out.
       include_dirs: True to include directories in the list
 
     Returns:
       [AffectedFile(path, action), AffectedFile(path, action)]
     """
     if include_dirs:
-      affected = self.affected_files
+      affected = self._affected_files
     else:
-      affected = filter(lambda x: not x.IsDirectory(), self.affected_files)
+      affected = filter(lambda x: not x.IsDirectory(), self._affected_files)
 
     if include_deletes:
       return affected
     else:
       return filter(lambda x: x.Action() != 'D', affected)
 
   def AffectedTextFiles(self, include_deletes=True):
     """Return a list of the text files in a change.
 
     It's common to want to iterate over only the text files.
@@ skipping 224 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))