Readdress use_counter_feature_enum issue

tools/metrics/histograms/update_histogram_enum.py

 # Copyright 2014 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.
 
 """Updates enums in histograms.xml file with values read from provided C++ enum.
 
 If the file was pretty-printed, the updated version is pretty-printed too.
 """
 
 import logging
@@ skipping 15 matching lines @@
 
 class UserError(Exception):
   def __init__(self, message):
     Exception.__init__(self, message)
 
   @property
   def message(self):
     return self.args[0]
 
 
+class DuplicatedValue(Exception):
+  """Exception raised for duplicated enum values.
+
+  Attributes:
+      first_label: First enum label that shares the duplicated enum value.
+      second_label: Second enum label that shares the duplicated enum value.
+  """
+  def __init__(self, first_label, second_label):
+    self.first_label = first_label
+    self.second_label = second_label
+
+
 def Log(message):
   logging.info(message)
 
 
 def ReadHistogramValues(filename, start_marker, end_marker, strip_k_prefix):
-  """Returns a dictionary of enum values and a pair of labels that have the same
-     enum values, read from a C++ file.
+  """Creates a dictionary of enum values, read from a C++ file.
 
   Args:
-      filename: The unix-style path (relative to src/) of the file to open.
+      filename: The unix-style (relative to src/) of the file to open.
       start_marker: A regex that signifies the start of the enum values.
       end_marker: A regex that signifies the end of the enum values.
       strip_k_prefix: Set to True if enum values are declared as kFoo and the
           'k' should be stripped.
   """

[Ilya Sherman, 2017/04/27 22:23:15]

Why did you remove the Returns and Raises documentation here?

[lunalu1, 2017/04/28 00:31:32]

Sorry I must have missed it after reverting this file.
I did a revert for the indentation.

Done. 

   # Read the file as a list of lines
   with open(path_util.GetInputFile(filename)) as f:
     content = f.readlines()
 
   START_REGEX = re.compile(start_marker)
   ITEM_REGEX = re.compile(r'^(\w+)')
   ITEM_REGEX_WITH_INIT = re.compile(r'(\w+)\s*=\s*(\d*)')
   WRAPPED_INIT = re.compile(r'(\d+)')
   END_REGEX = re.compile(end_marker)
 
@@ skipping 21 matching lines @@
         next_line = next(iterator).strip()
         enum_value = int(WRAPPED_INIT.match(next_line).group(1))
     else:
       m = ITEM_REGEX.match(line)
       if m:
         label = m.group(1)
       else:
         continue
     # If two enum labels have the same value
     if enum_value in result:
-      return result, (result[enum_value], label)
+      raise DuplicatedValue(result[enum_value], label)
     if strip_k_prefix:
       assert label.startswith('k'), "Enum " + label + " should start with 'k'."
       label = label[1:]
     result[enum_value] = label
     enum_value += 1
-  return result, None
+  return result
 
 
 def CreateEnumItemNode(document, value, label):
   """Creates an int element to append to an enum."""
   item_node = document.createElement('int')
   item_node.attributes['value'] = str(value)
   item_node.attributes['label'] = label
   return item_node
 
 
@@ skipping 67 matching lines @@
   UpdateHistogramDefinitions(histogram_enum_name, source_enum_values,
                              source_enum_path, histograms_doc)
 
   new_xml = print_style.GetPrintStyle().PrettyPrintNode(histograms_doc)
   return (xml, new_xml)
 
 
 def HistogramNeedsUpdate(histogram_enum_name, source_enum_path, start_marker,
                          end_marker, strip_k_prefix = False):
   """Reads a C++ enum from a .h file and does a dry run of updating
-  histograms.xml to match. Returns true if the histograms.xml file would be
-  changed.
+  histograms.xml to match.
 
   Args:
       histogram_enum_name: The name of the XML <enum> attribute to update.
       source_enum_path: A unix-style path, relative to src/, giving
           the C++ header file from which to read the enum.
       start_marker: A regular expression that matches the start of the C++ enum.
       end_marker: A regular expression that matches the end of the C++ enum.
       strip_k_prefix: Set to True if enum values are declared as kFoo and the
           'k' should be stripped.
+
+  Returns:
+      A boolean indicating wheather the histograms.xml file would be changed.
+
+  Raises:
+      DuplicatedValue: An error when two enum labels share the same value.
   """
   Log('Reading histogram enum definition from "{0}".'.format(source_enum_path))
   source_enum_values, duplicated_values = ReadHistogramValues(
       source_enum_path, start_marker, end_marker, strip_k_prefix)

[Ilya Sherman, 2017/04/27 22:23:15]

ReadHistogramValues now only returns the source_enum_values, and does not have a
second duplicated_values return value.  Right?  Please update this code.  (Also,
I already mentioned this in a previous comment.  Please reply 'Done' to
addressed comments, so that it is easier to keep track of what has been
addressed and what hasn't.)

[lunalu1, 2017/04/28 00:31:32]

Done. 

   if duplicated_values:
-    return False, duplicated_values
+    return False
 
   (xml, new_xml) = _GetOldAndUpdatedXml(histogram_enum_name, source_enum_values,
                                         source_enum_path)
-  return xml != new_xml, None
+  return xml != new_xml
 
 
 def UpdateHistogramFromDict(histogram_enum_name, source_enum_values,
                             source_enum_path):
   """Updates |histogram_enum_name| enum in histograms.xml file with values
   from the {value: 'key'} dictionary |source_enum_values|. A comment is added
   to histograms.xml citing that the values in |histogram_enum_name| were
   sourced from |source_enum_path|.
   """
   (xml, new_xml) = _GetOldAndUpdatedXml(histogram_enum_name, source_enum_values,
@@ skipping 22 matching lines @@
       strip_k_prefix: Set to True if enum values are declared as kFoo and the
           'k' should be stripped.
   """
 
   Log('Reading histogram enum definition from "{0}".'.format(source_enum_path))
   source_enum_values, ignored = ReadHistogramValues(source_enum_path,
       start_marker, end_marker, strip_k_prefix)
 
   UpdateHistogramFromDict(histogram_enum_name, source_enum_values,
       source_enum_path)