| 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: package telemetry</title> | 3 <html><head><title>Python: package telemetry</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>teleme
try</strong></big></big></font></td | 9 <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>teleme
try</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/__init__.py">telemetry/__init__.py</a></font></td></tr></table> | 11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href=
"../telemetry/__init__.py">telemetry/__init__.py</a></font></td></tr></table> |
| 12 <p><tt>A library for cross-platform browser tests.<
/tt></p> | 12 <p><tt>A library for cross-platform browser tests.<
/tt></p> |
| 13 <p> | 13 <p> |
| 14 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> | 14 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 15 <tr bgcolor="#aa55cc"> | 15 <tr bgcolor="#aa55cc"> |
| 16 <td colspan=3 valign=bottom> <br> | 16 <td colspan=3 valign=bottom> <br> |
| 17 <font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</str
ong></big></font></td></tr> | 17 <font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</str
ong></big></font></td></tr> |
| 18 | 18 |
| 19 <tr><td bgcolor="#aa55cc"><tt> </tt></td><td>
</td> | 19 <tr><td bgcolor="#aa55cc"><tt> </tt></td><td>
</td> |
| 20 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t
op><a href="telemetry.core.html"><strong>core</strong> (package)</a><br> | 20 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t
op><a href="telemetry.core.html"><strong>core</strong> (package)</a><br> |
| 21 <a href="telemetry.page.html"><strong>page</strong> (package)</a><br> | 21 <a href="telemetry.decorators.html">decorators</a><br> |
| 22 </td><td width="25%" valign=top><a href="telemetry.test.html">test</a><br> | 22 <a href="telemetry.exception_formatter.html">exception_formatter</a><br> |
| 23 </td><td width="25%" valign=top><a href="telemetry.page.html"><strong>page</stro
ng> (package)</a><br> |
| 24 <a href="telemetry.test.html">test</a><br> |
| 23 <a href="telemetry.test_runner.html">test_runner</a><br> | 25 <a href="telemetry.test_runner.html">test_runner</a><br> |
| 24 </td><td width="25%" valign=top><a href="telemetry.unittest.html"><strong>unitte
st</strong> (package)</a><br> | 26 </td><td width="25%" valign=top><a href="telemetry.unittest.html"><strong>unitte
st</strong> (package)</a><br> |
| 25 </td><td width="25%" valign=top></td></tr></table></td></tr></table><p> | 27 <a href="telemetry.util.html"><strong>util</strong> (package)</a><br> |
| 28 <a href="telemetry.value.html"><strong>value</strong> (package)</a><br> |
| 29 </td><td width="25%" valign=top><a href="telemetry.web_components.html"><strong>
web_components</strong> (package)</a><br> |
| 30 </td></tr></table></td></tr></table><p> |
| 26 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> | 31 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 27 <tr bgcolor="#ee77aa"> | 32 <tr bgcolor="#ee77aa"> |
| 28 <td colspan=3 valign=bottom> <br> | 33 <td colspan=3 valign=bottom> <br> |
| 29 <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> |
| 30 | 35 |
| 31 <tr><td bgcolor="#ee77aa"><tt> </tt></td><td>
</td> | 36 <tr><td bgcolor="#ee77aa"><tt> </tt></td><td>
</td> |
| 32 <td width="100%"><dl> | 37 <td width="100%"><dl> |
| 33 <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> |
| 34 </font></dt><dd> | 39 </font></dt><dd> |
| 35 <dl> | 40 <dl> |
| 36 <dt><font face="helvetica, arial"><a href="telemetry.core.browser.html#Browser">
telemetry.core.browser.Browser</a> | 41 <dt><font face="helvetica, arial"><a href="telemetry.core.browser.html#Browser">
telemetry.core.browser.Browser</a> |
| 37 </font></dt></dl> | 42 </font></dt></dl> |
| 38 </dd> | 43 </dd> |
| 39 <dt><font face="helvetica, arial"><a href="optparse.html#Values">optparse.Values
</a> | 44 <dt><font face="helvetica, arial"><a href="optparse.html#Values">optparse.Values
</a> |
| 40 </font></dt><dd> | 45 </font></dt><dd> |
| 41 <dl> | 46 <dl> |
| 42 <dt><font face="helvetica, arial"><a href="telemetry.core.browser_options.html#B
rowserOptions">telemetry.core.browser_options.BrowserOptions</a> | 47 <dt><font face="helvetica, arial"><a href="telemetry.core.browser_options.html#B
rowserFinderOptions">telemetry.core.browser_options.BrowserFinderOptions</a> |
| 43 </font></dt></dl> | 48 </font></dt></dl> |
| 44 </dd> | 49 </dd> |
| 45 <dt><font face="helvetica, arial"><a href="telemetry.core.web_contents.html#WebC
ontents">telemetry.core.web_contents.WebContents</a>(<a href="__builtin__.html#o
bject">__builtin__.object</a>) | 50 <dt><font face="helvetica, arial"><a href="telemetry.core.web_contents.html#WebC
ontents">telemetry.core.web_contents.WebContents</a>(<a href="__builtin__.html#o
bject">__builtin__.object</a>) |
| 46 </font></dt><dd> | 51 </font></dt><dd> |
| 47 <dl> | 52 <dl> |
| 48 <dt><font face="helvetica, arial"><a href="telemetry.core.tab.html#Tab">telemetr
y.core.tab.Tab</a> | 53 <dt><font face="helvetica, arial"><a href="telemetry.core.tab.html#Tab">telemetr
y.core.tab.Tab</a> |
| 49 </font></dt></dl> | 54 </font></dt></dl> |
| 50 </dd> | 55 </dd> |
| 51 <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>) | 56 <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>) |
| 52 </font></dt><dd> | 57 </font></dt><dd> |
| 53 <dl> | 58 <dl> |
| 54 <dt><font face="helvetica, arial"><a href="telemetry.page.page_measurement.html#
PageMeasurement">telemetry.page.page_measurement.PageMeasurement</a> | 59 <dt><font face="helvetica, arial"><a href="telemetry.page.page_measurement.html#
PageMeasurement">telemetry.page.page_measurement.PageMeasurement</a> |
| 55 </font></dt></dl> | 60 </font></dt></dl> |
| 56 </dd> | 61 </dd> |
| 57 </dl> | 62 </dl> |
| 58 <p> | 63 <p> |
| 59 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> | 64 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 60 <tr bgcolor="#ffc8d8"> | 65 <tr bgcolor="#ffc8d8"> |
| 61 <td colspan=3 valign=bottom> <br> | 66 <td colspan=3 valign=bottom> <br> |
| (...skipping 10 matching lines...) Expand all Loading... |
| 72 with browser_to_create.Create() as browser:<br> | 77 with browser_to_create.Create() as browser:<br> |
| 73 ... do all your operations on&n
bsp;browser here<br> </tt></td></tr> | 78 ... do all your operations on&n
bsp;browser here<br> </tt></td></tr> |
| 74 <tr><td> </td> | 79 <tr><td> </td> |
| 75 <td width="100%">Methods defined here:<br> | 80 <td width="100%">Methods defined here:<br> |
| 76 <dl><dt><a name="Browser-Close"><strong>Close</strong></a>(self)</dt><dd><tt>Clo
ses this browser.</tt></dd></dl> | 81 <dl><dt><a name="Browser-Close"><strong>Close</strong></a>(self)</dt><dd><tt>Clo
ses this browser.</tt></dd></dl> |
| 77 | 82 |
| 78 <dl><dt><a name="Browser-GetStackTrace"><strong>GetStackTrace</strong></a>(self)
</dt></dl> | 83 <dl><dt><a name="Browser-GetStackTrace"><strong>GetStackTrace</strong></a>(self)
</dt></dl> |
| 79 | 84 |
| 80 <dl><dt><a name="Browser-GetStandardOutput"><strong>GetStandardOutput</strong></
a>(self)</dt></dl> | 85 <dl><dt><a name="Browser-GetStandardOutput"><strong>GetStandardOutput</strong></
a>(self)</dt></dl> |
| 81 | 86 |
| 82 <dl><dt><a name="Browser-GetTraceResultAndReset"><strong>GetTraceResultAndReset<
/strong></a>(self)</dt><dd><tt>Returns the result of the&nbs
p;trace, as TraceResult <a href="__builtin__.html#object">object<
/a>.</tt></dd></dl> | 87 <dl><dt><a name="Browser-GetSystemInfo"><strong>GetSystemInfo</strong></a>(self)
</dt><dd><tt>Returns low-level information about the sy
stem, if available.<br> |
| 88 <br> |
| 89 See the documentation of the SystemInfo class 
;for more details.</tt></dd></dl> |
| 83 | 90 |
| 84 <dl><dt><a name="Browser-SetHTTPServerDirectories"><strong>SetHTTPServerDirector
ies</strong></a>(self, paths)</dt><dd><tt>Returns True if the&nbs
p;HTTP server was started, False otherwise.</tt></dd></
dl> | 91 <dl><dt><a name="Browser-SetHTTPServerDirectories"><strong>SetHTTPServerDirector
ies</strong></a>(self, paths)</dt><dd><tt>Returns True if the&nbs
p;HTTP server was started, False otherwise.</tt></dd></
dl> |
| 85 | 92 |
| 86 <dl><dt><a name="Browser-SetReplayArchivePath"><strong>SetReplayArchivePath</str
ong></a>(self, archive_path, append_to_existing_wpr<font color="#909090">=False<
/font>, make_javascript_deterministic<font color="#909090">=True</font>)</dt></d
l> | 93 <dl><dt><a name="Browser-SetReplayArchivePath"><strong>SetReplayArchivePath</str
ong></a>(self, archive_path, append_to_existing_wpr<font color="#909090">=False<
/font>, make_javascript_deterministic<font color="#909090">=True</font>)</dt></d
l> |
| 87 | 94 |
| 88 <dl><dt><a name="Browser-StartProfiling"><strong>StartProfiling</strong></a>(sel
f, options, base_output_file)</dt><dd><tt>Starts profiling using
|options|.profiler_tool. Results are saved to<br> | 95 <dl><dt><a name="Browser-Start"><strong>Start</strong></a>(self)</dt></dl> |
| 96 |
| 97 <dl><dt><a name="Browser-StartLocalServer"><strong>StartLocalServer</strong></a>
(self, server)</dt><dd><tt>Starts a LocalServer and associat
es it with this browser.<br> |
| 98 <br> |
| 99 It will be closed when the browser closes.</t
t></dd></dl> |
| 100 |
| 101 <dl><dt><a name="Browser-StartProfiling"><strong>StartProfiling</strong></a>(sel
f, profiler_name, base_output_file)</dt><dd><tt>Starts profiling using
|profiler_name|. Results are saved to<br> |
| 89 |base_output_file|.<process_name>.</tt></dd></dl> | 102 |base_output_file|.<process_name>.</tt></dd></dl> |
| 90 | 103 |
| 91 <dl><dt><a name="Browser-StartTracing"><strong>StartTracing</strong></a>(self, c
ustom_categories<font color="#909090">=None</font>, timeout<font color="#909090"
>=10</font>)</dt></dl> | 104 <dl><dt><a name="Browser-StartTracing"><strong>StartTracing</strong></a>(self, c
ustom_categories<font color="#909090">=None</font>, timeout<font color="#909090"
>=10</font>)</dt></dl> |
| 92 | 105 |
| 93 <dl><dt><a name="Browser-StopProfiling"><strong>StopProfiling</strong></a>(self)
</dt><dd><tt>Stops all active profilers and saves
their results.</tt></dd></dl> | 106 <dl><dt><a name="Browser-StopProfiling"><strong>StopProfiling</strong></a>(self)
</dt><dd><tt>Stops all active profilers and saves
their results.<br> |
| 107 <br> |
| 108 Returns:<br> |
| 109 A list of filenames produced by the&nb
sp;profiler.</tt></dd></dl> |
| 94 | 110 |
| 95 <dl><dt><a name="Browser-StopTracing"><strong>StopTracing</strong></a>(self)</dt
></dl> | 111 <dl><dt><a name="Browser-StopTracing"><strong>StopTracing</strong></a>(self)</dt
><dd><tt>Stops tracing and returns the result as&n
bsp;TimelineData <a href="__builtin__.html#object">object</a>.</tt></dd></d
l> |
| 96 | 112 |
| 97 <dl><dt><a name="Browser-__enter__"><strong>__enter__</strong></a>(self)</dt></d
l> | 113 <dl><dt><a name="Browser-__enter__"><strong>__enter__</strong></a>(self)</dt></d
l> |
| 98 | 114 |
| 99 <dl><dt><a name="Browser-__exit__"><strong>__exit__</strong></a>(self, *args)</d
t></dl> | 115 <dl><dt><a name="Browser-__exit__"><strong>__exit__</strong></a>(self, *args)</d
t></dl> |
| 100 | 116 |
| 101 <dl><dt><a name="Browser-__init__"><strong>__init__</strong></a>(self, backend,
platform_backend)</dt></dl> | 117 <dl><dt><a name="Browser-__init__"><strong>__init__</strong></a>(self, backend,
platform_backend)</dt></dl> |
| 102 | 118 |
| 103 <dl><dt><a name="Browser-is_profiler_active"><strong>is_profiler_active</strong>
</a>(self, profiler_name)</dt></dl> | 119 <dl><dt><a name="Browser-is_profiler_active"><strong>is_profiler_active</strong>
</a>(self, profiler_name)</dt></dl> |
| 104 | 120 |
| 105 <hr> | 121 <hr> |
| 106 Data descriptors defined here:<br> | 122 Data descriptors defined here:<br> |
| 107 <dl><dt><strong>__dict__</strong></dt> | 123 <dl><dt><strong>__dict__</strong></dt> |
| 108 <dd><tt>dictionary for instance variables (if defined)<
/tt></dd> | 124 <dd><tt>dictionary for instance variables (if defined)<
/tt></dd> |
| 109 </dl> | 125 </dl> |
| 110 <dl><dt><strong>__weakref__</strong></dt> | 126 <dl><dt><strong>__weakref__</strong></dt> |
| 111 <dd><tt>list of weak references to the object 
;(if defined)</tt></dd> | 127 <dd><tt>list of weak references to the object 
;(if defined)</tt></dd> |
| 112 </dl> | 128 </dl> |
| 113 <dl><dt><strong>browser_type</strong></dt> | 129 <dl><dt><strong>browser_type</strong></dt> |
| 114 </dl> | 130 </dl> |
| 131 <dl><dt><strong>cpu_stats</strong></dt> |
| 132 <dd><tt>Returns a dict of cpu statistics for
the system.<br> |
| 133 { 'Browser': {<br> |
| 134 'CpuProcessTime': S,<br> |
| 135 'TotalTime': T<br> |
| 136 },<br> |
| 137 'Gpu': {<br> |
| 138 'CpuProcessTime': S,<br> |
| 139 'TotalTime': T<br> |
| 140 },<br> |
| 141 'Renderer': {<br> |
| 142 'CpuProcessTime': S,<br> |
| 143 'TotalTime': T<br> |
| 144 }<br> |
| 145 }<br> |
| 146 Any of the above keys may be missing on&
nbsp;a per-platform basis.</tt></dd> |
| 147 </dl> |
| 115 <dl><dt><strong>extensions</strong></dt> | 148 <dl><dt><strong>extensions</strong></dt> |
| 116 <dd><tt>Returns the extension dictionary if it exi
sts.</tt></dd> | 149 </dl> |
| 150 <dl><dt><strong>foreground_tab</strong></dt> |
| 117 </dl> | 151 </dl> |
| 118 <dl><dt><strong>http_server</strong></dt> | 152 <dl><dt><strong>http_server</strong></dt> |
| 119 </dl> | 153 </dl> |
| 120 <dl><dt><strong>io_stats</strong></dt> | 154 <dl><dt><strong>io_stats</strong></dt> |
| 121 <dd><tt>Returns a dict of IO statistics for t
he browser:<br> | 155 <dd><tt>Returns a dict of IO statistics for t
he browser:<br> |
| 122 { 'Browser': {<br> | 156 { 'Browser': {<br> |
| 123 'ReadOperationCount': W,<br> | 157 'ReadOperationCount': W,<br> |
| 124 'WriteOperationCount': X,<br> | 158 'WriteOperationCount': X,<br> |
| 125 'ReadTransferCount': Y,<br> | 159 'ReadTransferCount': Y,<br> |
| 126 'WriteTransferCount': Z<br> | 160 'WriteTransferCount': Z<br> |
| 127 },<br> | 161 },<br> |
| 128 'Gpu': {<br> | 162 'Gpu': {<br> |
| 129 'ReadOperationCount': W,<br> | 163 'ReadOperationCount': W,<br> |
| 130 'WriteOperationCount': X,<br> | 164 'WriteOperationCount': X,<br> |
| 131 'ReadTransferCount': Y,<br> | 165 'ReadTransferCount': Y,<br> |
| 132 'WriteTransferCount': Z<br> | 166 'WriteTransferCount': Z<br> |
| 133 },<br> | 167 },<br> |
| 134 'Renderer': {<br> | 168 'Renderer': {<br> |
| 135 'ReadOperationCount': W,<br> | 169 'ReadOperationCount': W,<br> |
| 136 'WriteOperationCount': X,<br> | 170 'WriteOperationCount': X,<br> |
| 137 'ReadTransferCount': Y,<br> | 171 'ReadTransferCount': Y,<br> |
| 138 'WriteTransferCount': Z<br> | 172 'WriteTransferCount': Z<br> |
| 139 }<br> | 173 }<br> |
| 140 }</tt></dd> | 174 }</tt></dd> |
| 141 </dl> | 175 </dl> |
| 142 <dl><dt><strong>is_content_shell</strong></dt> | 176 <dl><dt><strong>is_content_shell</strong></dt> |
| 143 <dd><tt>Returns whether this browser is a content&
nbsp;shell, only.</tt></dd> | 177 <dd><tt>Returns whether this browser is a content&
nbsp;shell, only.</tt></dd> |
| 144 </dl> | 178 </dl> |
| 179 <dl><dt><strong>is_tracing_running</strong></dt> |
| 180 </dl> |
| 181 <dl><dt><strong>local_servers</strong></dt> |
| 182 <dd><tt>Returns the currently running local servers.</t
t></dd> |
| 183 </dl> |
| 145 <dl><dt><strong>memory_stats</strong></dt> | 184 <dl><dt><strong>memory_stats</strong></dt> |
| 146 <dd><tt>Returns a dict of memory statistics for&nb
sp;the browser:<br> | 185 <dd><tt>Returns a dict of memory statistics for&nb
sp;the browser:<br> |
| 147 { 'Browser': {<br> | 186 { 'Browser': {<br> |
| 148 'VM': S,<br> | 187 'VM': R,<br> |
| 149 'VMPeak': T,<br> | 188 'VMPeak': S,<br> |
| 150 'WorkingSetSize': U,<br> | 189 'WorkingSetSize': T,<br> |
| 151 'WorkingSetSizePeak': V,<br> | 190 'WorkingSetSizePeak': U,<br> |
| 152 'ProportionalSetSize': W,<br> | 191 'ProportionalSetSize': V,<br> |
| 153 'PrivateDirty': X<br> | 192 'PrivateDirty': W<br> |
| 154 },<br> | 193 },<br> |
| 155 'Gpu': {<br> | 194 'Gpu': {<br> |
| 156 'VM': S,<br> | 195 'VM': R,<br> |
| 157 'VMPeak': T,<br> | 196 'VMPeak': S,<br> |
| 158 'WorkingSetSize': U,<br> | 197 'WorkingSetSize': T,<br> |
| 159 'WorkingSetSizePeak': V,<br> | 198 'WorkingSetSizePeak': U,<br> |
| 160 'ProportionalSetSize': W,<br> | 199 'ProportionalSetSize': V,<br> |
| 161 'PrivateDirty': X<br> | 200 'PrivateDirty': W<br> |
| 162 },<br> | 201 },<br> |
| 163 'Renderer': {<br> | 202 'Renderer': {<br> |
| 164 'VM': S,<br> | 203 'VM': R,<br> |
| 165 'VMPeak': T,<br> | 204 'VMPeak': S,<br> |
| 166 'WorkingSetSize': U,<br> | 205 'WorkingSetSize': T,<br> |
| 167 'WorkingSetSizePeak': V,<br> | 206 'WorkingSetSizePeak': U,<br> |
| 168 'ProportionalSetSize': W,<br> | 207 'ProportionalSetSize': V,<br> |
| 169 'PrivateDirty': X<br> | 208 'PrivateDirty': W<br> |
| 170 },<br> | 209 },<br> |
| 171 'SystemCommitCharge': Y,<br> | 210 'SystemCommitCharge': X,<br> |
| 211 'SystemTotalPhysicalMemory': Y,<br> |
| 172 'ProcessCount': Z,<br> | 212 'ProcessCount': Z,<br> |
| 173 }<br> | 213 }<br> |
| 174 Any of the above keys may be missing on&
nbsp;a per-platform basis.</tt></dd> | 214 Any of the above keys may be missing on&
nbsp;a per-platform basis.</tt></dd> |
| 175 </dl> | 215 </dl> |
| 176 <dl><dt><strong>platform</strong></dt> | 216 <dl><dt><strong>platform</strong></dt> |
| 177 </dl> | 217 </dl> |
| 178 <dl><dt><strong>supports_extensions</strong></dt> | 218 <dl><dt><strong>supports_extensions</strong></dt> |
| 179 </dl> | 219 </dl> |
| 220 <dl><dt><strong>supports_system_info</strong></dt> |
| 221 </dl> |
| 180 <dl><dt><strong>supports_tab_control</strong></dt> | 222 <dl><dt><strong>supports_tab_control</strong></dt> |
| 181 </dl> | 223 </dl> |
| 182 <dl><dt><strong>supports_tracing</strong></dt> | 224 <dl><dt><strong>supports_tracing</strong></dt> |
| 183 </dl> | 225 </dl> |
| 226 <dl><dt><strong>synthetic_gesture_source_type</strong></dt> |
| 227 </dl> |
| 184 <dl><dt><strong>tabs</strong></dt> | 228 <dl><dt><strong>tabs</strong></dt> |
| 185 </dl> | 229 </dl> |
| 186 </td></tr></table> <p> | 230 </td></tr></table> <p> |
| 187 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> | 231 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 188 <tr bgcolor="#ffc8d8"> | 232 <tr bgcolor="#ffc8d8"> |
| 189 <td colspan=3 valign=bottom> <br> | 233 <td colspan=3 valign=bottom> <br> |
| 190 <font color="#000000" face="helvetica, arial"><a name="BrowserOptions">class <st
rong>BrowserOptions</strong></a>(<a href="optparse.html#Values">optparse.Values<
/a>)</font></td></tr> | 234 <font color="#000000" face="helvetica, arial"><a name="BrowserFinderOptions">cla
ss <strong>BrowserFinderOptions</strong></a>(<a href="optparse.html#Values">optp
arse.Values</a>)</font></td></tr> |
| 191 | 235 |
| 192 <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> | 236 <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| 193 <td colspan=2><tt>Options to be used for discovering&nb
sp;and launching a browser.<br> </tt></td></tr> | 237 <td colspan=2><tt>Options to be used for discovering&nb
sp;a browser.<br> </tt></td></tr> |
| 194 <tr><td> </td> | 238 <tr><td> </td> |
| 195 <td width="100%">Methods defined here:<br> | 239 <td width="100%">Methods defined here:<br> |
| 196 <dl><dt><a name="BrowserOptions-AppendExtraBrowserArg"><strong>AppendExtraBrowse
rArg</strong></a>(self, arg)</dt></dl> | 240 <dl><dt><a name="BrowserFinderOptions-AppendExtraBrowserArgs"><strong>AppendExtr
aBrowserArgs</strong></a>(self, args)</dt></dl> |
| 197 | 241 |
| 198 <dl><dt><a name="BrowserOptions-Copy"><strong>Copy</strong></a>(self)</dt></dl> | 242 <dl><dt><a name="BrowserFinderOptions-Copy"><strong>Copy</strong></a>(self)</dt>
</dl> |
| 199 | 243 |
| 200 <dl><dt><a name="BrowserOptions-CreateParser"><strong>CreateParser</strong></a>(
self, *args, **kwargs)</dt></dl> | 244 <dl><dt><a name="BrowserFinderOptions-CreateParser"><strong>CreateParser</strong
></a>(self, *args, **kwargs)</dt></dl> |
| 201 | 245 |
| 202 <dl><dt><a name="BrowserOptions-__init__"><strong>__init__</strong></a>(self, br
owser_type<font color="#909090">=None</font>)</dt></dl> | 246 <dl><dt><a name="BrowserFinderOptions-MergeDefaultValues"><strong>MergeDefaultVa
lues</strong></a>(self, defaults)</dt></dl> |
| 247 |
| 248 <dl><dt><a name="BrowserFinderOptions-__init__"><strong>__init__</strong></a>(se
lf, browser_type<font color="#909090">=None</font>)</dt></dl> |
| 203 | 249 |
| 204 <hr> | 250 <hr> |
| 205 Methods inherited from <a href="optparse.html#Values">optparse.Values</a>:<br> | 251 Methods inherited from <a href="optparse.html#Values">optparse.Values</a>:<br> |
| 206 <dl><dt><a name="BrowserOptions-__cmp__"><strong>__cmp__</strong></a>(self, othe
r)</dt></dl> | 252 <dl><dt><a name="BrowserFinderOptions-__cmp__"><strong>__cmp__</strong></a>(self
, other)</dt></dl> |
| 207 | 253 |
| 208 <dl><dt><a name="BrowserOptions-__repr__"><strong>__repr__</strong></a> = _repr(
self)</dt></dl> | 254 <dl><dt><a name="BrowserFinderOptions-__repr__"><strong>__repr__</strong></a> =
_repr(self)</dt></dl> |
| 209 | 255 |
| 210 <dl><dt><a name="BrowserOptions-__str__"><strong>__str__</strong></a>(self)</dt>
</dl> | 256 <dl><dt><a name="BrowserFinderOptions-__str__"><strong>__str__</strong></a>(self
)</dt></dl> |
| 211 | 257 |
| 212 <dl><dt><a name="BrowserOptions-ensure_value"><strong>ensure_value</strong></a>(
self, attr, value)</dt></dl> | 258 <dl><dt><a name="BrowserFinderOptions-ensure_value"><strong>ensure_value</strong
></a>(self, attr, value)</dt></dl> |
| 213 | 259 |
| 214 <dl><dt><a name="BrowserOptions-read_file"><strong>read_file</strong></a>(self,
filename, mode<font color="#909090">='careful'</font>)</dt></dl> | 260 <dl><dt><a name="BrowserFinderOptions-read_file"><strong>read_file</strong></a>(
self, filename, mode<font color="#909090">='careful'</font>)</dt></dl> |
| 215 | 261 |
| 216 <dl><dt><a name="BrowserOptions-read_module"><strong>read_module</strong></a>(se
lf, modname, mode<font color="#909090">='careful'</font>)</dt></dl> | 262 <dl><dt><a name="BrowserFinderOptions-read_module"><strong>read_module</strong><
/a>(self, modname, mode<font color="#909090">='careful'</font>)</dt></dl> |
| 217 | 263 |
| 218 </td></tr></table> <p> | 264 </td></tr></table> <p> |
| 219 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> | 265 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 220 <tr bgcolor="#ffc8d8"> | 266 <tr bgcolor="#ffc8d8"> |
| 221 <td colspan=3 valign=bottom> <br> | 267 <td colspan=3 valign=bottom> <br> |
| 222 <font color="#000000" face="helvetica, arial"><a name="PageMeasurement">class <s
trong>PageMeasurement</strong></a>(<a href="telemetry.page.page_test.html#PageTe
st">telemetry.page.page_test.PageTest</a>)</font></td></tr> | 268 <font color="#000000" face="helvetica, arial"><a name="PageMeasurement">class <s
trong>PageMeasurement</strong></a>(<a href="telemetry.page.page_test.html#PageTe
st">telemetry.page.page_test.PageTest</a>)</font></td></tr> |
| 223 | 269 |
| 224 <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> | 270 <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| 225 <td colspan=2><tt>Glue code for running a measurement&n
bsp;across a set of pages.<br> | 271 <td colspan=2><tt>Glue code for running a measurement&n
bsp;across a set of pages.<br> |
| 226 <br> | 272 <br> |
| 227 To use this, subclass from the measurement an
d override MeasurePage. For<br> | 273 To use this, subclass from the measurement an
d override MeasurePage. For<br> |
| 228 example:<br> | 274 example:<br> |
| 229 <br> | 275 <br> |
| 230 class BodyChildElementMeasurement(<a href="#PageMeasureme
nt">PageMeasurement</a>):<br> | 276 class BodyChildElementMeasurement(<a href="#PageMeasureme
nt">PageMeasurement</a>):<br> |
| 231 def <a href="#PageMeasurement-MeasurePa
ge">MeasurePage</a>(self, page, tab, results):<br> | 277 def <a href="#PageMeasurement-MeasurePa
ge">MeasurePage</a>(self, page, tab, results):<br> |
| 232 body_child_count =&nb
sp;tab.EvaluateJavaScript(<br> | 278 body_child_count =&nb
sp;tab.EvaluateJavaScript(<br> |
| 233 'd
ocument.body.children.length')<br> | 279 'd
ocument.body.children.length')<br> |
| 234 results.Add('body_children
', 'count', body_child_count)<br> | 280 results.Add('body_children
', 'count', body_child_count)<br> |
| 235 <br> | 281 <br> |
| 236 if __name__ == '__main__':<br> | 282 if __name__ == '__main__':<br> |
| 237 page_measurement.Main(BodyChildElement
Measurement())<br> | 283 page_measurement.Main(BodyChildElement
Measurement())<br> |
| 238 <br> | 284 <br> |
| 239 To add test-specific options:<br> | 285 To add test-specific options:<br> |
| 240 <br> | 286 <br> |
| 241 class BodyChildElementMeasurement(<a href="#PageMeasureme
nt">PageMeasurement</a>):<br> | 287 class BodyChildElementMeasurement(<a href="#PageMeasureme
nt">PageMeasurement</a>):<br> |
| 242 def <a href="#PageMeasurement-AddComman
dLineOptions">AddCommandLineOptions</a>(parser):<br> | 288 def <a href="#PageMeasurement-AddComman
dLineArgs">AddCommandLineArgs</a>(parser):<br> |
| 243 parser.add_option('--eleme
nt', action='store', default='body')<br> | 289 parser.add_option('--eleme
nt', action='store', default='body')<br> |
| 244 <br> | 290 <br> |
| 245 def <a href="#PageMeasurement-MeasurePa
ge">MeasurePage</a>(self, page, tab, results):<br> | 291 def <a href="#PageMeasurement-MeasurePa
ge">MeasurePage</a>(self, page, tab, results):<br> |
| 246 body_child_count =&nb
sp;tab.EvaluateJavaScript(<br> | 292 body_child_count =&nb
sp;tab.EvaluateJavaScript(<br> |
| 247 'documen
t.querySelector('%s').children.length')<br> | 293 'documen
t.querySelector('%s').children.length')<br> |
| 248 results.Add('children',&nb
sp;'count', child_count)<br> </tt></td></tr> | 294 results.Add('children',&nb
sp;'count', child_count)<br> </tt></td></tr> |
| 249 <tr><td> </td> | 295 <tr><td> </td> |
| 250 <td width="100%"><dl><dt>Method resolution order:</dt> | 296 <td width="100%"><dl><dt>Method resolution order:</dt> |
| 251 <dd><a href="telemetry.page.page_measurement.html#PageMeasurement">PageMeasureme
nt</a></dd> | 297 <dd><a href="telemetry.page.page_measurement.html#PageMeasurement">PageMeasureme
nt</a></dd> |
| 252 <dd><a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.Pa
geTest</a></dd> | 298 <dd><a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.Pa
geTest</a></dd> |
| 299 <dd><a href="telemetry.core.command_line.html#ArgumentHandlerMixIn">telemetry.co
re.command_line.ArgumentHandlerMixIn</a></dd> |
| 253 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> | 300 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| 254 </dl> | 301 </dl> |
| 255 <hr> | 302 <hr> |
| 256 Methods defined here:<br> | 303 Methods defined here:<br> |
| 257 <dl><dt><a name="PageMeasurement-AddOutputOptions"><strong>AddOutputOptions</str
ong></a>(self, parser)</dt></dl> | |
| 258 | |
| 259 <dl><dt><a name="PageMeasurement-MeasurePage"><strong>MeasurePage</strong></a>(s
elf, page, tab, results)</dt><dd><tt>Override to actually measure
the page's performance.<br> | 304 <dl><dt><a name="PageMeasurement-MeasurePage"><strong>MeasurePage</strong></a>(s
elf, page, tab, results)</dt><dd><tt>Override to actually measure
the page's performance.<br> |
| 260 <br> | 305 <br> |
| 261 page is a page_set.Page<br> | 306 page is a page_set.Page<br> |
| 262 tab is an instance of telemetry.core.<a href="#Tab">Tab
</a><br> | 307 tab is an instance of telemetry.core.<a href="#Tab">Tab
</a><br> |
| 263 <br> | 308 <br> |
| 264 Should call results.Add(name, units, value) for ea
ch result, or raise an<br> | 309 Should call results.Add(name, units, value) for ea
ch result, or raise an<br> |
| 265 exception on failure. The name and units of&n
bsp;each Add() call must be<br> | 310 exception on failure. The name and units of&n
bsp;each Add() call must be<br> |
| 266 the same across all iterations. The name 'url
' must not be used.<br> | 311 the same across all iterations. The name 'url
' must not be used.<br> |
| 267 <br> | 312 <br> |
| 268 Prefer field names that are in accordance wit
h python variable style. E.g.<br> | 313 Prefer field names that are in accordance wit
h python variable style. E.g.<br> |
| 269 field_name.<br> | 314 field_name.<br> |
| 270 <br> | 315 <br> |
| 271 Put together:<br> | 316 Put together:<br> |
| 272 <br> | 317 <br> |
| 273 def <a href="#PageMeasurement-MeasurePage">MeasurePage</a
>(self, page, tab, results):<br> | 318 def <a href="#PageMeasurement-MeasurePage">MeasurePage</a
>(self, page, tab, results):<br> |
| 274 res = tab.EvaluateJavaScript('2+2')<br> | 319 res = tab.EvaluateJavaScript('2+2')<br> |
| 275 if res != 4:<br> | 320 if res != 4:<br> |
| 276 raise Exception('Oh, wow.')<
br> | 321 raise Exception('Oh, wow.')<
br> |
| 277 results.Add('two_plus_two', 'count', res
)</tt></dd></dl> | 322 results.Add('two_plus_two', 'count', res
)</tt></dd></dl> |
| 278 | 323 |
| 279 <dl><dt><a name="PageMeasurement-PrepareResults"><strong>PrepareResults</strong>
</a>(self, options)</dt></dl> | 324 <dl><dt><a name="PageMeasurement-__init__"><strong>__init__</strong></a>(self, a
ction_name_to_run<font color="#909090">=''</font>, needs_browser_restart_after_e
ach_page<font color="#909090">=False</font>, discard_first_result<font color="#9
09090">=False</font>, clear_cache_before_each_run<font color="#909090">=False</f
ont>)</dt></dl> |
| 280 | |
| 281 <dl><dt><a name="PageMeasurement-__init__"><strong>__init__</strong></a>(self, a
ction_name_to_run<font color="#909090">=''</font>, needs_browser_restart_after_e
ach_run<font color="#909090">=False</font>, discard_first_result<font color="#90
9090">=False</font>, clear_cache_before_each_run<font color="#909090">=False</fo
nt>)</dt></dl> | |
| 282 | 325 |
| 283 <hr> | 326 <hr> |
| 284 Data descriptors defined here:<br> | 327 Data descriptors defined here:<br> |
| 285 <dl><dt><strong>output_format_choices</strong></dt> | |
| 286 </dl> | |
| 287 <dl><dt><strong>results_are_the_same_on_every_page</strong></dt> | 328 <dl><dt><strong>results_are_the_same_on_every_page</strong></dt> |
| 288 <dd><tt>By default, measurements are assumed to ou
tput the same values for every<br> | 329 <dd><tt>By default, measurements are assumed to ou
tput the same values for every<br> |
| 289 page. This allows incremental output, for example&
nbsp;in CSV. If, however, the<br> | 330 page. This allows incremental output, for example&
nbsp;in CSV. If, however, the<br> |
| 290 measurement discovers what values it can report&nb
sp;as it goes, and those values<br> | 331 measurement discovers what values it can report&nb
sp;as it goes, and those values<br> |
| 291 may vary from page to page, you need to&
nbsp;override this function and return<br> | 332 may vary from page to page, you need to&
nbsp;override this function and return<br> |
| 292 False. Output will not appear in this mode&nb
sp;until the entire pageset has<br> | 333 False. Output will not appear in this mode&nb
sp;until the entire pageset has<br> |
| 293 run.</tt></dd> | 334 run.</tt></dd> |
| 294 </dl> | 335 </dl> |
| 295 <hr> | 336 <hr> |
| 296 Methods inherited from <a href="telemetry.page.page_test.html#PageTest">telemetr
y.page.page_test.PageTest</a>:<br> | 337 Methods inherited from <a href="telemetry.page.page_test.html#PageTest">telemetr
y.page.page_test.PageTest</a>:<br> |
| 297 <dl><dt><a name="PageMeasurement-AddCommandLineOptions"><strong>AddCommandLineOp
tions</strong></a>(self, parser)</dt><dd><tt>Override to expose c
ommand-line options for this test.<br> | 338 <dl><dt><a name="PageMeasurement-CanRunForPage"><strong>CanRunForPage</strong></
a>(self, page)</dt><dd><tt>Override to customize if the 
;test can be ran for the given page.</tt></dd
></dl> |
| 298 <br> | |
| 299 The provided parser is an optparse.OptionParser in
stance and accepts all<br> | |
| 300 normal results. The parsed options are available&n
bsp;in Run as<br> | |
| 301 self.<strong>options</strong>.</tt></dd></dl> | |
| 302 | 339 |
| 303 <dl><dt><a name="PageMeasurement-CanRunForPage"><strong>CanRunForPage</strong></
a>(self, page)</dt><dd><tt>Override to customize if the 
;test can be ran for the given page.</tt></dd
></dl> | 340 <dl><dt><a name="PageMeasurement-CleanUpAfterPage"><strong>CleanUpAfterPage</str
ong></a>(self, page, tab)</dt><dd><tt>Called after the test
run method was run, even if it failed.</tt></
dd></dl> |
| 341 |
| 342 <dl><dt><a name="PageMeasurement-CreateExpectations"><strong>CreateExpectations<
/strong></a>(self, page_set)</dt><dd><tt>Override to make this&nb
sp;test generate its own expectations instead of<b
r> |
| 343 any that may have been defined in the pa
ge set.</tt></dd></dl> |
| 304 | 344 |
| 305 <dl><dt><a name="PageMeasurement-CreatePageSet"><strong>CreatePageSet</strong></
a>(self, args, options)</dt><dd><tt>Override to make this te
st generate its own page set instead of<br> | 345 <dl><dt><a name="PageMeasurement-CreatePageSet"><strong>CreatePageSet</strong></
a>(self, args, options)</dt><dd><tt>Override to make this te
st generate its own page set instead of<br> |
| 306 allowing arbitrary page sets entered from the 
;command-line.</tt></dd></dl> | 346 allowing arbitrary page sets entered from the 
;command-line.</tt></dd></dl> |
| 307 | 347 |
| 308 <dl><dt><a name="PageMeasurement-CustomizeBrowserOptions"><strong>CustomizeBrows
erOptions</strong></a>(self, options)</dt><dd><tt>Override to add 
;test-specific options to the <a href="#BrowserOptions">Brow
serOptions</a> <a href="__builtin__.html#object">object</a></tt></dd></dl> | 348 <dl><dt><a name="PageMeasurement-CustomizeBrowserOptions"><strong>CustomizeBrows
erOptions</strong></a>(self, options)</dt><dd><tt>Override to add 
;test-specific options to the BrowserOptions <a href="_
_builtin__.html#object">object</a></tt></dd></dl> |
| 309 | 349 |
| 310 <dl><dt><a name="PageMeasurement-CustomizeBrowserOptionsForPage"><strong>Customi
zeBrowserOptionsForPage</strong></a>(self, page, options)</dt><dd><tt>Add o
ptions specific to the test and the given&nbs
p;page.</tt></dd></dl> | 350 <dl><dt><a name="PageMeasurement-CustomizeBrowserOptionsForPageSet"><strong>Cust
omizeBrowserOptionsForPageSet</strong></a>(self, page_set, options)</dt><dd><tt>
Set options required for this page set.<br> |
| 351 <br> |
| 352 These options will be used every time the&nbs
p;browser is started while running<br> |
| 353 this page set. They may, however, be further&
nbsp;modified by<br> |
| 354 CustomizeBrowserOptionsForSinglePage or by the profiler.</tt
></dd></dl> |
| 311 | 355 |
| 312 <dl><dt><a name="PageMeasurement-DidNavigateToPage"><strong>DidNavigateToPage</s
trong></a>(self, page, tab)</dt><dd><tt>Override to do operations
right after the page is navigated, but
before<br> | 356 <dl><dt><a name="PageMeasurement-CustomizeBrowserOptionsForSinglePage"><strong>C
ustomizeBrowserOptionsForSinglePage</strong></a>(self, page, options)</dt><dd><t
t>Set options specific to the test and the&nb
sp;given page.<br> |
| 313 any waiting for completion has occurred.</tt></dd></dl> | 357 <br> |
| 358 This will be called with the current page&nbs
p;when the browser is (re)started.<br> |
| 359 Changing options at this point only makes sen
se if the browser is being<br> |
| 360 restarted for each page. Note that if page&nb
sp;has a startup_url, the browser<br> |
| 361 will always be restarted for each run.</tt></dd></
dl> |
| 362 |
| 363 <dl><dt><a name="PageMeasurement-DidNavigateToPage"><strong>DidNavigateToPage</s
trong></a>(self, page, tab)</dt><dd><tt>Override to do operations
right after the page is navigated and a
fter<br> |
| 364 all waiting for completion has occurred.</tt></dd></dl> |
| 314 | 365 |
| 315 <dl><dt><a name="PageMeasurement-DidRunAction"><strong>DidRunAction</strong></a>
(self, page, tab, action)</dt><dd><tt>Override to do operations&n
bsp;after running the action on the page.</tt></dd
></dl> | 366 <dl><dt><a name="PageMeasurement-DidRunAction"><strong>DidRunAction</strong></a>
(self, page, tab, action)</dt><dd><tt>Override to do operations&n
bsp;after running the action on the page.</tt></dd
></dl> |
| 316 | 367 |
| 317 <dl><dt><a name="PageMeasurement-DidRunPageSet"><strong>DidRunPageSet</strong></
a>(self, tab, results)</dt><dd><tt>Override to do operations 
;after page set is completed, but before brow
ser<br> | 368 <dl><dt><a name="PageMeasurement-DidRunActions"><strong>DidRunActions</strong></
a>(self, page, tab)</dt><dd><tt>Override to do operations af
ter running the actions on the page.</tt></dd></dl
> |
| 318 is torn down.</tt></dd></dl> | 369 |
| 370 <dl><dt><a name="PageMeasurement-DidRunPageRepeats"><strong>DidRunPageRepeats</s
trong></a>(self, page)</dt><dd><tt>Override to do operations 
;after each page is iterated over.</tt></dd></dl> |
| 371 |
| 372 <dl><dt><a name="PageMeasurement-DidRunTest"><strong>DidRunTest</strong></a>(sel
f, browser, results)</dt><dd><tt>Override to do operations a
fter all page set(s) are completed.<br> |
| 373 <br> |
| 374 This will occur before the browser is torn&nb
sp;down.</tt></dd></dl> |
| 375 |
| 376 <dl><dt><a name="PageMeasurement-DidStartBrowser"><strong>DidStartBrowser</stron
g></a>(self, browser)</dt><dd><tt>Override to customize the
browser right after it has launched.</tt></dd></dl> |
| 319 | 377 |
| 320 <dl><dt><a name="PageMeasurement-DidStartHTTPServer"><strong>DidStartHTTPServer<
/strong></a>(self, tab)</dt><dd><tt>Override to do operations&nbs
p;after the HTTP server is started.</tt></dd></dl> | 378 <dl><dt><a name="PageMeasurement-DidStartHTTPServer"><strong>DidStartHTTPServer<
/strong></a>(self, tab)</dt><dd><tt>Override to do operations&nbs
p;after the HTTP server is started.</tt></dd></dl> |
| 321 | 379 |
| 322 <dl><dt><a name="PageMeasurement-NeedsBrowserRestartAfterEachRun"><strong>NeedsB
rowserRestartAfterEachRun</strong></a>(self, tab)</dt><dd><tt>Override to&n
bsp;specify browser restart after each run.</tt></dd></
dl> | 380 <dl><dt><a name="PageMeasurement-IsExiting"><strong>IsExiting</strong></a>(self)
</dt></dl> |
| 323 | 381 |
| 324 <dl><dt><a name="PageMeasurement-Run"><strong>Run</strong></a>(self, options, pa
ge, tab, results)</dt></dl> | 382 <dl><dt><a name="PageMeasurement-RequestExit"><strong>RequestExit</strong></a>(s
elf)</dt></dl> |
| 325 | 383 |
| 326 <dl><dt><a name="PageMeasurement-SetUpBrowser"><strong>SetUpBrowser</strong></a>
(self, browser)</dt><dd><tt>Override to customize the browse
r right after it has launched.</tt></dd></dl> | 384 <dl><dt><a name="PageMeasurement-RestartBrowserBeforeEachPage"><strong>RestartBr
owserBeforeEachPage</strong></a>(self)</dt><dd><tt>Should the browser&
nbsp;be restarted for the page?<br> |
| 385 <br> |
| 386 This returns true if the test needs to u
nconditionally restart the<br> |
| 387 browser for each page. It may be called
before the browser is started.</tt></dd></dl> |
| 327 | 388 |
| 328 <dl><dt><a name="PageMeasurement-WillNavigateToPage"><strong>WillNavigateToPage<
/strong></a>(self, page, tab)</dt><dd><tt>Override to do operatio
ns before the page is navigated.</tt></dd></dl> | 389 <dl><dt><a name="PageMeasurement-Run"><strong>Run</strong></a>(self, page, tab,
results)</dt></dl> |
| 390 |
| 391 <dl><dt><a name="PageMeasurement-RunNavigateSteps"><strong>RunNavigateSteps</str
ong></a>(self, page, tab)</dt><dd><tt>Navigates the tab to t
he page URL attribute.<br> |
| 392 <br> |
| 393 Runs the 'navigate_steps' page attribute as a 
;compound action.</tt></dd></dl> |
| 394 |
| 395 <dl><dt><a name="PageMeasurement-StopBrowserAfterPage"><strong>StopBrowserAfterP
age</strong></a>(self, browser, page)</dt><dd><tt>Should the browser&n
bsp;be stopped after the page is run?<br> |
| 396 <br> |
| 397 This is called after a page is run to&nb
sp;decide whether the browser needs to<br> |
| 398 be stopped to clean up its state. If it&
nbsp;is stopped, then it will be<br> |
| 399 restarted to run the next page.<br> |
| 400 <br> |
| 401 A test that overrides this can look at b
oth the page and the browser to<br> |
| 402 decide whether it needs to stop the browser.<
/tt></dd></dl> |
| 403 |
| 404 <dl><dt><a name="PageMeasurement-TabForPage"><strong>TabForPage</strong></a>(sel
f, page, browser)</dt><dd><tt>Override to select a different
tab for the page. For instance, to<br> |
| 405 create a new tab for every page, return
browser.tabs.New().</tt></dd></dl> |
| 406 |
| 407 <dl><dt><a name="PageMeasurement-ValidatePageSet"><strong>ValidatePageSet</stron
g></a>(self, page_set)</dt><dd><tt>Override to examine the p
age set before the test run. Useful for
<br> |
| 408 example to validate that the pageset can be&n
bsp;used with the test.</tt></dd></dl> |
| 409 |
| 410 <dl><dt><a name="PageMeasurement-WillNavigateToPage"><strong>WillNavigateToPage<
/strong></a>(self, page, tab)</dt><dd><tt>Override to do operatio
ns before the page is navigated, notably Tele
metry<br> |
| 411 will already have performed the following operatio
ns on the browser before<br> |
| 412 calling this function:<br> |
| 413 * Ensure only one tab is open.<br> |
| 414 * Call WaitForDocumentReadyStateToComplete on the tab.<
/tt></dd></dl> |
| 329 | 415 |
| 330 <dl><dt><a name="PageMeasurement-WillRunAction"><strong>WillRunAction</strong></
a>(self, page, tab, action)</dt><dd><tt>Override to do operations
before running the action on the page.</tt><
/dd></dl> | 416 <dl><dt><a name="PageMeasurement-WillRunAction"><strong>WillRunAction</strong></
a>(self, page, tab, action)</dt><dd><tt>Override to do operations
before running the action on the page.</tt><
/dd></dl> |
| 331 | 417 |
| 332 <dl><dt><a name="PageMeasurement-WillRunPageSet"><strong>WillRunPageSet</strong>
</a>(self, tab)</dt><dd><tt>Override to do operations before
the page set is navigated.</tt></dd></dl> | 418 <dl><dt><a name="PageMeasurement-WillRunActions"><strong>WillRunActions</strong>
</a>(self, page, tab)</dt><dd><tt>Override to do operations
before running the actions on the page.</tt></dd><
/dl> |
| 419 |
| 420 <dl><dt><a name="PageMeasurement-WillRunPageRepeats"><strong>WillRunPageRepeats<
/strong></a>(self, page)</dt><dd><tt>Override to do operations&nb
sp;before each page is iterated over.</tt></dd></dl> |
| 421 |
| 422 <dl><dt><a name="PageMeasurement-WillRunTest"><strong>WillRunTest</strong></a>(s
elf, options)</dt><dd><tt>Override to do operations before&n
bsp;the page set(s) are navigated.</tt></dd></dl> |
| 423 |
| 424 <dl><dt><a name="PageMeasurement-WillStartBrowser"><strong>WillStartBrowser</str
ong></a>(self, browser)</dt><dd><tt>Override to manipulate the&nb
sp;browser environment before it launches.</tt></dd></dl> |
| 333 | 425 |
| 334 <hr> | 426 <hr> |
| 335 Data descriptors inherited from <a href="telemetry.page.page_test.html#PageTest"
>telemetry.page.page_test.PageTest</a>:<br> | 427 Data descriptors inherited from <a href="telemetry.page.page_test.html#PageTest"
>telemetry.page.page_test.PageTest</a>:<br> |
| 428 <dl><dt><strong>action_name_to_run</strong></dt> |
| 429 </dl> |
| 430 <dl><dt><strong>attempts</strong></dt> |
| 431 <dd><tt>Maximum number of times test will be
attempted.</tt></dd> |
| 432 </dl> |
| 433 <dl><dt><strong>clear_cache_before_each_run</strong></dt> |
| 434 <dd><tt>When set to True, the browser's disk
and memory cache will be cleared<br> |
| 435 before each run.</tt></dd> |
| 436 </dl> |
| 437 <dl><dt><strong>close_tabs_before_run</strong></dt> |
| 438 <dd><tt>When set to True, all tabs are closed
before running the test for the<br> |
| 439 first time.</tt></dd> |
| 440 </dl> |
| 441 <dl><dt><strong>discard_first_result</strong></dt> |
| 442 <dd><tt>When set to True, the first run of&nb
sp;the test is discarded. This is<br> |
| 443 useful for cases where it's desirable to have
some test resource cached so<br> |
| 444 the first run of the test can warm thing
s up.</tt></dd> |
| 445 </dl> |
| 446 <dl><dt><strong>max_errors</strong></dt> |
| 447 <dd><tt>Maximum number of errors allowed for the&n
bsp;page set.</tt></dd> |
| 448 </dl> |
| 449 <dl><dt><strong>max_failures</strong></dt> |
| 450 <dd><tt>Maximum number of failures allowed for the
page set.</tt></dd> |
| 451 </dl> |
| 452 <hr> |
| 453 Class methods inherited from <a href="telemetry.core.command_line.html#ArgumentH
andlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a>:<br> |
| 454 <dl><dt><a name="PageMeasurement-AddCommandLineArgs"><strong>AddCommandLineArgs<
/strong></a>(cls, parser)<font color="#909090"><font face="helvetica, arial"> fr
om <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><t
t>Override to accept custom command-line arguments.</tt
></dd></dl> |
| 455 |
| 456 <dl><dt><a name="PageMeasurement-ProcessCommandLineArgs"><strong>ProcessCommandL
ineArgs</strong></a>(cls, parser, args)<font color="#909090"><font face="helveti
ca, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></fo
nt></dt><dd><tt>Override to process command-line arguments.<
br> |
| 457 <br> |
| 458 We pass in parser so we can call parser.
error().</tt></dd></dl> |
| 459 |
| 460 <hr> |
| 461 Data descriptors inherited from <a href="telemetry.core.command_line.html#Argume
ntHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a>:<br> |
| 336 <dl><dt><strong>__dict__</strong></dt> | 462 <dl><dt><strong>__dict__</strong></dt> |
| 337 <dd><tt>dictionary for instance variables (if defined)<
/tt></dd> | 463 <dd><tt>dictionary for instance variables (if defined)<
/tt></dd> |
| 338 </dl> | 464 </dl> |
| 339 <dl><dt><strong>__weakref__</strong></dt> | 465 <dl><dt><strong>__weakref__</strong></dt> |
| 340 <dd><tt>list of weak references to the object 
;(if defined)</tt></dd> | 466 <dd><tt>list of weak references to the object 
;(if defined)</tt></dd> |
| 341 </dl> | 467 </dl> |
| 342 <dl><dt><strong>action_name_to_run</strong></dt> | |
| 343 </dl> | |
| 344 <dl><dt><strong>clear_cache_before_each_run</strong></dt> | |
| 345 <dd><tt>When set to True, the browser's disk
and memory cache will be cleared<br> | |
| 346 before each run.</tt></dd> | |
| 347 </dl> | |
| 348 <dl><dt><strong>discard_first_result</strong></dt> | |
| 349 <dd><tt>When set to True, the first run of&nb
sp;the test is discarded. This is<br> | |
| 350 useful for cases where it's desirable to have
some test resource cached so<br> | |
| 351 the first run of the test can warm thing
s up.</tt></dd> | |
| 352 </dl> | |
| 353 </td></tr></table> <p> | 468 </td></tr></table> <p> |
| 354 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> | 469 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 355 <tr bgcolor="#ffc8d8"> | 470 <tr bgcolor="#ffc8d8"> |
| 356 <td colspan=3 valign=bottom> <br> | 471 <td colspan=3 valign=bottom> <br> |
| 357 <font color="#000000" face="helvetica, arial"><a name="Tab">class <strong>Tab</s
trong></a>(<a href="telemetry.core.web_contents.html#WebContents">telemetry.core
.web_contents.WebContents</a>)</font></td></tr> | 472 <font color="#000000" face="helvetica, arial"><a name="Tab">class <strong>Tab</s
trong></a>(<a href="telemetry.core.web_contents.html#WebContents">telemetry.core
.web_contents.WebContents</a>)</font></td></tr> |
| 358 | 473 |
| 359 <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> | 474 <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| 360 <td colspan=2><tt>Represents a tab in the browser<br> | 475 <td colspan=2><tt>Represents a tab in the browser<br> |
| 361 <br> | 476 <br> |
| 362 The important parts of the <a href="#Tab">Tab</a>
<a href="__builtin__.html#object">object</a> are in the runt
ime and page objects.<br> | 477 The important parts of the <a href="#Tab">Tab</a>
<a href="__builtin__.html#object">object</a> are in the runt
ime and page objects.<br> |
| (...skipping 14 matching lines...) Expand all Loading... |
| 377 <dl><dt><a name="Tab-Activate"><strong>Activate</strong></a>(self)</dt><dd><tt>B
rings this tab to the foreground asynchronously.<b
r> | 492 <dl><dt><a name="Tab-Activate"><strong>Activate</strong></a>(self)</dt><dd><tt>B
rings this tab to the foreground asynchronously.<b
r> |
| 378 <br> | 493 <br> |
| 379 Not all browsers or browser versions support
this method.<br> | 494 Not all browsers or browser versions support
this method.<br> |
| 380 Be sure to check browser.supports_tab_control.<br> | 495 Be sure to check browser.supports_tab_control.<br> |
| 381 <br> | 496 <br> |
| 382 Please note: this is asynchronous. There is a
delay between this call<br> | 497 Please note: this is asynchronous. There is a
delay between this call<br> |
| 383 and the page's documentVisibilityState becoming 'visibl
e', and yet more<br> | 498 and the page's documentVisibilityState becoming 'visibl
e', and yet more<br> |
| 384 delay until the actual tab is visible to 
;the user. None of these delays<br> | 499 delay until the actual tab is visible to 
;the user. None of these delays<br> |
| 385 are included in this call.</tt></dd></dl> | 500 are included in this call.</tt></dd></dl> |
| 386 | 501 |
| 387 <dl><dt><a name="Tab-ClearCache"><strong>ClearCache</strong></a>(self)</dt><dd><
tt>Clears the browser's HTTP disk cache and t
he tab's HTTP memory cache.</tt></dd></dl> | 502 <dl><dt><a name="Tab-ClearCache"><strong>ClearCache</strong></a>(self, force)</d
t><dd><tt>Clears the browser's networking related disk,
memory and other caches.<br> |
| 503 <br> |
| 504 Args:<br> |
| 505 force: Iff true, navigates to about:blank&n
bsp;which destroys the previous<br> |
| 506 renderer, ensuring that even&
nbsp;"live" resources in the memory cache are<br> |
| 507 cleared.</tt></dd></dl> |
| 508 |
| 509 <dl><dt><a name="Tab-ClearHighlight"><strong>ClearHighlight</strong></a>(self, c
olor)</dt><dd><tt>Clears a highlight of the given
bitmap.RgbaColor.</tt></dd></dl> |
| 388 | 510 |
| 389 <dl><dt><a name="Tab-CollectGarbage"><strong>CollectGarbage</strong></a>(self)</
dt></dl> | 511 <dl><dt><a name="Tab-CollectGarbage"><strong>CollectGarbage</strong></a>(self)</
dt></dl> |
| 390 | 512 |
| 391 <dl><dt><a name="Tab-GetCookieByName"><strong>GetCookieByName</strong></a>(self,
name, timeout<font color="#909090">=60</font>)</dt><dd><tt>Returns the&nbs
p;value of the cookie by the given |name|.</t
t></dd></dl> | 513 <dl><dt><a name="Tab-GetCookieByName"><strong>GetCookieByName</strong></a>(self,
name, timeout<font color="#909090">=60</font>)</dt><dd><tt>Returns the&nbs
p;value of the cookie by the given |name|.</t
t></dd></dl> |
| 392 | 514 |
| 515 <dl><dt><a name="Tab-Highlight"><strong>Highlight</strong></a>(self, color)</dt>
<dd><tt>Synchronously highlights entire tab contents wi
th the given RgbaColor.<br> |
| 516 <br> |
| 517 TODO(tonyg): It is possible that the z-index
hack here might not work for<br> |
| 518 all pages. If this happens, DevTools also pro
vides a method for this.</tt></dd></dl> |
| 519 |
| 393 <dl><dt><a name="Tab-Navigate"><strong>Navigate</strong></a>(self, url, script_t
o_evaluate_on_commit<font color="#909090">=None</font>, timeout<font color="#909
090">=60</font>)</dt><dd><tt>Navigates to url.<br> | 520 <dl><dt><a name="Tab-Navigate"><strong>Navigate</strong></a>(self, url, script_t
o_evaluate_on_commit<font color="#909090">=None</font>, timeout<font color="#909
090">=60</font>)</dt><dd><tt>Navigates to url.<br> |
| 394 <br> | 521 <br> |
| 395 If |script_to_evaluate_on_commit| is given, the script&
nbsp;source string will be<br> | 522 If |script_to_evaluate_on_commit| is given, the script&
nbsp;source string will be<br> |
| 396 evaluated when the navigation is committed. This&n
bsp;is after the context of<br> | 523 evaluated when the navigation is committed. This&n
bsp;is after the context of<br> |
| 397 the page exists, but before any script on&nbs
p;the page itself has executed.</tt></dd></dl> | 524 the page exists, but before any script on&nbs
p;the page itself has executed.</tt></dd></dl> |
| 398 | 525 |
| 399 <dl><dt><a name="Tab-PerformActionAndWaitForNavigate"><strong>PerformActionAndWa
itForNavigate</strong></a>(self, action_function, timeout<font color="#909090">=
60</font>)</dt><dd><tt>Executes action_function, and waits f
or the navigation to complete.<br> | 526 <dl><dt><a name="Tab-PerformActionAndWaitForNavigate"><strong>PerformActionAndWa
itForNavigate</strong></a>(self, action_function, timeout<font color="#909090">=
60</font>)</dt><dd><tt>Executes action_function, and waits f
or the navigation to complete.<br> |
| 400 <br> | 527 <br> |
| 401 action_function must be a Python function that&nbs
p;results in a navigation.<br> | 528 action_function must be a Python function that&nbs
p;results in a navigation.<br> |
| 402 This function returns when the navigation is
complete or when<br> | 529 This function returns when the navigation is
complete or when<br> |
| 403 the timeout has been exceeded.</tt></dd></dl> | 530 the timeout has been exceeded.</tt></dd></dl> |
| 404 | 531 |
| 405 <dl><dt><a name="Tab-Screenshot"><strong>Screenshot</strong></a>(self, timeout<f
ont color="#909090">=60</font>)</dt><dd><tt>Capture a screenshot
of the window for rendering validation</tt></dd></dl> | 532 <dl><dt><a name="Tab-Screenshot"><strong>Screenshot</strong></a>(self, timeout<f
ont color="#909090">=60</font>)</dt><dd><tt>Capture a screenshot
of the tab's contents.<br> |
| 533 <br> |
| 534 Returns:<br> |
| 535 A telemetry.core.Bitmap.</tt></dd></dl> |
| 406 | 536 |
| 407 <dl><dt><a name="Tab-__del__"><strong>__del__</strong></a>(self)</dt></dl> | 537 <dl><dt><a name="Tab-StartVideoCapture"><strong>StartVideoCapture</strong></a>(s
elf, min_bitrate_mbps)</dt><dd><tt>Starts capturing video of 
;the tab's contents.<br> |
| 538 <br> |
| 539 This works by flashing the entire tab content
s to a arbitrary color and then<br> |
| 540 starting video recording. When the frames are 
;processed, we can look for<br> |
| 541 that flash as the content bounds.<br> |
| 542 <br> |
| 543 Args:<br> |
| 544 min_bitrate_mbps: The minimum caputre bitrate&nb
sp;in MegaBits Per Second.<br> |
| 545 The platform is free to&
nbsp;deliver a higher bitrate if it can do&nb
sp;so<br> |
| 546 without increasing overhead.</tt><
/dd></dl> |
| 547 |
| 548 <dl><dt><a name="Tab-StopVideoCapture"><strong>StopVideoCapture</strong></a>(sel
f)</dt><dd><tt>Stops recording video of the tab's
contents.<br> |
| 549 <br> |
| 550 This looks for the initial color flash in&nbs
p;the first frame to establish the<br> |
| 551 tab content boundaries and then omits all fra
mes displaying the flash.<br> |
| 552 <br> |
| 553 Yields:<br> |
| 554 (time_ms, bitmap) tuples representing each
video keyframe. Only the first<br> |
| 555 frame in a run of sequential duplicate
bitmaps is typically included.<br> |
| 556 time_ms is milliseconds since naviga
tionStart.<br> |
| 557 bitmap is a telemetry.core.Bitmap.</tt></
dd></dl> |
| 408 | 558 |
| 409 <dl><dt><a name="Tab-__init__"><strong>__init__</strong></a>(self, inspector_bac
kend)</dt></dl> | 559 <dl><dt><a name="Tab-__init__"><strong>__init__</strong></a>(self, inspector_bac
kend)</dt></dl> |
| 410 | 560 |
| 411 <hr> | 561 <hr> |
| 412 Data descriptors defined here:<br> | 562 Data descriptors defined here:<br> |
| 413 <dl><dt><strong>browser</strong></dt> | 563 <dl><dt><strong>browser</strong></dt> |
| 414 <dd><tt>The browser in which this tab resides.</tt
></dd> | 564 <dd><tt>The browser in which this tab resides.</tt
></dd> |
| 415 </dl> | 565 </dl> |
| 416 <dl><dt><strong>dom_stats</strong></dt> | 566 <dl><dt><strong>dom_stats</strong></dt> |
| 417 <dd><tt>A dictionary populated with measured DOM s
tatistics.<br> | 567 <dd><tt>A dictionary populated with measured DOM s
tatistics.<br> |
| 418 <br> | 568 <br> |
| 419 Currently this dictionary contains:<br> | 569 Currently this dictionary contains:<br> |
| 420 {<br> | 570 {<br> |
| 421 'document_count': integer,<br> | 571 'document_count': integer,<br> |
| 422 'node_count': integer,<br> | 572 'node_count': integer,<br> |
| 423 'event_listener_count': integer<br> | 573 'event_listener_count': integer<br> |
| 424 }</tt></dd> | 574 }</tt></dd> |
| 425 </dl> | 575 </dl> |
| 576 <dl><dt><strong>is_video_capture_running</strong></dt> |
| 577 </dl> |
| 426 <dl><dt><strong>screenshot_supported</strong></dt> | 578 <dl><dt><strong>screenshot_supported</strong></dt> |
| 427 <dd><tt>True if the browser instance is capable&nb
sp;of capturing screenshots</tt></dd> | 579 <dd><tt>True if the browser instance is capable&nb
sp;of capturing screenshots.</tt></dd> |
| 428 </dl> | 580 </dl> |
| 429 <dl><dt><strong>url</strong></dt> | 581 <dl><dt><strong>url</strong></dt> |
| 430 </dl> | 582 </dl> |
| 583 <dl><dt><strong>video_capture_supported</strong></dt> |
| 584 <dd><tt>True if the browser instance is capable&nb
sp;of capturing video.</tt></dd> |
| 585 </dl> |
| 431 <hr> | 586 <hr> |
| 432 Methods inherited from <a href="telemetry.core.web_contents.html#WebContents">te
lemetry.core.web_contents.WebContents</a>:<br> | 587 Methods inherited from <a href="telemetry.core.web_contents.html#WebContents">te
lemetry.core.web_contents.WebContents</a>:<br> |
| 433 <dl><dt><a name="Tab-Close"><strong>Close</strong></a>(self)</dt><dd><tt>Closes&
nbsp;this page.<br> | 588 <dl><dt><a name="Tab-Close"><strong>Close</strong></a>(self)</dt><dd><tt>Closes&
nbsp;this page.<br> |
| 434 <br> | 589 <br> |
| 435 Not all browsers or browser versions support
this method.<br> | 590 Not all browsers or browser versions support
this method.<br> |
| 436 Be sure to check browser.supports_tab_control.</tt></dd></dl
> | 591 Be sure to check browser.supports_tab_control.</tt></dd></dl
> |
| 437 | 592 |
| 438 <dl><dt><a name="Tab-Disconnect"><strong>Disconnect</strong></a>(self)</dt></dl> | 593 <dl><dt><a name="Tab-EvaluateJavaScript"><strong>EvaluateJavaScript</strong></a>
(self, expr, timeout<font color="#909090">=90</font>)</dt><dd><tt>Evalutes
expr in JavaScript and returns the JSONized r
esult.<br> |
| 439 | |
| 440 <dl><dt><a name="Tab-EvaluateJavaScript"><strong>EvaluateJavaScript</strong></a>
(self, expr, timeout<font color="#909090">=60</font>)</dt><dd><tt>Evalutes
expr in JavaScript and returns the JSONized r
esult.<br> | |
| 441 <br> | 594 <br> |
| 442 Consider using ExecuteJavaScript for cases where t
he result of the<br> | 595 Consider using ExecuteJavaScript for cases where t
he result of the<br> |
| 443 expression is not needed.<br> | 596 expression is not needed.<br> |
| 444 <br> | 597 <br> |
| 445 If evaluation throws in JavaScript, a Python
EvaluateException will<br> | 598 If evaluation throws in JavaScript, a Python
EvaluateException will<br> |
| 446 be raised.<br> | 599 be raised.<br> |
| 447 <br> | 600 <br> |
| 448 If the result of the evaluation cannot be&nbs
p;JSONized, then an<br> | 601 If the result of the evaluation cannot be&nbs
p;JSONized, then an<br> |
| 449 EvaluationException will be raised.</tt></dd></dl> | 602 EvaluationException will be raised.</tt></dd></dl> |
| 450 | 603 |
| 451 <dl><dt><a name="Tab-ExecuteJavaScript"><strong>ExecuteJavaScript</strong></a>(s
elf, expr, timeout<font color="#909090">=60</font>)</dt><dd><tt>Executes ex
pr in JavaScript. Does not return the result.
<br> | 604 <dl><dt><a name="Tab-EvaluateJavaScriptInContext"><strong>EvaluateJavaScriptInCo
ntext</strong></a>(self, expr, context_id, timeout<font color="#909090">=90</fon
t>)</dt><dd><tt>Similar to ExecuteJavaScript, except context
_id can refer to an iframe.<br> |
| 605 The main page has context_id=1, the first ifr
ame context_id=2, etc.</tt></dd></dl> |
| 606 |
| 607 <dl><dt><a name="Tab-ExecuteJavaScript"><strong>ExecuteJavaScript</strong></a>(s
elf, expr, timeout<font color="#909090">=90</font>)</dt><dd><tt>Executes ex
pr in JavaScript. Does not return the result.
<br> |
| 452 <br> | 608 <br> |
| 453 If the expression failed to evaluate, EvaluateExce
ption will be raised.</tt></dd></dl> | 609 If the expression failed to evaluate, EvaluateExce
ption will be raised.</tt></dd></dl> |
| 454 | 610 |
| 455 <dl><dt><a name="Tab-StartTimelineRecording"><strong>StartTimelineRecording</str
ong></a>(self)</dt></dl> | 611 <dl><dt><a name="Tab-ExecuteJavaScriptInContext"><strong>ExecuteJavaScriptInCont
ext</strong></a>(self, expr, context_id, timeout<font color="#909090">=90</font>
)</dt><dd><tt>Similar to ExecuteJavaScript, except context_i
d can refer to an iframe.<br> |
| 612 The main page has context_id=1, the first ifr
ame context_id=2, etc.</tt></dd></dl> |
| 613 |
| 614 <dl><dt><a name="Tab-HasReachedQuiescence"><strong>HasReachedQuiescence</strong>
</a>(self)</dt><dd><tt>Determine whether the page has r
eached quiescence after loading.<br> |
| 615 <br> |
| 616 Returns:<br> |
| 617 True if 2 seconds have passed since&nb
sp;last resource received, false<br> |
| 618 otherwise.</tt></dd></dl> |
| 619 |
| 620 <dl><dt><a name="Tab-StartTimelineRecording"><strong>StartTimelineRecording</str
ong></a>(self, options<font color="#909090">=None</font>)</dt></dl> |
| 456 | 621 |
| 457 <dl><dt><a name="Tab-StopTimelineRecording"><strong>StopTimelineRecording</stron
g></a>(self)</dt></dl> | 622 <dl><dt><a name="Tab-StopTimelineRecording"><strong>StopTimelineRecording</stron
g></a>(self)</dt></dl> |
| 458 | 623 |
| 459 <dl><dt><a name="Tab-WaitForDocumentReadyStateToBeComplete"><strong>WaitForDocum
entReadyStateToBeComplete</strong></a>(self, timeout<font color="#909090">=60</f
ont>)</dt></dl> | 624 <dl><dt><a name="Tab-TakeJSHeapSnapshot"><strong>TakeJSHeapSnapshot</strong></a>
(self, timeout<font color="#909090">=120</font>)</dt></dl> |
| 460 | 625 |
| 461 <dl><dt><a name="Tab-WaitForDocumentReadyStateToBeInteractiveOrBetter"><strong>W
aitForDocumentReadyStateToBeInteractiveOrBetter</strong></a>(self, timeout<font
color="#909090">=60</font>)</dt></dl> | 626 <dl><dt><a name="Tab-WaitForDocumentReadyStateToBeComplete"><strong>WaitForDocum
entReadyStateToBeComplete</strong></a>(self, timeout<font color="#909090">=90</f
ont>)</dt></dl> |
| 627 |
| 628 <dl><dt><a name="Tab-WaitForDocumentReadyStateToBeInteractiveOrBetter"><strong>W
aitForDocumentReadyStateToBeInteractiveOrBetter</strong></a>(self, timeout<font
color="#909090">=90</font>)</dt></dl> |
| 629 |
| 630 <dl><dt><a name="Tab-WaitForJavaScriptExpression"><strong>WaitForJavaScriptExpre
ssion</strong></a>(self, expr, timeout)</dt><dd><tt>Waits for the 
;given JavaScript expression to be True.<br> |
| 631 <br> |
| 632 This method is robust against any given Evalu
ation timing out.</tt></dd></dl> |
| 462 | 633 |
| 463 <hr> | 634 <hr> |
| 464 Data descriptors inherited from <a href="telemetry.core.web_contents.html#WebCon
tents">telemetry.core.web_contents.WebContents</a>:<br> | 635 Data descriptors inherited from <a href="telemetry.core.web_contents.html#WebCon
tents">telemetry.core.web_contents.WebContents</a>:<br> |
| 465 <dl><dt><strong>__dict__</strong></dt> | 636 <dl><dt><strong>__dict__</strong></dt> |
| 466 <dd><tt>dictionary for instance variables (if defined)<
/tt></dd> | 637 <dd><tt>dictionary for instance variables (if defined)<
/tt></dd> |
| 467 </dl> | 638 </dl> |
| 468 <dl><dt><strong>__weakref__</strong></dt> | 639 <dl><dt><strong>__weakref__</strong></dt> |
| 469 <dd><tt>list of weak references to the object 
;(if defined)</tt></dd> | 640 <dd><tt>list of weak references to the object 
;(if defined)</tt></dd> |
| 470 </dl> | 641 </dl> |
| 642 <dl><dt><strong>is_timeline_recording_running</strong></dt> |
| 643 </dl> |
| 471 <dl><dt><strong>message_output_stream</strong></dt> | 644 <dl><dt><strong>message_output_stream</strong></dt> |
| 472 </dl> | 645 </dl> |
| 473 <dl><dt><strong>timeline_model</strong></dt> | 646 <dl><dt><strong>timeline_model</strong></dt> |
| 474 </dl> | 647 </dl> |
| 475 </td></tr></table></td></tr></table><p> | 648 </td></tr></table></td></tr></table><p> |
| 476 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> | 649 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 477 <tr bgcolor="#eeaa77"> | 650 <tr bgcolor="#eeaa77"> |
| 478 <td colspan=3 valign=bottom> <br> | 651 <td colspan=3 valign=bottom> <br> |
| 479 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></b
ig></font></td></tr> | 652 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></b
ig></font></td></tr> |
| 480 | 653 |
| 481 <tr><td bgcolor="#eeaa77"><tt> </tt></td><td>
</td> | 654 <tr><td bgcolor="#eeaa77"><tt> </tt></td><td>
</td> |
| 482 <td width="100%"><dl><dt><a name="-RunPage"><strong>RunPage</strong></a> = Run(t
est, page_set, options)</dt><dd><tt>Runs a given test agains
t a given page_set with the given options.</t
t></dd></dl> | 655 <td width="100%"><dl><dt><a name="-RunPage"><strong>RunPage</strong></a> = Run(t
est, page_set, expectations, finder_options)</dt><dd><tt>Runs a given&
nbsp;test against a given page_set with the g
iven options.</tt></dd></dl> |
| 483 </td></tr></table><p> | 656 </td></tr></table><p> |
| 484 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> | 657 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 485 <tr bgcolor="#55aa55"> | 658 <tr bgcolor="#55aa55"> |
| 486 <td colspan=3 valign=bottom> <br> | 659 <td colspan=3 valign=bottom> <br> |
| 487 <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></
font></td></tr> | 660 <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></
font></td></tr> |
| 488 | 661 |
| 489 <tr><td bgcolor="#55aa55"><tt> </tt></td><td>
</td> | 662 <tr><td bgcolor="#55aa55"><tt> </tt></td><td>
</td> |
| 490 <td width="100%"><strong>__all__</strong> = ['Browser', 'BrowserOptions', 'PageM
easurement', 'RunPage', 'Tab']</td></tr></table> | 663 <td width="100%"><strong>__all__</strong> = ['Browser', 'BrowserFinderOptions',
'PageMeasurement', 'RunPage', 'Tab']</td></tr></table> |
| 491 </body></html> | 664 </body></html> |
| OLD | NEW |