Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(227)

Side by Side Diff: tools/telemetry/docs/telemetry.page.record_wpr.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
OLDNEW
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.record_wpr</title> 3 <html><head><title>Python: module telemetry.page.record_wpr</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>&nbsp;<br> 8 <td valign=bottom>&nbsp;<br>
9 <font color="#ffffff" face="helvetica, arial">&nbsp;<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>.record_wpr</strong></big></big ></font></td 9 <font color="#ffffff" face="helvetica, arial">&nbsp;<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>.record_wpr</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/record_wpr.py">telemetry/page/record_wpr.py</a></font></td></ tr></table> 11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href= "../telemetry/page/record_wpr.py">telemetry/page/record_wpr.py</a></font></td></ tr></table>
12 <p><tt>#&nbsp;Copyright&nbsp;(c)&nbsp;2012&nbsp;The&nbsp;Chromium&nbsp;Autho rs.&nbsp;All&nbsp;rights&nbsp;reserved.<br> 12 <p><tt>#&nbsp;Copyright&nbsp;(c)&nbsp;2012&nbsp;The&nbsp;Chromium&nbsp;Autho rs.&nbsp;All&nbsp;rights&nbsp;reserved.<br>
13 #&nbsp;Use&nbsp;of&nbsp;this&nbsp;source&nbsp;code&nbsp;is&nbsp;governed&nbsp;by &nbsp;a&nbsp;BSD-style&nbsp;license&nbsp;that&nbsp;can&nbsp;be<br> 13 #&nbsp;Use&nbsp;of&nbsp;this&nbsp;source&nbsp;code&nbsp;is&nbsp;governed&nbsp;by &nbsp;a&nbsp;BSD-style&nbsp;license&nbsp;that&nbsp;can&nbsp;be<br>
14 #&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;file.</tt></p> 14 #&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;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>&nbsp;<br> 18 <td colspan=3 valign=bottom>&nbsp;<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>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</td> 21 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</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="json.html">json</a><br>
24 <a href="logging.html">logging</a><br> 25 <a href="logging.html">logging</a><br>
25 <a href="os.html">os</a><br> 26 <a href="os.html">os</a><br>
26 </td><td width="25%" valign=top><a href="telemetry.page.page_measurement.html">t elemetry.page.page_measurement</a><br> 27 </td><td width="25%" valign=top><a href="telemetry.page.page_measurement.html">t elemetry.page.page_measurement</a><br>
28 <a href="telemetry.page.page_measurement_results.html">telemetry.page.page_measu rement_results</a><br>
27 <a href="telemetry.page.page_runner.html">telemetry.page.page_runner</a><br> 29 <a href="telemetry.page.page_runner.html">telemetry.page.page_runner</a><br>
28 <a href="telemetry.page.page_set.html">telemetry.page.page_set</a><br> 30 <a href="telemetry.page.page_set.html">telemetry.page.page_set</a><br>
29 <a href="telemetry.page.page_test.html">telemetry.page.page_test</a><br> 31 <a href="telemetry.page.page_test.html">telemetry.page.page_test</a><br>
30 </td><td width="25%" valign=top><a href="sys.html">sys</a><br> 32 </td><td width="25%" valign=top><a href="telemetry.page.profile_creator.html">te lemetry.page.profile_creator</a><br>
33 <a href="sys.html">sys</a><br>
31 <a href="tempfile.html">tempfile</a><br> 34 <a href="tempfile.html">tempfile</a><br>
32 <a href="telemetry.test.html">telemetry.test</a><br> 35 <a href="telemetry.test.html">telemetry.test</a><br>
33 <a href="time.html">time</a><br> 36 <a href="telemetry.page.test_expectations.html">telemetry.page.test_expectations </a><br>
34 </td><td width="25%" valign=top><a href="telemetry.core.wpr_modes.html">telemetr y.core.wpr_modes</a><br> 37 </td><td width="25%" valign=top><a href="time.html">time</a><br>
38 <a href="urlparse.html">urlparse</a><br>
39 <a href="telemetry.core.util.html">telemetry.core.util</a><br>
40 <a href="telemetry.core.wpr_modes.html">telemetry.core.wpr_modes</a><br>
35 </td></tr></table></td></tr></table><p> 41 </td></tr></table></td></tr></table><p>
36 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 42 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
37 <tr bgcolor="#ee77aa"> 43 <tr bgcolor="#ee77aa">
38 <td colspan=3 valign=bottom>&nbsp;<br> 44 <td colspan=3 valign=bottom>&nbsp;<br>
39 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big ></font></td></tr> 45 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big ></font></td></tr>
40 46
41 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</td> 47 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</td>
42 <td width="100%"><dl> 48 <td width="100%"><dl>
43 <dt><font face="helvetica, arial"><a href="telemetry.page.page_test.html#PageTes t">telemetry.page.page_test.PageTest</a>(<a href="__builtin__.html#object">__bui ltin__.object</a>) 49 <dt><font face="helvetica, arial"><a href="telemetry.page.page_test.html#PageTes t">telemetry.page.page_test.PageTest</a>(<a href="telemetry.core.command_line.ht ml#ArgumentHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a>)
44 </font></dt><dd> 50 </font></dt><dd>
45 <dl> 51 <dl>
46 <dt><font face="helvetica, arial"><a href="telemetry.page.record_wpr.html#Record Page">RecordPage</a> 52 <dt><font face="helvetica, arial"><a href="telemetry.page.record_wpr.html#Record Page">RecordPage</a>
47 </font></dt></dl> 53 </font></dt></dl>
48 </dd> 54 </dd>
49 </dl> 55 </dl>
50 <p> 56 <p>
51 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 57 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
52 <tr bgcolor="#ffc8d8"> 58 <tr bgcolor="#ffc8d8">
53 <td colspan=3 valign=bottom>&nbsp;<br> 59 <td colspan=3 valign=bottom>&nbsp;<br>
54 <font color="#000000" face="helvetica, arial"><a name="RecordPage">class <strong >RecordPage</strong></a>(<a href="telemetry.page.page_test.html#PageTest">teleme try.page.page_test.PageTest</a>)</font></td></tr> 60 <font color="#000000" face="helvetica, arial"><a name="RecordPage">class <strong >RecordPage</strong></a>(<a href="telemetry.page.page_test.html#PageTest">teleme try.page.page_test.PageTest</a>)</font></td></tr>
55 61
56 <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td> 62 <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
57 <td width="100%"><dl><dt>Method resolution order:</dt> 63 <td width="100%"><dl><dt>Method resolution order:</dt>
58 <dd><a href="telemetry.page.record_wpr.html#RecordPage">RecordPage</a></dd> 64 <dd><a href="telemetry.page.record_wpr.html#RecordPage">RecordPage</a></dd>
59 <dd><a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.Pa geTest</a></dd> 65 <dd><a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.Pa geTest</a></dd>
66 <dd><a href="telemetry.core.command_line.html#ArgumentHandlerMixIn">telemetry.co re.command_line.ArgumentHandlerMixIn</a></dd>
60 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> 67 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
61 </dl> 68 </dl>
62 <hr> 69 <hr>
63 Methods defined here:<br> 70 Methods defined here:<br>
64 <dl><dt><a name="RecordPage-CanRunForPage"><strong>CanRunForPage</strong></a>(se lf, page)</dt></dl> 71 <dl><dt><a name="RecordPage-CanRunForPage"><strong>CanRunForPage</strong></a>(se lf, page)</dt></dl>
65 72
66 <dl><dt><a name="RecordPage-CustomizeBrowserOptionsForPage"><strong>CustomizeBro wserOptionsForPage</strong></a>(self, page, options)</dt></dl> 73 <dl><dt><a name="RecordPage-CustomizeBrowserOptionsForPageSet"><strong>Customize BrowserOptionsForPageSet</strong></a>(self, pset, options)</dt></dl>
67 74
68 <dl><dt><a name="RecordPage-Run"><strong>Run</strong></a>(self, options, page, t ab, results)</dt></dl> 75 <dl><dt><a name="RecordPage-DidNavigateToPage"><strong>DidNavigateToPage</strong ></a>(self, page, tab)</dt><dd><tt>Forward&nbsp;the&nbsp;call&nbsp;to&nbsp;the&n bsp;test.</tt></dd></dl>
76
77 <dl><dt><a name="RecordPage-Run"><strong>Run</strong></a>(self, page, tab, resul ts)</dt></dl>
78
79 <dl><dt><a name="RecordPage-WillNavigateToPage"><strong>WillNavigateToPage</stro ng></a>(self, page, tab)</dt><dd><tt>Override&nbsp;to&nbsp;ensure&nbsp;all&nbsp; resources&nbsp;are&nbsp;fetched&nbsp;from&nbsp;network.</tt></dd></dl>
69 80
70 <dl><dt><a name="RecordPage-__init__"><strong>__init__</strong></a>(self, measur ements)</dt></dl> 81 <dl><dt><a name="RecordPage-__init__"><strong>__init__</strong></a>(self, measur ements)</dt></dl>
71 82
72 <hr> 83 <hr>
73 Methods inherited from <a href="telemetry.page.page_test.html#PageTest">telemetr y.page.page_test.PageTest</a>:<br> 84 Methods inherited from <a href="telemetry.page.page_test.html#PageTest">telemetr y.page.page_test.PageTest</a>:<br>
74 <dl><dt><a name="RecordPage-AddCommandLineOptions"><strong>AddCommandLineOptions </strong></a>(self, parser)</dt><dd><tt>Override&nbsp;to&nbsp;expose&nbsp;comman d-line&nbsp;options&nbsp;for&nbsp;this&nbsp;test.<br> 85 <dl><dt><a name="RecordPage-CleanUpAfterPage"><strong>CleanUpAfterPage</strong>< /a>(self, page, tab)</dt><dd><tt>Called&nbsp;after&nbsp;the&nbsp;test&nbsp;run&n bsp;method&nbsp;was&nbsp;run,&nbsp;even&nbsp;if&nbsp;it&nbsp;failed.</tt></dd></ dl>
75 &nbsp;<br>
76 The&nbsp;provided&nbsp;parser&nbsp;is&nbsp;an&nbsp;optparse.OptionParser&nbsp;in stance&nbsp;and&nbsp;accepts&nbsp;all<br>
77 normal&nbsp;results.&nbsp;The&nbsp;parsed&nbsp;options&nbsp;are&nbsp;available&n bsp;in&nbsp;Run&nbsp;as<br>
78 self.<strong>options</strong>.</tt></dd></dl>
79 86
80 <dl><dt><a name="RecordPage-AddOutputOptions"><strong>AddOutputOptions</strong>< /a>(self, parser)</dt></dl> 87 <dl><dt><a name="RecordPage-CreateExpectations"><strong>CreateExpectations</stro ng></a>(self, page_set)</dt><dd><tt>Override&nbsp;to&nbsp;make&nbsp;this&nbsp;te st&nbsp;generate&nbsp;its&nbsp;own&nbsp;expectations&nbsp;instead&nbsp;of<br>
88 any&nbsp;that&nbsp;may&nbsp;have&nbsp;been&nbsp;defined&nbsp;in&nbsp;the&nbsp;pa ge&nbsp;set.</tt></dd></dl>
81 89
82 <dl><dt><a name="RecordPage-CreatePageSet"><strong>CreatePageSet</strong></a>(se lf, args, options)</dt><dd><tt>Override&nbsp;to&nbsp;make&nbsp;this&nbsp;test&nb sp;generate&nbsp;its&nbsp;own&nbsp;page&nbsp;set&nbsp;instead&nbsp;of<br> 90 <dl><dt><a name="RecordPage-CreatePageSet"><strong>CreatePageSet</strong></a>(se lf, args, options)</dt><dd><tt>Override&nbsp;to&nbsp;make&nbsp;this&nbsp;test&nb sp;generate&nbsp;its&nbsp;own&nbsp;page&nbsp;set&nbsp;instead&nbsp;of<br>
83 allowing&nbsp;arbitrary&nbsp;page&nbsp;sets&nbsp;entered&nbsp;from&nbsp;the&nbsp ;command-line.</tt></dd></dl> 91 allowing&nbsp;arbitrary&nbsp;page&nbsp;sets&nbsp;entered&nbsp;from&nbsp;the&nbsp ;command-line.</tt></dd></dl>
84 92
85 <dl><dt><a name="RecordPage-CustomizeBrowserOptions"><strong>CustomizeBrowserOpt ions</strong></a>(self, options)</dt><dd><tt>Override&nbsp;to&nbsp;add&nbsp;test -specific&nbsp;options&nbsp;to&nbsp;the&nbsp;BrowserOptions&nbsp;object</tt></dd ></dl> 93 <dl><dt><a name="RecordPage-CustomizeBrowserOptions"><strong>CustomizeBrowserOpt ions</strong></a>(self, options)</dt><dd><tt>Override&nbsp;to&nbsp;add&nbsp;test -specific&nbsp;options&nbsp;to&nbsp;the&nbsp;BrowserOptions&nbsp;object</tt></dd ></dl>
86 94
87 <dl><dt><a name="RecordPage-DidNavigateToPage"><strong>DidNavigateToPage</strong ></a>(self, page, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp ;right&nbsp;after&nbsp;the&nbsp;page&nbsp;is&nbsp;navigated,&nbsp;but&nbsp;befor e<br> 95 <dl><dt><a name="RecordPage-CustomizeBrowserOptionsForSinglePage"><strong>Custom izeBrowserOptionsForSinglePage</strong></a>(self, page, options)</dt><dd><tt>Set &nbsp;options&nbsp;specific&nbsp;to&nbsp;the&nbsp;test&nbsp;and&nbsp;the&nbsp;gi ven&nbsp;page.<br>
88 any&nbsp;waiting&nbsp;for&nbsp;completion&nbsp;has&nbsp;occurred.</tt></dd></dl> 96 &nbsp;<br>
97 This&nbsp;will&nbsp;be&nbsp;called&nbsp;with&nbsp;the&nbsp;current&nbsp;page&nbs p;when&nbsp;the&nbsp;browser&nbsp;is&nbsp;(re)started.<br>
98 Changing&nbsp;options&nbsp;at&nbsp;this&nbsp;point&nbsp;only&nbsp;makes&nbsp;sen se&nbsp;if&nbsp;the&nbsp;browser&nbsp;is&nbsp;being<br>
99 restarted&nbsp;for&nbsp;each&nbsp;page.&nbsp;Note&nbsp;that&nbsp;if&nbsp;page&nb sp;has&nbsp;a&nbsp;startup_url,&nbsp;the&nbsp;browser<br>
100 will&nbsp;always&nbsp;be&nbsp;restarted&nbsp;for&nbsp;each&nbsp;run.</tt></dd></ dl>
89 101
90 <dl><dt><a name="RecordPage-DidRunAction"><strong>DidRunAction</strong></a>(self , page, tab, action)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;a fter&nbsp;running&nbsp;the&nbsp;action&nbsp;on&nbsp;the&nbsp;page.</tt></dd></dl > 102 <dl><dt><a name="RecordPage-DidRunAction"><strong>DidRunAction</strong></a>(self , page, tab, action)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;a fter&nbsp;running&nbsp;the&nbsp;action&nbsp;on&nbsp;the&nbsp;page.</tt></dd></dl >
91 103
92 <dl><dt><a name="RecordPage-DidRunPageSet"><strong>DidRunPageSet</strong></a>(se lf, tab, results)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;afte r&nbsp;page&nbsp;set&nbsp;is&nbsp;completed,&nbsp;but&nbsp;before&nbsp;browser<b r> 104 <dl><dt><a name="RecordPage-DidRunActions"><strong>DidRunActions</strong></a>(se lf, page, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;after&n bsp;running&nbsp;the&nbsp;actions&nbsp;on&nbsp;the&nbsp;page.</tt></dd></dl>
93 is&nbsp;torn&nbsp;down.</tt></dd></dl> 105
106 <dl><dt><a name="RecordPage-DidRunPageRepeats"><strong>DidRunPageRepeats</strong ></a>(self, page)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;afte r&nbsp;each&nbsp;page&nbsp;is&nbsp;iterated&nbsp;over.</tt></dd></dl>
107
108 <dl><dt><a name="RecordPage-DidRunTest"><strong>DidRunTest</strong></a>(self, br owser, results)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;after& nbsp;all&nbsp;page&nbsp;set(s)&nbsp;are&nbsp;completed.<br>
109 &nbsp;<br>
110 This&nbsp;will&nbsp;occur&nbsp;before&nbsp;the&nbsp;browser&nbsp;is&nbsp;torn&nb sp;down.</tt></dd></dl>
111
112 <dl><dt><a name="RecordPage-DidStartBrowser"><strong>DidStartBrowser</strong></a >(self, browser)</dt><dd><tt>Override&nbsp;to&nbsp;customize&nbsp;the&nbsp;brows er&nbsp;right&nbsp;after&nbsp;it&nbsp;has&nbsp;launched.</tt></dd></dl>
94 113
95 <dl><dt><a name="RecordPage-DidStartHTTPServer"><strong>DidStartHTTPServer</stro ng></a>(self, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;aft er&nbsp;the&nbsp;HTTP&nbsp;server&nbsp;is&nbsp;started.</tt></dd></dl> 114 <dl><dt><a name="RecordPage-DidStartHTTPServer"><strong>DidStartHTTPServer</stro ng></a>(self, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;aft er&nbsp;the&nbsp;HTTP&nbsp;server&nbsp;is&nbsp;started.</tt></dd></dl>
96 115
97 <dl><dt><a name="RecordPage-NeedsBrowserRestartAfterEachRun"><strong>NeedsBrowse rRestartAfterEachRun</strong></a>(self, tab)</dt><dd><tt>Override&nbsp;to&nbsp;s pecify&nbsp;browser&nbsp;restart&nbsp;after&nbsp;each&nbsp;run.</tt></dd></dl> 116 <dl><dt><a name="RecordPage-IsExiting"><strong>IsExiting</strong></a>(self)</dt> </dl>
98 117
99 <dl><dt><a name="RecordPage-PrepareResults"><strong>PrepareResults</strong></a>( self, options)</dt></dl> 118 <dl><dt><a name="RecordPage-RequestExit"><strong>RequestExit</strong></a>(self)< /dt></dl>
100 119
101 <dl><dt><a name="RecordPage-SetUpBrowser"><strong>SetUpBrowser</strong></a>(self , browser)</dt><dd><tt>Override&nbsp;to&nbsp;customize&nbsp;the&nbsp;browser&nbs p;right&nbsp;after&nbsp;it&nbsp;has&nbsp;launched.</tt></dd></dl> 120 <dl><dt><a name="RecordPage-RestartBrowserBeforeEachPage"><strong>RestartBrowser BeforeEachPage</strong></a>(self)</dt><dd><tt>Should&nbsp;the&nbsp;browser&nbsp; be&nbsp;restarted&nbsp;for&nbsp;the&nbsp;page?<br>
121 &nbsp;<br>
122 This&nbsp;returns&nbsp;true&nbsp;if&nbsp;the&nbsp;test&nbsp;needs&nbsp;to&nbsp;u nconditionally&nbsp;restart&nbsp;the<br>
123 browser&nbsp;for&nbsp;each&nbsp;page.&nbsp;It&nbsp;may&nbsp;be&nbsp;called&nbsp; before&nbsp;the&nbsp;browser&nbsp;is&nbsp;started.</tt></dd></dl>
102 124
103 <dl><dt><a name="RecordPage-WillNavigateToPage"><strong>WillNavigateToPage</stro ng></a>(self, page, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nb sp;before&nbsp;the&nbsp;page&nbsp;is&nbsp;navigated.</tt></dd></dl> 125 <dl><dt><a name="RecordPage-RunNavigateSteps"><strong>RunNavigateSteps</strong>< /a>(self, page, tab)</dt><dd><tt>Navigates&nbsp;the&nbsp;tab&nbsp;to&nbsp;the&nb sp;page&nbsp;URL&nbsp;attribute.<br>
126 &nbsp;<br>
127 Runs&nbsp;the&nbsp;'navigate_steps'&nbsp;page&nbsp;attribute&nbsp;as&nbsp;a&nbsp ;compound&nbsp;action.</tt></dd></dl>
128
129 <dl><dt><a name="RecordPage-StopBrowserAfterPage"><strong>StopBrowserAfterPage</ strong></a>(self, browser, page)</dt><dd><tt>Should&nbsp;the&nbsp;browser&nbsp;b e&nbsp;stopped&nbsp;after&nbsp;the&nbsp;page&nbsp;is&nbsp;run?<br>
130 &nbsp;<br>
131 This&nbsp;is&nbsp;called&nbsp;after&nbsp;a&nbsp;page&nbsp;is&nbsp;run&nbsp;to&nb sp;decide&nbsp;whether&nbsp;the&nbsp;browser&nbsp;needs&nbsp;to<br>
132 be&nbsp;stopped&nbsp;to&nbsp;clean&nbsp;up&nbsp;its&nbsp;state.&nbsp;If&nbsp;it& nbsp;is&nbsp;stopped,&nbsp;then&nbsp;it&nbsp;will&nbsp;be<br>
133 restarted&nbsp;to&nbsp;run&nbsp;the&nbsp;next&nbsp;page.<br>
134 &nbsp;<br>
135 A&nbsp;test&nbsp;that&nbsp;overrides&nbsp;this&nbsp;can&nbsp;look&nbsp;at&nbsp;b oth&nbsp;the&nbsp;page&nbsp;and&nbsp;the&nbsp;browser&nbsp;to<br>
136 decide&nbsp;whether&nbsp;it&nbsp;needs&nbsp;to&nbsp;stop&nbsp;the&nbsp;browser.< /tt></dd></dl>
137
138 <dl><dt><a name="RecordPage-TabForPage"><strong>TabForPage</strong></a>(self, pa ge, browser)</dt><dd><tt>Override&nbsp;to&nbsp;select&nbsp;a&nbsp;different&nbsp ;tab&nbsp;for&nbsp;the&nbsp;page.&nbsp;&nbsp;For&nbsp;instance,&nbsp;to<br>
139 create&nbsp;a&nbsp;new&nbsp;tab&nbsp;for&nbsp;every&nbsp;page,&nbsp;return&nbsp; browser.tabs.New().</tt></dd></dl>
140
141 <dl><dt><a name="RecordPage-ValidatePageSet"><strong>ValidatePageSet</strong></a >(self, page_set)</dt><dd><tt>Override&nbsp;to&nbsp;examine&nbsp;the&nbsp;page&n bsp;set&nbsp;before&nbsp;the&nbsp;test&nbsp;run.&nbsp;&nbsp;Useful&nbsp;for<br>
142 example&nbsp;to&nbsp;validate&nbsp;that&nbsp;the&nbsp;pageset&nbsp;can&nbsp;be&n bsp;used&nbsp;with&nbsp;the&nbsp;test.</tt></dd></dl>
104 143
105 <dl><dt><a name="RecordPage-WillRunAction"><strong>WillRunAction</strong></a>(se lf, page, tab, action)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp ;before&nbsp;running&nbsp;the&nbsp;action&nbsp;on&nbsp;the&nbsp;page.</tt></dd>< /dl> 144 <dl><dt><a name="RecordPage-WillRunAction"><strong>WillRunAction</strong></a>(se lf, page, tab, action)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp ;before&nbsp;running&nbsp;the&nbsp;action&nbsp;on&nbsp;the&nbsp;page.</tt></dd>< /dl>
106 145
107 <dl><dt><a name="RecordPage-WillRunPageSet"><strong>WillRunPageSet</strong></a>( self, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;before&nbsp ;the&nbsp;page&nbsp;set&nbsp;is&nbsp;navigated.</tt></dd></dl> 146 <dl><dt><a name="RecordPage-WillRunActions"><strong>WillRunActions</strong></a>( self, page, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;befor e&nbsp;running&nbsp;the&nbsp;actions&nbsp;on&nbsp;the&nbsp;page.</tt></dd></dl>
147
148 <dl><dt><a name="RecordPage-WillRunPageRepeats"><strong>WillRunPageRepeats</stro ng></a>(self, page)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;be fore&nbsp;each&nbsp;page&nbsp;is&nbsp;iterated&nbsp;over.</tt></dd></dl>
149
150 <dl><dt><a name="RecordPage-WillRunTest"><strong>WillRunTest</strong></a>(self, options)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;before&nbsp;t he&nbsp;page&nbsp;set(s)&nbsp;are&nbsp;navigated.</tt></dd></dl>
151
152 <dl><dt><a name="RecordPage-WillStartBrowser"><strong>WillStartBrowser</strong>< /a>(self, browser)</dt><dd><tt>Override&nbsp;to&nbsp;manipulate&nbsp;the&nbsp;br owser&nbsp;environment&nbsp;before&nbsp;it&nbsp;launches.</tt></dd></dl>
108 153
109 <hr> 154 <hr>
110 Data descriptors inherited from <a href="telemetry.page.page_test.html#PageTest" >telemetry.page.page_test.PageTest</a>:<br> 155 Data descriptors inherited from <a href="telemetry.page.page_test.html#PageTest" >telemetry.page.page_test.PageTest</a>:<br>
156 <dl><dt><strong>action_name_to_run</strong></dt>
157 </dl>
158 <dl><dt><strong>attempts</strong></dt>
159 <dd><tt>Maximum&nbsp;number&nbsp;of&nbsp;times&nbsp;test&nbsp;will&nbsp;be&nbsp; attempted.</tt></dd>
160 </dl>
161 <dl><dt><strong>clear_cache_before_each_run</strong></dt>
162 <dd><tt>When&nbsp;set&nbsp;to&nbsp;True,&nbsp;the&nbsp;browser's&nbsp;disk&nbsp; and&nbsp;memory&nbsp;cache&nbsp;will&nbsp;be&nbsp;cleared<br>
163 before&nbsp;each&nbsp;run.</tt></dd>
164 </dl>
165 <dl><dt><strong>close_tabs_before_run</strong></dt>
166 <dd><tt>When&nbsp;set&nbsp;to&nbsp;True,&nbsp;all&nbsp;tabs&nbsp;are&nbsp;closed &nbsp;before&nbsp;running&nbsp;the&nbsp;test&nbsp;for&nbsp;the<br>
167 first&nbsp;time.</tt></dd>
168 </dl>
169 <dl><dt><strong>discard_first_result</strong></dt>
170 <dd><tt>When&nbsp;set&nbsp;to&nbsp;True,&nbsp;the&nbsp;first&nbsp;run&nbsp;of&nb sp;the&nbsp;test&nbsp;is&nbsp;discarded.&nbsp;&nbsp;This&nbsp;is<br>
171 useful&nbsp;for&nbsp;cases&nbsp;where&nbsp;it's&nbsp;desirable&nbsp;to&nbsp;have &nbsp;some&nbsp;test&nbsp;resource&nbsp;cached&nbsp;so<br>
172 the&nbsp;first&nbsp;run&nbsp;of&nbsp;the&nbsp;test&nbsp;can&nbsp;warm&nbsp;thing s&nbsp;up.</tt></dd>
173 </dl>
174 <dl><dt><strong>max_errors</strong></dt>
175 <dd><tt>Maximum&nbsp;number&nbsp;of&nbsp;errors&nbsp;allowed&nbsp;for&nbsp;the&n bsp;page&nbsp;set.</tt></dd>
176 </dl>
177 <dl><dt><strong>max_failures</strong></dt>
178 <dd><tt>Maximum&nbsp;number&nbsp;of&nbsp;failures&nbsp;allowed&nbsp;for&nbsp;the &nbsp;page&nbsp;set.</tt></dd>
179 </dl>
180 <hr>
181 Class methods inherited from <a href="telemetry.core.command_line.html#ArgumentH andlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a>:<br>
182 <dl><dt><a name="RecordPage-AddCommandLineArgs"><strong>AddCommandLineArgs</stro ng></a>(cls, parser)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Ove rride&nbsp;to&nbsp;accept&nbsp;custom&nbsp;command-line&nbsp;arguments.</tt></dd ></dl>
183
184 <dl><dt><a name="RecordPage-ProcessCommandLineArgs"><strong>ProcessCommandLineAr gs</strong></a>(cls, parser, args)<font color="#909090"><font face="helvetica, a rial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></ dt><dd><tt>Override&nbsp;to&nbsp;process&nbsp;command-line&nbsp;arguments.<br>
185 &nbsp;<br>
186 We&nbsp;pass&nbsp;in&nbsp;parser&nbsp;so&nbsp;we&nbsp;can&nbsp;call&nbsp;parser. error().</tt></dd></dl>
187
188 <hr>
189 Data descriptors inherited from <a href="telemetry.core.command_line.html#Argume ntHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a>:<br>
111 <dl><dt><strong>__dict__</strong></dt> 190 <dl><dt><strong>__dict__</strong></dt>
112 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)< /tt></dd> 191 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)< /tt></dd>
113 </dl> 192 </dl>
114 <dl><dt><strong>__weakref__</strong></dt> 193 <dl><dt><strong>__weakref__</strong></dt>
115 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp ;(if&nbsp;defined)</tt></dd> 194 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp ;(if&nbsp;defined)</tt></dd>
116 </dl> 195 </dl>
117 <dl><dt><strong>action_name_to_run</strong></dt>
118 </dl>
119 <dl><dt><strong>clear_cache_before_each_run</strong></dt>
120 <dd><tt>When&nbsp;set&nbsp;to&nbsp;True,&nbsp;the&nbsp;browser's&nbsp;disk&nbsp; and&nbsp;memory&nbsp;cache&nbsp;will&nbsp;be&nbsp;cleared<br>
121 before&nbsp;each&nbsp;run.</tt></dd>
122 </dl>
123 <dl><dt><strong>discard_first_result</strong></dt>
124 <dd><tt>When&nbsp;set&nbsp;to&nbsp;True,&nbsp;the&nbsp;first&nbsp;run&nbsp;of&nb sp;the&nbsp;test&nbsp;is&nbsp;discarded.&nbsp;&nbsp;This&nbsp;is<br>
125 useful&nbsp;for&nbsp;cases&nbsp;where&nbsp;it's&nbsp;desirable&nbsp;to&nbsp;have &nbsp;some&nbsp;test&nbsp;resource&nbsp;cached&nbsp;so<br>
126 the&nbsp;first&nbsp;run&nbsp;of&nbsp;the&nbsp;test&nbsp;can&nbsp;warm&nbsp;thing s&nbsp;up.</tt></dd>
127 </dl>
128 <dl><dt><strong>output_format_choices</strong></dt>
129 <dd><tt>Allowed&nbsp;output&nbsp;formats.&nbsp;The&nbsp;default&nbsp;is&nbsp;the &nbsp;first&nbsp;item&nbsp;in&nbsp;the&nbsp;list.</tt></dd>
130 </dl>
131 </td></tr></table></td></tr></table><p> 196 </td></tr></table></td></tr></table><p>
132 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 197 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
133 <tr bgcolor="#eeaa77"> 198 <tr bgcolor="#eeaa77">
134 <td colspan=3 valign=bottom>&nbsp;<br> 199 <td colspan=3 valign=bottom>&nbsp;<br>
135 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></b ig></font></td></tr> 200 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></b ig></font></td></tr>
136 201
137 <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</td> 202 <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</td>
138 <td width="100%"><dl><dt><a name="-Main"><strong>Main</strong></a>(base_dir)</dt ></dl> 203 <td width="100%"><dl><dt><a name="-Main"><strong>Main</strong></a>(base_dir)</dt ></dl>
139 </td></tr></table> 204 </td></tr></table>
140 </body></html> 205 </body></html>
OLDNEW
« no previous file with comments | « tools/telemetry/docs/telemetry.page.perf_tests_helper.html ('k') | tools/telemetry/docs/telemetry.test.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698