tools/telemetry/docs/telemetry.core.browser.html - Issue 17150002: [telemetry] Initial (autogenerated) documentation plus support scripts

Unified Diff: tools/telemetry/docs/telemetry.core.browser.html

Issue 17150002: [telemetry] Initial (autogenerated) documentation plus support scripts (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: update with nits Created 7 years, 6 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 side-by-side diff with in-line comments

Download patch

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

diff --git a/tools/telemetry/docs/telemetry.core.browser.html b/tools/telemetry/docs/telemetry.core.browser.html

new file mode 100644

index 0000000000000000000000000000000000000000..4c7f8b1a0fd8b69b761538075e7f5ccf3c5672a8

--- /dev/null

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

@@ -0,0 +1,174 @@

+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

+<html><head><title>Python: module telemetry.core.browser</title>

+</head><body bgcolor="#f0f0f8">

+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">

+<tr bgcolor="#7799ee">

+<td valign=bottom>

+  <big><big><a href="telemetry.html">telemetry</a>.<a href="telemetry.core.html">core</a>.browser</big></big></td

+><td align=right valign=bottom

+><a href=".">index</a> <a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/browser.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/browser.py</a></td></tr></table>

+ <tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.

+# Use of this source code is governed by a BSD-style license that can be

+# found in the LICENSE file.</tt>

+

+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

+<tr bgcolor="#aa55cc">

+<td colspan=3 valign=bottom>

+<big>Modules</big></td></tr>

+<tr><td bgcolor="#aa55cc"><tt>      </tt></td><td> </td>

+<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>

+<a href="telemetry.core.browser_credentials.html">telemetry.core.browser_credentials</a>

+<a href="telemetry.core.extension_dict.html">telemetry.core.extension_dict</a>

+</td><td width="25%" valign=top><a href="os.html">os</a>

+<a href="telemetry.core.platform.html">telemetry.core.platform</a>

+<a href="telemetry.core.platform.profiler.profiler_finder.html">telemetry.core.platform.profiler.profiler_finder</a>

+</td><td width="25%" valign=top><a href="telemetry.core.tab_list.html">telemetry.core.tab_list</a>

+<a href="telemetry.core.temporary_http_server.html">telemetry.core.temporary_http_server</a>

+<a href="telemetry.core.wpr_modes.html">telemetry.core.wpr_modes</a>

+</td><td width="25%" valign=top><a href="telemetry.core.wpr_server.html">telemetry.core.wpr_server</a>

+</td></tr></table></td></tr></table>

+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

+<tr bgcolor="#ee77aa">

+<td colspan=3 valign=bottom>

+<big>Classes</big></td></tr>

+<tr><td bgcolor="#ee77aa"><tt>      </tt></td><td> </td>

+<td width="100%"><dl>

+<dt><a href="__builtin__.html#object">__builtin__.object</a>

+</dt><dd>

+<dl>

+<dt><a href="telemetry.core.browser.html#Browser">Browser</a>

+</dt></dl>

+</dd>

+</dl>

+

+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

+<tr bgcolor="#ffc8d8">

+<td colspan=3 valign=bottom>

+<a name="Browser">class Browser</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</td></tr>

+<tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>

+<td colspan=2><tt>A running browser instance that can be controlled in a limited way.

+

+To create a browser instance, use browser_finder.FindBrowser.

+

+Be sure to clean up after yourself by calling <a href="#Browser-Close">Close</a>() when you are done with

+the browser. Or better yet:

+  browser_to_create = FindBrowser(options)

+  with browser_to_create.Create() as browser:

+    ... do all your operations on browser here  </tt></td></tr>

+<tr><td> </td>

+<td width="100%">Methods defined here:

+<dl><dt><a name="Browser-Close">Close</a>(self)</dt><dd><tt>Closes this browser.</tt></dd></dl>

+<dl><dt><a name="Browser-GetStandardOutput">GetStandardOutput</a>(self)</dt></dl>

+<dl><dt><a name="Browser-GetTraceResultAndReset">GetTraceResultAndReset</a>(self)</dt><dd><tt>Returns the result of the trace, as TraceResult <a href="__builtin__.html#object">object</a>.</tt></dd></dl>

+<dl><dt><a name="Browser-SetHTTPServerDirectories">SetHTTPServerDirectories</a>(self, paths)</dt><dd><tt>Returns True if the HTTP server was started, False otherwise.</tt></dd></dl>

+<dl><dt><a name="Browser-SetReplayArchivePath">SetReplayArchivePath</a>(self, archive_path, append_to_existing_wpr=False)</dt></dl>

+<dl><dt><a name="Browser-StartProfiling">StartProfiling</a>(self, options, base_output_file)</dt><dd><tt>Starts profiling using |options|.profiler_tool. Results are saved to

+|base_output_file|.<process_name>.</tt></dd></dl>

+<dl><dt><a name="Browser-StartTracing">StartTracing</a>(self, custom_categories=None)</dt></dl>

+<dl><dt><a name="Browser-StopProfiling">StopProfiling</a>(self)</dt><dd><tt>Stops all active profilers and saves their results.</tt></dd></dl>

+<dl><dt><a name="Browser-StopTracing">StopTracing</a>(self)</dt></dl>

+<dl><dt><a name="Browser-__enter__">__enter__</a>(self)</dt></dl>

+<dl><dt><a name="Browser-__exit__">__exit__</a>(self, *args)</dt></dl>

+<dl><dt><a name="Browser-__init__">__init__</a>(self, backend, platform_backend)</dt></dl>

+<dl><dt><a name="Browser-is_profiler_active">is_profiler_active</a>(self, profiler_name)</dt></dl>

+<hr>

+Data descriptors defined here:

+<dl><dt>__dict__</dt>

+<dd><tt>dictionary for instance variables (if defined)</tt></dd>

+</dl>

+<dl><dt>__weakref__</dt>

+<dd><tt>list of weak references to the object (if defined)</tt></dd>

+</dl>

+<dl><dt>browser_type</dt>

+</dl>

+<dl><dt>extensions</dt>

+<dd><tt>Returns the extension dictionary if it exists.</tt></dd>

+</dl>

+<dl><dt>http_server</dt>

+</dl>

+<dl><dt>io_stats</dt>

+<dd><tt>Returns a dict of IO statistics for the browser:

+{ 'Browser': {

+    'ReadOperationCount': W,

+    'WriteOperationCount': X,

+    'ReadTransferCount': Y,

+    'WriteTransferCount': Z

+  },

+  'Gpu': {

+    'ReadOperationCount': W,

+    'WriteOperationCount': X,

+    'ReadTransferCount': Y,

+    'WriteTransferCount': Z

+  },

+  'Renderer': {

+    'ReadOperationCount': W,

+    'WriteOperationCount': X,

+    'ReadTransferCount': Y,

+    'WriteTransferCount': Z

+  }

+}</tt></dd>

+</dl>

+<dl><dt>is_content_shell</dt>

+<dd><tt>Returns whether this browser is a content shell, only.</tt></dd>

+</dl>

+<dl><dt>memory_stats</dt>

+<dd><tt>Returns a dict of memory statistics for the browser:

+{ 'Browser': {

+    'VM': S,

+    'VMPeak': T,

+    'WorkingSetSize': U,

+    'WorkingSetSizePeak': V,

+    'ProportionalSetSize': W,

+    'PrivateDirty': X

+  },

+  'Gpu': {

+    'VM': S,

+    'VMPeak': T,

+    'WorkingSetSize': U,

+    'WorkingSetSizePeak': V,

+    'ProportionalSetSize': W,

+    'PrivateDirty': X

+  },

+  'Renderer': {

+    'VM': S,

+    'VMPeak': T,

+    'WorkingSetSize': U,

+    'WorkingSetSizePeak': V,

+    'ProportionalSetSize': W,

+    'PrivateDirty': X

+  },

+  'SystemCommitCharge': Y,

+  'ProcessCount': Z,

+}

+Any of the above keys may be missing on a per-platform basis.</tt></dd>

+</dl>

+<dl><dt>platform</dt>

+</dl>

+<dl><dt>supports_extensions</dt>

+</dl>

+<dl><dt>supports_tab_control</dt>

+</dl>

+<dl><dt>supports_tracing</dt>

+</dl>

+<dl><dt>tabs</dt>

+</dl>

+</td></tr></table></td></tr></table>

+</body></html>

« no previous file with comments | « tools/telemetry/docs/telemetry.core.html ('k') | tools/telemetry/docs/telemetry.core.browser_credentials.html » ('j') | no next file with comments »