src/tools/telemetry/docs/telemetry.page.page_test.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   3 <html><head><title>Python: module telemetry.page.page_test</title>
   4 </head><body bgcolor="#f0f0f8">
   5
   6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
   7 <tr bgcolor="#7799ee">
   8 <td valign=bottom>&nbsp;<br>
   9 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.page_test</strong></big></big></font></td
  10 ><td align=right valign=bottom
  11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/page/page_test.py">telemetry/page/page_test.py</a></font></td></tr></table>
  12     <p><tt>#&nbsp;Copyright&nbsp;(c)&nbsp;2012&nbsp;The&nbsp;Chromium&nbsp;Authors.&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>
  14 #&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;file.</tt></p>
  15 <p>
  16 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  17 <tr bgcolor="#aa55cc">
  18 <td colspan=3 valign=bottom>&nbsp;<br>
  19 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
  20
  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=top><a href="telemetry.page.actions.all_page_actions.html">telemetry.page.actions.all_page_actions</a><br>
  23 <a href="telemetry.core.command_line.html">telemetry.core.command_line</a><br>
  24 </td><td width="25%" valign=top><a href="telemetry.page.actions.interact.html">telemetry.page.actions.interact</a><br>
  25 <a href="logging.html">logging</a><br>
  26 </td><td width="25%" valign=top><a href="telemetry.page.actions.navigate.html">telemetry.page.actions.navigate</a><br>
  27 <a href="telemetry.page.actions.page_action.html">telemetry.page.actions.page_action</a><br>
  28 </td><td width="25%" valign=top><a href="telemetry.page.test_expectations.html">telemetry.page.test_expectations</a><br>
  29 </td></tr></table></td></tr></table><p>
  30 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  31 <tr bgcolor="#ee77aa">
  32 <td colspan=3 valign=bottom>&nbsp;<br>
  33 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
  34
  35 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  36 <td width="100%"><dl>
  37 <dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)
  38 </font></dt><dd>
  39 <dl>
  40 <dt><font face="helvetica, arial"><a href="telemetry.page.page_test.html#Failure">Failure</a>
  41 </font></dt></dl>
  42 </dd>
  43 <dt><font face="helvetica, arial"><a href="telemetry.core.command_line.html#ArgumentHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
  44 </font></dt><dd>
  45 <dl>
  46 <dt><font face="helvetica, arial"><a href="telemetry.page.page_test.html#PageTest">PageTest</a>
  47 </font></dt></dl>
  48 </dd>
  49 </dl>
  50  <p>
  51 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  52 <tr bgcolor="#ffc8d8">
  53 <td colspan=3 valign=bottom>&nbsp;<br>
  54 <font color="#000000" face="helvetica, arial"><a name="Failure">class <strong>Failure</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr>
  55
  56 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
  57 <td colspan=2><tt><a href="exceptions.html#Exception">Exception</a>&nbsp;that&nbsp;can&nbsp;be&nbsp;thrown&nbsp;from&nbsp;PageMeasurement&nbsp;to&nbsp;indicate&nbsp;an<br>
  58 undesired&nbsp;but&nbsp;designed-for&nbsp;problem.<br>&nbsp;</tt></td></tr>
  59 <tr><td>&nbsp;</td>
  60 <td width="100%"><dl><dt>Method resolution order:</dt>
  61 <dd><a href="telemetry.page.page_test.html#Failure">Failure</a></dd>
  62 <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
  63 <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
  64 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
  65 </dl>
  66 <hr>
  67 Data descriptors defined here:<br>
  68 <dl><dt><strong>__weakref__</strong></dt>
  69 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  70 </dl>
  71 <hr>
  72 Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
  73 <dl><dt><a name="Failure-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__init__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;help(type(x))&nbsp;for&nbsp;signature</tt></dd></dl>
  74
  75 <hr>
  76 Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
  77 <dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#Failure-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;object&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
  78
  79 <hr>
  80 Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
  81 <dl><dt><a name="Failure-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>
  82
  83 <dl><dt><a name="Failure-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>
  84
  85 <dl><dt><a name="Failure-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
  86
  87 <dl><dt><a name="Failure-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
  88 &nbsp;<br>
  89 Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>
  90
  91 <dl><dt><a name="Failure-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
  92
  93 <dl><dt><a name="Failure-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>
  94
  95 <dl><dt><a name="Failure-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>
  96
  97 <dl><dt><a name="Failure-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
  98
  99 <dl><dt><a name="Failure-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__str__">__str__</a>()&nbsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>
 100
 101 <dl><dt><a name="Failure-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
 102
 103 <hr>
 104 Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
 105 <dl><dt><strong>__dict__</strong></dt>
 106 </dl>
 107 <dl><dt><strong>args</strong></dt>
 108 </dl>
 109 <dl><dt><strong>message</strong></dt>
 110 </dl>
 111 </td></tr></table> <p>
 112 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 113 <tr bgcolor="#ffc8d8">
 114 <td colspan=3 valign=bottom>&nbsp;<br>
 115 <font color="#000000" face="helvetica, arial"><a name="PageTest">class <strong>PageTest</strong></a>(<a href="telemetry.core.command_line.html#ArgumentHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a>)</font></td></tr>
 116
 117 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
 118 <td colspan=2><tt>A&nbsp;class&nbsp;styled&nbsp;on&nbsp;unittest.TestCase&nbsp;for&nbsp;creating&nbsp;page-specific&nbsp;tests.<br>&nbsp;</tt></td></tr>
 119 <tr><td>&nbsp;</td>
 120 <td width="100%"><dl><dt>Method resolution order:</dt>
 121 <dd><a href="telemetry.page.page_test.html#PageTest">PageTest</a></dd>
 122 <dd><a href="telemetry.core.command_line.html#ArgumentHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a></dd>
 123 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
 124 </dl>
 125 <hr>
 126 Methods defined here:<br>
 127 <dl><dt><a name="PageTest-CanRunForPage"><strong>CanRunForPage</strong></a>(self, page)</dt><dd><tt>Override&nbsp;to&nbsp;customize&nbsp;if&nbsp;the&nbsp;test&nbsp;can&nbsp;be&nbsp;ran&nbsp;for&nbsp;the&nbsp;given&nbsp;page.</tt></dd></dl>
 128
 129 <dl><dt><a name="PageTest-CleanUpAfterPage"><strong>CleanUpAfterPage</strong></a>(self, page, tab)</dt><dd><tt>Called&nbsp;after&nbsp;the&nbsp;test&nbsp;run&nbsp;method&nbsp;was&nbsp;run,&nbsp;even&nbsp;if&nbsp;it&nbsp;failed.</tt></dd></dl>
 130
 131 <dl><dt><a name="PageTest-CreateExpectations"><strong>CreateExpectations</strong></a>(self, page_set)</dt><dd><tt>Override&nbsp;to&nbsp;make&nbsp;this&nbsp;test&nbsp;generate&nbsp;its&nbsp;own&nbsp;expectations&nbsp;instead&nbsp;of<br>
 132 any&nbsp;that&nbsp;may&nbsp;have&nbsp;been&nbsp;defined&nbsp;in&nbsp;the&nbsp;page&nbsp;set.</tt></dd></dl>
 133
 134 <dl><dt><a name="PageTest-CreatePageSet"><strong>CreatePageSet</strong></a>(self, args, options)</dt><dd><tt>Override&nbsp;to&nbsp;make&nbsp;this&nbsp;test&nbsp;generate&nbsp;its&nbsp;own&nbsp;page&nbsp;set&nbsp;instead&nbsp;of<br>
 135 allowing&nbsp;arbitrary&nbsp;page&nbsp;sets&nbsp;entered&nbsp;from&nbsp;the&nbsp;command-line.</tt></dd></dl>
 136
 137 <dl><dt><a name="PageTest-CustomizeBrowserOptions"><strong>CustomizeBrowserOptions</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>
 138
 139 <dl><dt><a name="PageTest-CustomizeBrowserOptionsForPageSet"><strong>CustomizeBrowserOptionsForPageSet</strong></a>(self, page_set, options)</dt><dd><tt>Set&nbsp;options&nbsp;required&nbsp;for&nbsp;this&nbsp;page&nbsp;set.<br>
 140 &nbsp;<br>
 141 These&nbsp;options&nbsp;will&nbsp;be&nbsp;used&nbsp;every&nbsp;time&nbsp;the&nbsp;browser&nbsp;is&nbsp;started&nbsp;while&nbsp;running<br>
 142 this&nbsp;page&nbsp;set.&nbsp;They&nbsp;may,&nbsp;however,&nbsp;be&nbsp;further&nbsp;modified&nbsp;by<br>
 143 CustomizeBrowserOptionsForSinglePage&nbsp;or&nbsp;by&nbsp;the&nbsp;profiler.</tt></dd></dl>
 144
 145 <dl><dt><a name="PageTest-CustomizeBrowserOptionsForSinglePage"><strong>CustomizeBrowserOptionsForSinglePage</strong></a>(self, page, options)</dt><dd><tt>Set&nbsp;options&nbsp;specific&nbsp;to&nbsp;the&nbsp;test&nbsp;and&nbsp;the&nbsp;given&nbsp;page.<br>
 146 &nbsp;<br>
 147 This&nbsp;will&nbsp;be&nbsp;called&nbsp;with&nbsp;the&nbsp;current&nbsp;page&nbsp;when&nbsp;the&nbsp;browser&nbsp;is&nbsp;(re)started.<br>
 148 Changing&nbsp;options&nbsp;at&nbsp;this&nbsp;point&nbsp;only&nbsp;makes&nbsp;sense&nbsp;if&nbsp;the&nbsp;browser&nbsp;is&nbsp;being<br>
 149 restarted&nbsp;for&nbsp;each&nbsp;page.&nbsp;Note&nbsp;that&nbsp;if&nbsp;page&nbsp;has&nbsp;a&nbsp;startup_url,&nbsp;the&nbsp;browser<br>
 150 will&nbsp;always&nbsp;be&nbsp;restarted&nbsp;for&nbsp;each&nbsp;run.</tt></dd></dl>
 151
 152 <dl><dt><a name="PageTest-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;and&nbsp;after<br>
 153 all&nbsp;waiting&nbsp;for&nbsp;completion&nbsp;has&nbsp;occurred.</tt></dd></dl>
 154
 155 <dl><dt><a name="PageTest-DidRunAction"><strong>DidRunAction</strong></a>(self, page, tab, action)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;after&nbsp;running&nbsp;the&nbsp;action&nbsp;on&nbsp;the&nbsp;page.</tt></dd></dl>
 156
 157 <dl><dt><a name="PageTest-DidRunActions"><strong>DidRunActions</strong></a>(self, page, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;after&nbsp;running&nbsp;the&nbsp;actions&nbsp;on&nbsp;the&nbsp;page.</tt></dd></dl>
 158
 159 <dl><dt><a name="PageTest-DidRunPageRepeats"><strong>DidRunPageRepeats</strong></a>(self, page)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;after&nbsp;each&nbsp;page&nbsp;is&nbsp;iterated&nbsp;over.</tt></dd></dl>
 160
 161 <dl><dt><a name="PageTest-DidRunTest"><strong>DidRunTest</strong></a>(self, browser, 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>
 162 &nbsp;<br>
 163 This&nbsp;will&nbsp;occur&nbsp;before&nbsp;the&nbsp;browser&nbsp;is&nbsp;torn&nbsp;down.</tt></dd></dl>
 164
 165 <dl><dt><a name="PageTest-DidStartBrowser"><strong>DidStartBrowser</strong></a>(self, browser)</dt><dd><tt>Override&nbsp;to&nbsp;customize&nbsp;the&nbsp;browser&nbsp;right&nbsp;after&nbsp;it&nbsp;has&nbsp;launched.</tt></dd></dl>
 166
 167 <dl><dt><a name="PageTest-DidStartHTTPServer"><strong>DidStartHTTPServer</strong></a>(self, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;after&nbsp;the&nbsp;HTTP&nbsp;server&nbsp;is&nbsp;started.</tt></dd></dl>
 168
 169 <dl><dt><a name="PageTest-IsExiting"><strong>IsExiting</strong></a>(self)</dt></dl>
 170
 171 <dl><dt><a name="PageTest-RequestExit"><strong>RequestExit</strong></a>(self)</dt></dl>
 172
 173 <dl><dt><a name="PageTest-RestartBrowserBeforeEachPage"><strong>RestartBrowserBeforeEachPage</strong></a>(self)</dt><dd><tt>Should&nbsp;the&nbsp;browser&nbsp;be&nbsp;restarted&nbsp;for&nbsp;the&nbsp;page?<br>
 174 &nbsp;<br>
 175 This&nbsp;returns&nbsp;true&nbsp;if&nbsp;the&nbsp;test&nbsp;needs&nbsp;to&nbsp;unconditionally&nbsp;restart&nbsp;the<br>
 176 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>
 177
 178 <dl><dt><a name="PageTest-Run"><strong>Run</strong></a>(self, page, tab, results)</dt></dl>
 179
 180 <dl><dt><a name="PageTest-RunNavigateSteps"><strong>RunNavigateSteps</strong></a>(self, page, tab)</dt><dd><tt>Navigates&nbsp;the&nbsp;tab&nbsp;to&nbsp;the&nbsp;page&nbsp;URL&nbsp;attribute.<br>
 181 &nbsp;<br>
 182 Runs&nbsp;the&nbsp;'navigate_steps'&nbsp;page&nbsp;attribute&nbsp;as&nbsp;a&nbsp;compound&nbsp;action.</tt></dd></dl>
 183
 184 <dl><dt><a name="PageTest-StopBrowserAfterPage"><strong>StopBrowserAfterPage</strong></a>(self, browser, page)</dt><dd><tt>Should&nbsp;the&nbsp;browser&nbsp;be&nbsp;stopped&nbsp;after&nbsp;the&nbsp;page&nbsp;is&nbsp;run?<br>
 185 &nbsp;<br>
 186 This&nbsp;is&nbsp;called&nbsp;after&nbsp;a&nbsp;page&nbsp;is&nbsp;run&nbsp;to&nbsp;decide&nbsp;whether&nbsp;the&nbsp;browser&nbsp;needs&nbsp;to<br>
 187 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>
 188 restarted&nbsp;to&nbsp;run&nbsp;the&nbsp;next&nbsp;page.<br>
 189 &nbsp;<br>
 190 A&nbsp;test&nbsp;that&nbsp;overrides&nbsp;this&nbsp;can&nbsp;look&nbsp;at&nbsp;both&nbsp;the&nbsp;page&nbsp;and&nbsp;the&nbsp;browser&nbsp;to<br>
 191 decide&nbsp;whether&nbsp;it&nbsp;needs&nbsp;to&nbsp;stop&nbsp;the&nbsp;browser.</tt></dd></dl>
 192
 193 <dl><dt><a name="PageTest-TabForPage"><strong>TabForPage</strong></a>(self, page, 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>
 194 create&nbsp;a&nbsp;new&nbsp;tab&nbsp;for&nbsp;every&nbsp;page,&nbsp;return&nbsp;browser.tabs.New().</tt></dd></dl>
 195
 196 <dl><dt><a name="PageTest-ValidatePageSet"><strong>ValidatePageSet</strong></a>(self, page_set)</dt><dd><tt>Override&nbsp;to&nbsp;examine&nbsp;the&nbsp;page&nbsp;set&nbsp;before&nbsp;the&nbsp;test&nbsp;run.&nbsp;&nbsp;Useful&nbsp;for<br>
 197 example&nbsp;to&nbsp;validate&nbsp;that&nbsp;the&nbsp;pageset&nbsp;can&nbsp;be&nbsp;used&nbsp;with&nbsp;the&nbsp;test.</tt></dd></dl>
 198
 199 <dl><dt><a name="PageTest-WillNavigateToPage"><strong>WillNavigateToPage</strong></a>(self, page, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;before&nbsp;the&nbsp;page&nbsp;is&nbsp;navigated,&nbsp;notably&nbsp;Telemetry<br>
 200 will&nbsp;already&nbsp;have&nbsp;performed&nbsp;the&nbsp;following&nbsp;operations&nbsp;on&nbsp;the&nbsp;browser&nbsp;before<br>
 201 calling&nbsp;this&nbsp;function:<br>
 202 *&nbsp;Ensure&nbsp;only&nbsp;one&nbsp;tab&nbsp;is&nbsp;open.<br>
 203 *&nbsp;Call&nbsp;WaitForDocumentReadyStateToComplete&nbsp;on&nbsp;the&nbsp;tab.</tt></dd></dl>
 204
 205 <dl><dt><a name="PageTest-WillRunAction"><strong>WillRunAction</strong></a>(self, 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>
 206
 207 <dl><dt><a name="PageTest-WillRunActions"><strong>WillRunActions</strong></a>(self, page, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;before&nbsp;running&nbsp;the&nbsp;actions&nbsp;on&nbsp;the&nbsp;page.</tt></dd></dl>
 208
 209 <dl><dt><a name="PageTest-WillRunPageRepeats"><strong>WillRunPageRepeats</strong></a>(self, page)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;before&nbsp;each&nbsp;page&nbsp;is&nbsp;iterated&nbsp;over.</tt></dd></dl>
 210
 211 <dl><dt><a name="PageTest-WillRunTest"><strong>WillRunTest</strong></a>(self, options)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;before&nbsp;the&nbsp;page&nbsp;set(s)&nbsp;are&nbsp;navigated.</tt></dd></dl>
 212
 213 <dl><dt><a name="PageTest-WillStartBrowser"><strong>WillStartBrowser</strong></a>(self, browser)</dt><dd><tt>Override&nbsp;to&nbsp;manipulate&nbsp;the&nbsp;browser&nbsp;environment&nbsp;before&nbsp;it&nbsp;launches.</tt></dd></dl>
 214
 215 <dl><dt><a name="PageTest-__init__"><strong>__init__</strong></a>(self, test_method_name, action_name_to_run<font color="#909090">=''</font>, needs_browser_restart_after_each_page<font color="#909090">=False</font>, discard_first_result<font color="#909090">=False</font>, clear_cache_before_each_run<font color="#909090">=False</font>, attempts<font color="#909090">=3</font>, max_failures<font color="#909090">=None</font>, max_errors<font color="#909090">=None</font>)</dt></dl>
 216
 217 <hr>
 218 Data descriptors defined here:<br>
 219 <dl><dt><strong>action_name_to_run</strong></dt>
 220 </dl>
 221 <dl><dt><strong>attempts</strong></dt>
 222 <dd><tt>Maximum&nbsp;number&nbsp;of&nbsp;times&nbsp;test&nbsp;will&nbsp;be&nbsp;attempted.</tt></dd>
 223 </dl>
 224 <dl><dt><strong>clear_cache_before_each_run</strong></dt>
 225 <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>
 226 before&nbsp;each&nbsp;run.</tt></dd>
 227 </dl>
 228 <dl><dt><strong>close_tabs_before_run</strong></dt>
 229 <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>
 230 first&nbsp;time.</tt></dd>
 231 </dl>
 232 <dl><dt><strong>discard_first_result</strong></dt>
 233 <dd><tt>When&nbsp;set&nbsp;to&nbsp;True,&nbsp;the&nbsp;first&nbsp;run&nbsp;of&nbsp;the&nbsp;test&nbsp;is&nbsp;discarded.&nbsp;&nbsp;This&nbsp;is<br>
 234 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>
 235 the&nbsp;first&nbsp;run&nbsp;of&nbsp;the&nbsp;test&nbsp;can&nbsp;warm&nbsp;things&nbsp;up.</tt></dd>
 236 </dl>
 237 <dl><dt><strong>max_errors</strong></dt>
 238 <dd><tt>Maximum&nbsp;number&nbsp;of&nbsp;errors&nbsp;allowed&nbsp;for&nbsp;the&nbsp;page&nbsp;set.</tt></dd>
 239 </dl>
 240 <dl><dt><strong>max_failures</strong></dt>
 241 <dd><tt>Maximum&nbsp;number&nbsp;of&nbsp;failures&nbsp;allowed&nbsp;for&nbsp;the&nbsp;page&nbsp;set.</tt></dd>
 242 </dl>
 243 <hr>
 244 Class methods inherited from <a href="telemetry.core.command_line.html#ArgumentHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a>:<br>
 245 <dl><dt><a name="PageTest-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><dd><tt>Override&nbsp;to&nbsp;accept&nbsp;custom&nbsp;command-line&nbsp;arguments.</tt></dd></dl>
 246
 247 <dl><dt><a name="PageTest-ProcessCommandLineArgs"><strong>ProcessCommandLineArgs</strong></a>(cls, parser, args)<font color="#909090"><font face="helvetica, arial"> 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>
 248 &nbsp;<br>
 249 We&nbsp;pass&nbsp;in&nbsp;parser&nbsp;so&nbsp;we&nbsp;can&nbsp;call&nbsp;parser.error().</tt></dd></dl>
 250
 251 <hr>
 252 Data descriptors inherited from <a href="telemetry.core.command_line.html#ArgumentHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a>:<br>
 253 <dl><dt><strong>__dict__</strong></dt>
 254 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
 255 </dl>
 256 <dl><dt><strong>__weakref__</strong></dt>
 257 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
 258 </dl>
 259 </td></tr></table></td></tr></table><p>
 260 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 261 <tr bgcolor="#eeaa77">
 262 <td colspan=3 valign=bottom>&nbsp;<br>
 263 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
 264
 265 <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 266 <td width="100%"><dl><dt><a name="-GetCompoundActionFromPage"><strong>GetCompoundActionFromPage</strong></a>(page, action_name, interactive<font color="#909090">=False</font>)</dt></dl>
 267  <dl><dt><a name="-GetSubactionFromData"><strong>GetSubactionFromData</strong></a>(page, subaction_data, interactive)</dt></dl>
 268 </td></tr></table>
 269 </body></html>