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

Side by Side Diff: tools/telemetry/docs/telemetry.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
« no previous file with comments | « no previous file | tools/telemetry/docs/telemetry.core.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
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: 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>&nbsp;<br> 8 <td valign=bottom>&nbsp;<br>
9 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>teleme try</strong></big></big></font></td 9 <font color="#ffffff" face="helvetica, arial">&nbsp;<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&nbsp;library&nbsp;for&nbsp;cross-platform&nbsp;browser&nbsp;tests.< /tt></p> 12 <p><tt>A&nbsp;library&nbsp;for&nbsp;cross-platform&nbsp;browser&nbsp;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>&nbsp;<br> 16 <td colspan=3 valign=bottom>&nbsp;<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>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</td> 19 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</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>&nbsp;(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>&nbsp;(package)</a><br>
21 <a href="telemetry.page.html"><strong>page</strong>&nbsp;(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>&nbsp;(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>&nbsp;(package)</a><br> 26 </td><td width="25%" valign=top><a href="telemetry.unittest.html"><strong>unitte st</strong>&nbsp;(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>&nbsp;(package)</a><br>
28 <a href="telemetry.value.html"><strong>value</strong>&nbsp;(package)</a><br>
29 </td><td width="25%" valign=top><a href="telemetry.web_components.html"><strong> web_components</strong>&nbsp;(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>&nbsp;<br> 33 <td colspan=3 valign=bottom>&nbsp;<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>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</td> 36 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</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>&nbsp;<br> 66 <td colspan=3 valign=bottom>&nbsp;<br>
(...skipping 10 matching lines...) Expand all
72 &nbsp;&nbsp;with&nbsp;browser_to_create.Create()&nbsp;as&nbsp;browser:<br> 77 &nbsp;&nbsp;with&nbsp;browser_to_create.Create()&nbsp;as&nbsp;browser:<br>
73 &nbsp;&nbsp;&nbsp;&nbsp;...&nbsp;do&nbsp;all&nbsp;your&nbsp;operations&nbsp;on&n bsp;browser&nbsp;here<br>&nbsp;</tt></td></tr> 78 &nbsp;&nbsp;&nbsp;&nbsp;...&nbsp;do&nbsp;all&nbsp;your&nbsp;operations&nbsp;on&n bsp;browser&nbsp;here<br>&nbsp;</tt></td></tr>
74 <tr><td>&nbsp;</td> 79 <tr><td>&nbsp;</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&nbsp;this&nbsp;browser.</tt></dd></dl> 81 <dl><dt><a name="Browser-Close"><strong>Close</strong></a>(self)</dt><dd><tt>Clo ses&nbsp;this&nbsp;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&nbsp;the&nbsp;result&nbsp;of&nbsp;the&nbs p;trace,&nbsp;as&nbsp;TraceResult&nbsp;<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&nbsp;low-level&nbsp;information&nbsp;about&nbsp;the&nbsp;sy stem,&nbsp;if&nbsp;available.<br>
88 &nbsp;<br>
89 See&nbsp;the&nbsp;documentation&nbsp;of&nbsp;the&nbsp;SystemInfo&nbsp;class&nbsp ;for&nbsp;more&nbsp;details.</tt></dd></dl>
83 90
84 <dl><dt><a name="Browser-SetHTTPServerDirectories"><strong>SetHTTPServerDirector ies</strong></a>(self, paths)</dt><dd><tt>Returns&nbsp;True&nbsp;if&nbsp;the&nbs p;HTTP&nbsp;server&nbsp;was&nbsp;started,&nbsp;False&nbsp;otherwise.</tt></dd></ dl> 91 <dl><dt><a name="Browser-SetHTTPServerDirectories"><strong>SetHTTPServerDirector ies</strong></a>(self, paths)</dt><dd><tt>Returns&nbsp;True&nbsp;if&nbsp;the&nbs p;HTTP&nbsp;server&nbsp;was&nbsp;started,&nbsp;False&nbsp;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&nbsp;profiling&nbsp;using&nbsp; |options|.profiler_tool.&nbsp;Results&nbsp;are&nbsp;saved&nbsp;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&nbsp;a&nbsp;LocalServer&nbsp;and&nbsp;associat es&nbsp;it&nbsp;with&nbsp;this&nbsp;browser.<br>
98 &nbsp;<br>
99 It&nbsp;will&nbsp;be&nbsp;closed&nbsp;when&nbsp;the&nbsp;browser&nbsp;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&nbsp;profiling&nbsp;using &nbsp;|profiler_name|.&nbsp;Results&nbsp;are&nbsp;saved&nbsp;to<br>
89 |base_output_file|.&lt;process_name&gt;.</tt></dd></dl> 102 |base_output_file|.&lt;process_name&gt;.</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&nbsp;all&nbsp;active&nbsp;profilers&nbsp;and&nbsp;saves&nbsp; their&nbsp;results.</tt></dd></dl> 106 <dl><dt><a name="Browser-StopProfiling"><strong>StopProfiling</strong></a>(self) </dt><dd><tt>Stops&nbsp;all&nbsp;active&nbsp;profilers&nbsp;and&nbsp;saves&nbsp; their&nbsp;results.<br>
107 &nbsp;<br>
108 Returns:<br>
109 &nbsp;&nbsp;A&nbsp;list&nbsp;of&nbsp;filenames&nbsp;produced&nbsp;by&nbsp;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&nbsp;tracing&nbsp;and&nbsp;returns&nbsp;the&nbsp;result&nbsp;as&n bsp;TimelineData&nbsp;<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&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)< /tt></dd> 124 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;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&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp ;(if&nbsp;defined)</tt></dd> 127 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp ;(if&nbsp;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&nbsp;a&nbsp;dict&nbsp;of&nbsp;cpu&nbsp;statistics&nbsp;for&nbsp; the&nbsp;system.<br>
133 {&nbsp;'Browser':&nbsp;{<br>
134 &nbsp;&nbsp;&nbsp;&nbsp;'CpuProcessTime':&nbsp;S,<br>
135 &nbsp;&nbsp;&nbsp;&nbsp;'TotalTime':&nbsp;T<br>
136 &nbsp;&nbsp;},<br>
137 &nbsp;&nbsp;'Gpu':&nbsp;{<br>
138 &nbsp;&nbsp;&nbsp;&nbsp;'CpuProcessTime':&nbsp;S,<br>
139 &nbsp;&nbsp;&nbsp;&nbsp;'TotalTime':&nbsp;T<br>
140 &nbsp;&nbsp;},<br>
141 &nbsp;&nbsp;'Renderer':&nbsp;{<br>
142 &nbsp;&nbsp;&nbsp;&nbsp;'CpuProcessTime':&nbsp;S,<br>
143 &nbsp;&nbsp;&nbsp;&nbsp;'TotalTime':&nbsp;T<br>
144 &nbsp;&nbsp;}<br>
145 }<br>
146 Any&nbsp;of&nbsp;the&nbsp;above&nbsp;keys&nbsp;may&nbsp;be&nbsp;missing&nbsp;on& nbsp;a&nbsp;per-platform&nbsp;basis.</tt></dd>
147 </dl>
115 <dl><dt><strong>extensions</strong></dt> 148 <dl><dt><strong>extensions</strong></dt>
116 <dd><tt>Returns&nbsp;the&nbsp;extension&nbsp;dictionary&nbsp;if&nbsp;it&nbsp;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&nbsp;a&nbsp;dict&nbsp;of&nbsp;IO&nbsp;statistics&nbsp;for&nbsp;t he&nbsp;browser:<br> 155 <dd><tt>Returns&nbsp;a&nbsp;dict&nbsp;of&nbsp;IO&nbsp;statistics&nbsp;for&nbsp;t he&nbsp;browser:<br>
122 {&nbsp;'Browser':&nbsp;{<br> 156 {&nbsp;'Browser':&nbsp;{<br>
123 &nbsp;&nbsp;&nbsp;&nbsp;'ReadOperationCount':&nbsp;W,<br> 157 &nbsp;&nbsp;&nbsp;&nbsp;'ReadOperationCount':&nbsp;W,<br>
124 &nbsp;&nbsp;&nbsp;&nbsp;'WriteOperationCount':&nbsp;X,<br> 158 &nbsp;&nbsp;&nbsp;&nbsp;'WriteOperationCount':&nbsp;X,<br>
125 &nbsp;&nbsp;&nbsp;&nbsp;'ReadTransferCount':&nbsp;Y,<br> 159 &nbsp;&nbsp;&nbsp;&nbsp;'ReadTransferCount':&nbsp;Y,<br>
126 &nbsp;&nbsp;&nbsp;&nbsp;'WriteTransferCount':&nbsp;Z<br> 160 &nbsp;&nbsp;&nbsp;&nbsp;'WriteTransferCount':&nbsp;Z<br>
127 &nbsp;&nbsp;},<br> 161 &nbsp;&nbsp;},<br>
128 &nbsp;&nbsp;'Gpu':&nbsp;{<br> 162 &nbsp;&nbsp;'Gpu':&nbsp;{<br>
129 &nbsp;&nbsp;&nbsp;&nbsp;'ReadOperationCount':&nbsp;W,<br> 163 &nbsp;&nbsp;&nbsp;&nbsp;'ReadOperationCount':&nbsp;W,<br>
130 &nbsp;&nbsp;&nbsp;&nbsp;'WriteOperationCount':&nbsp;X,<br> 164 &nbsp;&nbsp;&nbsp;&nbsp;'WriteOperationCount':&nbsp;X,<br>
131 &nbsp;&nbsp;&nbsp;&nbsp;'ReadTransferCount':&nbsp;Y,<br> 165 &nbsp;&nbsp;&nbsp;&nbsp;'ReadTransferCount':&nbsp;Y,<br>
132 &nbsp;&nbsp;&nbsp;&nbsp;'WriteTransferCount':&nbsp;Z<br> 166 &nbsp;&nbsp;&nbsp;&nbsp;'WriteTransferCount':&nbsp;Z<br>
133 &nbsp;&nbsp;},<br> 167 &nbsp;&nbsp;},<br>
134 &nbsp;&nbsp;'Renderer':&nbsp;{<br> 168 &nbsp;&nbsp;'Renderer':&nbsp;{<br>
135 &nbsp;&nbsp;&nbsp;&nbsp;'ReadOperationCount':&nbsp;W,<br> 169 &nbsp;&nbsp;&nbsp;&nbsp;'ReadOperationCount':&nbsp;W,<br>
136 &nbsp;&nbsp;&nbsp;&nbsp;'WriteOperationCount':&nbsp;X,<br> 170 &nbsp;&nbsp;&nbsp;&nbsp;'WriteOperationCount':&nbsp;X,<br>
137 &nbsp;&nbsp;&nbsp;&nbsp;'ReadTransferCount':&nbsp;Y,<br> 171 &nbsp;&nbsp;&nbsp;&nbsp;'ReadTransferCount':&nbsp;Y,<br>
138 &nbsp;&nbsp;&nbsp;&nbsp;'WriteTransferCount':&nbsp;Z<br> 172 &nbsp;&nbsp;&nbsp;&nbsp;'WriteTransferCount':&nbsp;Z<br>
139 &nbsp;&nbsp;}<br> 173 &nbsp;&nbsp;}<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&nbsp;whether&nbsp;this&nbsp;browser&nbsp;is&nbsp;a&nbsp;content& nbsp;shell,&nbsp;only.</tt></dd> 177 <dd><tt>Returns&nbsp;whether&nbsp;this&nbsp;browser&nbsp;is&nbsp;a&nbsp;content& nbsp;shell,&nbsp;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&nbsp;the&nbsp;currently&nbsp;running&nbsp;local&nbsp;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&nbsp;a&nbsp;dict&nbsp;of&nbsp;memory&nbsp;statistics&nbsp;for&nb sp;the&nbsp;browser:<br> 185 <dd><tt>Returns&nbsp;a&nbsp;dict&nbsp;of&nbsp;memory&nbsp;statistics&nbsp;for&nb sp;the&nbsp;browser:<br>
147 {&nbsp;'Browser':&nbsp;{<br> 186 {&nbsp;'Browser':&nbsp;{<br>
148 &nbsp;&nbsp;&nbsp;&nbsp;'VM':&nbsp;S,<br> 187 &nbsp;&nbsp;&nbsp;&nbsp;'VM':&nbsp;R,<br>
149 &nbsp;&nbsp;&nbsp;&nbsp;'VMPeak':&nbsp;T,<br> 188 &nbsp;&nbsp;&nbsp;&nbsp;'VMPeak':&nbsp;S,<br>
150 &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSize':&nbsp;U,<br> 189 &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSize':&nbsp;T,<br>
151 &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSizePeak':&nbsp;V,<br> 190 &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSizePeak':&nbsp;U,<br>
152 &nbsp;&nbsp;&nbsp;&nbsp;'ProportionalSetSize':&nbsp;W,<br> 191 &nbsp;&nbsp;&nbsp;&nbsp;'ProportionalSetSize':&nbsp;V,<br>
153 &nbsp;&nbsp;&nbsp;&nbsp;'PrivateDirty':&nbsp;X<br> 192 &nbsp;&nbsp;&nbsp;&nbsp;'PrivateDirty':&nbsp;W<br>
154 &nbsp;&nbsp;},<br> 193 &nbsp;&nbsp;},<br>
155 &nbsp;&nbsp;'Gpu':&nbsp;{<br> 194 &nbsp;&nbsp;'Gpu':&nbsp;{<br>
156 &nbsp;&nbsp;&nbsp;&nbsp;'VM':&nbsp;S,<br> 195 &nbsp;&nbsp;&nbsp;&nbsp;'VM':&nbsp;R,<br>
157 &nbsp;&nbsp;&nbsp;&nbsp;'VMPeak':&nbsp;T,<br> 196 &nbsp;&nbsp;&nbsp;&nbsp;'VMPeak':&nbsp;S,<br>
158 &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSize':&nbsp;U,<br> 197 &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSize':&nbsp;T,<br>
159 &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSizePeak':&nbsp;V,<br> 198 &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSizePeak':&nbsp;U,<br>
160 &nbsp;&nbsp;&nbsp;&nbsp;'ProportionalSetSize':&nbsp;W,<br> 199 &nbsp;&nbsp;&nbsp;&nbsp;'ProportionalSetSize':&nbsp;V,<br>
161 &nbsp;&nbsp;&nbsp;&nbsp;'PrivateDirty':&nbsp;X<br> 200 &nbsp;&nbsp;&nbsp;&nbsp;'PrivateDirty':&nbsp;W<br>
162 &nbsp;&nbsp;},<br> 201 &nbsp;&nbsp;},<br>
163 &nbsp;&nbsp;'Renderer':&nbsp;{<br> 202 &nbsp;&nbsp;'Renderer':&nbsp;{<br>
164 &nbsp;&nbsp;&nbsp;&nbsp;'VM':&nbsp;S,<br> 203 &nbsp;&nbsp;&nbsp;&nbsp;'VM':&nbsp;R,<br>
165 &nbsp;&nbsp;&nbsp;&nbsp;'VMPeak':&nbsp;T,<br> 204 &nbsp;&nbsp;&nbsp;&nbsp;'VMPeak':&nbsp;S,<br>
166 &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSize':&nbsp;U,<br> 205 &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSize':&nbsp;T,<br>
167 &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSizePeak':&nbsp;V,<br> 206 &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSizePeak':&nbsp;U,<br>
168 &nbsp;&nbsp;&nbsp;&nbsp;'ProportionalSetSize':&nbsp;W,<br> 207 &nbsp;&nbsp;&nbsp;&nbsp;'ProportionalSetSize':&nbsp;V,<br>
169 &nbsp;&nbsp;&nbsp;&nbsp;'PrivateDirty':&nbsp;X<br> 208 &nbsp;&nbsp;&nbsp;&nbsp;'PrivateDirty':&nbsp;W<br>
170 &nbsp;&nbsp;},<br> 209 &nbsp;&nbsp;},<br>
171 &nbsp;&nbsp;'SystemCommitCharge':&nbsp;Y,<br> 210 &nbsp;&nbsp;'SystemCommitCharge':&nbsp;X,<br>
211 &nbsp;&nbsp;'SystemTotalPhysicalMemory':&nbsp;Y,<br>
172 &nbsp;&nbsp;'ProcessCount':&nbsp;Z,<br> 212 &nbsp;&nbsp;'ProcessCount':&nbsp;Z,<br>
173 }<br> 213 }<br>
174 Any&nbsp;of&nbsp;the&nbsp;above&nbsp;keys&nbsp;may&nbsp;be&nbsp;missing&nbsp;on& nbsp;a&nbsp;per-platform&nbsp;basis.</tt></dd> 214 Any&nbsp;of&nbsp;the&nbsp;above&nbsp;keys&nbsp;may&nbsp;be&nbsp;missing&nbsp;on& nbsp;a&nbsp;per-platform&nbsp;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>&nbsp;<br> 233 <td colspan=3 valign=bottom>&nbsp;<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>&nbsp;&nbsp;&nbsp;</tt></td> 236 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
193 <td colspan=2><tt>Options&nbsp;to&nbsp;be&nbsp;used&nbsp;for&nbsp;discovering&nb sp;and&nbsp;launching&nbsp;a&nbsp;browser.<br>&nbsp;</tt></td></tr> 237 <td colspan=2><tt>Options&nbsp;to&nbsp;be&nbsp;used&nbsp;for&nbsp;discovering&nb sp;a&nbsp;browser.<br>&nbsp;</tt></td></tr>
194 <tr><td>&nbsp;</td> 238 <tr><td>&nbsp;</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>&nbsp;<br> 267 <td colspan=3 valign=bottom>&nbsp;<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>&nbsp;&nbsp;&nbsp;</tt></td> 270 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
225 <td colspan=2><tt>Glue&nbsp;code&nbsp;for&nbsp;running&nbsp;a&nbsp;measurement&n bsp;across&nbsp;a&nbsp;set&nbsp;of&nbsp;pages.<br> 271 <td colspan=2><tt>Glue&nbsp;code&nbsp;for&nbsp;running&nbsp;a&nbsp;measurement&n bsp;across&nbsp;a&nbsp;set&nbsp;of&nbsp;pages.<br>
226 &nbsp;<br> 272 &nbsp;<br>
227 To&nbsp;use&nbsp;this,&nbsp;subclass&nbsp;from&nbsp;the&nbsp;measurement&nbsp;an d&nbsp;override&nbsp;MeasurePage.&nbsp;For<br> 273 To&nbsp;use&nbsp;this,&nbsp;subclass&nbsp;from&nbsp;the&nbsp;measurement&nbsp;an d&nbsp;override&nbsp;MeasurePage.&nbsp;For<br>
228 example:<br> 274 example:<br>
229 &nbsp;<br> 275 &nbsp;<br>
230 &nbsp;&nbsp;&nbsp;class&nbsp;BodyChildElementMeasurement(<a href="#PageMeasureme nt">PageMeasurement</a>):<br> 276 &nbsp;&nbsp;&nbsp;class&nbsp;BodyChildElementMeasurement(<a href="#PageMeasureme nt">PageMeasurement</a>):<br>
231 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;def&nbsp;<a href="#PageMeasurement-MeasurePa ge">MeasurePage</a>(self,&nbsp;page,&nbsp;tab,&nbsp;results):<br> 277 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;def&nbsp;<a href="#PageMeasurement-MeasurePa ge">MeasurePage</a>(self,&nbsp;page,&nbsp;tab,&nbsp;results):<br>
232 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;body_child_count&nbsp;=&nb sp;tab.EvaluateJavaScript(<br> 278 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;body_child_count&nbsp;=&nb sp;tab.EvaluateJavaScript(<br>
233 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'d ocument.body.children.length')<br> 279 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'d ocument.body.children.length')<br>
234 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;results.Add('body_children ',&nbsp;'count',&nbsp;body_child_count)<br> 280 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;results.Add('body_children ',&nbsp;'count',&nbsp;body_child_count)<br>
235 &nbsp;<br> 281 &nbsp;<br>
236 &nbsp;&nbsp;&nbsp;if&nbsp;__name__&nbsp;==&nbsp;'__main__':<br> 282 &nbsp;&nbsp;&nbsp;if&nbsp;__name__&nbsp;==&nbsp;'__main__':<br>
237 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;page_measurement.Main(BodyChildElement Measurement())<br> 283 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;page_measurement.Main(BodyChildElement Measurement())<br>
238 &nbsp;<br> 284 &nbsp;<br>
239 To&nbsp;add&nbsp;test-specific&nbsp;options:<br> 285 To&nbsp;add&nbsp;test-specific&nbsp;options:<br>
240 &nbsp;<br> 286 &nbsp;<br>
241 &nbsp;&nbsp;&nbsp;class&nbsp;BodyChildElementMeasurement(<a href="#PageMeasureme nt">PageMeasurement</a>):<br> 287 &nbsp;&nbsp;&nbsp;class&nbsp;BodyChildElementMeasurement(<a href="#PageMeasureme nt">PageMeasurement</a>):<br>
242 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;def&nbsp;<a href="#PageMeasurement-AddComman dLineOptions">AddCommandLineOptions</a>(parser):<br> 288 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;def&nbsp;<a href="#PageMeasurement-AddComman dLineArgs">AddCommandLineArgs</a>(parser):<br>
243 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;parser.add_option('--eleme nt',&nbsp;action='store',&nbsp;default='body')<br> 289 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;parser.add_option('--eleme nt',&nbsp;action='store',&nbsp;default='body')<br>
244 &nbsp;<br> 290 &nbsp;<br>
245 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;def&nbsp;<a href="#PageMeasurement-MeasurePa ge">MeasurePage</a>(self,&nbsp;page,&nbsp;tab,&nbsp;results):<br> 291 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;def&nbsp;<a href="#PageMeasurement-MeasurePa ge">MeasurePage</a>(self,&nbsp;page,&nbsp;tab,&nbsp;results):<br>
246 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;body_child_count&nbsp;=&nb sp;tab.EvaluateJavaScript(<br> 292 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;body_child_count&nbsp;=&nb sp;tab.EvaluateJavaScript(<br>
247 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'documen t.querySelector('%s').children.length')<br> 293 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'documen t.querySelector('%s').children.length')<br>
248 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;results.Add('children',&nb sp;'count',&nbsp;child_count)<br>&nbsp;</tt></td></tr> 294 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;results.Add('children',&nb sp;'count',&nbsp;child_count)<br>&nbsp;</tt></td></tr>
249 <tr><td>&nbsp;</td> 295 <tr><td>&nbsp;</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&nbsp;to&nbsp;actually&nbsp;measure &nbsp;the&nbsp;page's&nbsp;performance.<br> 304 <dl><dt><a name="PageMeasurement-MeasurePage"><strong>MeasurePage</strong></a>(s elf, page, tab, results)</dt><dd><tt>Override&nbsp;to&nbsp;actually&nbsp;measure &nbsp;the&nbsp;page's&nbsp;performance.<br>
260 &nbsp;<br> 305 &nbsp;<br>
261 page&nbsp;is&nbsp;a&nbsp;page_set.Page<br> 306 page&nbsp;is&nbsp;a&nbsp;page_set.Page<br>
262 tab&nbsp;is&nbsp;an&nbsp;instance&nbsp;of&nbsp;telemetry.core.<a href="#Tab">Tab </a><br> 307 tab&nbsp;is&nbsp;an&nbsp;instance&nbsp;of&nbsp;telemetry.core.<a href="#Tab">Tab </a><br>
263 &nbsp;<br> 308 &nbsp;<br>
264 Should&nbsp;call&nbsp;results.Add(name,&nbsp;units,&nbsp;value)&nbsp;for&nbsp;ea ch&nbsp;result,&nbsp;or&nbsp;raise&nbsp;an<br> 309 Should&nbsp;call&nbsp;results.Add(name,&nbsp;units,&nbsp;value)&nbsp;for&nbsp;ea ch&nbsp;result,&nbsp;or&nbsp;raise&nbsp;an<br>
265 exception&nbsp;on&nbsp;failure.&nbsp;The&nbsp;name&nbsp;and&nbsp;units&nbsp;of&n bsp;each&nbsp;Add()&nbsp;call&nbsp;must&nbsp;be<br> 310 exception&nbsp;on&nbsp;failure.&nbsp;The&nbsp;name&nbsp;and&nbsp;units&nbsp;of&n bsp;each&nbsp;Add()&nbsp;call&nbsp;must&nbsp;be<br>
266 the&nbsp;same&nbsp;across&nbsp;all&nbsp;iterations.&nbsp;The&nbsp;name&nbsp;'url '&nbsp;must&nbsp;not&nbsp;be&nbsp;used.<br> 311 the&nbsp;same&nbsp;across&nbsp;all&nbsp;iterations.&nbsp;The&nbsp;name&nbsp;'url '&nbsp;must&nbsp;not&nbsp;be&nbsp;used.<br>
267 &nbsp;<br> 312 &nbsp;<br>
268 Prefer&nbsp;field&nbsp;names&nbsp;that&nbsp;are&nbsp;in&nbsp;accordance&nbsp;wit h&nbsp;python&nbsp;variable&nbsp;style.&nbsp;E.g.<br> 313 Prefer&nbsp;field&nbsp;names&nbsp;that&nbsp;are&nbsp;in&nbsp;accordance&nbsp;wit h&nbsp;python&nbsp;variable&nbsp;style.&nbsp;E.g.<br>
269 field_name.<br> 314 field_name.<br>
270 &nbsp;<br> 315 &nbsp;<br>
271 Put&nbsp;together:<br> 316 Put&nbsp;together:<br>
272 &nbsp;<br> 317 &nbsp;<br>
273 &nbsp;&nbsp;&nbsp;def&nbsp;<a href="#PageMeasurement-MeasurePage">MeasurePage</a >(self,&nbsp;page,&nbsp;tab,&nbsp;results):<br> 318 &nbsp;&nbsp;&nbsp;def&nbsp;<a href="#PageMeasurement-MeasurePage">MeasurePage</a >(self,&nbsp;page,&nbsp;tab,&nbsp;results):<br>
274 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;res&nbsp;=&nbsp;tab.EvaluateJavaScript('2+2')<br> 319 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;res&nbsp;=&nbsp;tab.EvaluateJavaScript('2+2')<br>
275 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if&nbsp;res&nbsp;!=&nbsp;4:<br> 320 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if&nbsp;res&nbsp;!=&nbsp;4:<br>
276 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;raise&nbsp;Exception('Oh,&nbsp;wow.')< br> 321 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;raise&nbsp;Exception('Oh,&nbsp;wow.')< br>
277 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;results.Add('two_plus_two',&nbsp;'count',&nbsp;res )</tt></dd></dl> 322 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;results.Add('two_plus_two',&nbsp;'count',&nbsp;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&nbsp;default,&nbsp;measurements&nbsp;are&nbsp;assumed&nbsp;to&nbsp;ou tput&nbsp;the&nbsp;same&nbsp;values&nbsp;for&nbsp;every<br> 329 <dd><tt>By&nbsp;default,&nbsp;measurements&nbsp;are&nbsp;assumed&nbsp;to&nbsp;ou tput&nbsp;the&nbsp;same&nbsp;values&nbsp;for&nbsp;every<br>
289 page.&nbsp;This&nbsp;allows&nbsp;incremental&nbsp;output,&nbsp;for&nbsp;example& nbsp;in&nbsp;CSV.&nbsp;If,&nbsp;however,&nbsp;the<br> 330 page.&nbsp;This&nbsp;allows&nbsp;incremental&nbsp;output,&nbsp;for&nbsp;example& nbsp;in&nbsp;CSV.&nbsp;If,&nbsp;however,&nbsp;the<br>
290 measurement&nbsp;discovers&nbsp;what&nbsp;values&nbsp;it&nbsp;can&nbsp;report&nb sp;as&nbsp;it&nbsp;goes,&nbsp;and&nbsp;those&nbsp;values<br> 331 measurement&nbsp;discovers&nbsp;what&nbsp;values&nbsp;it&nbsp;can&nbsp;report&nb sp;as&nbsp;it&nbsp;goes,&nbsp;and&nbsp;those&nbsp;values<br>
291 may&nbsp;vary&nbsp;from&nbsp;page&nbsp;to&nbsp;page,&nbsp;you&nbsp;need&nbsp;to& nbsp;override&nbsp;this&nbsp;function&nbsp;and&nbsp;return<br> 332 may&nbsp;vary&nbsp;from&nbsp;page&nbsp;to&nbsp;page,&nbsp;you&nbsp;need&nbsp;to& nbsp;override&nbsp;this&nbsp;function&nbsp;and&nbsp;return<br>
292 False.&nbsp;Output&nbsp;will&nbsp;not&nbsp;appear&nbsp;in&nbsp;this&nbsp;mode&nb sp;until&nbsp;the&nbsp;entire&nbsp;pageset&nbsp;has<br> 333 False.&nbsp;Output&nbsp;will&nbsp;not&nbsp;appear&nbsp;in&nbsp;this&nbsp;mode&nb sp;until&nbsp;the&nbsp;entire&nbsp;pageset&nbsp;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&nbsp;to&nbsp;expose&nbsp;c ommand-line&nbsp;options&nbsp;for&nbsp;this&nbsp;test.<br> 338 <dl><dt><a name="PageMeasurement-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>
298 &nbsp;<br>
299 The&nbsp;provided&nbsp;parser&nbsp;is&nbsp;an&nbsp;optparse.OptionParser&nbsp;in stance&nbsp;and&nbsp;accepts&nbsp;all<br>
300 normal&nbsp;results.&nbsp;The&nbsp;parsed&nbsp;options&nbsp;are&nbsp;available&n bsp;in&nbsp;Run&nbsp;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&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> 340 <dl><dt><a name="PageMeasurement-CleanUpAfterPage"><strong>CleanUpAfterPage</str ong></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>
341
342 <dl><dt><a name="PageMeasurement-CreateExpectations"><strong>CreateExpectations< /strong></a>(self, page_set)</dt><dd><tt>Override&nbsp;to&nbsp;make&nbsp;this&nb sp;test&nbsp;generate&nbsp;its&nbsp;own&nbsp;expectations&nbsp;instead&nbsp;of<b r>
343 any&nbsp;that&nbsp;may&nbsp;have&nbsp;been&nbsp;defined&nbsp;in&nbsp;the&nbsp;pa ge&nbsp;set.</tt></dd></dl>
304 344
305 <dl><dt><a name="PageMeasurement-CreatePageSet"><strong>CreatePageSet</strong></ a>(self, args, options)</dt><dd><tt>Override&nbsp;to&nbsp;make&nbsp;this&nbsp;te st&nbsp;generate&nbsp;its&nbsp;own&nbsp;page&nbsp;set&nbsp;instead&nbsp;of<br> 345 <dl><dt><a name="PageMeasurement-CreatePageSet"><strong>CreatePageSet</strong></ a>(self, args, options)</dt><dd><tt>Override&nbsp;to&nbsp;make&nbsp;this&nbsp;te st&nbsp;generate&nbsp;its&nbsp;own&nbsp;page&nbsp;set&nbsp;instead&nbsp;of<br>
306 allowing&nbsp;arbitrary&nbsp;page&nbsp;sets&nbsp;entered&nbsp;from&nbsp;the&nbsp ;command-line.</tt></dd></dl> 346 allowing&nbsp;arbitrary&nbsp;page&nbsp;sets&nbsp;entered&nbsp;from&nbsp;the&nbsp ;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&nbsp;to&nbsp;add&nbsp ;test-specific&nbsp;options&nbsp;to&nbsp;the&nbsp;<a href="#BrowserOptions">Brow serOptions</a>&nbsp;<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&nbsp;to&nbsp;add&nbsp ;test-specific&nbsp;options&nbsp;to&nbsp;the&nbsp;BrowserOptions&nbsp;<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&nbsp;o ptions&nbsp;specific&nbsp;to&nbsp;the&nbsp;test&nbsp;and&nbsp;the&nbsp;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&nbsp;options&nbsp;required&nbsp;for&nbsp;this&nbsp;page&nbsp;set.<br>
351 &nbsp;<br>
352 These&nbsp;options&nbsp;will&nbsp;be&nbsp;used&nbsp;every&nbsp;time&nbsp;the&nbs p;browser&nbsp;is&nbsp;started&nbsp;while&nbsp;running<br>
353 this&nbsp;page&nbsp;set.&nbsp;They&nbsp;may,&nbsp;however,&nbsp;be&nbsp;further& nbsp;modified&nbsp;by<br>
354 CustomizeBrowserOptionsForSinglePage&nbsp;or&nbsp;by&nbsp;the&nbsp;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&nbsp;to&nbsp;do&nbsp;operations &nbsp;right&nbsp;after&nbsp;the&nbsp;page&nbsp;is&nbsp;navigated,&nbsp;but&nbsp; before<br> 356 <dl><dt><a name="PageMeasurement-CustomizeBrowserOptionsForSinglePage"><strong>C ustomizeBrowserOptionsForSinglePage</strong></a>(self, page, options)</dt><dd><t t>Set&nbsp;options&nbsp;specific&nbsp;to&nbsp;the&nbsp;test&nbsp;and&nbsp;the&nb sp;given&nbsp;page.<br>
313 any&nbsp;waiting&nbsp;for&nbsp;completion&nbsp;has&nbsp;occurred.</tt></dd></dl> 357 &nbsp;<br>
358 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>
359 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>
360 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>
361 will&nbsp;always&nbsp;be&nbsp;restarted&nbsp;for&nbsp;each&nbsp;run.</tt></dd></ dl>
362
363 <dl><dt><a name="PageMeasurement-DidNavigateToPage"><strong>DidNavigateToPage</s trong></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;a fter<br>
364 all&nbsp;waiting&nbsp;for&nbsp;completion&nbsp;has&nbsp;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&nbsp;to&nbsp;do&nbsp;operations&n bsp;after&nbsp;running&nbsp;the&nbsp;action&nbsp;on&nbsp;the&nbsp;page.</tt></dd ></dl> 366 <dl><dt><a name="PageMeasurement-DidRunAction"><strong>DidRunAction</strong></a> (self, page, tab, action)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&n bsp;after&nbsp;running&nbsp;the&nbsp;action&nbsp;on&nbsp;the&nbsp;page.</tt></dd ></dl>
316 367
317 <dl><dt><a name="PageMeasurement-DidRunPageSet"><strong>DidRunPageSet</strong></ a>(self, tab, results)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp ;after&nbsp;page&nbsp;set&nbsp;is&nbsp;completed,&nbsp;but&nbsp;before&nbsp;brow ser<br> 368 <dl><dt><a name="PageMeasurement-DidRunActions"><strong>DidRunActions</strong></ a>(self, page, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;af ter&nbsp;running&nbsp;the&nbsp;actions&nbsp;on&nbsp;the&nbsp;page.</tt></dd></dl >
318 is&nbsp;torn&nbsp;down.</tt></dd></dl> 369
370 <dl><dt><a name="PageMeasurement-DidRunPageRepeats"><strong>DidRunPageRepeats</s trong></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>
371
372 <dl><dt><a name="PageMeasurement-DidRunTest"><strong>DidRunTest</strong></a>(sel f, browser, results)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;a fter&nbsp;all&nbsp;page&nbsp;set(s)&nbsp;are&nbsp;completed.<br>
373 &nbsp;<br>
374 This&nbsp;will&nbsp;occur&nbsp;before&nbsp;the&nbsp;browser&nbsp;is&nbsp;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&nbsp;to&nbsp;customize&nbsp;the&nbsp; browser&nbsp;right&nbsp;after&nbsp;it&nbsp;has&nbsp;launched.</tt></dd></dl>
319 377
320 <dl><dt><a name="PageMeasurement-DidStartHTTPServer"><strong>DidStartHTTPServer< /strong></a>(self, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbs p;after&nbsp;the&nbsp;HTTP&nbsp;server&nbsp;is&nbsp;started.</tt></dd></dl> 378 <dl><dt><a name="PageMeasurement-DidStartHTTPServer"><strong>DidStartHTTPServer< /strong></a>(self, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbs p;after&nbsp;the&nbsp;HTTP&nbsp;server&nbsp;is&nbsp;started.</tt></dd></dl>
321 379
322 <dl><dt><a name="PageMeasurement-NeedsBrowserRestartAfterEachRun"><strong>NeedsB rowserRestartAfterEachRun</strong></a>(self, tab)</dt><dd><tt>Override&nbsp;to&n bsp;specify&nbsp;browser&nbsp;restart&nbsp;after&nbsp;each&nbsp;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&nbsp;to&nbsp;customize&nbsp;the&nbsp;browse r&nbsp;right&nbsp;after&nbsp;it&nbsp;has&nbsp;launched.</tt></dd></dl> 384 <dl><dt><a name="PageMeasurement-RestartBrowserBeforeEachPage"><strong>RestartBr owserBeforeEachPage</strong></a>(self)</dt><dd><tt>Should&nbsp;the&nbsp;browser& nbsp;be&nbsp;restarted&nbsp;for&nbsp;the&nbsp;page?<br>
385 &nbsp;<br>
386 This&nbsp;returns&nbsp;true&nbsp;if&nbsp;the&nbsp;test&nbsp;needs&nbsp;to&nbsp;u nconditionally&nbsp;restart&nbsp;the<br>
387 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>
327 388
328 <dl><dt><a name="PageMeasurement-WillNavigateToPage"><strong>WillNavigateToPage< /strong></a>(self, page, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operatio ns&nbsp;before&nbsp;the&nbsp;page&nbsp;is&nbsp;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&nbsp;the&nbsp;tab&nbsp;to&nbsp;t he&nbsp;page&nbsp;URL&nbsp;attribute.<br>
392 &nbsp;<br>
393 Runs&nbsp;the&nbsp;'navigate_steps'&nbsp;page&nbsp;attribute&nbsp;as&nbsp;a&nbsp ;compound&nbsp;action.</tt></dd></dl>
394
395 <dl><dt><a name="PageMeasurement-StopBrowserAfterPage"><strong>StopBrowserAfterP age</strong></a>(self, browser, page)</dt><dd><tt>Should&nbsp;the&nbsp;browser&n bsp;be&nbsp;stopped&nbsp;after&nbsp;the&nbsp;page&nbsp;is&nbsp;run?<br>
396 &nbsp;<br>
397 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>
398 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>
399 restarted&nbsp;to&nbsp;run&nbsp;the&nbsp;next&nbsp;page.<br>
400 &nbsp;<br>
401 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>
402 decide&nbsp;whether&nbsp;it&nbsp;needs&nbsp;to&nbsp;stop&nbsp;the&nbsp;browser.< /tt></dd></dl>
403
404 <dl><dt><a name="PageMeasurement-TabForPage"><strong>TabForPage</strong></a>(sel f, 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>
405 create&nbsp;a&nbsp;new&nbsp;tab&nbsp;for&nbsp;every&nbsp;page,&nbsp;return&nbsp; 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&nbsp;to&nbsp;examine&nbsp;the&nbsp;p age&nbsp;set&nbsp;before&nbsp;the&nbsp;test&nbsp;run.&nbsp;&nbsp;Useful&nbsp;for <br>
408 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>
409
410 <dl><dt><a name="PageMeasurement-WillNavigateToPage"><strong>WillNavigateToPage< /strong></a>(self, page, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operatio ns&nbsp;before&nbsp;the&nbsp;page&nbsp;is&nbsp;navigated,&nbsp;notably&nbsp;Tele metry<br>
411 will&nbsp;already&nbsp;have&nbsp;performed&nbsp;the&nbsp;following&nbsp;operatio ns&nbsp;on&nbsp;the&nbsp;browser&nbsp;before<br>
412 calling&nbsp;this&nbsp;function:<br>
413 *&nbsp;Ensure&nbsp;only&nbsp;one&nbsp;tab&nbsp;is&nbsp;open.<br>
414 *&nbsp;Call&nbsp;WaitForDocumentReadyStateToComplete&nbsp;on&nbsp;the&nbsp;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&nbsp;to&nbsp;do&nbsp;operations &nbsp;before&nbsp;running&nbsp;the&nbsp;action&nbsp;on&nbsp;the&nbsp;page.</tt>< /dd></dl> 416 <dl><dt><a name="PageMeasurement-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>
331 417
332 <dl><dt><a name="PageMeasurement-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> 418 <dl><dt><a name="PageMeasurement-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>
419
420 <dl><dt><a name="PageMeasurement-WillRunPageRepeats"><strong>WillRunPageRepeats< /strong></a>(self, page)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nb sp;before&nbsp;each&nbsp;page&nbsp;is&nbsp;iterated&nbsp;over.</tt></dd></dl>
421
422 <dl><dt><a name="PageMeasurement-WillRunTest"><strong>WillRunTest</strong></a>(s elf, options)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;before&n bsp;the&nbsp;page&nbsp;set(s)&nbsp;are&nbsp;navigated.</tt></dd></dl>
423
424 <dl><dt><a name="PageMeasurement-WillStartBrowser"><strong>WillStartBrowser</str ong></a>(self, browser)</dt><dd><tt>Override&nbsp;to&nbsp;manipulate&nbsp;the&nb sp;browser&nbsp;environment&nbsp;before&nbsp;it&nbsp;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&nbsp;number&nbsp;of&nbsp;times&nbsp;test&nbsp;will&nbsp;be&nbsp; attempted.</tt></dd>
432 </dl>
433 <dl><dt><strong>clear_cache_before_each_run</strong></dt>
434 <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>
435 before&nbsp;each&nbsp;run.</tt></dd>
436 </dl>
437 <dl><dt><strong>close_tabs_before_run</strong></dt>
438 <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>
439 first&nbsp;time.</tt></dd>
440 </dl>
441 <dl><dt><strong>discard_first_result</strong></dt>
442 <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>
443 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>
444 the&nbsp;first&nbsp;run&nbsp;of&nbsp;the&nbsp;test&nbsp;can&nbsp;warm&nbsp;thing s&nbsp;up.</tt></dd>
445 </dl>
446 <dl><dt><strong>max_errors</strong></dt>
447 <dd><tt>Maximum&nbsp;number&nbsp;of&nbsp;errors&nbsp;allowed&nbsp;for&nbsp;the&n bsp;page&nbsp;set.</tt></dd>
448 </dl>
449 <dl><dt><strong>max_failures</strong></dt>
450 <dd><tt>Maximum&nbsp;number&nbsp;of&nbsp;failures&nbsp;allowed&nbsp;for&nbsp;the &nbsp;page&nbsp;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&nbsp;to&nbsp;accept&nbsp;custom&nbsp;command-line&nbsp;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&nbsp;to&nbsp;process&nbsp;command-line&nbsp;arguments.< br>
457 &nbsp;<br>
458 We&nbsp;pass&nbsp;in&nbsp;parser&nbsp;so&nbsp;we&nbsp;can&nbsp;call&nbsp;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&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)< /tt></dd> 463 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;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&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp ;(if&nbsp;defined)</tt></dd> 466 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp ;(if&nbsp;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&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>
346 before&nbsp;each&nbsp;run.</tt></dd>
347 </dl>
348 <dl><dt><strong>discard_first_result</strong></dt>
349 <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>
350 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>
351 the&nbsp;first&nbsp;run&nbsp;of&nbsp;the&nbsp;test&nbsp;can&nbsp;warm&nbsp;thing s&nbsp;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>&nbsp;<br> 471 <td colspan=3 valign=bottom>&nbsp;<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>&nbsp;&nbsp;&nbsp;</tt></td> 474 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
360 <td colspan=2><tt>Represents&nbsp;a&nbsp;tab&nbsp;in&nbsp;the&nbsp;browser<br> 475 <td colspan=2><tt>Represents&nbsp;a&nbsp;tab&nbsp;in&nbsp;the&nbsp;browser<br>
361 &nbsp;<br> 476 &nbsp;<br>
362 The&nbsp;important&nbsp;parts&nbsp;of&nbsp;the&nbsp;<a href="#Tab">Tab</a>&nbsp; <a href="__builtin__.html#object">object</a>&nbsp;are&nbsp;in&nbsp;the&nbsp;runt ime&nbsp;and&nbsp;page&nbsp;objects.<br> 477 The&nbsp;important&nbsp;parts&nbsp;of&nbsp;the&nbsp;<a href="#Tab">Tab</a>&nbsp; <a href="__builtin__.html#object">object</a>&nbsp;are&nbsp;in&nbsp;the&nbsp;runt ime&nbsp;and&nbsp;page&nbsp;objects.<br>
(...skipping 14 matching lines...) Expand all
377 <dl><dt><a name="Tab-Activate"><strong>Activate</strong></a>(self)</dt><dd><tt>B rings&nbsp;this&nbsp;tab&nbsp;to&nbsp;the&nbsp;foreground&nbsp;asynchronously.<b r> 492 <dl><dt><a name="Tab-Activate"><strong>Activate</strong></a>(self)</dt><dd><tt>B rings&nbsp;this&nbsp;tab&nbsp;to&nbsp;the&nbsp;foreground&nbsp;asynchronously.<b r>
378 &nbsp;<br> 493 &nbsp;<br>
379 Not&nbsp;all&nbsp;browsers&nbsp;or&nbsp;browser&nbsp;versions&nbsp;support&nbsp; this&nbsp;method.<br> 494 Not&nbsp;all&nbsp;browsers&nbsp;or&nbsp;browser&nbsp;versions&nbsp;support&nbsp; this&nbsp;method.<br>
380 Be&nbsp;sure&nbsp;to&nbsp;check&nbsp;browser.supports_tab_control.<br> 495 Be&nbsp;sure&nbsp;to&nbsp;check&nbsp;browser.supports_tab_control.<br>
381 &nbsp;<br> 496 &nbsp;<br>
382 Please&nbsp;note:&nbsp;this&nbsp;is&nbsp;asynchronous.&nbsp;There&nbsp;is&nbsp;a &nbsp;delay&nbsp;between&nbsp;this&nbsp;call<br> 497 Please&nbsp;note:&nbsp;this&nbsp;is&nbsp;asynchronous.&nbsp;There&nbsp;is&nbsp;a &nbsp;delay&nbsp;between&nbsp;this&nbsp;call<br>
383 and&nbsp;the&nbsp;page's&nbsp;documentVisibilityState&nbsp;becoming&nbsp;'visibl e',&nbsp;and&nbsp;yet&nbsp;more<br> 498 and&nbsp;the&nbsp;page's&nbsp;documentVisibilityState&nbsp;becoming&nbsp;'visibl e',&nbsp;and&nbsp;yet&nbsp;more<br>
384 delay&nbsp;until&nbsp;the&nbsp;actual&nbsp;tab&nbsp;is&nbsp;visible&nbsp;to&nbsp ;the&nbsp;user.&nbsp;None&nbsp;of&nbsp;these&nbsp;delays<br> 499 delay&nbsp;until&nbsp;the&nbsp;actual&nbsp;tab&nbsp;is&nbsp;visible&nbsp;to&nbsp ;the&nbsp;user.&nbsp;None&nbsp;of&nbsp;these&nbsp;delays<br>
385 are&nbsp;included&nbsp;in&nbsp;this&nbsp;call.</tt></dd></dl> 500 are&nbsp;included&nbsp;in&nbsp;this&nbsp;call.</tt></dd></dl>
386 501
387 <dl><dt><a name="Tab-ClearCache"><strong>ClearCache</strong></a>(self)</dt><dd>< tt>Clears&nbsp;the&nbsp;browser's&nbsp;HTTP&nbsp;disk&nbsp;cache&nbsp;and&nbsp;t he&nbsp;tab's&nbsp;HTTP&nbsp;memory&nbsp;cache.</tt></dd></dl> 502 <dl><dt><a name="Tab-ClearCache"><strong>ClearCache</strong></a>(self, force)</d t><dd><tt>Clears&nbsp;the&nbsp;browser's&nbsp;networking&nbsp;related&nbsp;disk, &nbsp;memory&nbsp;and&nbsp;other&nbsp;caches.<br>
503 &nbsp;<br>
504 Args:<br>
505 &nbsp;&nbsp;force:&nbsp;Iff&nbsp;true,&nbsp;navigates&nbsp;to&nbsp;about:blank&n bsp;which&nbsp;destroys&nbsp;the&nbsp;previous<br>
506 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;renderer,&nbsp;ensuring&nbsp;that&nbsp;even& nbsp;"live"&nbsp;resources&nbsp;in&nbsp;the&nbsp;memory&nbsp;cache&nbsp;are<br>
507 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cleared.</tt></dd></dl>
508
509 <dl><dt><a name="Tab-ClearHighlight"><strong>ClearHighlight</strong></a>(self, c olor)</dt><dd><tt>Clears&nbsp;a&nbsp;highlight&nbsp;of&nbsp;the&nbsp;given&nbsp; 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&nbsp;the&nbs p;value&nbsp;of&nbsp;the&nbsp;cookie&nbsp;by&nbsp;the&nbsp;given&nbsp;|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&nbsp;the&nbs p;value&nbsp;of&nbsp;the&nbsp;cookie&nbsp;by&nbsp;the&nbsp;given&nbsp;|name|.</t t></dd></dl>
392 514
515 <dl><dt><a name="Tab-Highlight"><strong>Highlight</strong></a>(self, color)</dt> <dd><tt>Synchronously&nbsp;highlights&nbsp;entire&nbsp;tab&nbsp;contents&nbsp;wi th&nbsp;the&nbsp;given&nbsp;RgbaColor.<br>
516 &nbsp;<br>
517 TODO(tonyg):&nbsp;It&nbsp;is&nbsp;possible&nbsp;that&nbsp;the&nbsp;z-index&nbsp; hack&nbsp;here&nbsp;might&nbsp;not&nbsp;work&nbsp;for<br>
518 all&nbsp;pages.&nbsp;If&nbsp;this&nbsp;happens,&nbsp;DevTools&nbsp;also&nbsp;pro vides&nbsp;a&nbsp;method&nbsp;for&nbsp;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&nbsp;to&nbsp;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&nbsp;to&nbsp;url.<br>
394 &nbsp;<br> 521 &nbsp;<br>
395 If&nbsp;|script_to_evaluate_on_commit|&nbsp;is&nbsp;given,&nbsp;the&nbsp;script& nbsp;source&nbsp;string&nbsp;will&nbsp;be<br> 522 If&nbsp;|script_to_evaluate_on_commit|&nbsp;is&nbsp;given,&nbsp;the&nbsp;script& nbsp;source&nbsp;string&nbsp;will&nbsp;be<br>
396 evaluated&nbsp;when&nbsp;the&nbsp;navigation&nbsp;is&nbsp;committed.&nbsp;This&n bsp;is&nbsp;after&nbsp;the&nbsp;context&nbsp;of<br> 523 evaluated&nbsp;when&nbsp;the&nbsp;navigation&nbsp;is&nbsp;committed.&nbsp;This&n bsp;is&nbsp;after&nbsp;the&nbsp;context&nbsp;of<br>
397 the&nbsp;page&nbsp;exists,&nbsp;but&nbsp;before&nbsp;any&nbsp;script&nbsp;on&nbs p;the&nbsp;page&nbsp;itself&nbsp;has&nbsp;executed.</tt></dd></dl> 524 the&nbsp;page&nbsp;exists,&nbsp;but&nbsp;before&nbsp;any&nbsp;script&nbsp;on&nbs p;the&nbsp;page&nbsp;itself&nbsp;has&nbsp;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&nbsp;action_function,&nbsp;and&nbsp;waits&nbsp;f or&nbsp;the&nbsp;navigation&nbsp;to&nbsp;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&nbsp;action_function,&nbsp;and&nbsp;waits&nbsp;f or&nbsp;the&nbsp;navigation&nbsp;to&nbsp;complete.<br>
400 &nbsp;<br> 527 &nbsp;<br>
401 action_function&nbsp;must&nbsp;be&nbsp;a&nbsp;Python&nbsp;function&nbsp;that&nbs p;results&nbsp;in&nbsp;a&nbsp;navigation.<br> 528 action_function&nbsp;must&nbsp;be&nbsp;a&nbsp;Python&nbsp;function&nbsp;that&nbs p;results&nbsp;in&nbsp;a&nbsp;navigation.<br>
402 This&nbsp;function&nbsp;returns&nbsp;when&nbsp;the&nbsp;navigation&nbsp;is&nbsp; complete&nbsp;or&nbsp;when<br> 529 This&nbsp;function&nbsp;returns&nbsp;when&nbsp;the&nbsp;navigation&nbsp;is&nbsp; complete&nbsp;or&nbsp;when<br>
403 the&nbsp;timeout&nbsp;has&nbsp;been&nbsp;exceeded.</tt></dd></dl> 530 the&nbsp;timeout&nbsp;has&nbsp;been&nbsp;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&nbsp;a&nbsp;screenshot&nbsp; of&nbsp;the&nbsp;window&nbsp;for&nbsp;rendering&nbsp;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&nbsp;a&nbsp;screenshot&nbsp; of&nbsp;the&nbsp;tab's&nbsp;contents.<br>
533 &nbsp;<br>
534 Returns:<br>
535 &nbsp;&nbsp;A&nbsp;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&nbsp;capturing&nbsp;video&nbsp;of&nbsp ;the&nbsp;tab's&nbsp;contents.<br>
538 &nbsp;<br>
539 This&nbsp;works&nbsp;by&nbsp;flashing&nbsp;the&nbsp;entire&nbsp;tab&nbsp;content s&nbsp;to&nbsp;a&nbsp;arbitrary&nbsp;color&nbsp;and&nbsp;then<br>
540 starting&nbsp;video&nbsp;recording.&nbsp;When&nbsp;the&nbsp;frames&nbsp;are&nbsp ;processed,&nbsp;we&nbsp;can&nbsp;look&nbsp;for<br>
541 that&nbsp;flash&nbsp;as&nbsp;the&nbsp;content&nbsp;bounds.<br>
542 &nbsp;<br>
543 Args:<br>
544 &nbsp;&nbsp;min_bitrate_mbps:&nbsp;The&nbsp;minimum&nbsp;caputre&nbsp;bitrate&nb sp;in&nbsp;MegaBits&nbsp;Per&nbsp;Second.<br>
545 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;platform&nbsp;is&nbsp;free&nbsp;to& nbsp;deliver&nbsp;a&nbsp;higher&nbsp;bitrate&nbsp;if&nbsp;it&nbsp;can&nbsp;do&nb sp;so<br>
546 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;without&nbsp;increasing&nbsp;overhead.</tt>< /dd></dl>
547
548 <dl><dt><a name="Tab-StopVideoCapture"><strong>StopVideoCapture</strong></a>(sel f)</dt><dd><tt>Stops&nbsp;recording&nbsp;video&nbsp;of&nbsp;the&nbsp;tab's&nbsp; contents.<br>
549 &nbsp;<br>
550 This&nbsp;looks&nbsp;for&nbsp;the&nbsp;initial&nbsp;color&nbsp;flash&nbsp;in&nbs p;the&nbsp;first&nbsp;frame&nbsp;to&nbsp;establish&nbsp;the<br>
551 tab&nbsp;content&nbsp;boundaries&nbsp;and&nbsp;then&nbsp;omits&nbsp;all&nbsp;fra mes&nbsp;displaying&nbsp;the&nbsp;flash.<br>
552 &nbsp;<br>
553 Yields:<br>
554 &nbsp;&nbsp;(time_ms,&nbsp;bitmap)&nbsp;tuples&nbsp;representing&nbsp;each&nbsp; video&nbsp;keyframe.&nbsp;Only&nbsp;the&nbsp;first<br>
555 &nbsp;&nbsp;frame&nbsp;in&nbsp;a&nbsp;run&nbsp;of&nbsp;sequential&nbsp;duplicate &nbsp;bitmaps&nbsp;is&nbsp;typically&nbsp;included.<br>
556 &nbsp;&nbsp;&nbsp;&nbsp;time_ms&nbsp;is&nbsp;milliseconds&nbsp;since&nbsp;naviga tionStart.<br>
557 &nbsp;&nbsp;&nbsp;&nbsp;bitmap&nbsp;is&nbsp;a&nbsp;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&nbsp;browser&nbsp;in&nbsp;which&nbsp;this&nbsp;tab&nbsp;resides.</tt ></dd> 564 <dd><tt>The&nbsp;browser&nbsp;in&nbsp;which&nbsp;this&nbsp;tab&nbsp;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&nbsp;dictionary&nbsp;populated&nbsp;with&nbsp;measured&nbsp;DOM&nbsp;s tatistics.<br> 567 <dd><tt>A&nbsp;dictionary&nbsp;populated&nbsp;with&nbsp;measured&nbsp;DOM&nbsp;s tatistics.<br>
418 &nbsp;<br> 568 &nbsp;<br>
419 Currently&nbsp;this&nbsp;dictionary&nbsp;contains:<br> 569 Currently&nbsp;this&nbsp;dictionary&nbsp;contains:<br>
420 {<br> 570 {<br>
421 &nbsp;&nbsp;'document_count':&nbsp;integer,<br> 571 &nbsp;&nbsp;'document_count':&nbsp;integer,<br>
422 &nbsp;&nbsp;'node_count':&nbsp;integer,<br> 572 &nbsp;&nbsp;'node_count':&nbsp;integer,<br>
423 &nbsp;&nbsp;'event_listener_count':&nbsp;integer<br> 573 &nbsp;&nbsp;'event_listener_count':&nbsp;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&nbsp;if&nbsp;the&nbsp;browser&nbsp;instance&nbsp;is&nbsp;capable&nb sp;of&nbsp;capturing&nbsp;screenshots</tt></dd> 579 <dd><tt>True&nbsp;if&nbsp;the&nbsp;browser&nbsp;instance&nbsp;is&nbsp;capable&nb sp;of&nbsp;capturing&nbsp;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&nbsp;if&nbsp;the&nbsp;browser&nbsp;instance&nbsp;is&nbsp;capable&nb sp;of&nbsp;capturing&nbsp;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&nbsp;page.<br> 588 <dl><dt><a name="Tab-Close"><strong>Close</strong></a>(self)</dt><dd><tt>Closes& nbsp;this&nbsp;page.<br>
434 &nbsp;<br> 589 &nbsp;<br>
435 Not&nbsp;all&nbsp;browsers&nbsp;or&nbsp;browser&nbsp;versions&nbsp;support&nbsp; this&nbsp;method.<br> 590 Not&nbsp;all&nbsp;browsers&nbsp;or&nbsp;browser&nbsp;versions&nbsp;support&nbsp; this&nbsp;method.<br>
436 Be&nbsp;sure&nbsp;to&nbsp;check&nbsp;browser.supports_tab_control.</tt></dd></dl > 591 Be&nbsp;sure&nbsp;to&nbsp;check&nbsp;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&nbsp; expr&nbsp;in&nbsp;JavaScript&nbsp;and&nbsp;returns&nbsp;the&nbsp;JSONized&nbsp;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&nbsp; expr&nbsp;in&nbsp;JavaScript&nbsp;and&nbsp;returns&nbsp;the&nbsp;JSONized&nbsp;r esult.<br>
441 &nbsp;<br> 594 &nbsp;<br>
442 Consider&nbsp;using&nbsp;ExecuteJavaScript&nbsp;for&nbsp;cases&nbsp;where&nbsp;t he&nbsp;result&nbsp;of&nbsp;the<br> 595 Consider&nbsp;using&nbsp;ExecuteJavaScript&nbsp;for&nbsp;cases&nbsp;where&nbsp;t he&nbsp;result&nbsp;of&nbsp;the<br>
443 expression&nbsp;is&nbsp;not&nbsp;needed.<br> 596 expression&nbsp;is&nbsp;not&nbsp;needed.<br>
444 &nbsp;<br> 597 &nbsp;<br>
445 If&nbsp;evaluation&nbsp;throws&nbsp;in&nbsp;JavaScript,&nbsp;a&nbsp;Python&nbsp; EvaluateException&nbsp;will<br> 598 If&nbsp;evaluation&nbsp;throws&nbsp;in&nbsp;JavaScript,&nbsp;a&nbsp;Python&nbsp; EvaluateException&nbsp;will<br>
446 be&nbsp;raised.<br> 599 be&nbsp;raised.<br>
447 &nbsp;<br> 600 &nbsp;<br>
448 If&nbsp;the&nbsp;result&nbsp;of&nbsp;the&nbsp;evaluation&nbsp;cannot&nbsp;be&nbs p;JSONized,&nbsp;then&nbsp;an<br> 601 If&nbsp;the&nbsp;result&nbsp;of&nbsp;the&nbsp;evaluation&nbsp;cannot&nbsp;be&nbs p;JSONized,&nbsp;then&nbsp;an<br>
449 EvaluationException&nbsp;will&nbsp;be&nbsp;raised.</tt></dd></dl> 602 EvaluationException&nbsp;will&nbsp;be&nbsp;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&nbsp;ex pr&nbsp;in&nbsp;JavaScript.&nbsp;Does&nbsp;not&nbsp;return&nbsp;the&nbsp;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&nbsp;to&nbsp;ExecuteJavaScript,&nbsp;except&nbsp;context _id&nbsp;can&nbsp;refer&nbsp;to&nbsp;an&nbsp;iframe.<br>
605 The&nbsp;main&nbsp;page&nbsp;has&nbsp;context_id=1,&nbsp;the&nbsp;first&nbsp;ifr ame&nbsp;context_id=2,&nbsp;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&nbsp;ex pr&nbsp;in&nbsp;JavaScript.&nbsp;Does&nbsp;not&nbsp;return&nbsp;the&nbsp;result. <br>
452 &nbsp;<br> 608 &nbsp;<br>
453 If&nbsp;the&nbsp;expression&nbsp;failed&nbsp;to&nbsp;evaluate,&nbsp;EvaluateExce ption&nbsp;will&nbsp;be&nbsp;raised.</tt></dd></dl> 609 If&nbsp;the&nbsp;expression&nbsp;failed&nbsp;to&nbsp;evaluate,&nbsp;EvaluateExce ption&nbsp;will&nbsp;be&nbsp;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&nbsp;to&nbsp;ExecuteJavaScript,&nbsp;except&nbsp;context_i d&nbsp;can&nbsp;refer&nbsp;to&nbsp;an&nbsp;iframe.<br>
612 The&nbsp;main&nbsp;page&nbsp;has&nbsp;context_id=1,&nbsp;the&nbsp;first&nbsp;ifr ame&nbsp;context_id=2,&nbsp;etc.</tt></dd></dl>
613
614 <dl><dt><a name="Tab-HasReachedQuiescence"><strong>HasReachedQuiescence</strong> </a>(self)</dt><dd><tt>Determine&nbsp;whether&nbsp;the&nbsp;page&nbsp;has&nbsp;r eached&nbsp;quiescence&nbsp;after&nbsp;loading.<br>
615 &nbsp;<br>
616 Returns:<br>
617 &nbsp;&nbsp;True&nbsp;if&nbsp;2&nbsp;seconds&nbsp;have&nbsp;passed&nbsp;since&nb sp;last&nbsp;resource&nbsp;received,&nbsp;false<br>
618 &nbsp;&nbsp;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&nbsp;for&nbsp;the&nbsp ;given&nbsp;JavaScript&nbsp;expression&nbsp;to&nbsp;be&nbsp;True.<br>
631 &nbsp;<br>
632 This&nbsp;method&nbsp;is&nbsp;robust&nbsp;against&nbsp;any&nbsp;given&nbsp;Evalu ation&nbsp;timing&nbsp;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&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)< /tt></dd> 637 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;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&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp ;(if&nbsp;defined)</tt></dd> 640 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp ;(if&nbsp;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>&nbsp;<br> 651 <td colspan=3 valign=bottom>&nbsp;<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>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</td> 654 <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</td>
482 <td width="100%"><dl><dt><a name="-RunPage"><strong>RunPage</strong></a> = Run(t est, page_set, options)</dt><dd><tt>Runs&nbsp;a&nbsp;given&nbsp;test&nbsp;agains t&nbsp;a&nbsp;given&nbsp;page_set&nbsp;with&nbsp;the&nbsp;given&nbsp;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&nbsp;a&nbsp;given& nbsp;test&nbsp;against&nbsp;a&nbsp;given&nbsp;page_set&nbsp;with&nbsp;the&nbsp;g iven&nbsp;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>&nbsp;<br> 659 <td colspan=3 valign=bottom>&nbsp;<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>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</td> 662 <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</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>
OLDNEW
« no previous file with comments | « no previous file | tools/telemetry/docs/telemetry.core.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698