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

Side by Side Diff: tools/telemetry/docs/telemetry.test.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

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.test</title>	3 <html><head><title>Python: module telemetry.test</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>.test</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>.test</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/test.py">telemetry/test.py</a></font></td></tr></table>	11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href= "../telemetry/test.py">telemetry/test.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_runner.html">telemetry.page.page_runner</a><br>	22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t op><a href="telemetry.core.browser_finder.html">telemetry.core.browser_finder</a ><br>

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

	24 <a href="telemetry.core.command_line.html">telemetry.core.command_line</a><br>

	25 <a href="telemetry.decorators.html">telemetry.decorators</a><br>

	26 </td><td width="25%" valign=top><a href="logging.html">logging</a><br>

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

	28 <a href="os.html">os</a><br>

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

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

24 </td><td width="25%" valign=top><a href="telemetry.page.page_test.html">telemetr y.page.page_test</a><br>	31 <a href="telemetry.page.page_test.html">telemetry.page.page_test</a><br>

25 </td><td width="25%" valign=top></td></tr></table></td></tr></table><p>	32 <a href="shutil.html">shutil</a><br>

	33 <a href="sys.html">sys</a><br>

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

	35 <a href="telemetry.core.util.html">telemetry.core.util</a><br>

	36 <a href="zipfile.html">zipfile</a><br>

	37 </td></tr></table></td></tr></table><p>

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

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

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

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

30	42

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

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

33 <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__. object</a>	45 <dt><font face="helvetica, arial"><a href="telemetry.core.command_line.html#Comm and">telemetry.core.command_line.Command</a>(<a href="telemetry.core.command_lin e.html#ArgumentHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a >)

34 </font></dt><dd>	46 </font></dt><dd>

35 <dl>	47 <dl>

36 <dt><font face="helvetica, arial"><a href="telemetry.test.html#Test">Test</a>	48 <dt><font face="helvetica, arial"><a href="telemetry.test.html#Test">Test</a>

37 </font></dt></dl>	49 </font></dt></dl>

38 </dd>	50 </dd>

39 </dl>	51 </dl>

40 <p>	52 <p>

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

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

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

44 <font color="#000000" face="helvetica, arial"><a name="Test">class <strong>Test< /strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></t d></tr>	56 <font color="#000000" face="helvetica, arial"><a name="Test">class <strong>Test< /strong></a>(<a href="telemetry.core.command_line.html#Command">telemetry.core.c ommand_line.Command</a>)</font></td></tr>

45	57

46 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>	58 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>

47 <td colspan=2><tt>Base class for a Telemetry test  or benchmark.<br>	59 <td colspan=2><tt>Base class for a Telemetry test  or benchmark.<br>

48  <br>	60  <br>

49 A test packages a PageTest/PageMeasurement and a&n bsp;PageSet together.<br> </tt></td></tr>	61 A test packages a PageTest/PageMeasurement and a&n bsp;PageSet together.<br> </tt></td></tr>

50 <tr><td> </td>	62 <tr><td> </td>

51 <td width="100%">Methods defined here:<br>	63 <td width="100%"><dl><dt>Method resolution order:</dt>

52 <dl><dt><a name="Test-CreatePageSet"><strong>CreatePageSet</strong></a>(self, op tions)</dt><dd><tt>Get the page set this test will  run on.<br>	64 <dd><a href="telemetry.test.html#Test">Test</a></dd>

	65 <dd><a href="telemetry.core.command_line.html#Command">telemetry.core.command_li ne.Command</a></dd>

	66 <dd><a href="telemetry.core.command_line.html#ArgumentHandlerMixIn">telemetry.co re.command_line.ArgumentHandlerMixIn</a></dd>

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

	68 </dl>

	69 <hr>

	70 Methods defined here:<br>

	71 <dl><dt><a name="Test-CustomizeBrowserOptions"><strong>CustomizeBrowserOptions</ strong></a>(self, options)</dt><dd><tt>Add browser options that&n bsp;are required by this benchmark.</tt></dd></dl>

	72

	73 <dl><dt><a name="Test-Run"><strong>Run</strong></a>(self, args)</dt><dd><tt>Run& nbsp;this test with the given options.</tt></dd></dl>

	74

	75 <hr>

	76 Class methods defined here:<br>

	77 <dl><dt><a name="Test-AddCommandLineArgs"><strong>AddCommandLineArgs</strong></a >(cls, parser)<font color="#909090"><font face="helvetica, arial"> from <a href= "__builtin__.html#type">__builtin__.type</a></font></font></dt></dl>

	78

	79 <dl><dt><a name="Test-CreateExpectations"><strong>CreateExpectations</strong></a >(cls, ps)<font color="#909090"><font face="helvetica, arial"> from <a href="__b uiltin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Get the& nbsp;expectations this test will run with.<br>

	80  <br>

	81 By default, it will create an empty expectati ons set. Override to generate<br>

	82 custom expectations.</tt></dd></dl>

	83

	84 <dl><dt><a name="Test-CreatePageSet"><strong>CreatePageSet</strong></a>(cls, opt ions)<font color="#909090"><font face="helvetica, arial"> from <a href="__builti n__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Get the  page set this test will run on.<br>

53  <br>	85  <br>

54 By default, it will create a page set fr om the file at this test's<br>	86 By default, it will create a page set fr om the file at this test's<br>

55 page_set attribute. Override to generate a custom& nbsp;page set.</tt></dd></dl>	87 page_set attribute. Override to generate a custom& nbsp;page set.</tt></dd></dl>

56	88

57 <dl><dt><a name="Test-Run"><strong>Run</strong></a>(self, options)</dt><dd><tt>R un this test with the given options.</tt></dd></dl >	89 <dl><dt><a name="Test-Name"><strong>Name</strong></a>(cls)<font color="#909090"> <font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__. type</a></font></font></dt></dl>

	90

	91 <dl><dt><a name="Test-PageTestClass"><strong>PageTestClass</strong></a>(cls)<fon t color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html# type">__builtin__.type</a></font></font></dt><dd><tt>Get the PageTest& nbsp;for this <a href="#Test">Test</a>.<br>

	92  <br>

	93 If the <a href="#Test">Test</a> has no PageTest, r aises NotImplementedError.</tt></dd></dl>

	94

	95 <dl><dt><a name="Test-ProcessCommandLineArgs"><strong>ProcessCommandLineArgs</st rong></a>(cls, parser, args)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></d l>

58	96

59 <hr>	97 <hr>

60 Data descriptors defined here:<br>	98 Data and other attributes defined here:<br>

	99 <dl><dt><strong>options</strong> = {}</dl>

	100

	101 <hr>

	102 Class methods inherited from <a href="telemetry.core.command_line.html#Command"> telemetry.core.command_line.Command</a>:<br>

	103 <dl><dt><a name="Test-Description"><strong>Description</strong></a>(cls)<font co lor="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type ">__builtin__.type</a></font></font></dt></dl>

	104

	105 <hr>

	106 Data descriptors inherited from <a href="telemetry.core.command_line.html#Argume ntHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a>:<br>

61 <dl><dt><strong>__dict__</strong></dt>	107 <dl><dt><strong>__dict__</strong></dt>

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

63 </dl>	109 </dl>

64 <dl><dt><strong>__weakref__</strong></dt>	110 <dl><dt><strong>__weakref__</strong></dt>

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

66 </dl>	112 </dl>

67 <hr>	113 </td></tr></table></td></tr></table><p>

68 Data and other attributes defined here:<br>	114 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

69 <dl><dt><strong>enabled</strong> = True</dl>	115 <tr bgcolor="#eeaa77">

70	116 <td colspan=3 valign=bottom> <br>

71 <dl><dt><strong>options</strong> = {}</dl>	117 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></b ig></font></td></tr>

72	118

73 </td></tr></table></td></tr></table>	119 <tr><td bgcolor="#eeaa77"><tt>      </tt></td><td>  </td>

	120 <td width="100%"><dl><dt><a name="-AddCommandLineArgs"><strong>AddCommandLineArg s</strong></a>(parser)</dt></dl>

	121 <dl><dt><a name="-ProcessCommandLineArgs"><strong>ProcessCommandLineArgs</stron g></a>(parser, args)</dt></dl>

	122 </td></tr></table>

74 </body></html>	123 </body></html>

OLD	NEW

« no previous file with comments | « tools/telemetry/docs/telemetry.page.record_wpr.html ('k') | tools/telemetry/docs/telemetry.test_runner.html » ('j') | no next file with comments »