shaka-packager/tools/telemetry/docs/telemetry.page.page_measure...


<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module telemetry.page.page_measurement_results</title>
</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.page.html"><font color="#ffffff">page</font></a>.page_measurement_results</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/page/page_measurement_results.py">telemetry/page/page_measurement_results.py</a></font></td></tr></table>
    <p><tt>#&nbsp;Copyright&nbsp;(c)&nbsp;2012&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="telemetry.page.page_measurement_value.html">telemetry.page.page_measurement_value</a><br>
</td><td width="25%" valign=top><a href="telemetry.page.page_test_results.html">telemetry.page.page_test_results</a><br>
</td><td width="25%" valign=top></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="__builtin__.html#object">__builtin__.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="telemetry.page.page_measurement_results.html#ValuesForSinglePage">ValuesForSinglePage</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a>(<a href="unittest.result.html#TestResult">unittest.result.TestResult</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">PageMeasurementResults</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="PageMeasurementResults">class <strong>PageMeasurementResults</strong></a>(<a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a>)</font></td></tr>

<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">PageMeasurementResults</a></dd>
<dd><a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a></dd>
<dd><a href="unittest.result.html#TestResult">unittest.result.TestResult</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="PageMeasurementResults-Add"><strong>Add</strong></a>(self, trace_name, units, value, chart_name<font color="#909090">=None</font>, data_type<font color="#909090">='default'</font>)</dt></dl>

<dl><dt><a name="PageMeasurementResults-AddSummary"><strong>AddSummary</strong></a>(self, trace_name, units, value, chart_name<font color="#909090">=None</font>, data_type<font color="#909090">='default'</font>)</dt></dl>

<dl><dt><a name="PageMeasurementResults-DidMeasurePage"><strong>DidMeasurePage</strong></a>(self)</dt></dl>

<dl><dt><a name="PageMeasurementResults-WillMeasurePage"><strong>WillMeasurePage</strong></a>(self, page)</dt></dl>

<dl><dt><a name="PageMeasurementResults-__getitem__"><strong>__getitem__</strong></a>(self, i)</dt><dd><tt>Shorthand&nbsp;for&nbsp;self.<strong>page_results</strong>[i]</tt></dd></dl>

<dl><dt><a name="PageMeasurementResults-__init__"><strong>__init__</strong></a>(self, trace_tag<font color="#909090">=''</font>)</dt></dl>

<dl><dt><a name="PageMeasurementResults-__len__"><strong>__len__</strong></a>(self)</dt></dl>

<hr>
Data descriptors defined here:<br>
<dl><dt><strong>all_measurements_that_have_been_seen</strong></dt>
</dl>
<dl><dt><strong>page_results</strong></dt>
</dl>
<dl><dt><strong>values_for_current_page</strong></dt>
</dl>
<hr>
Methods inherited from <a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a>:<br>
<dl><dt><a name="PageMeasurementResults-AddError"><strong>AddError</strong></a>(self, page, err)</dt></dl>

<dl><dt><a name="PageMeasurementResults-AddErrorMessage"><strong>AddErrorMessage</strong></a>(self, page, message)</dt></dl>

<dl><dt><a name="PageMeasurementResults-AddFailure"><strong>AddFailure</strong></a>(self, page, err)</dt></dl>

<dl><dt><a name="PageMeasurementResults-AddFailureMessage"><strong>AddFailureMessage</strong></a>(self, page, message)</dt></dl>

<dl><dt><a name="PageMeasurementResults-AddSkip"><strong>AddSkip</strong></a>(self, page, reason)</dt></dl>

<dl><dt><a name="PageMeasurementResults-AddSuccess"><strong>AddSuccess</strong></a>(self, page)</dt></dl>

<dl><dt><a name="PageMeasurementResults-PrintSummary"><strong>PrintSummary</strong></a>(self)</dt></dl>

<dl><dt><a name="PageMeasurementResults-StartTest"><strong>StartTest</strong></a>(self, page)</dt></dl>

<dl><dt><a name="PageMeasurementResults-StopTest"><strong>StopTest</strong></a>(self, page)</dt></dl>

<dl><dt><a name="PageMeasurementResults-addSkip"><strong>addSkip</strong></a>(self, test, reason)</dt></dl>

<dl><dt><a name="PageMeasurementResults-addSuccess"><strong>addSuccess</strong></a>(self, test)</dt></dl>

<hr>
Methods inherited from <a href="unittest.result.html#TestResult">unittest.result.TestResult</a>:<br>
<dl><dt><a name="PageMeasurementResults-__repr__"><strong>__repr__</strong></a>(self)</dt></dl>

<dl><dt><a name="PageMeasurementResults-addError"><strong>addError</strong></a>(self, *args, **kw)</dt><dd><tt>Called&nbsp;when&nbsp;an&nbsp;error&nbsp;has&nbsp;occurred.&nbsp;'err'&nbsp;is&nbsp;a&nbsp;tuple&nbsp;of&nbsp;values&nbsp;as<br>
returned&nbsp;by&nbsp;sys.exc_info().</tt></dd></dl>

<dl><dt><a name="PageMeasurementResults-addExpectedFailure"><strong>addExpectedFailure</strong></a>(self, test, err)</dt><dd><tt>Called&nbsp;when&nbsp;an&nbsp;expected&nbsp;failure/error&nbsp;occured.</tt></dd></dl>

<dl><dt><a name="PageMeasurementResults-addFailure"><strong>addFailure</strong></a>(self, *args, **kw)</dt><dd><tt>Called&nbsp;when&nbsp;an&nbsp;error&nbsp;has&nbsp;occurred.&nbsp;'err'&nbsp;is&nbsp;a&nbsp;tuple&nbsp;of&nbsp;values&nbsp;as<br>
returned&nbsp;by&nbsp;sys.exc_info().</tt></dd></dl>

<dl><dt><a name="PageMeasurementResults-addUnexpectedSuccess"><strong>addUnexpectedSuccess</strong></a>(self, *args, **kw)</dt><dd><tt>Called&nbsp;when&nbsp;a&nbsp;test&nbsp;was&nbsp;expected&nbsp;to&nbsp;fail,&nbsp;but&nbsp;succeed.</tt></dd></dl>

<dl><dt><a name="PageMeasurementResults-printErrors"><strong>printErrors</strong></a>(self)</dt><dd><tt>Called&nbsp;by&nbsp;TestRunner&nbsp;after&nbsp;test&nbsp;run</tt></dd></dl>

<dl><dt><a name="PageMeasurementResults-startTest"><strong>startTest</strong></a>(self, test)</dt><dd><tt>Called&nbsp;when&nbsp;the&nbsp;given&nbsp;test&nbsp;is&nbsp;about&nbsp;to&nbsp;be&nbsp;run</tt></dd></dl>

<dl><dt><a name="PageMeasurementResults-startTestRun"><strong>startTestRun</strong></a>(self)</dt><dd><tt>Called&nbsp;once&nbsp;before&nbsp;any&nbsp;tests&nbsp;are&nbsp;executed.<br>
&nbsp;<br>
See&nbsp;startTest&nbsp;for&nbsp;a&nbsp;method&nbsp;called&nbsp;before&nbsp;each&nbsp;test.</tt></dd></dl>

<dl><dt><a name="PageMeasurementResults-stop"><strong>stop</strong></a>(self)</dt><dd><tt>Indicates&nbsp;that&nbsp;the&nbsp;tests&nbsp;should&nbsp;be&nbsp;aborted</tt></dd></dl>

<dl><dt><a name="PageMeasurementResults-stopTest"><strong>stopTest</strong></a>(self, test)</dt><dd><tt>Called&nbsp;when&nbsp;the&nbsp;given&nbsp;test&nbsp;has&nbsp;been&nbsp;run</tt></dd></dl>

<dl><dt><a name="PageMeasurementResults-stopTestRun"><strong>stopTestRun</strong></a>(self)</dt><dd><tt>Called&nbsp;once&nbsp;after&nbsp;all&nbsp;tests&nbsp;are&nbsp;executed.<br>
&nbsp;<br>
See&nbsp;stopTest&nbsp;for&nbsp;a&nbsp;method&nbsp;called&nbsp;after&nbsp;each&nbsp;test.</tt></dd></dl>

<dl><dt><a name="PageMeasurementResults-wasSuccessful"><strong>wasSuccessful</strong></a>(self)</dt><dd><tt>Tells&nbsp;whether&nbsp;or&nbsp;not&nbsp;this&nbsp;result&nbsp;was&nbsp;a&nbsp;success</tt></dd></dl>

<hr>
Data descriptors inherited from <a href="unittest.result.html#TestResult">unittest.result.TestResult</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>
</td></tr></table> <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="ValuesForSinglePage">class <strong>ValuesForSinglePage</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>

<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="ValuesForSinglePage-AddValue"><strong>AddValue</strong></a>(self, value)</dt></dl>

<dl><dt><a name="ValuesForSinglePage-FindValueByMeasurementName"><strong>FindValueByMeasurementName</strong></a>(self, measurement_name)</dt></dl>

<dl><dt><a name="ValuesForSinglePage-FindValueByTraceName"><strong>FindValueByTraceName</strong></a>(self, trace_name)</dt></dl>

<dl><dt><a name="ValuesForSinglePage-__contains__"><strong>__contains__</strong></a>(self, trace_name)</dt></dl>

<dl><dt><a name="ValuesForSinglePage-__getitem__"><strong>__getitem__</strong></a>(self, trace_name)</dt></dl>

<dl><dt><a name="ValuesForSinglePage-__init__"><strong>__init__</strong></a>(self, page)</dt></dl>

<hr>
Data descriptors defined here:<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>measurement_names</strong></dt>
</dl>
</td></tr></table></td></tr></table>
</body></html>