Add missing docstrings and don't copy generated payloads if only pre-generating.

autoupdate.py

 # Copyright (c) 2009-2010 The Chromium OS Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 from buildutil import BuildObject
 from xml.dom import minidom
 
 import cherrypy
 import os
 import shutil
@@ skipping 30 matching lines @@
 
   Members:
     serve_only: Serve only pre-built updates. static_dir must contain update.gz
       and stateful.tgz.
     factory_config: Path to the factory config file if handling factory
       requests.
     use_test_image: Use chromiumos_test_image.bin rather than the standard.
     static_url_base: base URL, other than devserver, for update images.
     client_prefix: The prefix for the update engine client.
     forced_image: Path to an image to use for all updates.
+    forced_payload: Path to pre-generated payload to serve.
+    port: port to host devserver
+    proxy_port: port of local proxy to tell client to connect to you through.
+    src_image: If specifies, creates a delta payload from this image.

[petkov, 2011/01/19 23:56:04]

typoe: specifies

+    vm: Set for VM images (doesn't patch kernel)
+    board: board for the image.  Needed for pre-generating of updates.
+    copy_to_static_root: Copies images generated from the cache to
+      ~/static.
   """
 
   def __init__(self, serve_only=None, test_image=False, urlbase=None,
                factory_config_path=None, client_prefix=None,
                forced_image=None, forced_payload=None,
                port=8080, proxy_port=None, src_image='', vm=False, board=None,
+               copy_to_static_root=True,
                *args, **kwargs):
     super(Autoupdate, self).__init__(*args, **kwargs)
     self.serve_only = serve_only
     self.factory_config = factory_config_path
     self.use_test_image = test_image
     if urlbase:
       self.urlbase = urlbase
     else:
       self.urlbase = None
 
     self.client_prefix = client_prefix
     self.forced_image = forced_image
     self.forced_payload = forced_payload
     self.src_image = src_image
     self.proxy_port = proxy_port
     self.vm = vm
     self.board = board
+    self.copy_to_static_root = copy_to_static_root
 
     # Track update pregeneration, so we don't recopy if not needed.
     self.pregenerated = False
 
   def _GetSecondsSinceMidnight(self):
     """Returns the seconds since midnight as a decimal value."""
     now = time.localtime()
     return now[3] * 3600 + now[4] * 60 + now[5]
 
   def _GetDefaultBoardID(self):
@@ skipping 282 matching lines @@
         os.makedirs(full_cache_dir)
 
       result = self.GenerateUpdateImage(image_path,
                                         full_cache_dir)
 
       if not result:
         # Clean up cache dir if it's not valid
         os.system("rm -rf %s" % os.path.join(static_image_dir, cache_sub_dir))
         return None
 
-    # If the generation worked, copy files
-    self._Copy(cache_update_payload, update_payload)
-    self._Copy(cache_stateful_payload, stateful_payload)
+    # Generation complete, copy if requested.
+    if self.copy_to_static_root:
+      self._Copy(cache_update_payload, update_payload)
+      self._Copy(cache_stateful_payload, stateful_payload)
 
     # Return just the filename in static_image_dir.
     return UPDATE_FILE
 
   def GenerateLatestUpdateImage(self, board_id, client_version,
                                 static_image_dir):
     """Generates an update using the latest image that has been built.
 
     This will only generate an update if the newest update is newer than that
     on the client or client_version is 'ForcedUpdate'.
@@ skipping 257 matching lines @@
         is_delta_format = self._IsDeltaFormatFile(filename)
         if label:
           url = '%s/%s/%s' % (static_urlbase, label, payload_path)
         else:
           url = '%s/%s' % (static_urlbase, payload_path)
 
         _LogMessage('Responding to client to use url %s to get image.' % url)
         return self.GetUpdatePayload(hash, sha256, size, url, is_delta_format)
       else:
         return self.GetNoUpdatePayload()