blob: 53aff2eed8c8d5b593985178294a98bcbcf1d540 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module telemetry.internal.browser.browser</title>
<meta charset="utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.internal.html"><font color="#ffffff">internal</font></a>.<a href="telemetry.internal.browser.html"><font color="#ffffff">browser</font></a>.browser</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/internal/browser/browser.py">telemetry/internal/browser/browser.py</a></font></td></tr></table>
<p><tt>#&nbsp;Copyright&nbsp;2012&nbsp;The&nbsp;Chromium&nbsp;Authors.&nbsp;All&nbsp;rights&nbsp;reserved.<br>
#&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>
#&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;file.</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.internal.app.html">telemetry.internal.app</a><br>
<a href="telemetry.internal.backends.browser_backend.html">telemetry.internal.backends.browser_backend</a><br>
<a href="telemetry.internal.browser.browser_credentials.html">telemetry.internal.browser.browser_credentials</a><br>
<a href="catapult_base.cloud_storage.html">catapult_base.cloud_storage</a><br>
</td><td width="25%" valign=top><a href="telemetry.decorators.html">telemetry.decorators</a><br>
<a href="telemetry.internal.util.exception_formatter.html">telemetry.internal.util.exception_formatter</a><br>
<a href="telemetry.core.exceptions.html">telemetry.core.exceptions</a><br>
<a href="telemetry.internal.browser.extension_dict.html">telemetry.internal.browser.extension_dict</a><br>
</td><td width="25%" valign=top><a href="logging.html">logging</a><br>
<a href="telemetry.core.profiling_controller.html">telemetry.core.profiling_controller</a><br>
<a href="sys.html">sys</a><br>
<a href="telemetry.internal.browser.tab_list.html">telemetry.internal.browser.tab_list</a><br>
</td><td width="25%" valign=top><a href="telemetry.internal.browser.web_contents.html">telemetry.internal.browser.web_contents</a><br>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="telemetry.internal.app.html#App">telemetry.internal.app.App</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="telemetry.internal.browser.browser.html#Browser">Browser</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="Browser">class <strong>Browser</strong></a>(<a href="telemetry.internal.app.html#App">telemetry.internal.app.App</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<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>
&nbsp;<br>
To&nbsp;create&nbsp;a&nbsp;browser&nbsp;instance,&nbsp;use&nbsp;browser_finder.FindBrowser.<br>
&nbsp;<br>
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>
the&nbsp;browser.&nbsp;Or&nbsp;better&nbsp;yet:<br>
&nbsp;&nbsp;browser_to_create&nbsp;=&nbsp;FindBrowser(options)<br>
&nbsp;&nbsp;with&nbsp;browser_to_create.Create(options)&nbsp;as&nbsp;browser:<br>
&nbsp;&nbsp;&nbsp;&nbsp;...&nbsp;do&nbsp;all&nbsp;your&nbsp;operations&nbsp;on&nbsp;browser&nbsp;here<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="telemetry.internal.browser.browser.html#Browser">Browser</a></dd>
<dd><a href="telemetry.internal.app.html#App">telemetry.internal.app.App</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Browser-Close"><strong>Close</strong></a>(self)</dt><dd><tt>Closes&nbsp;this&nbsp;browser.</tt></dd></dl>
<dl><dt><a name="Browser-DumpMemory"><strong>DumpMemory</strong></a>(self, timeout<font color="#909090">=90</font>)</dt></dl>
<dl><dt><a name="Browser-GetStackTrace"><strong>GetStackTrace</strong></a>(self)</dt></dl>
<dl><dt><a name="Browser-GetStandardOutput"><strong>GetStandardOutput</strong></a>(self)</dt></dl>
<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;system,&nbsp;if&nbsp;available.<br>
&nbsp;<br>
See&nbsp;the&nbsp;documentation&nbsp;of&nbsp;the&nbsp;SystemInfo&nbsp;class&nbsp;for&nbsp;more&nbsp;details.</tt></dd></dl>
<dl><dt><a name="Browser-SetMemoryPressureNotificationsSuppressed"><strong>SetMemoryPressureNotificationsSuppressed</strong></a>(self, suppressed, timeout<font color="#909090">=90</font>)</dt></dl>
<dl><dt><a name="Browser-SimulateMemoryPressureNotification"><strong>SimulateMemoryPressureNotification</strong></a>(self, pressure_level, timeout<font color="#909090">=90</font>)</dt></dl>
<dl><dt><a name="Browser-__init__"><strong>__init__</strong></a>(self, backend, platform_backend, credentials_path)</dt></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>browser_type</strong></dt>
</dl>
<dl><dt><strong>cpu_stats</strong></dt>
<dd><tt>Returns&nbsp;a&nbsp;dict&nbsp;of&nbsp;cpu&nbsp;statistics&nbsp;for&nbsp;the&nbsp;system.<br>
{&nbsp;'Browser':&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;'CpuProcessTime':&nbsp;S,<br>
&nbsp;&nbsp;&nbsp;&nbsp;'TotalTime':&nbsp;T<br>
&nbsp;&nbsp;},<br>
&nbsp;&nbsp;'Gpu':&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;'CpuProcessTime':&nbsp;S,<br>
&nbsp;&nbsp;&nbsp;&nbsp;'TotalTime':&nbsp;T<br>
&nbsp;&nbsp;},<br>
&nbsp;&nbsp;'Renderer':&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;'CpuProcessTime':&nbsp;S,<br>
&nbsp;&nbsp;&nbsp;&nbsp;'TotalTime':&nbsp;T<br>
&nbsp;&nbsp;}<br>
}<br>
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>
</dl>
<dl><dt><strong>extensions</strong></dt>
</dl>
<dl><dt><strong>foreground_tab</strong></dt>
</dl>
<dl><dt><strong>memory_stats</strong></dt>
<dd><tt>Returns&nbsp;a&nbsp;dict&nbsp;of&nbsp;memory&nbsp;statistics&nbsp;for&nbsp;the&nbsp;browser:<br>
{&nbsp;'Browser':&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;'VM':&nbsp;R,<br>
&nbsp;&nbsp;&nbsp;&nbsp;'VMPeak':&nbsp;S,<br>
&nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSize':&nbsp;T,<br>
&nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSizePeak':&nbsp;U,<br>
&nbsp;&nbsp;&nbsp;&nbsp;'ProportionalSetSize':&nbsp;V,<br>
&nbsp;&nbsp;&nbsp;&nbsp;'PrivateDirty':&nbsp;W<br>
&nbsp;&nbsp;},<br>
&nbsp;&nbsp;'Gpu':&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;'VM':&nbsp;R,<br>
&nbsp;&nbsp;&nbsp;&nbsp;'VMPeak':&nbsp;S,<br>
&nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSize':&nbsp;T,<br>
&nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSizePeak':&nbsp;U,<br>
&nbsp;&nbsp;&nbsp;&nbsp;'ProportionalSetSize':&nbsp;V,<br>
&nbsp;&nbsp;&nbsp;&nbsp;'PrivateDirty':&nbsp;W<br>
&nbsp;&nbsp;},<br>
&nbsp;&nbsp;'Renderer':&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;'VM':&nbsp;R,<br>
&nbsp;&nbsp;&nbsp;&nbsp;'VMPeak':&nbsp;S,<br>
&nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSize':&nbsp;T,<br>
&nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSizePeak':&nbsp;U,<br>
&nbsp;&nbsp;&nbsp;&nbsp;'ProportionalSetSize':&nbsp;V,<br>
&nbsp;&nbsp;&nbsp;&nbsp;'PrivateDirty':&nbsp;W<br>
&nbsp;&nbsp;},<br>
&nbsp;&nbsp;'SystemCommitCharge':&nbsp;X,<br>
&nbsp;&nbsp;'SystemTotalPhysicalMemory':&nbsp;Y,<br>
&nbsp;&nbsp;'ProcessCount':&nbsp;Z,<br>
}<br>
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>
</dl>
<dl><dt><strong>profiling_controller</strong></dt>
</dl>
<dl><dt><strong>supports_cpu_metrics</strong></dt>
</dl>
<dl><dt><strong>supports_extensions</strong></dt>
</dl>
<dl><dt><strong>supports_memory_dumping</strong></dt>
</dl>
<dl><dt><strong>supports_memory_metrics</strong></dt>
</dl>
<dl><dt><strong>supports_overriding_memory_pressure_notifications</strong></dt>
</dl>
<dl><dt><strong>supports_power_metrics</strong></dt>
</dl>
<dl><dt><strong>supports_system_info</strong></dt>
</dl>
<dl><dt><strong>supports_tab_control</strong></dt>
</dl>
<dl><dt><strong>tabs</strong></dt>
</dl>
<hr>
Methods inherited from <a href="telemetry.internal.app.html#App">telemetry.internal.app.App</a>:<br>
<dl><dt><a name="Browser-__enter__"><strong>__enter__</strong></a>(self)</dt></dl>
<dl><dt><a name="Browser-__exit__"><strong>__exit__</strong></a>(self, *args)</dt></dl>
<hr>
Data descriptors inherited from <a href="telemetry.internal.app.html#App">telemetry.internal.app.App</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>app_type</strong></dt>
</dl>
<dl><dt><strong>platform</strong></dt>
</dl>
</td></tr></table></td></tr></table>
</body></html>