rebaseline_server: create ImagePairSet-- holds a number of ImagePairs to examine

gm/rebaseline_server/imagepair.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.
 
 ImagePair class (see class docstring for details)
 """
 
 import posixpath
 
 # Keys used within ImagePair dictionary representations.
-KEY_DIFFERENCE_DATA = 'differenceData'
-KEY_EXPECTATIONS_DATA = 'expectationsData'
-KEY_EXTRA_COLUMN_VALUES = 'extraColumnValues'
-KEY_IMAGE_A_URL = 'imageAUrl'
-KEY_IMAGE_B_URL = 'imageBUrl'
-KEY_IS_DIFFERENT = 'isDifferent'
+KEY__DIFFERENCE_DATA = 'differenceData'
+KEY__EXPECTATIONS_DATA = 'expectations'

[epoger, 2014/02/11 06:15:40]

I started using two underscores to delineate between "this is a dictionary key"
and "which field does it refer to" (since there are already single underscores
within the "which field" part)

[rmistry, 2014/02/12 19:23:56]

Sorry I do not follow, single underscores within which "which field" part?

[epoger, 2014/02/12 19:59:16]

I mean, so it's clear that this should be parsed as ['KEY',
'EXPECTATIONS_DATA'], not ['KEY', 'EXPECTATIONS', 'DATA'].

This is more important in imagepairset,py, where I have
KEY__IMAGESETS__BASE_URL, which should be parsed as ['KEY', 'IMAGESETS',
'BASE_URL']   (BASE_URL key within IMAGESETS dict)

[rmistry, 2014/02/13 12:10:02]

Thanks for the explanation.

+KEY__EXTRA_COLUMN_VALUES = 'extraColumns'
+KEY__IMAGE_A_URL = 'imageAUrl'
+KEY__IMAGE_B_URL = 'imageBUrl'
+KEY__IS_DIFFERENT = 'isDifferent'
 
 
 class ImagePair(object):
   """
   Describes a pair of images, along with optional metadata (pixel difference
   metrics, whether to ignore mismatches, etc.)
   """
 
   def __init__(self, image_diff_db,
                base_url, imageA_relative_url, imageB_relative_url,
@@ skipping 27 matching lines @@
           expected_image_url=posixpath.join(base_url, imageA_relative_url),
           actual_image_locator=imageB_relative_url,
           actual_image_url=posixpath.join(base_url, imageB_relative_url))
       self.diff_record = image_diff_db.get_diff_record(
           expected_image_locator=imageA_relative_url,
           actual_image_locator=imageB_relative_url)
 
   def as_dict(self):
     """
     Return a dictionary describing this ImagePair, as needed when constructing
-    the JSON representation.  Uses the KEY_* constants as keys.
+    the JSON representation.  Uses the KEY__* constants as keys.
     """
     asdict = {
-        KEY_IMAGE_A_URL: self.imageA_relative_url,
-        KEY_IMAGE_B_URL: self.imageB_relative_url,
+        KEY__IMAGE_A_URL: self.imageA_relative_url,
+        KEY__IMAGE_B_URL: self.imageB_relative_url,
     }
     if self.expectations_dict:
-      asdict[KEY_EXPECTATIONS_DATA] = self.expectations_dict
+      asdict[KEY__EXPECTATIONS_DATA] = self.expectations_dict
     if self.extra_columns_dict:
-      asdict[KEY_EXTRA_COLUMN_VALUES] = self.extra_columns_dict
+      asdict[KEY__EXTRA_COLUMN_VALUES] = self.extra_columns_dict
     if self.diff_record and (self.diff_record.get_num_pixels_differing() > 0):
-      asdict[KEY_IS_DIFFERENT] = True
-      asdict[KEY_DIFFERENCE_DATA] = self.diff_record.as_dict()
+      asdict[KEY__IS_DIFFERENT] = True
+      asdict[KEY__DIFFERENCE_DATA] = self.diff_record.as_dict()
     else:
-      asdict[KEY_IS_DIFFERENT] = False
+      asdict[KEY__IS_DIFFERENT] = False
     return asdict