tools/telemetry/docs/pydoc/telemetry.internal.results.chart_json_output_formatter.html - chromium/src - Git at Google


 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 <html><head><title>Python: module telemetry.internal.results.chart_json_output_formatter</title>
 <meta charset="utf-8">
 </head><body bgcolor="#f0f0f8">

 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
 <tr bgcolor="#7799ee">
 <td valign=bottom>&nbsp;<br>
 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.internal.html"><font color="#ffffff">internal</font></a>.<a href="telemetry.internal.results.html"><font color="#ffffff">results</font></a>.chart_json_output_formatter</strong></big></big></font></td
 ><td align=right valign=bottom
 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/internal/results/chart_json_output_formatter.py">telemetry/internal/results/chart_json_output_formatter.py</a></font></td></tr></table>
     <p><tt>#&nbsp;Copyright&nbsp;2014&nbsp;The&nbsp;Chromium&nbsp;Authors.&nbsp;All&nbsp;rights&nbsp;reserved.<br>
 #&nbsp;Use&nbsp;of&nbsp;this&nbsp;source&nbsp;code&nbsp;is&nbsp;governed&nbsp;by&nbsp;a&nbsp;BSD-style&nbsp;license&nbsp;that&nbsp;can&nbsp;be<br>
 #&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;file.</tt></p>
 <p>
 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 <tr bgcolor="#aa55cc">
 <td colspan=3 valign=bottom>&nbsp;<br>
 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>

 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="collections.html">collections</a><br>
 <a href="itertools.html">itertools</a><br>
 </td><td width="25%" valign=top><a href="json.html">json</a><br>
 <a href="telemetry.internal.results.output_formatter.html">telemetry.internal.results.output_formatter</a><br>
 </td><td width="25%" valign=top><a href="telemetry.value.summary.html">telemetry.value.summary</a><br>
 </td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 <tr bgcolor="#ee77aa">
 <td colspan=3 valign=bottom>&nbsp;<br>
 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>

 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 <td width="100%"><dl>
 <dt><font face="helvetica, arial"><a href="telemetry.internal.results.output_formatter.html#OutputFormatter">telemetry.internal.results.output_formatter.OutputFormatter</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
 </font></dt><dd>
 <dl>
 <dt><font face="helvetica, arial"><a href="telemetry.internal.results.chart_json_output_formatter.html#ChartJsonOutputFormatter">ChartJsonOutputFormatter</a>
 </font></dt></dl>
 </dd>
 </dl>
  <p>
 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 <tr bgcolor="#ffc8d8">
 <td colspan=3 valign=bottom>&nbsp;<br>
 <font color="#000000" face="helvetica, arial"><a name="ChartJsonOutputFormatter">class <strong>ChartJsonOutputFormatter</strong></a>(<a href="telemetry.internal.results.output_formatter.html#OutputFormatter">telemetry.internal.results.output_formatter.OutputFormatter</a>)</font></td></tr>

 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
 <td colspan=2><tt>#&nbsp;TODO(eakuefner):&nbsp;Transition&nbsp;this&nbsp;to&nbsp;translate&nbsp;Telemetry&nbsp;JSON.<br>&nbsp;</tt></td></tr>
 <tr><td>&nbsp;</td>
 <td width="100%"><dl><dt>Method resolution order:</dt>
 <dd><a href="telemetry.internal.results.chart_json_output_formatter.html#ChartJsonOutputFormatter">ChartJsonOutputFormatter</a></dd>
 <dd><a href="telemetry.internal.results.output_formatter.html#OutputFormatter">telemetry.internal.results.output_formatter.OutputFormatter</a></dd>
 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
 </dl>
 <hr>
 Methods defined here:<br>
 <dl><dt><a name="ChartJsonOutputFormatter-Format"><strong>Format</strong></a>(self, page_test_results)</dt></dl>

 <dl><dt><a name="ChartJsonOutputFormatter-__init__"><strong>__init__</strong></a>(self, output_stream, benchmark_metadata)</dt></dl>

 <hr>
 Data descriptors inherited from <a href="telemetry.internal.results.output_formatter.html#OutputFormatter">telemetry.internal.results.output_formatter.OutputFormatter</a>:<br>
 <dl><dt><strong>__dict__</strong></dt>
 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
 </dl>
 <dl><dt><strong>__weakref__</strong></dt>
 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
 </dl>
 <dl><dt><strong>output_stream</strong></dt>
 </dl>
 </td></tr></table></td></tr></table><p>
 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 <tr bgcolor="#eeaa77">
 <td colspan=3 valign=bottom>&nbsp;<br>
 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>

 <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 <td width="100%"><dl><dt><a name="-ResultsAsChartDict"><strong>ResultsAsChartDict</strong></a>(benchmark_metadata, page_specific_values, summary_values)</dt><dd><tt>Produces&nbsp;a&nbsp;dict&nbsp;for&nbsp;serialization&nbsp;to&nbsp;Chart&nbsp;JSON&nbsp;format&nbsp;from&nbsp;raw&nbsp;values.<br>
 &nbsp;<br>
 Chart&nbsp;JSON&nbsp;is&nbsp;a&nbsp;transformation&nbsp;of&nbsp;the&nbsp;basic&nbsp;Telemetry&nbsp;JSON&nbsp;format&nbsp;that<br>
 removes&nbsp;the&nbsp;page&nbsp;map,&nbsp;summarizes&nbsp;the&nbsp;raw&nbsp;values,&nbsp;and&nbsp;organizes&nbsp;the&nbsp;results<br>
 by&nbsp;chart&nbsp;and&nbsp;trace&nbsp;name.&nbsp;This&nbsp;function&nbsp;takes&nbsp;the&nbsp;key&nbsp;pieces&nbsp;of&nbsp;data&nbsp;needed&nbsp;to<br>
 perform&nbsp;this&nbsp;transformation&nbsp;(namely,&nbsp;lists&nbsp;of&nbsp;values&nbsp;and&nbsp;a&nbsp;benchmark&nbsp;metadata<br>
 object)&nbsp;and&nbsp;processes&nbsp;them&nbsp;into&nbsp;a&nbsp;dict&nbsp;which&nbsp;can&nbsp;be&nbsp;serialized&nbsp;using&nbsp;the&nbsp;json<br>
 module.<br>
 &nbsp;<br>
 Design&nbsp;doc&nbsp;for&nbsp;schema:&nbsp;<a href="http://goo.gl/kOtf1Y">http://goo.gl/kOtf1Y</a><br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;page_specific_values:&nbsp;list&nbsp;of&nbsp;page-specific&nbsp;values<br>
 &nbsp;&nbsp;summary_values:&nbsp;list&nbsp;of&nbsp;summary&nbsp;values<br>
 &nbsp;&nbsp;benchmark_metadata:&nbsp;a&nbsp;benchmark.BenchmarkMetadata&nbsp;object<br>
 &nbsp;<br>
 Returns:<br>
 &nbsp;&nbsp;A&nbsp;Chart&nbsp;JSON&nbsp;dict&nbsp;corresponding&nbsp;to&nbsp;the&nbsp;given&nbsp;data.</tt></dd></dl>
 </td></tr></table>
 </body></html>

	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	<html><head><title>Python: module telemetry.internal.results.chart_json_output_formatter</title>
	<meta charset="utf-8">
	</head><body bgcolor="#f0f0f8">

	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
	<tr bgcolor="#7799ee">
	<td valign=bottom> <br>
	<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.internal.html"><font color="#ffffff">internal</font></a>.<a href="telemetry.internal.results.html"><font color="#ffffff">results</font></a>.chart_json_output_formatter</strong></big></big></font></td
	><td align=right valign=bottom
	><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/internal/results/chart_json_output_formatter.py">telemetry/internal/results/chart_json_output_formatter.py</a></font></td></tr></table>
	<p><tt># Copyright 2014 The Chromium Authors. All rights reserved.<br>
	# Use of this source code is governed by a BSD-style license that can be<br>
	# found in the LICENSE file.</tt></p>
	<p>
	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
	<tr bgcolor="#aa55cc">
	<td colspan=3 valign=bottom> <br>
	<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>

	<tr><td bgcolor="#aa55cc"><tt>      </tt></td><td> </td>
	<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="collections.html">collections</a><br>
	<a href="itertools.html">itertools</a><br>
	</td><td width="25%" valign=top><a href="json.html">json</a><br>
	<a href="telemetry.internal.results.output_formatter.html">telemetry.internal.results.output_formatter</a><br>
	</td><td width="25%" valign=top><a href="telemetry.value.summary.html">telemetry.value.summary</a><br>
	</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
	<tr bgcolor="#ee77aa">
	<td colspan=3 valign=bottom> <br>
	<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>

	<tr><td bgcolor="#ee77aa"><tt>      </tt></td><td> </td>
	<td width="100%"><dl>
	<dt><font face="helvetica, arial"><a href="telemetry.internal.results.output_formatter.html#OutputFormatter">telemetry.internal.results.output_formatter.OutputFormatter</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
	</font></dt><dd>
	<dl>
	<dt><font face="helvetica, arial"><a href="telemetry.internal.results.chart_json_output_formatter.html#ChartJsonOutputFormatter">ChartJsonOutputFormatter</a>
	</font></dt></dl>
	</dd>
	</dl>
	<p>
	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
	<tr bgcolor="#ffc8d8">
	<td colspan=3 valign=bottom> <br>
	<font color="#000000" face="helvetica, arial"><a name="ChartJsonOutputFormatter">class <strong>ChartJsonOutputFormatter</strong></a>(<a href="telemetry.internal.results.output_formatter.html#OutputFormatter">telemetry.internal.results.output_formatter.OutputFormatter</a>)</font></td></tr>

	<tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>
	<td colspan=2><tt># TODO(eakuefner): Transition this to translate Telemetry JSON.<br> </tt></td></tr>
	<tr><td> </td>
	<td width="100%"><dl><dt>Method resolution order:</dt>
	<dd><a href="telemetry.internal.results.chart_json_output_formatter.html#ChartJsonOutputFormatter">ChartJsonOutputFormatter</a></dd>
	<dd><a href="telemetry.internal.results.output_formatter.html#OutputFormatter">telemetry.internal.results.output_formatter.OutputFormatter</a></dd>
	<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
	</dl>
	<hr>
	Methods defined here:<br>
	<dl><dt><a name="ChartJsonOutputFormatter-Format"><strong>Format</strong></a>(self, page_test_results)</dt></dl>

	<dl><dt><a name="ChartJsonOutputFormatter-__init__"><strong>__init__</strong></a>(self, output_stream, benchmark_metadata)</dt></dl>

	<hr>
	Data descriptors inherited from <a href="telemetry.internal.results.output_formatter.html#OutputFormatter">telemetry.internal.results.output_formatter.OutputFormatter</a>:<br>
	<dl><dt><strong>__dict__</strong></dt>
	<dd><tt>dictionary for instance variables (if defined)</tt></dd>
	</dl>
	<dl><dt><strong>__weakref__</strong></dt>
	<dd><tt>list of weak references to the object (if defined)</tt></dd>
	</dl>
	<dl><dt><strong>output_stream</strong></dt>
	</dl>
	</td></tr></table></td></tr></table><p>
	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
	<tr bgcolor="#eeaa77">
	<td colspan=3 valign=bottom> <br>
	<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>

	<tr><td bgcolor="#eeaa77"><tt>      </tt></td><td> </td>
	<td width="100%"><dl><dt><a name="-ResultsAsChartDict"><strong>ResultsAsChartDict</strong></a>(benchmark_metadata, page_specific_values, summary_values)</dt><dd><tt>Produces a dict for serialization to Chart JSON format from raw values.<br>
	<br>
	Chart JSON is a transformation of the basic Telemetry JSON format that<br>
	removes the page map, summarizes the raw values, and organizes the results<br>
	by chart and trace name. This function takes the key pieces of data needed to<br>
	perform this transformation (namely, lists of values and a benchmark metadata<br>
	object) and processes them into a dict which can be serialized using the json<br>
	module.<br>
	<br>
	Design doc for schema: <a href="http://goo.gl/kOtf1Y">http://goo.gl/kOtf1Y</a><br>
	<br>
	Args:<br>
	page_specific_values: list of page-specific values<br>
	summary_values: list of summary values<br>
	benchmark_metadata: a benchmark.BenchmarkMetadata object<br>
	<br>
	Returns:<br>
	A Chart JSON dict corresponding to the given data.</tt></dd></dl>
	</td></tr></table>
	</body></html>