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

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

23 <a href="telemetry.core.discover.html">telemetry.core.discover</a><br>	23 <a href="telemetry.core.discover.html">telemetry.core.discover</a><br>

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

25 </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>

26 <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>

27 <a href="telemetry.page.page_test.html">telemetry.page.page_test</a><br>	27 <a href="telemetry.page.page_test.html">telemetry.page.page_test</a><br>

28 </td><td width="25%" valign=top><a href="telemetry.core.profile_types.html">tele metry.core.profile_types</a><br>	28 </td><td width="25%" valign=top><a href="sys.html">sys</a><br>

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

30 <a href="telemetry.test.html">telemetry.test</a><br>	29 <a href="telemetry.test.html">telemetry.test</a><br>

31 </td><td width="25%" valign=top></td></tr></table></td></tr></table><p>	30 </td></tr></table></td></tr></table><p>

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

33 <tr bgcolor="#ee77aa">	32 <tr bgcolor="#ee77aa">

34 <td colspan=3 valign=bottom> <br>	33 <td colspan=3 valign=bottom> <br>

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

36	35

37 <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td>  </td>	36 <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td>  </td>

38 <td width="100%"><dl>	37 <td width="100%"><dl>

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

40 </font></dt><dd>	39 </font></dt><dd>

41 <dl>	40 <dl>

42 <dt><font face="helvetica, arial"><a href="telemetry.page.page_test_runner.html# PageTestRunner">PageTestRunner</a>	41 <dt><font face="helvetica, arial"><a href="telemetry.page.page_test_runner.html# PageTestRunner">PageTestRunner</a>

43 </font></dt></dl>	42 </font></dt></dl>

44 </dd>	43 </dd>

45 </dl>	44 </dl>

46 <p>	45 <p>

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

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

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

50 <font color="#000000" face="helvetica, arial"><a name="PageTestRunner">class <st rong>PageTestRunner</strong></a>(<a href="__builtin__.html#object">__builtin__.o bject</a>)</font></td></tr>	49 <font color="#000000" face="helvetica, arial"><a name="PageTestRunner">class <st rong>PageTestRunner</strong></a>(<a href="__builtin__.html#object">__builtin__.o bject</a>)</font></td></tr>

51	50

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

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

54 <dl><dt><a name="PageTestRunner-FindTestConstructors"><strong>FindTestConstructo rs</strong></a>(self, base_dir)</dt></dl>	53 <dl><dt><a name="PageTestRunner-FindTestConstructors"><strong>FindTestConstructo rs</strong></a>(self, base_dirs)</dt></dl>

55	54

56 <dl><dt><a name="PageTestRunner-FindTestName"><strong>FindTestName</strong></a>( self, test_constructors, args)</dt><dd><tt>Find the test name&nbs p;in an arbitrary argument list.<br>	55 <dl><dt><a name="PageTestRunner-FindTestName"><strong>FindTestName</strong></a>( self, test_constructors, args)</dt><dd><tt>Find the test name&nbs p;in an arbitrary argument list.<br>

57  <br>	56  <br>

58 We can't use the optparse parser, because the  test may add its own<br>	57 We can't use the optparse parser, because the  test may add its own<br>

59 command-line options. If the user passed in a ny of those, the<br>	58 command-line options. If the user passed in a ny of those, the<br>

60 optparse parsing will fail.<br>	59 optparse parsing will fail.<br>

61  <br>	60  <br>

62 Returns:<br>	61 Returns:<br>

63   test_name or None</tt></dd></dl>	62   test_name or None</tt></dd></dl>

64	63

65 <dl><dt><a name="PageTestRunner-GetModernizedTestName"><strong>GetModernizedTest Name</strong></a>(self, arg)</dt><dd><tt>Sometimes tests change n ames but buildbots keep calling the old name. <br>	64 <dl><dt><a name="PageTestRunner-GetPageSet"><strong>GetPageSet</strong></a>(self , test, env)</dt></dl>

66  <br>

67 If arg matches an old test name, return  the new test name instead.<br>

68 Otherwise, return the arg.</tt></dd></dl>

69	65

70 <dl><dt><a name="PageTestRunner-GetPageSet"><strong>GetPageSet</strong></a>(self , test, page_set_filenames)</dt></dl>	66 <dl><dt><a name="PageTestRunner-ParseCommandLine"><strong>ParseCommandLine</stro ng></a>(self, args, env)</dt></dl>

71

72 <dl><dt><a name="PageTestRunner-ParseCommandLine"><strong>ParseCommandLine</stro ng></a>(self, args, base_dir, page_set_filenames)</dt></dl>

73	67

74 <dl><dt><a name="PageTestRunner-PrintParseError"><strong>PrintParseError</strong ></a>(self, message)</dt></dl>	68 <dl><dt><a name="PageTestRunner-PrintParseError"><strong>PrintParseError</strong ></a>(self, message)</dt></dl>

75	69

76 <dl><dt><a name="PageTestRunner-Run"><strong>Run</strong></a>(self, base_dir, pa ge_set_filenames)</dt></dl>	70 <dl><dt><a name="PageTestRunner-Run"><strong>Run</strong></a>(self, env)</dt></d l>

77	71

78 <dl><dt><a name="PageTestRunner-__init__"><strong>__init__</strong></a>(self)</d t></dl>	72 <dl><dt><a name="PageTestRunner-__init__"><strong>__init__</strong></a>(self)</d t></dl>

79	73

80 <hr>	74 <hr>

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

82 <dl><dt><strong>__dict__</strong></dt>	76 <dl><dt><strong>__dict__</strong></dt>

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

84 </dl>	78 </dl>

85 <dl><dt><strong>__weakref__</strong></dt>	79 <dl><dt><strong>__weakref__</strong></dt>

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

87 </dl>	81 </dl>

88 <dl><dt><strong>test_class</strong></dt>	82 <dl><dt><strong>test_class</strong></dt>

89 </dl>	83 </dl>

90 <dl><dt><strong>test_class_name</strong></dt>	84 <dl><dt><strong>test_class_name</strong></dt>

91 </dl>	85 </dl>

92 </td></tr></table></td></tr></table><p>	86 </td></tr></table></td></tr></table><p>

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

94 <tr bgcolor="#eeaa77">	88 <tr bgcolor="#eeaa77">

95 <td colspan=3 valign=bottom> <br>	89 <td colspan=3 valign=bottom> <br>

96 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></b ig></font></td></tr>	90 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></b ig></font></td></tr>

97	91

98 <tr><td bgcolor="#eeaa77"><tt>      </tt></td><td>  </td>	92 <tr><td bgcolor="#eeaa77"><tt>      </tt></td><td>  </td>

99 <td width="100%"><dl><dt><a name="-Main"><strong>Main</strong></a>(base_dir, pag e_set_filenames)</dt><dd><tt>Turns a PageTest into a co mmand-line program.<br>	93 <td width="100%"><dl><dt><a name="-Main"><strong>Main</strong></a>(env)</dt><dd> <tt>Turns a PageTest into a command-line program.< br>

100  <br>	94  <br>

101 Args:<br>	95 Args:<br>

102   base_dir: Path to directory containing test s and ProfileCreators.</tt></dd></dl>	96   base_dir: Path to directory containing test s and ProfileCreators.</tt></dd></dl>

103 </td></tr></table>	97 </td></tr></table>

104 </body></html>	98 </body></html>

OLD	NEW