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

Side by Side Diff: tools/telemetry/docs/telemetry.page.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.page_measurement.html ('k') | tools/telemetry/docs/telemetry.page.page_measurement_runner.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.page_measurement_results</title >	3 <html><head><title>Python: module telemetry.page.page_measurement_results</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>.page_measurement_results</stro ng></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>.page_measurement_results</stro ng></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/page_measurement_results.py">telemetry/page/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/page_measurement_results.py">telemetry/page/page_measurement_ results.py</a></font></td></tr></table>

12 <p><tt># Copyright (c) 2012 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_value.html">telemetry.page.page_meas urement_value</a><br>	22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t op><a href="telemetry.page.page_test_results.html">telemetry.page.page_test_resu lts</a><br>

23 </td><td width="25%" valign=top><a href="telemetry.page.page_test_results.html"> telemetry.page.page_test_results</a><br>	23 </td><td width="25%" valign=top><a href="telemetry.value.value_backcompat.html"> telemetry.value.value_backcompat</a><br>

24 </td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></tabl e></td></tr></table><p>	24 </td><td width="25%" valign=top><a href="telemetry.value.html">telemetry.value</ a><br>

	25 </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 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

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

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

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

29	30

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

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

32 <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__. object</a>

33 </font></dt><dd>

34 <dl>

35 <dt><font face="helvetica, arial"><a href="telemetry.page.page_measurement_resul ts.html#ValuesForSinglePage">ValuesForSinglePage</a>

36 </font></dt></dl>

37 </dd>

38 <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>)	33 <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>)

39 </font></dt><dd>	34 </font></dt><dd>

40 <dl>	35 <dl>

41 <dt><font face="helvetica, arial"><a href="telemetry.page.page_measurement_resul ts.html#PageMeasurementResults">PageMeasurementResults</a>	36 <dt><font face="helvetica, arial"><a href="telemetry.page.page_measurement_resul ts.html#PageMeasurementResults">PageMeasurementResults</a>

42 </font></dt></dl>	37 </font></dt></dl>

43 </dd>	38 </dd>

44 </dl>	39 </dl>

45 <p>	40 <p>

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

47 <tr bgcolor="#ffc8d8">	42 <tr bgcolor="#ffc8d8">

48 <td colspan=3 valign=bottom> <br>	43 <td colspan=3 valign=bottom> <br>

49 <font color="#000000" face="helvetica, arial"><a name="PageMeasurementResults">c lass <strong>PageMeasurementResults</strong></a>(<a href="telemetry.page.page_te st_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResult s</a>)</font></td></tr>	44 <font color="#000000" face="helvetica, arial"><a name="PageMeasurementResults">c lass <strong>PageMeasurementResults</strong></a>(<a href="telemetry.page.page_te st_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResult s</a>)</font></td></tr>

50	45

51 <tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>	46 <tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>

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

53 <dd><a href="telemetry.page.page_measurement_results.html#PageMeasurementResults ">PageMeasurementResults</a></dd>	48 <dd><a href="telemetry.page.page_measurement_results.html#PageMeasurementResults ">PageMeasurementResults</a></dd>

54 <dd><a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.pa ge.page_test_results.PageTestResults</a></dd>	49 <dd><a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.pa ge.page_test_results.PageTestResults</a></dd>

55 <dd><a href="unittest.result.html#TestResult">unittest.result.TestResult</a></dd >	50 <dd><a href="unittest.result.html#TestResult">unittest.result.TestResult</a></dd >

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

57 </dl>	52 </dl>

58 <hr>	53 <hr>

59 Methods defined here:<br>	54 Methods defined here:<br>

60 <dl><dt><a name="PageMeasurementResults-Add"><strong>Add</strong></a>(self, trac e_name, units, value, chart_name<font color="#909090">=None</font>, data_type<fo nt color="#909090">='default'</font>)</dt></dl>	55 <dl><dt><a name="PageMeasurementResults-Add"><strong>Add</strong></a>(self, trac e_name, units, value, chart_name<font color="#909090">=None</font>, data_type<fo nt color="#909090">='default'</font>)</dt></dl>

61	56

62 <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>	57 <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>

63	58

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

65	60

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

	62

	63 <dl><dt><a name="PageMeasurementResults-FindPageSpecificValuesForPage"><strong>F indPageSpecificValuesForPage</strong></a>(self, page, value_name)</dt></dl>

	64

	65 <dl><dt><a name="PageMeasurementResults-GetUnitsForValueName"><strong>GetUnitsFo rValueName</strong></a>(self, value_name)</dt></dl>

	66

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

67	68

68 <dl><dt><a name="PageMeasurementResults-__getitem__"><strong>__getitem__</strong ></a>(self, i)</dt><dd><tt>Shorthand for self.<strong>page_results</st rong>[i]</tt></dd></dl>	69 <dl><dt><a name="PageMeasurementResults-__init__"><strong>__init__</strong></a>( self, output_stream<font color="#909090">=None</font>, trace_tag<font color="#90 9090">=''</font>)</dt></dl>

69

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

71

72 <dl><dt><a name="PageMeasurementResults-__len__"><strong>__len__</strong></a>(se lf)</dt></dl>

73	70

74 <hr>	71 <hr>

75 Data descriptors defined here:<br>	72 Data descriptors defined here:<br>

76 <dl><dt><strong>all_measurements_that_have_been_seen</strong></dt>	73 <dl><dt><strong>all_page_specific_values</strong></dt>

77 </dl>	74 </dl>

78 <dl><dt><strong>page_results</strong></dt>	75 <dl><dt><strong>all_value_names_that_have_been_seen</strong></dt>

79 </dl>	76 </dl>

80 <dl><dt><strong>values_for_current_page</strong></dt>	77 <dl><dt><strong>current_page</strong></dt>

	78 </dl>

	79 <dl><dt><strong>page_specific_values_for_current_page</strong></dt>

	80 </dl>

	81 <dl><dt><strong>pages_that_succeeded</strong></dt>

81 </dl>	82 </dl>

82 <hr>	83 <hr>

83 Methods inherited from <a href="telemetry.page.page_test_results.html#PageTestRe sults">telemetry.page.page_test_results.PageTestResults</a>:<br>	84 Methods inherited from <a href="telemetry.page.page_test_results.html#PageTestRe sults">telemetry.page.page_test_results.PageTestResults</a>:<br>

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

85	86

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

87	88

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

89	90

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

91	92

92 <dl><dt><a name="PageMeasurementResults-AddSkip"><strong>AddSkip</strong></a>(se lf, page, reason)</dt></dl>	93 <dl><dt><a name="PageMeasurementResults-AddSkip"><strong>AddSkip</strong></a>(se lf, page, reason)</dt></dl>

93	94

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

95	96

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

97	98

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

99	100

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

101	102

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

	104

102 <dl><dt><a name="PageMeasurementResults-addSkip"><strong>addSkip</strong></a>(se lf, test, reason)</dt></dl>	105 <dl><dt><a name="PageMeasurementResults-addSkip"><strong>addSkip</strong></a>(se lf, test, reason)</dt></dl>

103	106

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

105	108

106 <hr>	109 <hr>

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

	111 <dl><dt><strong>pages_that_had_errors_or_failures</strong></dt>

	112 </dl>

	113 <hr>

107 Methods inherited from <a href="unittest.result.html#TestResult">unittest.result .TestResult</a>:<br>	114 Methods inherited from <a href="unittest.result.html#TestResult">unittest.result .TestResult</a>:<br>

108 <dl><dt><a name="PageMeasurementResults-__repr__"><strong>__repr__</strong></a>( self)</dt></dl>	115 <dl><dt><a name="PageMeasurementResults-__repr__"><strong>__repr__</strong></a>( self)</dt></dl>

109	116

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

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

112	119

113 <dl><dt><a name="PageMeasurementResults-addExpectedFailure"><strong>addExpectedF ailure</strong></a>(self, test, err)</dt><dd><tt>Called when an e xpected failure/error occured.</tt></dd></dl>	120 <dl><dt><a name="PageMeasurementResults-addExpectedFailure"><strong>addExpectedF ailure</strong></a>(self, test, err)</dt><dd><tt>Called when an e xpected failure/error occured.</tt></dd></dl>

114	121

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

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

(...skipping 19 matching lines...) Expand all Loading...
136 <dl><dt><a name="PageMeasurementResults-wasSuccessful"><strong>wasSuccessful</st rong></a>(self)</dt><dd><tt>Tells whether or not this r esult was a success</tt></dd></dl>	143 <dl><dt><a name="PageMeasurementResults-wasSuccessful"><strong>wasSuccessful</st rong></a>(self)</dt><dd><tt>Tells whether or not this r esult was a success</tt></dd></dl>

137	144

138 <hr>	145 <hr>

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

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

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

142 </dl>	149 </dl>

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

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

145 </dl>	152 </dl>

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

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

148 <tr bgcolor="#ffc8d8">

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

150 <font color="#000000" face="helvetica, arial"><a name="ValuesForSinglePage">clas s <strong>ValuesForSinglePage</strong></a>(<a href="__builtin__.html#object">__b uiltin__.object</a>)</font></td></tr>

151

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

153 <td width="100%">Methods defined here:<br>

154 <dl><dt><a name="ValuesForSinglePage-AddValue"><strong>AddValue</strong></a>(sel f, value)</dt></dl>

155

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

157

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

159

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

161

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

163

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

165

166 <hr>

167 Data descriptors defined here:<br>

168 <dl><dt><strong>__dict__</strong></dt>

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

170 </dl>

171 <dl><dt><strong>__weakref__</strong></dt>

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

173 </dl>

174 <dl><dt><strong>measurement_names</strong></dt>

175 </dl>

176 </td></tr></table></td></tr></table>	153 </td></tr></table></td></tr></table>

177 </body></html>	154 </body></html>

OLD	NEW