Split static data from logic.

gclient.py

 #!/usr/bin/env python
 # Copyright (c) 2011 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 118 matching lines @@
 
     def Lookup(self, var_name):
       """Implements the Var syntax."""
       if var_name in self._custom_vars:
         return self._custom_vars[var_name]
       elif var_name in self._local_scope.get("vars", {}):
         return self._local_scope["vars"][var_name]
       raise gclient_utils.Error("Var is not defined: %s" % var_name)
 
 
-class Dependency(GClientKeywords, gclient_utils.WorkItem):
+class DependencySettings(object):
+  """Immutable configuration settings."""
+  def __init__(
+      self, parent, safesync_url, managed, custom_deps, custom_vars,
+      deps_file, should_process):
+    # These are not mutable:
+    self._parent = parent
+    self._safesync_url = safesync_url
+    self._deps_file = deps_file
+    # 'managed' determines whether or not this dependency is synced/updated by
+    # gclient after gclient checks it out initially.  The difference between
+    # 'managed' and 'should_process' is that the user specifies 'managed' via
+    # the --unmanaged command-line flag or a .gclient config, where
+    # 'should_process' is dynamically set by gclient if it goes over its
+    # recursion limit and controls gclient's behavior so it does not misbehave.
+    self._managed = managed
+    self._should_process = should_process
+
+    # These are only set in .gclient and not in DEPS files.
+    self._custom_vars = custom_vars or {}
+    self._custom_deps = custom_deps or {}
+
+    if '/' in self._deps_file or '\\' in self._deps_file:
+      raise gclient_utils.Error('deps_file name must not be a path, just a '
+                                'filename. %s' % self._deps_file)
+
+  @property
+  def deps_file(self):
+    """Immutable so no need to lock."""
+    return self._deps_file
+
+  @property
+  def managed(self):
+    """Immutable so no need to lock."""
+    return self._managed
+
+  @property
+  def parent(self):
+    """Immutable so no need to lock."""
+    return self._parent
+
+  @property
+  def safesync_url(self):
+    """Immutable so no need to lock."""
+    return self._safesync_url
+
+  @property
+  def should_process(self):
+    """True if this dependency should be processed, i.e. checked out."""
+    return self._should_process
+
+  @property
+  def custom_vars(self):
+    """Immutable so no need to lock."""
+    return self._custom_vars.copy()
+
+  @property
+  def custom_deps(self):
+    """Immutable so no need to lock."""
+    return self._custom_deps.copy()
+
+
+class Dependency(GClientKeywords, gclient_utils.WorkItem, DependencySettings):
   """Object that represents a dependency checkout."""
 
   def __init__(self, parent, name, url, safesync_url, managed, custom_deps,
                custom_vars, deps_file, should_process):
     # Warning: this function can be called from any thread. Both
     # self.dependencies and self.requirements are read and modified from
     # multiple threads at the same time. Sad.
     GClientKeywords.__init__(self)
     gclient_utils.WorkItem.__init__(self, name)
-
-    # These are not mutable:
-    self._parent = parent
-    self._safesync_url = safesync_url
-    self._deps_file = deps_file
-    self._should_process = should_process
+    DependencySettings.__init__(
+        self, parent, safesync_url, managed, custom_deps, custom_vars,
+        deps_file, should_process)
 
     # This is in both .gclient and DEPS files:
     self.url = url
 
-    # These are only set in .gclient and not in DEPS files.
-    # 'managed' determines whether or not this dependency is synced/updated by
-    # gclient after gclient checks it out initially.  The difference between
-    # 'managed' and 'should_process' (defined below) is that the user specifies
-    # 'managed' via the --unmanaged command-line flag or a .gclient config,
-    # where 'should_process' is dynamically set by gclient if it goes over its
-    # recursion limit and controls gclient's behavior so it does not misbehave.
-    self._managed = managed
-    self._custom_vars = custom_vars or {}
-    self._custom_deps = custom_deps or {}
     self.deps_hooks = []
 
     # Calculates properties:
     self.parsed_url = None
     self.dependencies = []
     # A cache of the files affected by the current operation, necessary for
     # hooks.
     self._file_list = []
     # If it is not set to True, the dependency wasn't processed for its child
     # dependency, i.e. its DEPS wasn't read.
@@ skipping 14 matching lines @@
     self._FindDependencies()
 
     # Sanity checks
     if not self.name and self.parent:
       raise gclient_utils.Error('Dependency without name')
     if not isinstance(self.url,
         (basestring, self.FromImpl, self.FileImpl, None.__class__)):
       raise gclient_utils.Error('dependency url must be either a string, None, '
                                 'File() or From() instead of %s' %
                                 self.url.__class__.__name__)
-    if '/' in self.deps_file or '\\' in self.deps_file:
-      raise gclient_utils.Error('deps_file name must not be a path, just a '
-                                'filename. %s' % self.deps_file)
 
   def _FindDependencies(self):
     """Setup self.requirements and find any other dependency who would have self
     as a requirement.
     """
     # self.parent is implicitly a requirement. This will be recursive by
     # definition.
     if self.parent and self.parent.name:
       self._requirements.add(self.parent.name)
 
@@ skipping 364 matching lines @@
     """Returns a custom deps if applicable."""
     if self.parent:
       url = self.parent.get_custom_deps(name, url)
     # None is a valid return value to disable a dependency.
     return self.custom_deps.get(name, url)
 
   @property
   def recursion_limit(self):
     """Returns > 0 if this dependency is not too recursed to be processed.
 
-    Immutable so no need to lock."""
+    Immutable so no need to lock.
+    """
     return max(self.parent.recursion_limit - 1, 0)
 
   @property
-  def deps_file(self):
-    """Immutable so no need to lock."""
-    return self._deps_file
-
-  @property
-  def managed(self):
-    """Immutable so no need to lock."""
-    return self._managed
-
-  @property
-  def safesync_url(self):
-    """Immutable so no need to lock."""
-    return self._safesync_url
-
-  @property
-  def should_process(self):
-    """True if this dependency should be processed, i.e. checked out."""
-    return self._should_process
-
-  @property
-  def parent(self):
-    """Immutable so no need to lock."""
-    return self._parent
-
-  @property
-  def custom_vars(self):
-    """Immutable so no need to lock."""
-    return self._custom_vars.copy()
-
-  @property
-  def custom_deps(self):
-    """Immutable so no need to lock."""
-    return self._custom_deps.copy()
-
-  @property
   @gclient_utils.lockedmethod
   def file_list(self):
     result = self._file_list[:]
     for d in self.dependencies:
       result.extend(d.file_list)
     return tuple(result)
 
   def __str__(self):
     out = []
     for i in ('name', 'url', 'parsed_url', 'safesync_url', 'custom_deps',
@@ skipping 786 matching lines @@
   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: