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

Side by Side Diff: tools/telemetry/docs/telemetry.page.page_measurement_unittest_base.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_runner.html ('k') | tools/telemetry/docs/telemetry.page.page_measurement_value.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_unittest_base< /title>	3 <html><head><title>Python: module telemetry.page.page_measurement_unittest_base< /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_unittest_base </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>.page_measurement_unittest_base </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/page_measurement_unittest_base.py">telemetry/page/page_measur ement_unittest_base.py</a></font></td></tr></table>	11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href= "../telemetry/page/page_measurement_unittest_base.py">telemetry/page/page_measur ement_unittest_base.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) 2012 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.unittest.options_for_unittests.html">telemetry.unittest.op tions_for_unittests</a><br>	22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t op><a href="telemetry.unittest.options_for_unittests.html">telemetry.unittest.op tions_for_unittests</a><br>

23 <a href="os.html">os</a><br>	23 <a href="telemetry.page.page.html">telemetry.page.page</a><br>

24 </td><td width="25%" valign=top><a href="telemetry.page.page.html">telemetry.pag e.page</a><br>	24 </td><td width="25%" valign=top><a href="telemetry.page.page_runner.html">teleme try.page.page_runner</a><br>

25 <a href="telemetry.page.page_runner.html">telemetry.page.page_runner</a><br>	25 <a href="telemetry.page.page_set.html">telemetry.page.page_set</a><br>

26 </td><td width="25%" valign=top><a href="telemetry.page.page_set.html">telemetry .page.page_set</a><br>	26 </td><td width="25%" valign=top><a href="telemetry.page.test_expectations.html"> telemetry.page.test_expectations</a><br>

27 <a href="unittest.html">unittest</a><br>	27 <a href="unittest.html">unittest</a><br>

28 </td><td width="25%" valign=top></td></tr></table></td></tr></table><p>	28 </td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.cor e.util</a><br>

	29 </td></tr></table></td></tr></table><p>

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

30 <tr bgcolor="#ee77aa">	31 <tr bgcolor="#ee77aa">

31 <td colspan=3 valign=bottom> <br>	32 <td colspan=3 valign=bottom> <br>

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

33	34

34 <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td>  </td>	35 <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td>  </td>

35 <td width="100%"><dl>	36 <td width="100%"><dl>

36 <dt><font face="helvetica, arial"><a href="unittest.case.html#TestCase">unittest .case.TestCase</a>(<a href="__builtin__.html#object">__builtin__.object</a>)	37 <dt><font face="helvetica, arial"><a href="unittest.case.html#TestCase">unittest .case.TestCase</a>(<a href="__builtin__.html#object">__builtin__.object</a>)

37 </font></dt><dd>	38 </font></dt><dd>

38 <dl>	39 <dl>

(...skipping 15 matching lines...) Expand all Loading...
54 <dd><a href="telemetry.page.page_measurement_unittest_base.html#PageMeasurementU nitTestBase">PageMeasurementUnitTestBase</a></dd>	55 <dd><a href="telemetry.page.page_measurement_unittest_base.html#PageMeasurementU nitTestBase">PageMeasurementUnitTestBase</a></dd>

55 <dd><a href="unittest.case.html#TestCase">unittest.case.TestCase</a></dd>	56 <dd><a href="unittest.case.html#TestCase">unittest.case.TestCase</a></dd>

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

57 </dl>	58 </dl>

58 <hr>	59 <hr>

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

60 <dl><dt><a name="PageMeasurementUnitTestBase-CreatePageSet"><strong>CreatePageSe t</strong></a>(self, test_filename)</dt></dl>	61 <dl><dt><a name="PageMeasurementUnitTestBase-CreatePageSet"><strong>CreatePageSe t</strong></a>(self, test_filename)</dt></dl>

61	62

62 <dl><dt><a name="PageMeasurementUnitTestBase-CreatePageSetFromFileInUnittestData Dir"><strong>CreatePageSetFromFileInUnittestDataDir</strong></a>(self, test_file name)</dt></dl>	63 <dl><dt><a name="PageMeasurementUnitTestBase-CreatePageSetFromFileInUnittestData Dir"><strong>CreatePageSetFromFileInUnittestDataDir</strong></a>(self, test_file name)</dt></dl>

63	64

64 <dl><dt><a name="PageMeasurementUnitTestBase-RunMeasurement"><strong>RunMeasurem ent</strong></a>(self, measurement, ps, options<font color="#909090">=None</font >)</dt><dd><tt>Runs a measurement against a pageset,&nb sp;returning the rows its outputs.</tt></dd></dl>	65 <dl><dt><a name="PageMeasurementUnitTestBase-RunMeasurement"><strong>RunMeasurem ent</strong></a>(self, measurement, ps, expectations<font color="#909090">=<t elemetry.page.test_expectations.TestExpectations object></font>, options<font color="#909090">=None</font>)</dt><dd><tt>Runs a measurement aga inst a pageset, returning the rows its output s.</tt></dd></dl>

65	66

66 <hr>	67 <hr>

67 Methods inherited from <a href="unittest.case.html#TestCase">unittest.case.TestC ase</a>:<br>	68 Methods inherited from <a href="unittest.case.html#TestCase">unittest.case.TestC ase</a>:<br>

68 <dl><dt><a name="PageMeasurementUnitTestBase-__call__"><strong>__call__</strong> </a>(self, args, *kwds)</dt></dl>	69 <dl><dt><a name="PageMeasurementUnitTestBase-__call__"><strong>__call__</strong> </a>(self, args, *kwds)</dt></dl>

69	70

70 <dl><dt><a name="PageMeasurementUnitTestBase-__eq__"><strong>__eq__</strong></a> (self, other)</dt></dl>	71 <dl><dt><a name="PageMeasurementUnitTestBase-__eq__"><strong>__eq__</strong></a> (self, other)</dt></dl>

71	72

72 <dl><dt><a name="PageMeasurementUnitTestBase-__hash__"><strong>__hash__</strong> </a>(self)</dt></dl>	73 <dl><dt><a name="PageMeasurementUnitTestBase-__hash__"><strong>__hash__</strong> </a>(self)</dt></dl>

73	74

74 <dl><dt><a name="PageMeasurementUnitTestBase-__init__"><strong>__init__</strong> </a>(self, methodName<font color="#909090">='runTest'</font>)</dt><dd><tt>Create  an instance of the class that will use& nbsp;the named test<br>	75 <dl><dt><a name="PageMeasurementUnitTestBase-__init__"><strong>__init__</strong> </a>(self, methodName<font color="#909090">='runTest'</font>)</dt><dd><tt>Create  an instance of the class that will use& nbsp;the named test<br>

(...skipping 114 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
189 <dl><dt><a name="PageMeasurementUnitTestBase-assertNotAlmostEquals"><strong>asse rtNotAlmostEquals</strong></a> = assertNotAlmostEqual(self, first, second, place s<font color="#909090">=None</font>, msg<font color="#909090">=None</font>, delt a<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two& nbsp;objects are equal as determined by their<br>	190 <dl><dt><a name="PageMeasurementUnitTestBase-assertNotAlmostEquals"><strong>asse rtNotAlmostEquals</strong></a> = assertNotAlmostEqual(self, first, second, place s<font color="#909090">=None</font>, msg<font color="#909090">=None</font>, delt a<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two& nbsp;objects are equal as determined by their<br>

190 difference rounded to the given number of dec imal places<br>	191 difference rounded to the given number of dec imal places<br>

191 (default 7) and comparing to zero, or by&nbsp ;comparing that the<br>	192 (default 7) and comparing to zero, or by&nbsp ;comparing that the<br>

192 between the two objects is less than the&nbsp ;given delta.<br>	193 between the two objects is less than the&nbsp ;given delta.<br>

193  <br>	194  <br>

194 Note that decimal places (from zero) are usua lly not the same<br>	195 Note that decimal places (from zero) are usua lly not the same<br>

195 as significant digits (measured from the most&nbsp ;signficant digit).<br>	196 as significant digits (measured from the most&nbsp ;signficant digit).<br>

196  <br>	197  <br>

197 Objects that are equal automatically fail.</tt></dd></d l>	198 Objects that are equal automatically fail.</tt></dd></d l>

198	199

199 <dl><dt><a name="PageMeasurementUnitTestBase-assertNotEqual"><strong>assertNotEq ual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt ><dd><tt>Fail if the two objects are equal as  determined by the '=='<br>	200 <dl><dt><a name="PageMeasurementUnitTestBase-assertNotEqual"><strong>assertNotEq ual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt ><dd><tt>Fail if the two objects are equal as  determined by the '!='<br>

200 operator.</tt></dd></dl>	201 operator.</tt></dd></dl>

201	202

202 <dl><dt><a name="PageMeasurementUnitTestBase-assertNotEquals"><strong>assertNotE quals</strong></a> = assertNotEqual(self, first, second, msg<font color="#909090 ">=None</font>)</dt><dd><tt>Fail if the two objects are  equal as determined by the '=='<br>	203 <dl><dt><a name="PageMeasurementUnitTestBase-assertNotEquals"><strong>assertNotE quals</strong></a> = assertNotEqual(self, first, second, msg<font color="#909090 ">=None</font>)</dt><dd><tt>Fail if the two objects are  equal as determined by the '!='<br>

203 operator.</tt></dd></dl>	204 operator.</tt></dd></dl>

204	205

205 <dl><dt><a name="PageMeasurementUnitTestBase-assertNotIn"><strong>assertNotIn</s trong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt>< dd><tt>Just like <a href="#PageMeasurementUnitTestBase-assertTrue">ass ertTrue</a>(a not in b), but with a nicer&nbs p;default message.</tt></dd></dl>	206 <dl><dt><a name="PageMeasurementUnitTestBase-assertNotIn"><strong>assertNotIn</s trong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt>< dd><tt>Just like <a href="#PageMeasurementUnitTestBase-assertTrue">ass ertTrue</a>(a not in b), but with a nicer&nbs p;default message.</tt></dd></dl>

206	207

207 <dl><dt><a name="PageMeasurementUnitTestBase-assertNotIsInstance"><strong>assert NotIsInstance</strong></a>(self, obj, cls, msg<font color="#909090">=None</font> )</dt><dd><tt>Included for symmetry with assertIsInstance.</ tt></dd></dl>	208 <dl><dt><a name="PageMeasurementUnitTestBase-assertNotIsInstance"><strong>assert NotIsInstance</strong></a>(self, obj, cls, msg<font color="#909090">=None</font> )</dt><dd><tt>Included for symmetry with assertIsInstance.</ tt></dd></dl>

208	209

209 <dl><dt><a name="PageMeasurementUnitTestBase-assertNotRegexpMatches"><strong>ass ertNotRegexpMatches</strong></a>(self, text, unexpected_regexp, msg<font color=" #909090">=None</font>)</dt><dd><tt>Fail the test if the&nbsp ;text matches the regular expression.</tt></dd></dl>	210 <dl><dt><a name="PageMeasurementUnitTestBase-assertNotRegexpMatches"><strong>ass ertNotRegexpMatches</strong></a>(self, text, unexpected_regexp, msg<font color=" #909090">=None</font>)</dt><dd><tt>Fail the test if the&nbsp ;text matches the regular expression.</tt></dd></dl>

210	211

211 <dl><dt><a name="PageMeasurementUnitTestBase-assertRaises"><strong>assertRaises< /strong></a>(self, excClass, callableObj<font color="#909090">=None</font>, arg s, *kwargs)</dt><dd><tt>Fail unless an exception of cl ass excClass is thrown<br>	212 <dl><dt><a name="PageMeasurementUnitTestBase-assertRaises"><strong>assertRaises< /strong></a>(self, excClass, callableObj<font color="#909090">=None</font>, arg s, *kwargs)</dt><dd><tt>Fail unless an exception of cl ass excClass is raised<br>

212 by callableObj when invoked with arguments args&nb sp;and keyword<br>	213 by callableObj when invoked with arguments args&nb sp;and keyword<br>

213 arguments kwargs. If a different type of exce ption is<br>	214 arguments kwargs. If a different type of exce ption is<br>

214 thrown, it will not be caught, and the t est case will be<br>	215 raised, it will not be caught, and the t est case will be<br>

215 deemed to have suffered an error, exactly as& nbsp;for an<br>	216 deemed to have suffered an error, exactly as& nbsp;for an<br>

216 unexpected exception.<br>	217 unexpected exception.<br>

217  <br>	218  <br>

218 If called with callableObj omitted or None, w ill return a<br>	219 If called with callableObj omitted or None, w ill return a<br>

219 context object used like this::<br>	220 context object used like this::<br>

220  <br>	221  <br>

221      with <a href="#PageMeasurementUnitTestBase-as sertRaises">assertRaises</a>(SomeException):<br>	222      with <a href="#PageMeasurementUnitTestBase-as sertRaises">assertRaises</a>(SomeException):<br>

222          do_something()<br>	223          do_something()<br>

223  <br>	224  <br>

224 The context manager keeps a reference to the& nbsp;exception as<br>	225 The context manager keeps a reference to the& nbsp;exception as<br>

(...skipping 112 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
337 <hr>	338 <hr>

338 Data and other attributes inherited from <a href="unittest.case.html#TestCase">u nittest.case.TestCase</a>:<br>	339 Data and other attributes inherited from <a href="unittest.case.html#TestCase">u nittest.case.TestCase</a>:<br>

339 <dl><dt><strong>failureException</strong> = <type 'exceptions.AssertionError' ><dd><tt>Assertion failed.</tt></dl>	340 <dl><dt><strong>failureException</strong> = <type 'exceptions.AssertionError' ><dd><tt>Assertion failed.</tt></dl>

340	341

341 <dl><dt><strong>longMessage</strong> = False</dl>	342 <dl><dt><strong>longMessage</strong> = False</dl>

342	343

343 <dl><dt><strong>maxDiff</strong> = 640</dl>	344 <dl><dt><strong>maxDiff</strong> = 640</dl>

344	345

345 </td></tr></table></td></tr></table>	346 </td></tr></table></td></tr></table>

346 </body></html>	347 </body></html>

OLD	NEW