tools/metrics/histograms/print_expanded_histograms.py

#!/usr/bin/env python3
# Copyright 2020 The Chromium Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Prints expanded histograms."""

import argparse
import re
import sys
import xml.dom.minidom

import extract_histograms
import histogram_paths
import histogram_configuration_model
import merge_xml


def _ConstructHistogram(doc, name, histogram_dict):
  """Constructs a histogram node based on the |histogram_dict|."""
  histogram = doc.createElement('histogram')
  # Set histogram node attributes.
  histogram.setAttribute('name', name)
  if 'enumDetails' in histogram_dict:
    histogram.setAttribute('enum', histogram_dict['enumDetails']['name'])
  elif 'units' in histogram_dict:
    histogram.setAttribute('units', histogram_dict['units'])
  if 'expires_after' in histogram_dict:
    histogram.setAttribute('expires_after', histogram_dict['expires_after'])
  # Populate owner nodes.
  for owner in histogram_dict.get('owners', []):
    owner_node = doc.createElement('owner')
    owner_node.appendChild(doc.createTextNode(owner))
    histogram.appendChild(owner_node)
  # Populate the description nodes.
  if 'description' in histogram_dict:
    description_node = doc.createElement('description')
    description_node.appendChild(
        doc.createTextNode(histogram_dict['description']))
    histogram.appendChild(description_node)
  return histogram


def main():
  """Prints expanded histograms."""
  parser = argparse.ArgumentParser(description='Print expanded histograms.')
  parser.add_argument('--pattern',
                      type=str,
                      default='.*',
                      help='The histogram regex you want to print.')
  parser.add_argument('--print-names-only',
                      action='store_true',
                      help='If set, only prints the histogram names.')
  args = parser.parse_args()

  try:
    pattern = re.compile(args.pattern)
  except re.error:
    print("Non valid regex pattern.")
    return 1

  # Extract all histograms into a dict. This is the expensive part that
  # handles expansion of suffixes and variants.
  doc = merge_xml.MergeFiles(filenames=histogram_paths.ALL_XMLS,
                             expand_owners_and_extract_components=True)
  histograms, had_errors = extract_histograms.ExtractHistogramsFromDom(doc)
  if had_errors:
    raise ValueError("Error parsing inputs.")

  # If only names are requested, print them and exit. This is much faster as
  # it skips the expensive XML construction and pretty-printing.
  if args.print_names_only:
    for name in sorted(histograms.keys()):
      if re.match(pattern, name):
        print(name)
    return 0

  # Construct a dom tree that is similar to the normal histograms.xml so that
  # we can use histogram_configuration_model to pretty print it.
  doc = xml.dom.minidom.Document()
  configuration = doc.createElement('histogram-configuration')
  histograms_node = doc.createElement('histograms')
  for name, histogram in sorted(histograms.items()):
    if re.match(pattern, name):
      histograms_node.appendChild(_ConstructHistogram(doc, name, histogram))
  configuration.appendChild(histograms_node)
  doc.appendChild(configuration)
  print(histogram_configuration_model.PrettifyTree(doc))
  return 0


if __name__ == '__main__':
  sys.exit(main())