tools/telemetry/docs/telemetry.core.browser.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   3 <html><head><title>Python: module telemetry.core.browser</title>
   4 </head><body bgcolor="#f0f0f8">
   5
   6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
   7 <tr bgcolor="#7799ee">
   8 <td valign=bottom>&nbsp;<br>
   9 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.core.html"><font color="#ffffff">core</font></a>.browser</strong></big></big></font></td
  10 ><td align=right valign=bottom
  11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/core/browser.py">telemetry/core/browser.py</a></font></td></tr></table>
  12     <p><tt>#&nbsp;Copyright&nbsp;(c)&nbsp;2012&nbsp;The&nbsp;Chromium&nbsp;Authors.&nbsp;All&nbsp;rights&nbsp;reserved.<br>
  13 #&nbsp;Use&nbsp;of&nbsp;this&nbsp;source&nbsp;code&nbsp;is&nbsp;governed&nbsp;by&nbsp;a&nbsp;BSD-style&nbsp;license&nbsp;that&nbsp;can&nbsp;be<br>
  14 #&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;file.</tt></p>
  15 <p>
  16 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  17 <tr bgcolor="#aa55cc">
  18 <td colspan=3 valign=bottom>&nbsp;<br>
  19 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
  20
  21 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.core.chrome.browser_backend.html">telemetry.core.chrome.browser_backend</a><br>
  23 <a href="telemetry.core.browser_credentials.html">telemetry.core.browser_credentials</a><br>
  24 <a href="telemetry.core.extension_dict.html">telemetry.core.extension_dict</a><br>
  25 </td><td width="25%" valign=top><a href="os.html">os</a><br>
  26 <a href="telemetry.core.platform.html">telemetry.core.platform</a><br>
  27 <a href="telemetry.core.platform.profiler.profiler_finder.html">telemetry.core.platform.profiler.profiler_finder</a><br>
  28 </td><td width="25%" valign=top><a href="telemetry.core.tab_list.html">telemetry.core.tab_list</a><br>
  29 <a href="telemetry.core.temporary_http_server.html">telemetry.core.temporary_http_server</a><br>
  30 <a href="telemetry.core.wpr_modes.html">telemetry.core.wpr_modes</a><br>
  31 </td><td width="25%" valign=top><a href="telemetry.core.wpr_server.html">telemetry.core.wpr_server</a><br>
  32 </td></tr></table></td></tr></table><p>
  33 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  34 <tr bgcolor="#ee77aa">
  35 <td colspan=3 valign=bottom>&nbsp;<br>
  36 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
  37
  38 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  39 <td width="100%"><dl>
  40 <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
  41 </font></dt><dd>
  42 <dl>
  43 <dt><font face="helvetica, arial"><a href="telemetry.core.browser.html#Browser">Browser</a>
  44 </font></dt></dl>
  45 </dd>
  46 </dl>
  47  <p>
  48 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  49 <tr bgcolor="#ffc8d8">
  50 <td colspan=3 valign=bottom>&nbsp;<br>
  51 <font color="#000000" face="helvetica, arial"><a name="Browser">class <strong>Browser</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
  52
  53 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
  54 <td colspan=2><tt>A&nbsp;running&nbsp;browser&nbsp;instance&nbsp;that&nbsp;can&nbsp;be&nbsp;controlled&nbsp;in&nbsp;a&nbsp;limited&nbsp;way.<br>
  55 &nbsp;<br>
  56 To&nbsp;create&nbsp;a&nbsp;browser&nbsp;instance,&nbsp;use&nbsp;browser_finder.FindBrowser.<br>
  57 &nbsp;<br>
  58 Be&nbsp;sure&nbsp;to&nbsp;clean&nbsp;up&nbsp;after&nbsp;yourself&nbsp;by&nbsp;calling&nbsp;<a href="#Browser-Close">Close</a>()&nbsp;when&nbsp;you&nbsp;are&nbsp;done&nbsp;with<br>
  59 the&nbsp;browser.&nbsp;Or&nbsp;better&nbsp;yet:<br>
  60 &nbsp;&nbsp;browser_to_create&nbsp;=&nbsp;FindBrowser(options)<br>
  61 &nbsp;&nbsp;with&nbsp;browser_to_create.Create()&nbsp;as&nbsp;browser:<br>
  62 &nbsp;&nbsp;&nbsp;&nbsp;...&nbsp;do&nbsp;all&nbsp;your&nbsp;operations&nbsp;on&nbsp;browser&nbsp;here<br>&nbsp;</tt></td></tr>
  63 <tr><td>&nbsp;</td>
  64 <td width="100%">Methods defined here:<br>
  65 <dl><dt><a name="Browser-Close"><strong>Close</strong></a>(self)</dt><dd><tt>Closes&nbsp;this&nbsp;browser.</tt></dd></dl>
  66
  67 <dl><dt><a name="Browser-GetStackTrace"><strong>GetStackTrace</strong></a>(self)</dt></dl>
  68
  69 <dl><dt><a name="Browser-GetStandardOutput"><strong>GetStandardOutput</strong></a>(self)</dt></dl>
  70
  71 <dl><dt><a name="Browser-GetTraceResultAndReset"><strong>GetTraceResultAndReset</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;result&nbsp;of&nbsp;the&nbsp;trace,&nbsp;as&nbsp;TraceResult&nbsp;<a href="__builtin__.html#object">object</a>.</tt></dd></dl>
  72
  73 <dl><dt><a name="Browser-SetHTTPServerDirectories"><strong>SetHTTPServerDirectories</strong></a>(self, paths)</dt><dd><tt>Returns&nbsp;True&nbsp;if&nbsp;the&nbsp;HTTP&nbsp;server&nbsp;was&nbsp;started,&nbsp;False&nbsp;otherwise.</tt></dd></dl>
  74
  75 <dl><dt><a name="Browser-SetReplayArchivePath"><strong>SetReplayArchivePath</strong></a>(self, archive_path, append_to_existing_wpr<font color="#909090">=False</font>, make_javascript_deterministic<font color="#909090">=True</font>)</dt></dl>
  76
  77 <dl><dt><a name="Browser-StartProfiling"><strong>StartProfiling</strong></a>(self, 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>
  78 |base_output_file|.&lt;process_name&gt;.</tt></dd></dl>
  79
  80 <dl><dt><a name="Browser-StartTracing"><strong>StartTracing</strong></a>(self, custom_categories<font color="#909090">=None</font>, timeout<font color="#909090">=10</font>)</dt></dl>
  81
  82 <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>
  83
  84 <dl><dt><a name="Browser-StopTracing"><strong>StopTracing</strong></a>(self)</dt></dl>
  85
  86 <dl><dt><a name="Browser-__enter__"><strong>__enter__</strong></a>(self)</dt></dl>
  87
  88 <dl><dt><a name="Browser-__exit__"><strong>__exit__</strong></a>(self, *args)</dt></dl>
  89
  90 <dl><dt><a name="Browser-__init__"><strong>__init__</strong></a>(self, backend, platform_backend)</dt></dl>
  91
  92 <dl><dt><a name="Browser-is_profiler_active"><strong>is_profiler_active</strong></a>(self, profiler_name)</dt></dl>
  93
  94 <hr>
  95 Data descriptors defined here:<br>
  96 <dl><dt><strong>__dict__</strong></dt>
  97 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
  98 </dl>
  99 <dl><dt><strong>__weakref__</strong></dt>
 100 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
 101 </dl>
 102 <dl><dt><strong>browser_type</strong></dt>
 103 </dl>
 104 <dl><dt><strong>extensions</strong></dt>
 105 <dd><tt>Returns&nbsp;the&nbsp;extension&nbsp;dictionary&nbsp;if&nbsp;it&nbsp;exists.</tt></dd>
 106 </dl>
 107 <dl><dt><strong>http_server</strong></dt>
 108 </dl>
 109 <dl><dt><strong>io_stats</strong></dt>
 110 <dd><tt>Returns&nbsp;a&nbsp;dict&nbsp;of&nbsp;IO&nbsp;statistics&nbsp;for&nbsp;the&nbsp;browser:<br>
 111 {&nbsp;'Browser':&nbsp;{<br>
 112 &nbsp;&nbsp;&nbsp;&nbsp;'ReadOperationCount':&nbsp;W,<br>
 113 &nbsp;&nbsp;&nbsp;&nbsp;'WriteOperationCount':&nbsp;X,<br>
 114 &nbsp;&nbsp;&nbsp;&nbsp;'ReadTransferCount':&nbsp;Y,<br>
 115 &nbsp;&nbsp;&nbsp;&nbsp;'WriteTransferCount':&nbsp;Z<br>
 116 &nbsp;&nbsp;},<br>
 117 &nbsp;&nbsp;'Gpu':&nbsp;{<br>
 118 &nbsp;&nbsp;&nbsp;&nbsp;'ReadOperationCount':&nbsp;W,<br>
 119 &nbsp;&nbsp;&nbsp;&nbsp;'WriteOperationCount':&nbsp;X,<br>
 120 &nbsp;&nbsp;&nbsp;&nbsp;'ReadTransferCount':&nbsp;Y,<br>
 121 &nbsp;&nbsp;&nbsp;&nbsp;'WriteTransferCount':&nbsp;Z<br>
 122 &nbsp;&nbsp;},<br>
 123 &nbsp;&nbsp;'Renderer':&nbsp;{<br>
 124 &nbsp;&nbsp;&nbsp;&nbsp;'ReadOperationCount':&nbsp;W,<br>
 125 &nbsp;&nbsp;&nbsp;&nbsp;'WriteOperationCount':&nbsp;X,<br>
 126 &nbsp;&nbsp;&nbsp;&nbsp;'ReadTransferCount':&nbsp;Y,<br>
 127 &nbsp;&nbsp;&nbsp;&nbsp;'WriteTransferCount':&nbsp;Z<br>
 128 &nbsp;&nbsp;}<br>
 129 }</tt></dd>
 130 </dl>
 131 <dl><dt><strong>is_content_shell</strong></dt>
 132 <dd><tt>Returns&nbsp;whether&nbsp;this&nbsp;browser&nbsp;is&nbsp;a&nbsp;content&nbsp;shell,&nbsp;only.</tt></dd>
 133 </dl>
 134 <dl><dt><strong>memory_stats</strong></dt>
 135 <dd><tt>Returns&nbsp;a&nbsp;dict&nbsp;of&nbsp;memory&nbsp;statistics&nbsp;for&nbsp;the&nbsp;browser:<br>
 136 {&nbsp;'Browser':&nbsp;{<br>
 137 &nbsp;&nbsp;&nbsp;&nbsp;'VM':&nbsp;S,<br>
 138 &nbsp;&nbsp;&nbsp;&nbsp;'VMPeak':&nbsp;T,<br>
 139 &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSize':&nbsp;U,<br>
 140 &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSizePeak':&nbsp;V,<br>
 141 &nbsp;&nbsp;&nbsp;&nbsp;'ProportionalSetSize':&nbsp;W,<br>
 142 &nbsp;&nbsp;&nbsp;&nbsp;'PrivateDirty':&nbsp;X<br>
 143 &nbsp;&nbsp;},<br>
 144 &nbsp;&nbsp;'Gpu':&nbsp;{<br>
 145 &nbsp;&nbsp;&nbsp;&nbsp;'VM':&nbsp;S,<br>
 146 &nbsp;&nbsp;&nbsp;&nbsp;'VMPeak':&nbsp;T,<br>
 147 &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSize':&nbsp;U,<br>
 148 &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSizePeak':&nbsp;V,<br>
 149 &nbsp;&nbsp;&nbsp;&nbsp;'ProportionalSetSize':&nbsp;W,<br>
 150 &nbsp;&nbsp;&nbsp;&nbsp;'PrivateDirty':&nbsp;X<br>
 151 &nbsp;&nbsp;},<br>
 152 &nbsp;&nbsp;'Renderer':&nbsp;{<br>
 153 &nbsp;&nbsp;&nbsp;&nbsp;'VM':&nbsp;S,<br>
 154 &nbsp;&nbsp;&nbsp;&nbsp;'VMPeak':&nbsp;T,<br>
 155 &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSize':&nbsp;U,<br>
 156 &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSizePeak':&nbsp;V,<br>
 157 &nbsp;&nbsp;&nbsp;&nbsp;'ProportionalSetSize':&nbsp;W,<br>
 158 &nbsp;&nbsp;&nbsp;&nbsp;'PrivateDirty':&nbsp;X<br>
 159 &nbsp;&nbsp;},<br>
 160 &nbsp;&nbsp;'SystemCommitCharge':&nbsp;Y,<br>
 161 &nbsp;&nbsp;'ProcessCount':&nbsp;Z,<br>
 162 }<br>
 163 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>
 164 </dl>
 165 <dl><dt><strong>platform</strong></dt>
 166 </dl>
 167 <dl><dt><strong>supports_extensions</strong></dt>
 168 </dl>
 169 <dl><dt><strong>supports_tab_control</strong></dt>
 170 </dl>
 171 <dl><dt><strong>supports_tracing</strong></dt>
 172 </dl>
 173 <dl><dt><strong>tabs</strong></dt>
 174 </dl>
 175 </td></tr></table></td></tr></table>
 176 </body></html>