| #!/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. |
| |
| ImagePairSet class; see its docstring below. |
| """ |
| |
| # System-level imports |
| import posixpath |
| |
| # Local imports |
| import column |
| import imagepair |
| |
| # Keys used within dictionary representation of ImagePairSet. |
| # NOTE: Keep these in sync with static/constants.js |
| KEY__ROOT__EXTRACOLUMNHEADERS = 'extraColumnHeaders' |
| KEY__ROOT__HEADER = 'header' |
| KEY__ROOT__IMAGEPAIRS = 'imagePairs' |
| KEY__ROOT__IMAGESETS = 'imageSets' |
| KEY__IMAGESETS__FIELD__BASE_URL = 'baseUrl' |
| KEY__IMAGESETS__FIELD__DESCRIPTION = 'description' |
| KEY__IMAGESETS__SET__DIFFS = 'diffs' |
| KEY__IMAGESETS__SET__IMAGE_A = 'imageA' |
| KEY__IMAGESETS__SET__IMAGE_B = 'imageB' |
| KEY__IMAGESETS__SET__WHITEDIFFS = 'whiteDiffs' |
| |
| DEFAULT_DESCRIPTIONS = ('setA', 'setB') |
| |
| |
| class ImagePairSet(object): |
| """A collection of ImagePairs, representing two arbitrary sets of images. |
| |
| These could be: |
| - images generated before and after a code patch |
| - expected and actual images for some tests |
| - or any other pairwise set of images. |
| """ |
| |
| def __init__(self, diff_base_url, descriptions=None): |
| """ |
| Args: |
| diff_base_url: base URL indicating where diff images can be loaded from |
| descriptions: a (string, string) tuple describing the two image sets. |
| If not specified, DEFAULT_DESCRIPTIONS will be used. |
| """ |
| self._column_header_factories = {} |
| self._descriptions = descriptions or DEFAULT_DESCRIPTIONS |
| self._extra_column_tallies = {} # maps column_id -> values |
| # -> instances_per_value |
| self._image_pair_dicts = [] |
| self._image_base_url = None |
| self._diff_base_url = diff_base_url |
| |
| def add_image_pair(self, image_pair): |
| """Adds an ImagePair; this may be repeated any number of times.""" |
| # Special handling when we add the first ImagePair... |
| if not self._image_pair_dicts: |
| self._image_base_url = image_pair.base_url |
| |
| if image_pair.base_url != self._image_base_url: |
| raise Exception('added ImagePair with base_url "%s" instead of "%s"' % ( |
| image_pair.base_url, self._image_base_url)) |
| self._image_pair_dicts.append(image_pair.as_dict()) |
| extra_columns_dict = image_pair.extra_columns_dict |
| if extra_columns_dict: |
| for column_id, value in extra_columns_dict.iteritems(): |
| self._add_extra_column_value_to_summary(column_id, value) |
| |
| def set_column_header_factory(self, column_id, column_header_factory): |
| """Overrides the default settings for one of the extraColumn headers. |
| |
| Args: |
| column_id: string; unique ID of this column (must match a key within |
| an ImagePair's extra_columns dictionary) |
| column_header_factory: a ColumnHeaderFactory object |
| """ |
| self._column_header_factories[column_id] = column_header_factory |
| |
| def get_column_header_factory(self, column_id): |
| """Returns the ColumnHeaderFactory object for a particular extraColumn. |
| |
| Args: |
| column_id: string; unique ID of this column (must match a key within |
| an ImagePair's extra_columns dictionary) |
| """ |
| column_header_factory = self._column_header_factories.get(column_id, None) |
| if not column_header_factory: |
| column_header_factory = column.ColumnHeaderFactory(header_text=column_id) |
| self._column_header_factories[column_id] = column_header_factory |
| return column_header_factory |
| |
| def ensure_extra_column_values_in_summary(self, column_id, values): |
| """Ensure this column_id/value pair is part of the extraColumns summary. |
| |
| Args: |
| column_id: string; unique ID of this column |
| value: string; a possible value for this column |
| """ |
| for value in values: |
| self._add_extra_column_value_to_summary( |
| column_id=column_id, value=value, addend=0) |
| |
| def _add_extra_column_value_to_summary(self, column_id, value, addend=1): |
| """Records one column_id/value extraColumns pair found within an ImagePair. |
| |
| We use this information to generate tallies within the column header |
| (how many instances we saw of a particular value, within a particular |
| extraColumn). |
| |
| Args: |
| column_id: string; unique ID of this column (must match a key within |
| an ImagePair's extra_columns dictionary) |
| value: string; a possible value for this column |
| addend: integer; how many instances to add to the tally |
| """ |
| known_values_for_column = self._extra_column_tallies.get(column_id, None) |
| if not known_values_for_column: |
| known_values_for_column = {} |
| self._extra_column_tallies[column_id] = known_values_for_column |
| instances_of_this_value = known_values_for_column.get(value, 0) |
| instances_of_this_value += addend |
| known_values_for_column[value] = instances_of_this_value |
| |
| def _column_headers_as_dict(self): |
| """Returns all column headers as a dictionary.""" |
| asdict = {} |
| for column_id, values_for_column in self._extra_column_tallies.iteritems(): |
| column_header_factory = self.get_column_header_factory(column_id) |
| asdict[column_id] = column_header_factory.create_as_dict( |
| values_for_column) |
| return asdict |
| |
| def as_dict(self): |
| """Returns a dictionary describing this package of ImagePairs. |
| |
| Uses the KEY__* constants as keys. |
| """ |
| key_description = KEY__IMAGESETS__FIELD__DESCRIPTION |
| key_base_url = KEY__IMAGESETS__FIELD__BASE_URL |
| return { |
| KEY__ROOT__EXTRACOLUMNHEADERS: self._column_headers_as_dict(), |
| KEY__ROOT__IMAGEPAIRS: self._image_pair_dicts, |
| KEY__ROOT__IMAGESETS: { |
| KEY__IMAGESETS__SET__IMAGE_A: { |
| key_description: self._descriptions[0], |
| key_base_url: self._image_base_url, |
| }, |
| KEY__IMAGESETS__SET__IMAGE_B: { |
| key_description: self._descriptions[1], |
| key_base_url: self._image_base_url, |
| }, |
| KEY__IMAGESETS__SET__DIFFS: { |
| key_description: 'color difference per channel', |
| key_base_url: posixpath.join( |
| self._diff_base_url, 'diffs'), |
| }, |
| KEY__IMAGESETS__SET__WHITEDIFFS: { |
| key_description: 'differing pixels in white', |
| key_base_url: posixpath.join( |
| self._diff_base_url, 'whitediffs'), |
| }, |
| }, |
| } |
