change setA/setB labels if viewing actuals vs expectations

gm/rebaseline_server/compare_rendered_pictures.py

 #!/usr/bin/python
 
 """
 Copyright 2014 Google Inc.
 
 Use of this source code is governed by a BSD-style license that can be
 found in the LICENSE file.
 
 Compare results of two render_pictures runs.
 
@@ skipping 60 matching lines @@
 
 class RenderedPicturesComparisons(results.BaseComparisons):
   """Loads results from multiple render_pictures runs into an ImagePairSet.
   """
 
   def __init__(self,
                setA_dirs, setB_dirs,
                setA_section, setB_section,
                image_diff_db,
                image_base_gs_url=DEFAULT_IMAGE_BASE_GS_URL, diff_base_url=None,
-               setA_label='setA', setB_label='setB',
+               setA_label=None, setB_label=None,
                gs=None, truncate_results=False, prefetch_only=False,
                download_all_images=False):
     """Constructor: downloads images and generates diffs.
 
     Once the object has been created (which may take a while), you can call its
     get_packaged_results_of_type() method to quickly retrieve the results...
     unless you have set prefetch_only to True, in which case we will
     asynchronously warm up the ImageDiffDB cache but not fill in self._results.
 
     Args:
       setA_dirs: list of root directories to copy all JSON summaries from,
           and to use as setA within the comparisons. These directories may be
           gs:// URLs, special "repo:" URLs, or local filepaths.
       setB_dirs: list of root directories to copy all JSON summaries from,
           and to use as setB within the comparisons. These directories may be
           gs:// URLs, special "repo:" URLs, or local filepaths.
       setA_section: which section within setA to examine; must be one of
           ALLOWED_SECTION_NAMES
       setB_section: which section within setB to examine; must be one of
           ALLOWED_SECTION_NAMES
       image_diff_db: ImageDiffDB instance
       image_base_gs_url: "gs://" URL pointing at the Google Storage bucket/dir
           under which all render_pictures result images can
           be found; this will be used to read images for comparison within
           this code, and included in the ImagePairSet (as an HTTP URL) so its
           consumers know where to download the images from
       diff_base_url: base URL within which the client should look for diff
           images; if not specified, defaults to a "file:///" URL representation
           of image_diff_db's storage_root
-      setA_label: description to use for results in setA
-      setB_label: description to use for results in setB
+      setA_label: description to use for results in setA; if None, will be
+          set to a reasonable default
+      setB_label: description to use for results in setB; if None, will be
+          set to a reasonable default
       gs: instance of GSUtils object we can use to download summary files
       truncate_results: FOR MANUAL TESTING: if True, truncate the set of images
           we process, to speed up testing.
       prefetch_only: if True, return the new object as quickly as possible
           with empty self._results (just queue up all the files to process,
           don't wait around for them to be processed and recorded); otherwise,
           block until the results have been assembled and recorded in
           self._results.
       download_all_images: if True, download all images, even if we don't
           need them to generate diffs.  This will take much longer to complete,
           but is useful for warming up the bitmap cache on local disk.
     """
     super(RenderedPicturesComparisons, self).__init__()
     self._image_diff_db = image_diff_db
     self._image_base_gs_url = image_base_gs_url
     self._diff_base_url = (
         diff_base_url or
         url_utils.create_filepath_url(image_diff_db.storage_root))
-    self._setA_label = setA_label
-    self._setB_label = setB_label
     self._gs = gs
     self.truncate_results = truncate_results
     self._prefetch_only = prefetch_only
     self._download_all_images = download_all_images
 
+    # If we are comparing two different section types, we can use those
+    # as the default labels for setA and setB.
+    if setA_section != setB_section:
+      self._setA_label = setA_label or setA_section
+      self._setB_label = setB_label or setB_section
+    else:
+      self._setA_label = setA_label or 'setA'
+      self._setB_label = setB_label or 'setB'
+
     tempdir = tempfile.mkdtemp()
     try:
       setA_root = os.path.join(tempdir, 'setA')
       setB_root = os.path.join(tempdir, 'setB')
       for source_dir in setA_dirs:
         self._copy_dir_contents(source_dir=source_dir, dest_dir=setA_root)
       for source_dir in setB_dirs:
         self._copy_dir_contents(source_dir=source_dir, dest_dir=setB_root)
 
       time_start = int(time.time())
@@ skipping 230 matching lines @@
     """
     if gs_utils.GSUtils.is_gs_url(source_dir):
       (bucket, path) = gs_utils.GSUtils.split_gs_url(source_dir)
       self._gs.download_dir_contents(source_bucket=bucket, source_dir=path,
                                      dest_dir=dest_dir)
     elif source_dir.lower().startswith(REPO_URL_PREFIX):
       repo_dir = os.path.join(REPO_BASEPATH, source_dir[len(REPO_URL_PREFIX):])
       shutil.copytree(repo_dir, dest_dir)
     else:
       shutil.copytree(source_dir, dest_dir)