tools/telemetry/docs/telemetry.page.buildbot_page_measurement_results.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   3 <html><head><title>Python: module telemetry.page.buildbot_page_measurement_results</title>
   4 </head><body bgcolor="#f0f0f8">
   5
   6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
   7 <tr bgcolor="#7799ee">
   8 <td valign=bottom>&nbsp;<br>
   9 <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>.buildbot_page_measurement_results</strong></big></big></font></td
  10 ><td align=right valign=bottom
  11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/page/buildbot_page_measurement_results.py">telemetry/page/buildbot_page_measurement_results.py</a></font></td></tr></table>
  12     <p><tt>#&nbsp;Copyright&nbsp;(c)&nbsp;2013&nbsp;The&nbsp;Chromium&nbsp;Authors.&nbsp;All&nbsp;rights&nbsp;reserved.<br>
  13 #&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>
  14 #&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;file.</tt></p>
  15 <p>
  16 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  17 <tr bgcolor="#aa55cc">
  18 <td colspan=3 valign=bottom>&nbsp;<br>
  19 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
  20
  21 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.page.page_measurement_results.html">telemetry.page.page_measurement_results</a><br>
  23 </td><td width="25%" valign=top><a href="telemetry.page.perf_tests_helper.html">telemetry.page.perf_tests_helper</a><br>
  24 </td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
  25 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  26 <tr bgcolor="#ee77aa">
  27 <td colspan=3 valign=bottom>&nbsp;<br>
  28 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
  29
  30 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  31 <td width="100%"><dl>
  32 <dt><font face="helvetica, arial"><a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a>(<a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a>)
  33 </font></dt><dd>
  34 <dl>
  35 <dt><font face="helvetica, arial"><a href="telemetry.page.buildbot_page_measurement_results.html#BuildbotPageMeasurementResults">BuildbotPageMeasurementResults</a>
  36 </font></dt></dl>
  37 </dd>
  38 </dl>
  39  <p>
  40 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  41 <tr bgcolor="#ffc8d8">
  42 <td colspan=3 valign=bottom>&nbsp;<br>
  43 <font color="#000000" face="helvetica, arial"><a name="BuildbotPageMeasurementResults">class <strong>BuildbotPageMeasurementResults</strong></a>(<a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a>)</font></td></tr>
  44
  45 <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  46 <td width="100%"><dl><dt>Method resolution order:</dt>
  47 <dd><a href="telemetry.page.buildbot_page_measurement_results.html#BuildbotPageMeasurementResults">BuildbotPageMeasurementResults</a></dd>
  48 <dd><a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a></dd>
  49 <dd><a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a></dd>
  50 <dd><a href="unittest.result.html#TestResult">unittest.result.TestResult</a></dd>
  51 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
  52 </dl>
  53 <hr>
  54 Methods defined here:<br>
  55 <dl><dt><a name="BuildbotPageMeasurementResults-PrintSummary"><strong>PrintSummary</strong></a>(self)</dt><dd><tt>Print&nbsp;summary&nbsp;data&nbsp;in&nbsp;a&nbsp;format&nbsp;expected&nbsp;by&nbsp;buildbot&nbsp;for&nbsp;perf&nbsp;dashboards.<br>
  56 &nbsp;<br>
  57 If&nbsp;any&nbsp;failed&nbsp;pages&nbsp;exist,&nbsp;only&nbsp;output&nbsp;individual&nbsp;page&nbsp;results&nbsp;for<br>
  58 non-failing&nbsp;pages,&nbsp;and&nbsp;do&nbsp;not&nbsp;output&nbsp;any&nbsp;average&nbsp;data.</tt></dd></dl>
  59
  60 <dl><dt><a name="BuildbotPageMeasurementResults-__init__"><strong>__init__</strong></a>(self, trace_tag<font color="#909090">=''</font>)</dt></dl>
  61
  62 <hr>
  63 Methods inherited from <a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a>:<br>
  64 <dl><dt><a name="BuildbotPageMeasurementResults-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>
  65
  66 <dl><dt><a name="BuildbotPageMeasurementResults-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>
  67
  68 <dl><dt><a name="BuildbotPageMeasurementResults-DidMeasurePage"><strong>DidMeasurePage</strong></a>(self)</dt></dl>
  69
  70 <dl><dt><a name="BuildbotPageMeasurementResults-WillMeasurePage"><strong>WillMeasurePage</strong></a>(self, page)</dt></dl>
  71
  72 <dl><dt><a name="BuildbotPageMeasurementResults-__getitem__"><strong>__getitem__</strong></a>(self, i)</dt><dd><tt>Shorthand&nbsp;for&nbsp;self.<strong>page_results</strong>[i]</tt></dd></dl>
  73
  74 <dl><dt><a name="BuildbotPageMeasurementResults-__len__"><strong>__len__</strong></a>(self)</dt></dl>
  75
  76 <hr>
  77 Data descriptors inherited from <a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a>:<br>
  78 <dl><dt><strong>all_measurements_that_have_been_seen</strong></dt>
  79 </dl>
  80 <dl><dt><strong>page_results</strong></dt>
  81 </dl>
  82 <dl><dt><strong>values_for_current_page</strong></dt>
  83 </dl>
  84 <hr>
  85 Methods inherited from <a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a>:<br>
  86 <dl><dt><a name="BuildbotPageMeasurementResults-AddError"><strong>AddError</strong></a>(self, page, err)</dt></dl>
  87
  88 <dl><dt><a name="BuildbotPageMeasurementResults-AddErrorMessage"><strong>AddErrorMessage</strong></a>(self, page, message)</dt></dl>
  89
  90 <dl><dt><a name="BuildbotPageMeasurementResults-AddFailure"><strong>AddFailure</strong></a>(self, page, err)</dt></dl>
  91
  92 <dl><dt><a name="BuildbotPageMeasurementResults-AddFailureMessage"><strong>AddFailureMessage</strong></a>(self, page, message)</dt></dl>
  93
  94 <dl><dt><a name="BuildbotPageMeasurementResults-AddSkip"><strong>AddSkip</strong></a>(self, page, reason)</dt></dl>
  95
  96 <dl><dt><a name="BuildbotPageMeasurementResults-AddSuccess"><strong>AddSuccess</strong></a>(self, page)</dt></dl>
  97
  98 <dl><dt><a name="BuildbotPageMeasurementResults-StartTest"><strong>StartTest</strong></a>(self, page)</dt></dl>
  99
 100 <dl><dt><a name="BuildbotPageMeasurementResults-StopTest"><strong>StopTest</strong></a>(self, page)</dt></dl>
 101
 102 <dl><dt><a name="BuildbotPageMeasurementResults-addSkip"><strong>addSkip</strong></a>(self, test, reason)</dt></dl>
 103
 104 <dl><dt><a name="BuildbotPageMeasurementResults-addSuccess"><strong>addSuccess</strong></a>(self, test)</dt></dl>
 105
 106 <hr>
 107 Methods inherited from <a href="unittest.result.html#TestResult">unittest.result.TestResult</a>:<br>
 108 <dl><dt><a name="BuildbotPageMeasurementResults-__repr__"><strong>__repr__</strong></a>(self)</dt></dl>
 109
 110 <dl><dt><a name="BuildbotPageMeasurementResults-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>
 111 returned&nbsp;by&nbsp;sys.exc_info().</tt></dd></dl>
 112
 113 <dl><dt><a name="BuildbotPageMeasurementResults-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>
 114
 115 <dl><dt><a name="BuildbotPageMeasurementResults-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>
 116 returned&nbsp;by&nbsp;sys.exc_info().</tt></dd></dl>
 117
 118 <dl><dt><a name="BuildbotPageMeasurementResults-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>
 119
 120 <dl><dt><a name="BuildbotPageMeasurementResults-printErrors"><strong>printErrors</strong></a>(self)</dt><dd><tt>Called&nbsp;by&nbsp;TestRunner&nbsp;after&nbsp;test&nbsp;run</tt></dd></dl>
 121
 122 <dl><dt><a name="BuildbotPageMeasurementResults-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>
 123
 124 <dl><dt><a name="BuildbotPageMeasurementResults-startTestRun"><strong>startTestRun</strong></a>(self)</dt><dd><tt>Called&nbsp;once&nbsp;before&nbsp;any&nbsp;tests&nbsp;are&nbsp;executed.<br>
 125 &nbsp;<br>
 126 See&nbsp;startTest&nbsp;for&nbsp;a&nbsp;method&nbsp;called&nbsp;before&nbsp;each&nbsp;test.</tt></dd></dl>
 127
 128 <dl><dt><a name="BuildbotPageMeasurementResults-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>
 129
 130 <dl><dt><a name="BuildbotPageMeasurementResults-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>
 131
 132 <dl><dt><a name="BuildbotPageMeasurementResults-stopTestRun"><strong>stopTestRun</strong></a>(self)</dt><dd><tt>Called&nbsp;once&nbsp;after&nbsp;all&nbsp;tests&nbsp;are&nbsp;executed.<br>
 133 &nbsp;<br>
 134 See&nbsp;stopTest&nbsp;for&nbsp;a&nbsp;method&nbsp;called&nbsp;after&nbsp;each&nbsp;test.</tt></dd></dl>
 135
 136 <dl><dt><a name="BuildbotPageMeasurementResults-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>
 137
 138 <hr>
 139 Data descriptors inherited from <a href="unittest.result.html#TestResult">unittest.result.TestResult</a>:<br>
 140 <dl><dt><strong>__dict__</strong></dt>
 141 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
 142 </dl>
 143 <dl><dt><strong>__weakref__</strong></dt>
 144 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
 145 </dl>
 146 </td></tr></table></td></tr></table>
 147 </body></html>