tools/telemetry/docs/telemetry.page.buildbot_page_measurement_results.html - Issue 196383034: Update telemetry docs by running the update_docs script.

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

Issue 196383034: Update telemetry docs by running the update_docs script. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 6 years, 9 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.cloud_storage.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

OLD	NEW
1	1

2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">	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>	3 <html><head><title>Python: module telemetry.page.buildbot_page_measurement_resul ts</title>

4 </head><body bgcolor="#f0f0f8">	4 </head><body bgcolor="#f0f0f8">

5	5

6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">	6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">

7 <tr bgcolor="#7799ee">	7 <tr bgcolor="#7799ee">

8 <td valign=bottom> <br>	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	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	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>	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># Copyright (c) 2013 The Chromium Autho rs. All rights reserved.<br>	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>	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>	14 # found in the LICENSE file.</tt></p>

15 <p>	15 <p>

16 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">	16 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

17 <tr bgcolor="#aa55cc">	17 <tr bgcolor="#aa55cc">

18 <td colspan=3 valign=bottom> <br>	18 <td colspan=3 valign=bottom> <br>

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

20	20

21 <tr><td bgcolor="#aa55cc"><tt>      </tt></td><td>  </td>	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>	22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t op><a href="telemetry.value.merge_values.html">telemetry.value.merge_values</a>< br>

	23 </td><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><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 </td><td width="25%" valign=top><a href="telemetry.value.html">telemetry.value</ a><br>

	26 </td></tr></table></td></tr></table><p>

25 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">	27 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

26 <tr bgcolor="#ee77aa">	28 <tr bgcolor="#ee77aa">

27 <td colspan=3 valign=bottom> <br>	29 <td colspan=3 valign=bottom> <br>

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

29	31

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

31 <td width="100%"><dl>	33 <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>)	34 <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>	35 </font></dt><dd>

34 <dl>	36 <dl>

(...skipping 12 matching lines...) Expand all Loading...
47 <dd><a href="telemetry.page.buildbot_page_measurement_results.html#BuildbotPageM easurementResults">BuildbotPageMeasurementResults</a></dd>	49 <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>	50 <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>	51 <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 >	52 <dd><a href="unittest.result.html#TestResult">unittest.result.TestResult</a></dd >

51 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>	53 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

52 </dl>	54 </dl>

53 <hr>	55 <hr>

54 Methods defined here:<br>	56 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>	57 <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>	58  <br>

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

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

59	61

60 <dl><dt><a name="BuildbotPageMeasurementResults-__init__"><strong>__init__</stro ng></a>(self, trace_tag<font color="#909090">=''</font>)</dt></dl>	62 <dl><dt><a name="BuildbotPageMeasurementResults-__init__"><strong>__init__</stro ng></a>(self, output_stream, trace_tag<font color="#909090">=''</font>)</dt></dl >

61	63

62 <hr>	64 <hr>

	65 Data descriptors defined here:<br>

	66 <dl><dt><strong>had_errors_or_failures</strong></dt>

	67 </dl>

	68 <hr>

63 Methods inherited from <a href="telemetry.page.page_measurement_results.html#Pag eMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResu lts</a>:<br>	69 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>	70 <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	71

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>	72 <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	73

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

69	75

	76 <dl><dt><a name="BuildbotPageMeasurementResults-FindAllPageSpecificValuesNamed"> <strong>FindAllPageSpecificValuesNamed</strong></a>(self, value_name)</dt></dl>

	77

	78 <dl><dt><a name="BuildbotPageMeasurementResults-FindPageSpecificValuesForPage">< strong>FindPageSpecificValuesForPage</strong></a>(self, page, value_name)</dt></ dl>

	79

	80 <dl><dt><a name="BuildbotPageMeasurementResults-GetUnitsForValueName"><strong>Ge tUnitsForValueName</strong></a>(self, value_name)</dt></dl>

	81

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

71	83

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>	84 <hr>

77 Data descriptors inherited from <a href="telemetry.page.page_measurement_results .html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasur ementResults</a>:<br>	85 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>	86 <dl><dt><strong>all_page_specific_values</strong></dt>

79 </dl>	87 </dl>

80 <dl><dt><strong>page_results</strong></dt>	88 <dl><dt><strong>all_value_names_that_have_been_seen</strong></dt>

81 </dl>	89 </dl>

82 <dl><dt><strong>values_for_current_page</strong></dt>	90 <dl><dt><strong>current_page</strong></dt>

	91 </dl>

	92 <dl><dt><strong>page_specific_values_for_current_page</strong></dt>

	93 </dl>

	94 <dl><dt><strong>pages_that_succeeded</strong></dt>

83 </dl>	95 </dl>

84 <hr>	96 <hr>

85 Methods inherited from <a href="telemetry.page.page_test_results.html#PageTestRe sults">telemetry.page.page_test_results.PageTestResults</a>:<br>	97 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>	98 <dl><dt><a name="BuildbotPageMeasurementResults-AddError"><strong>AddError</stro ng></a>(self, page, err)</dt></dl>

87	99

88 <dl><dt><a name="BuildbotPageMeasurementResults-AddErrorMessage"><strong>AddErro rMessage</strong></a>(self, page, message)</dt></dl>	100 <dl><dt><a name="BuildbotPageMeasurementResults-AddErrorMessage"><strong>AddErro rMessage</strong></a>(self, page, message)</dt></dl>

89	101

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

91	103

92 <dl><dt><a name="BuildbotPageMeasurementResults-AddFailureMessage"><strong>AddFa ilureMessage</strong></a>(self, page, message)</dt></dl>	104 <dl><dt><a name="BuildbotPageMeasurementResults-AddFailureMessage"><strong>AddFa ilureMessage</strong></a>(self, page, message)</dt></dl>

93	105

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

95	107

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

97	109

98 <dl><dt><a name="BuildbotPageMeasurementResults-StartTest"><strong>StartTest</st rong></a>(self, page)</dt></dl>	110 <dl><dt><a name="BuildbotPageMeasurementResults-StartTest"><strong>StartTest</st rong></a>(self, page)</dt></dl>

99	111

100 <dl><dt><a name="BuildbotPageMeasurementResults-StopTest"><strong>StopTest</stro ng></a>(self, page)</dt></dl>	112 <dl><dt><a name="BuildbotPageMeasurementResults-StopTest"><strong>StopTest</stro ng></a>(self, page)</dt></dl>

101	113

	114 <dl><dt><a name="BuildbotPageMeasurementResults-__copy__"><strong>__copy__</stro ng></a>(self)</dt></dl>

	115

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

103	117

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

105	119

106 <hr>	120 <hr>

	121 Data descriptors inherited from <a href="telemetry.page.page_test_results.html#P ageTestResults">telemetry.page.page_test_results.PageTestResults</a>:<br>

	122 <dl><dt><strong>pages_that_had_errors_or_failures</strong></dt>

	123 </dl>

	124 <hr>

107 Methods inherited from <a href="unittest.result.html#TestResult">unittest.result .TestResult</a>:<br>	125 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>	126 <dl><dt><a name="BuildbotPageMeasurementResults-__repr__"><strong>__repr__</stro ng></a>(self)</dt></dl>

109	127

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>	128 <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>	129 returned by sys.exc_info().</tt></dd></dl>

112	130

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>	131 <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	132

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>	133 <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>	134 returned by sys.exc_info().</tt></dd></dl>

(...skipping 21 matching lines...) Expand all Loading...
138 <hr>	156 <hr>

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

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

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

142 </dl>	160 </dl>

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

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

145 </dl>	163 </dl>

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

147 </body></html>	165 </body></html>

OLD	NEW