tools/telemetry/docs/telemetry.page.buildbot_page_measurement_results.html - Issue 17150002: [telemetry] Initial (autogenerated) documentation plus support scripts

Side by Side Diff: tools/telemetry/docs/telemetry.page.buildbot_page_measurement_results.html

Issue 17150002: [telemetry] Initial (autogenerated) documentation plus support scripts (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: update with nits Created 7 years, 6 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch | Annotate | Revision Log

« no previous file with comments | « tools/telemetry/docs/telemetry.page.block_page_measurement_results.html ('k') | tools/telemetry/docs/telemetry.page.csv_page_measurement_results.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

OLD	NEW
(Empty)
	1

	2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

	3 <html><head><title>Python: module telemetry.page.buildbot_page_measurement_resul ts</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> <br>

	9 <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a hre f="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry .page.html"><font color="#ffffff">page</font></a>.buildbot_page_measurement_resu lts</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= "file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/buildbot_page _measurement_results.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry /page/buildbot_page_measurement_results.py</a></font></td></tr></table>

	12 <p><tt># Copyright (c) 2013 The Chromium Autho rs. All rights reserved.<br>

	13 # Use of this source code is governed by  a BSD-style license that can be<br>

	14 # found in the LICENSE 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> <br>

	19 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big ></font></td></tr>

	20

	21 <tr><td bgcolor="#aa55cc"><tt>      </tt></td><td>  </td>

	22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t op><a href="telemetry.page.page_measurement_results.html">telemetry.page.page_me asurement_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></tabl e></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> <br>

	28 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big ></font></td></tr>

	29

	30 <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td>  </td>

	31 <td width="100%"><dl>

	32 <dt><font face="helvetica, arial"><a href="telemetry.page.page_measurement_resul ts.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeas urementResults</a>(<a href="telemetry.page.page_test_results.html#PageTestResult s">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_measurem ent_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> <br>

	43 <font color="#000000" face="helvetica, arial"><a name="BuildbotPageMeasurementRe sults">class <strong>BuildbotPageMeasurementResults</strong></a>(<a href="teleme try.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.pa ge_measurement_results.PageMeasurementResults</a>)</font></td></tr>

	44

	45 <tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>

	46 <td width="100%"><dl><dt>Method resolution order:</dt>

	47 <dd><a href="telemetry.page.buildbot_page_measurement_results.html#BuildbotPageM easurementResults">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.pa ge.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>PrintSumma ry</strong></a>(self)</dt><dd><tt>Print summary data in a&nb sp;format expected by buildbot for perf dashboards .<br>

	56  <br>

	57 If any failed pages exist, only output indivi dual page results for<br>

	58 non-failing pages, and do not output any aver age data.</tt></dd></dl>

	59

	60 <dl><dt><a name="BuildbotPageMeasurementResults-__init__"><strong>__init__</stro ng></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#Pag eMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResu lts</a>:<br>

	64 <dl><dt><a name="BuildbotPageMeasurementResults-Add"><strong>Add</strong></a>(se lf, 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">=Non e</font>, data_type<font color="#909090">='default'</font>)</dt></dl>

	67

	68 <dl><dt><a name="BuildbotPageMeasurementResults-DidMeasurePage"><strong>DidMeasu rePage</strong></a>(self)</dt></dl>

	69

	70 <dl><dt><a name="BuildbotPageMeasurementResults-WillMeasurePage"><strong>WillMea surePage</strong></a>(self, page)</dt></dl>

	71

	72 <dl><dt><a name="BuildbotPageMeasurementResults-__getitem__"><strong>__getitem__ </strong></a>(self, i)</dt><dd><tt>Shorthand for self.<strong>page_res ults</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.PageMeasur ementResults</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#PageTestRe sults">telemetry.page.page_test_results.PageTestResults</a>:<br>

	86 <dl><dt><a name="BuildbotPageMeasurementResults-AddError"><strong>AddError</stro ng></a>(self, page, err)</dt></dl>

	87

	88 <dl><dt><a name="BuildbotPageMeasurementResults-AddErrorMessage"><strong>AddErro rMessage</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>AddFa ilureMessage</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</st rong></a>(self, page)</dt></dl>

	99

	100 <dl><dt><a name="BuildbotPageMeasurementResults-StopTest"><strong>StopTest</stro ng></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__</stro ng></a>(self)</dt></dl>

	109

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

	111 returned by sys.exc_info().</tt></dd></dl>

	112

	113 <dl><dt><a name="BuildbotPageMeasurementResults-addExpectedFailure"><strong>addE xpectedFailure</strong></a>(self, test, err)</dt><dd><tt>Called when a n expected failure/error occured.</tt></dd></dl>

	114

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

	116 returned by sys.exc_info().</tt></dd></dl>

	117

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

	119

	120 <dl><dt><a name="BuildbotPageMeasurementResults-printErrors"><strong>printErrors </strong></a>(self)</dt><dd><tt>Called by TestRunner after t est run</tt></dd></dl>

	121

	122 <dl><dt><a name="BuildbotPageMeasurementResults-startTest"><strong>startTest</st rong></a>(self, test)</dt><dd><tt>Called when the given test  is about to be run</tt></dd></dl>

	123

	124 <dl><dt><a name="BuildbotPageMeasurementResults-startTestRun"><strong>startTestR un</strong></a>(self)</dt><dd><tt>Called once before any tes ts are executed.<br>

	125  <br>

	126 See startTest for a method called before each  test.</tt></dd></dl>

	127

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

	129

	130 <dl><dt><a name="BuildbotPageMeasurementResults-stopTest"><strong>stopTest</stro ng></a>(self, test)</dt><dd><tt>Called when the given test&n bsp;has been run</tt></dd></dl>

	131

	132 <dl><dt><a name="BuildbotPageMeasurementResults-stopTestRun"><strong>stopTestRun </strong></a>(self)</dt><dd><tt>Called once after all tests& nbsp;are executed.<br>

	133  <br>

	134 See stopTest for a method called after each&n bsp;test.</tt></dd></dl>

	135

	136 <dl><dt><a name="BuildbotPageMeasurementResults-wasSuccessful"><strong>wasSucces sful</strong></a>(self)</dt><dd><tt>Tells whether or not thi s result was a success</tt></dd></dl>

	137

	138 <hr>

	139 Data descriptors inherited from <a href="unittest.result.html#TestResult">unitte st.result.TestResult</a>:<br>

	140 <dl><dt><strong>__dict__</strong></dt>

	141 <dd><tt>dictionary for instance variables (if defined)< /tt></dd>

	142 </dl>

	143 <dl><dt><strong>__weakref__</strong></dt>

	144 <dd><tt>list of weak references to the object&nbsp ;(if defined)</tt></dd>

	145 </dl>

	146 </td></tr></table></td></tr></table>

	147 </body></html>

OLD	NEW