diff options
| author | nduca@chromium.org <nduca@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2013-06-19 03:31:53 +0000 |
|---|---|---|
| committer | nduca@chromium.org <nduca@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2013-06-19 03:31:53 +0000 |
| commit | f9a5c9e6e7f0959187f0a3f4cda6bdcfde0a3b9c (patch) | |
| tree | 67190aa58fac3c675c78f6b2a6722726a7f4a70e /tools | |
| parent | 2919ace54733841b4858ca9e21008f5b8100b873 (diff) | |
| download | chromium_src-f9a5c9e6e7f0959187f0a3f4cda6bdcfde0a3b9c.zip chromium_src-f9a5c9e6e7f0959187f0a3f4cda6bdcfde0a3b9c.tar.gz chromium_src-f9a5c9e6e7f0959187f0a3f4cda6bdcfde0a3b9c.tar.bz2 | |
[telemetry] Initial (autogenerated) documentation plus support scripts
This makes help(telemetry) show the classes and methods we care most about.
Then, it adds ./update_docs script that autogenerates a docs/ folder using
pydoc.writedoc. Finally, it adds docs/ which contains HTML documentation on telemetry generated by update_docs.
BUG=241616
Review URL: https://chromiumcodereview.appspot.com/17150002
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@207156 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'tools')
112 files changed, 12621 insertions, 2 deletions
diff --git a/tools/telemetry/build/__init__.py b/tools/telemetry/build/__init__.py new file mode 100644 index 0000000..9228df8 --- /dev/null +++ b/tools/telemetry/build/__init__.py @@ -0,0 +1,3 @@ +# Copyright 2013 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. diff --git a/tools/telemetry/build/update_docs.py b/tools/telemetry/build/update_docs.py new file mode 100644 index 0000000..019ad55 --- /dev/null +++ b/tools/telemetry/build/update_docs.py @@ -0,0 +1,64 @@ +# Copyright 2013 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. +import logging +import optparse +import os +import pkgutil +import pydoc +import sys + +from telemetry.core import util + +def RemoveAllDocs(docs_dir): + for dirname, _, filenames in os.walk(docs_dir): + for filename in filenames: + os.remove(os.path.join(dirname, filename)) + +def WriteDocsFor(module): + pydoc.writedoc(module) + for _, modname, _ in pkgutil.walk_packages( + module.__path__, module.__name__ + '.'): + if modname.endswith('_unittest'): + logging.info("skipping %s due to being a unittest", modname) + continue + + module = __import__(modname, fromlist=[""]) + name, _ = os.path.splitext(module.__file__) + if not os.path.exists(name + '.py'): + logging.info("skipping %s due to being an orphan .pyc", module.__file__) + continue + + pydoc.writedoc(module) + +def Main(args): + parser = optparse.OptionParser() + parser.add_option( + '-v', '--verbose', action='count', default=0, + help='Increase verbosity level (repeat as needed)') + options, args = parser.parse_args(args) + if options.verbose >= 2: + logging.basicConfig(level=logging.DEBUG) + elif options.verbose: + logging.basicConfig(level=logging.INFO) + else: + logging.basicConfig(level=logging.WARNING) + + + telemetry_dir = util.GetTelemetryDir() + docs_dir = os.path.join(telemetry_dir, 'docs') + + assert os.path.isdir(docs_dir) + + RemoveAllDocs(docs_dir) + + if telemetry_dir not in sys.path: + sys.path.append(telemetry_dir) + import telemetry + + old_cwd = os.getcwd() + try: + os.chdir(docs_dir) + WriteDocsFor(telemetry) + finally: + os.chdir(old_cwd) diff --git a/tools/telemetry/docs/telemetry.core.browser.html b/tools/telemetry/docs/telemetry.core.browser.html new file mode 100644 index 0000000..4c7f8b1 --- /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> <br> +<font color="#ffffff" face="helvetica, arial"> <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 +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><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></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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><br> +<a href="telemetry.core.browser_credentials.html">telemetry.core.browser_credentials</a><br> +<a href="telemetry.core.extension_dict.html">telemetry.core.extension_dict</a><br> +</td><td width="25%" valign=top><a href="os.html">os</a><br> +<a href="telemetry.core.platform.html">telemetry.core.platform</a><br> +<a href="telemetry.core.platform.profiler.profiler_finder.html">telemetry.core.platform.profiler.profiler_finder</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.tab_list.html">telemetry.core.tab_list</a><br> +<a href="telemetry.core.temporary_http_server.html">telemetry.core.temporary_http_server</a><br> +<a href="telemetry.core.wpr_modes.html">telemetry.core.wpr_modes</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.wpr_server.html">telemetry.core.wpr_server</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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.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> <br> +<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> + +<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.<br> + <br> +To create a browser instance, use browser_finder.FindBrowser.<br> + <br> +Be sure to clean up after yourself by calling <a href="#Browser-Close">Close</a>() when you are done with<br> +the browser. Or better yet:<br> + browser_to_create = FindBrowser(options)<br> + with browser_to_create.Create() as browser:<br> + ... do all your operations on browser here<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="Browser-Close"><strong>Close</strong></a>(self)</dt><dd><tt>Closes this browser.</tt></dd></dl> + +<dl><dt><a name="Browser-GetStandardOutput"><strong>GetStandardOutput</strong></a>(self)</dt></dl> + +<dl><dt><a name="Browser-GetTraceResultAndReset"><strong>GetTraceResultAndReset</strong></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"><strong>SetHTTPServerDirectories</strong></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"><strong>SetReplayArchivePath</strong></a>(self, archive_path, append_to_existing_wpr<font color="#909090">=False</font>)</dt></dl> + +<dl><dt><a name="Browser-StartProfiling"><strong>StartProfiling</strong></a>(self, options, base_output_file)</dt><dd><tt>Starts profiling using |options|.profiler_tool. Results are saved to<br> +|base_output_file|.<process_name>.</tt></dd></dl> + +<dl><dt><a name="Browser-StartTracing"><strong>StartTracing</strong></a>(self, custom_categories<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="Browser-StopProfiling"><strong>StopProfiling</strong></a>(self)</dt><dd><tt>Stops all active profilers and saves their results.</tt></dd></dl> + +<dl><dt><a name="Browser-StopTracing"><strong>StopTracing</strong></a>(self)</dt></dl> + +<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> + +<dl><dt><a name="Browser-__init__"><strong>__init__</strong></a>(self, backend, platform_backend)</dt></dl> + +<dl><dt><a name="Browser-is_profiler_active"><strong>is_profiler_active</strong></a>(self, profiler_name)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>browser_type</strong></dt> +</dl> +<dl><dt><strong>extensions</strong></dt> +<dd><tt>Returns the extension dictionary if it exists.</tt></dd> +</dl> +<dl><dt><strong>http_server</strong></dt> +</dl> +<dl><dt><strong>io_stats</strong></dt> +<dd><tt>Returns a dict of IO statistics for the browser:<br> +{ 'Browser': {<br> + 'ReadOperationCount': W,<br> + 'WriteOperationCount': X,<br> + 'ReadTransferCount': Y,<br> + 'WriteTransferCount': Z<br> + },<br> + 'Gpu': {<br> + 'ReadOperationCount': W,<br> + 'WriteOperationCount': X,<br> + 'ReadTransferCount': Y,<br> + 'WriteTransferCount': Z<br> + },<br> + 'Renderer': {<br> + 'ReadOperationCount': W,<br> + 'WriteOperationCount': X,<br> + 'ReadTransferCount': Y,<br> + 'WriteTransferCount': Z<br> + }<br> +}</tt></dd> +</dl> +<dl><dt><strong>is_content_shell</strong></dt> +<dd><tt>Returns whether this browser is a content shell, only.</tt></dd> +</dl> +<dl><dt><strong>memory_stats</strong></dt> +<dd><tt>Returns a dict of memory statistics for the browser:<br> +{ 'Browser': {<br> + 'VM': S,<br> + 'VMPeak': T,<br> + 'WorkingSetSize': U,<br> + 'WorkingSetSizePeak': V,<br> + 'ProportionalSetSize': W,<br> + 'PrivateDirty': X<br> + },<br> + 'Gpu': {<br> + 'VM': S,<br> + 'VMPeak': T,<br> + 'WorkingSetSize': U,<br> + 'WorkingSetSizePeak': V,<br> + 'ProportionalSetSize': W,<br> + 'PrivateDirty': X<br> + },<br> + 'Renderer': {<br> + 'VM': S,<br> + 'VMPeak': T,<br> + 'WorkingSetSize': U,<br> + 'WorkingSetSizePeak': V,<br> + 'ProportionalSetSize': W,<br> + 'PrivateDirty': X<br> + },<br> + 'SystemCommitCharge': Y,<br> + 'ProcessCount': Z,<br> +}<br> +Any of the above keys may be missing on a per-platform basis.</tt></dd> +</dl> +<dl><dt><strong>platform</strong></dt> +</dl> +<dl><dt><strong>supports_extensions</strong></dt> +</dl> +<dl><dt><strong>supports_tab_control</strong></dt> +</dl> +<dl><dt><strong>supports_tracing</strong></dt> +</dl> +<dl><dt><strong>tabs</strong></dt> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.browser_credentials.html b/tools/telemetry/docs/telemetry.core.browser_credentials.html new file mode 100644 index 0000000..dd73f11 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.browser_credentials.html @@ -0,0 +1,78 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.browser_credentials</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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_credentials</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/browser_credentials.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/browser_credentials.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.facebook_credentials_backend.html">telemetry.core.chrome.facebook_credentials_backend</a><br> +<a href="telemetry.core.chrome.google_credentials_backend.html">telemetry.core.chrome.google_credentials_backend</a><br> +</td><td width="25%" valign=top><a href="json.html">json</a><br> +<a href="logging.html">logging</a><br> +</td><td width="25%" valign=top><a href="telemetry.unittest.options_for_unittests.html">telemetry.unittest.options_for_unittests</a><br> +<a href="os.html">os</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.browser_credentials.html#BrowserCredentials">BrowserCredentials</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> <br> +<font color="#000000" face="helvetica, arial"><a name="BrowserCredentials">class <strong>BrowserCredentials</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="BrowserCredentials-Add"><strong>Add</strong></a>(self, credentials_type, data)</dt></dl> + +<dl><dt><a name="BrowserCredentials-AddBackend"><strong>AddBackend</strong></a>(self, backend)</dt></dl> + +<dl><dt><a name="BrowserCredentials-CanLogin"><strong>CanLogin</strong></a>(self, credentials_type)</dt></dl> + +<dl><dt><a name="BrowserCredentials-IsLoggedIn"><strong>IsLoggedIn</strong></a>(self, credentials_type)</dt></dl> + +<dl><dt><a name="BrowserCredentials-LoginNeeded"><strong>LoginNeeded</strong></a>(self, tab, credentials_type)</dt></dl> + +<dl><dt><a name="BrowserCredentials-LoginNoLongerNeeded"><strong>LoginNoLongerNeeded</strong></a>(self, tab, credentials_type)</dt></dl> + +<dl><dt><a name="BrowserCredentials-WarnIfMissingCredentials"><strong>WarnIfMissingCredentials</strong></a>(self, page_set)</dt></dl> + +<dl><dt><a name="BrowserCredentials-__init__"><strong>__init__</strong></a>(self, backends<font color="#909090">=None</font>)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>credentials_path</strong></dt> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.browser_finder.html b/tools/telemetry/docs/telemetry.core.browser_finder.html new file mode 100644 index 0000000..5e60c35 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.browser_finder.html @@ -0,0 +1,179 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.browser_finder</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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_finder</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/browser_finder.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/browser_finder.py</a></font></td></tr></table> + <p><tt>Finds browsers that can be controlled by telemetry.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.android_browser_finder.html">telemetry.core.chrome.android_browser_finder</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.chrome.cros_browser_finder.html">telemetry.core.chrome.cros_browser_finder</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.chrome.desktop_browser_finder.html">telemetry.core.chrome.desktop_browser_finder</a><br> +</td><td width="25%" valign=top><a href="logging.html">logging</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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.browser_finder.html#BrowserFinderException">BrowserFinderException</a> +</font></dt><dt><font face="helvetica, arial"><a href="telemetry.core.browser_finder.html#BrowserTypeRequiredException">BrowserTypeRequiredException</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> <br> +<font color="#000000" face="helvetica, arial"><a name="BrowserFinderException">class <strong>BrowserFinderException</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.browser_finder.html#BrowserFinderException">BrowserFinderException</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><a name="BrowserFinderException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserFinderException-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#BrowserFinderException-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><a name="BrowserFinderException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserFinderException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="BrowserFinderException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserFinderException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="BrowserFinderException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserFinderException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="BrowserFinderException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserFinderException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="BrowserFinderException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="BrowserFinderException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserFinderException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="BrowserFinderException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserFinderException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="BrowserFinderException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="BrowserFinderException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserFinderException-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="BrowserFinderException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> + +<hr> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +<dl><dt><strong>message</strong></dt> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="BrowserTypeRequiredException">class <strong>BrowserTypeRequiredException</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.browser_finder.html#BrowserTypeRequiredException">BrowserTypeRequiredException</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><a name="BrowserTypeRequiredException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserTypeRequiredException-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#BrowserTypeRequiredException-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><a name="BrowserTypeRequiredException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserTypeRequiredException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="BrowserTypeRequiredException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserTypeRequiredException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="BrowserTypeRequiredException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserTypeRequiredException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="BrowserTypeRequiredException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserTypeRequiredException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="BrowserTypeRequiredException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="BrowserTypeRequiredException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserTypeRequiredException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="BrowserTypeRequiredException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserTypeRequiredException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="BrowserTypeRequiredException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="BrowserTypeRequiredException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserTypeRequiredException-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="BrowserTypeRequiredException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> + +<hr> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +<dl><dt><strong>message</strong></dt> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-FindBrowser"><strong>FindBrowser</strong></a>(options)</dt><dd><tt>Finds the best PossibleBrowser object to run given the provided<br> +BrowserOptions object. The returned possiblity object can then be used to<br> +connect to and control the located browser. A <a href="#BrowserFinderException">BrowserFinderException</a> will<br> +be raised if the BrowserOptions argument is improperly set or if an error<br> +occurs when finding a browser.</tt></dd></dl> + <dl><dt><a name="-GetAllAvailableBrowserTypes"><strong>GetAllAvailableBrowserTypes</strong></a>(options)</dt><dd><tt>Returns an array of browser types supported on this system.<br> +A <a href="#BrowserFinderException">BrowserFinderException</a> will be raised if the BrowserOptions argument is<br> +improperly set or if an error occurs when finding a browser.</tt></dd></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>ALL_BROWSER_TYPES</strong> = 'exact,release,debug,canary,content-shell-debug,c...chrome,cros-chrome,cros-chrome-guest,system-guest'</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.browser_options.html b/tools/telemetry/docs/telemetry.core.browser_options.html new file mode 100644 index 0000000..8e0d963 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.browser_options.html @@ -0,0 +1,79 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.browser_options</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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_options</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/browser_options.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/browser_options.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.browser_finder.html">telemetry.core.browser_finder</a><br> +<a href="copy.html">copy</a><br> +<a href="logging.html">logging</a><br> +</td><td width="25%" valign=top><a href="optparse.html">optparse</a><br> +<a href="telemetry.core.profile_types.html">telemetry.core.profile_types</a><br> +<a href="telemetry.core.platform.profiler.profiler_finder.html">telemetry.core.platform.profiler.profiler_finder</a><br> +</td><td width="25%" valign=top><a href="shlex.html">shlex</a><br> +<a href="sys.html">sys</a><br> +<a href="telemetry.core.wpr_modes.html">telemetry.core.wpr_modes</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="optparse.html#Values">optparse.Values</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.browser_options.html#BrowserOptions">BrowserOptions</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> <br> +<font color="#000000" face="helvetica, arial"><a name="BrowserOptions">class <strong>BrowserOptions</strong></a>(<a href="optparse.html#Values">optparse.Values</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Options to be used for discovering and launching a browser.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="BrowserOptions-AppendExtraBrowserArg"><strong>AppendExtraBrowserArg</strong></a>(self, arg)</dt></dl> + +<dl><dt><a name="BrowserOptions-Copy"><strong>Copy</strong></a>(self)</dt></dl> + +<dl><dt><a name="BrowserOptions-CreateParser"><strong>CreateParser</strong></a>(self, *args, **kwargs)</dt></dl> + +<dl><dt><a name="BrowserOptions-__init__"><strong>__init__</strong></a>(self, browser_type<font color="#909090">=None</font>)</dt></dl> + +<hr> +Methods inherited from <a href="optparse.html#Values">optparse.Values</a>:<br> +<dl><dt><a name="BrowserOptions-__cmp__"><strong>__cmp__</strong></a>(self, other)</dt></dl> + +<dl><dt><a name="BrowserOptions-__repr__"><strong>__repr__</strong></a> = _repr(self)</dt></dl> + +<dl><dt><a name="BrowserOptions-__str__"><strong>__str__</strong></a>(self)</dt></dl> + +<dl><dt><a name="BrowserOptions-ensure_value"><strong>ensure_value</strong></a>(self, attr, value)</dt></dl> + +<dl><dt><a name="BrowserOptions-read_file"><strong>read_file</strong></a>(self, filename, mode<font color="#909090">='careful'</font>)</dt></dl> + +<dl><dt><a name="BrowserOptions-read_module"><strong>read_module</strong></a>(self, modname, mode<font color="#909090">='careful'</font>)</dt></dl> + +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.adb_commands.html b/tools/telemetry/docs/telemetry.core.chrome.adb_commands.html new file mode 100644 index 0000000..7aa7d88 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.adb_commands.html @@ -0,0 +1,165 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.adb_commands</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.adb_commands</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/adb_commands.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/adb_commands.py</a></font></td></tr></table> + <p><tt>Brings in Chrome Android's android_commands module, which itself is a<br> +thin(ish) wrapper around adb.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="pylib.android_commands.html">pylib.android_commands</a><br> +<a href="pylib.cmd_helper.html">pylib.cmd_helper</a><br> +</td><td width="25%" valign=top><a href="pylib.forwarder.html">pylib.forwarder</a><br> +<a href="os.html">os</a><br> +</td><td width="25%" valign=top><a href="pylib.ports.html">pylib.ports</a><br> +<a href="sys.html">sys</a><br> +</td><td width="25%" valign=top><a href="pylib.valgrind_tools.html">pylib.valgrind_tools</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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.adb_commands.html#AdbCommands">AdbCommands</a> +</font></dt><dt><font face="helvetica, arial"><a href="telemetry.core.chrome.adb_commands.html#Forwarder">Forwarder</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> <br> +<font color="#000000" face="helvetica, arial"><a name="AdbCommands">class <strong>AdbCommands</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>A thin wrapper around ADB<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="AdbCommands-Adb"><strong>Adb</strong></a>(self)</dt></dl> + +<dl><dt><a name="AdbCommands-CloseApplication"><strong>CloseApplication</strong></a>(self, package)</dt><dd><tt>Attempt to close down the application, using increasing violence.<br> + <br> +Args:<br> + package: Name of the process to kill off, e.g.<br> + com.google.android.apps.chrome</tt></dd></dl> + +<dl><dt><a name="AdbCommands-ExtractPid"><strong>ExtractPid</strong></a>(self, process_name)</dt><dd><tt>Extracts Process Ids for a given process name from Android Shell.<br> + <br> +Args:<br> + process_name: name of the process on the device.<br> + <br> +Returns:<br> + List of all the process ids (as strings) that match the given name.<br> + If the name of a process exactly matches the given name, the pid of<br> + that process will be inserted to the front of the pid list.</tt></dd></dl> + +<dl><dt><a name="AdbCommands-FileExistsOnDevice"><strong>FileExistsOnDevice</strong></a>(self, file_name)</dt></dl> + +<dl><dt><a name="AdbCommands-Forward"><strong>Forward</strong></a>(self, local, remote)</dt></dl> + +<dl><dt><a name="AdbCommands-IsRootEnabled"><strong>IsRootEnabled</strong></a>(self)</dt></dl> + +<dl><dt><a name="AdbCommands-KillAll"><strong>KillAll</strong></a>(self, process)</dt><dd><tt>Android version of killall, connected via adb.<br> + <br> +Args:<br> + process: name of the process to kill off<br> + <br> +Returns:<br> + the number of processess killed</tt></dd></dl> + +<dl><dt><a name="AdbCommands-Pull"><strong>Pull</strong></a>(self, remote, local)</dt></dl> + +<dl><dt><a name="AdbCommands-Push"><strong>Push</strong></a>(self, local, remote)</dt></dl> + +<dl><dt><a name="AdbCommands-RunShellCommand"><strong>RunShellCommand</strong></a>(self, command, timeout_time<font color="#909090">=20</font>, log_result<font color="#909090">=False</font>)</dt><dd><tt>Send a command to the adb shell and return the result.<br> + <br> +Args:<br> + command: String containing the shell command to send. Must not include<br> + the single quotes as we use them to escape the whole command.<br> + timeout_time: Number of seconds to wait for command to respond before<br> + retrying, used by AdbInterface.SendShellCommand.<br> + log_result: Boolean to indicate whether we should log the result of the<br> + shell command.<br> + <br> +Returns:<br> + list containing the lines of output received from running the command</tt></dd></dl> + +<dl><dt><a name="AdbCommands-StartActivity"><strong>StartActivity</strong></a>(self, package, activity, wait_for_completion<font color="#909090">=False</font>, action<font color="#909090">='android.intent.action.VIEW'</font>, category<font color="#909090">=None</font>, data<font color="#909090">=None</font>, extras<font color="#909090">=None</font>, trace_file_name<font color="#909090">=None</font>)</dt><dd><tt>Starts |package|'s activity on the device.<br> + <br> +Args:<br> + package: Name of package to start (e.g. 'com.google.android.apps.chrome').<br> + activity: Name of activity (e.g. '.Main' or<br> + 'com.google.android.apps.chrome.Main').<br> + wait_for_completion: wait for the activity to finish launching (-W flag).<br> + action: string (e.g. 'android.intent.action.MAIN'). Default is VIEW.<br> + category: string (e.g. 'android.intent.category.HOME')<br> + data: Data string to pass to activity (e.g. '<a href="http://www.example.com/">http://www.example.com/</a>').<br> + extras: Dict of extras to pass to activity. Values are significant.<br> + trace_file_name: If used, turns on and saves the trace to this file name.</tt></dd></dl> + +<dl><dt><a name="AdbCommands-__init__"><strong>__init__</strong></a>(self, device)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="Forwarder">class <strong>Forwarder</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="Forwarder-Close"><strong>Close</strong></a>(self)</dt></dl> + +<dl><dt><a name="Forwarder-__init__"><strong>__init__</strong></a>(self, adb, *port_pairs)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>url</strong></dt> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-AllocateTestServerPort"><strong>AllocateTestServerPort</strong></a>()</dt></dl> + <dl><dt><a name="-GetAttachedDevices"><strong>GetAttachedDevices</strong></a>()</dt><dd><tt>Returns a list of attached, online android devices.<br> + <br> +If a preferred device has been set with ANDROID_SERIAL, it will be first in<br> +the returned list.</tt></dd></dl> + <dl><dt><a name="-GetOutDirectory"><strong>GetOutDirectory</strong></a>()</dt></dl> + <dl><dt><a name="-HasForwarder"><strong>HasForwarder</strong></a>(buildtype<font color="#909090">=None</font>)</dt></dl> + <dl><dt><a name="-IsAndroidSupported"><strong>IsAndroidSupported</strong></a>()</dt></dl> + <dl><dt><a name="-ResetTestServerPortAllocation"><strong>ResetTestServerPortAllocation</strong></a>()</dt></dl> +</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.android_browser_backend.html b/tools/telemetry/docs/telemetry.core.chrome.android_browser_backend.html new file mode 100644 index 0000000..61d74ef --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.android_browser_backend.html @@ -0,0 +1,316 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.android_browser_backend</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.android_browser_backend</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/android_browser_backend.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/android_browser_backend.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.adb_commands.html">telemetry.core.chrome.adb_commands</a><br> +<a href="telemetry.core.chrome.browser_backend.html">telemetry.core.chrome.browser_backend</a><br> +<a href="telemetry.core.exceptions.html">telemetry.core.exceptions</a><br> +</td><td width="25%" valign=top><a href="logging.html">logging</a><br> +<a href="os.html">os</a><br> +<a href="subprocess.html">subprocess</a><br> +</td><td width="25%" valign=top><a href="sys.html">sys</a><br> +<a href="tempfile.html">tempfile</a><br> +<a href="time.html">time</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.android_browser_backend.html#AndroidBrowserBackendSettings">AndroidBrowserBackendSettings</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.android_browser_backend.html#ChromeBackendSettings">ChromeBackendSettings</a> +</font></dt><dt><font face="helvetica, arial"><a href="telemetry.core.chrome.android_browser_backend.html#ChromiumTestShellBackendSettings">ChromiumTestShellBackendSettings</a> +</font></dt><dt><font face="helvetica, arial"><a href="telemetry.core.chrome.android_browser_backend.html#ContentShellBackendSettings">ContentShellBackendSettings</a> +</font></dt><dt><font face="helvetica, arial"><a href="telemetry.core.chrome.android_browser_backend.html#WebviewBackendSettings">WebviewBackendSettings</a> +</font></dt></dl> +</dd> +</dl> +</dd> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.android_browser_backend.html#AndroidBrowserBackend">AndroidBrowserBackend</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> <br> +<font color="#000000" face="helvetica, arial"><a name="AndroidBrowserBackend">class <strong>AndroidBrowserBackend</strong></a>(<a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>The backend for controlling a browser instance running on Android.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.chrome.android_browser_backend.html#AndroidBrowserBackend">AndroidBrowserBackend</a></dd> +<dd><a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="AndroidBrowserBackend-Close"><strong>Close</strong></a>(self)</dt></dl> + +<dl><dt><a name="AndroidBrowserBackend-CreateForwarder"><strong>CreateForwarder</strong></a>(self, *port_pairs)</dt></dl> + +<dl><dt><a name="AndroidBrowserBackend-GetBrowserStartupArgs"><strong>GetBrowserStartupArgs</strong></a>(self)</dt></dl> + +<dl><dt><a name="AndroidBrowserBackend-GetRemotePort"><strong>GetRemotePort</strong></a>(self, local_port)</dt></dl> + +<dl><dt><a name="AndroidBrowserBackend-GetStandardOutput"><strong>GetStandardOutput</strong></a>(self)</dt></dl> + +<dl><dt><a name="AndroidBrowserBackend-IsBrowserRunning"><strong>IsBrowserRunning</strong></a>(self)</dt></dl> + +<dl><dt><a name="AndroidBrowserBackend-__del__"><strong>__del__</strong></a>(self)</dt></dl> + +<dl><dt><a name="AndroidBrowserBackend-__init__"><strong>__init__</strong></a>(self, options, backend_settings)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>adb</strong></dt> +</dl> +<dl><dt><strong>pid</strong></dt> +</dl> +<hr> +Methods inherited from <a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>:<br> +<dl><dt><a name="AndroidBrowserBackend-GetProcessName"><strong>GetProcessName</strong></a>(self, cmd_line)</dt><dd><tt>Returns a user-friendly name for the process of the given |cmd_line|.</tt></dd></dl> + +<dl><dt><a name="AndroidBrowserBackend-GetTraceResultAndReset"><strong>GetTraceResultAndReset</strong></a>(self)</dt></dl> + +<dl><dt><a name="AndroidBrowserBackend-Request"><strong>Request</strong></a>(self, path, timeout<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="AndroidBrowserBackend-SetBrowser"><strong>SetBrowser</strong></a>(self, browser)</dt></dl> + +<dl><dt><a name="AndroidBrowserBackend-StartTracing"><strong>StartTracing</strong></a>(self, custom_categories<font color="#909090">=None</font>)</dt><dd><tt>custom_categories is an optional string containing a list of<br> +comma separated categories that will be traced instead of the<br> +default category set. Example: use<br> +"webkit,cc,disabled-by-default-cc.debug" to trace only those three<br> +event categories.</tt></dd></dl> + +<dl><dt><a name="AndroidBrowserBackend-StopTracing"><strong>StopTracing</strong></a>(self)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>browser</strong></dt> +</dl> +<dl><dt><strong>chrome_branch_number</strong></dt> +</dl> +<dl><dt><strong>extension_dict_backend</strong></dt> +</dl> +<dl><dt><strong>misc_web_contents_backend</strong></dt> +<dd><tt>Access to chrome://oobe/login page which is neither a tab nor an<br> +extension.</tt></dd> +</dl> +<dl><dt><strong>supports_extensions</strong></dt> +<dd><tt>True if this browser backend supports extensions.</tt></dd> +</dl> +<dl><dt><strong>supports_tab_control</strong></dt> +</dl> +<dl><dt><strong>supports_tracing</strong></dt> +</dl> +<dl><dt><strong>tab_list_backend</strong></dt> +</dl> +<dl><dt><strong>wpr_mode</strong></dt> +</dl> +<hr> +Data and other attributes inherited from <a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>:<br> +<dl><dt><strong>WEBPAGEREPLAY_HOST</strong> = '127.0.0.1'</dl> + +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="AndroidBrowserBackendSettings">class <strong>AndroidBrowserBackendSettings</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="AndroidBrowserBackendSettings-GetDevtoolsRemotePort"><strong>GetDevtoolsRemotePort</strong></a>(self)</dt></dl> + +<dl><dt><a name="AndroidBrowserBackendSettings-PushProfile"><strong>PushProfile</strong></a>(self, _)</dt></dl> + +<dl><dt><a name="AndroidBrowserBackendSettings-RemoveProfile"><strong>RemoveProfile</strong></a>(self)</dt></dl> + +<dl><dt><a name="AndroidBrowserBackendSettings-__init__"><strong>__init__</strong></a>(self, adb, activity, cmdline_file, package, pseudo_exec_name)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>is_content_shell</strong></dt> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="ChromeBackendSettings">class <strong>ChromeBackendSettings</strong></a>(<a href="telemetry.core.chrome.android_browser_backend.html#AndroidBrowserBackendSettings">AndroidBrowserBackendSettings</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.chrome.android_browser_backend.html#ChromeBackendSettings">ChromeBackendSettings</a></dd> +<dd><a href="telemetry.core.chrome.android_browser_backend.html#AndroidBrowserBackendSettings">AndroidBrowserBackendSettings</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="ChromeBackendSettings-GetDevtoolsRemotePort"><strong>GetDevtoolsRemotePort</strong></a>(self)</dt></dl> + +<dl><dt><a name="ChromeBackendSettings-PushProfile"><strong>PushProfile</strong></a>(self, new_profile_dir)</dt></dl> + +<dl><dt><a name="ChromeBackendSettings-__init__"><strong>__init__</strong></a>(self, adb, package)</dt></dl> + +<hr> +Methods inherited from <a href="telemetry.core.chrome.android_browser_backend.html#AndroidBrowserBackendSettings">AndroidBrowserBackendSettings</a>:<br> +<dl><dt><a name="ChromeBackendSettings-RemoveProfile"><strong>RemoveProfile</strong></a>(self)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.chrome.android_browser_backend.html#AndroidBrowserBackendSettings">AndroidBrowserBackendSettings</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>is_content_shell</strong></dt> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="ChromiumTestShellBackendSettings">class <strong>ChromiumTestShellBackendSettings</strong></a>(<a href="telemetry.core.chrome.android_browser_backend.html#AndroidBrowserBackendSettings">AndroidBrowserBackendSettings</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.chrome.android_browser_backend.html#ChromiumTestShellBackendSettings">ChromiumTestShellBackendSettings</a></dd> +<dd><a href="telemetry.core.chrome.android_browser_backend.html#AndroidBrowserBackendSettings">AndroidBrowserBackendSettings</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="ChromiumTestShellBackendSettings-GetDevtoolsRemotePort"><strong>GetDevtoolsRemotePort</strong></a>(self)</dt></dl> + +<dl><dt><a name="ChromiumTestShellBackendSettings-__init__"><strong>__init__</strong></a>(self, adb, package)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>is_content_shell</strong></dt> +</dl> +<hr> +Methods inherited from <a href="telemetry.core.chrome.android_browser_backend.html#AndroidBrowserBackendSettings">AndroidBrowserBackendSettings</a>:<br> +<dl><dt><a name="ChromiumTestShellBackendSettings-PushProfile"><strong>PushProfile</strong></a>(self, _)</dt></dl> + +<dl><dt><a name="ChromiumTestShellBackendSettings-RemoveProfile"><strong>RemoveProfile</strong></a>(self)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.chrome.android_browser_backend.html#AndroidBrowserBackendSettings">AndroidBrowserBackendSettings</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="ContentShellBackendSettings">class <strong>ContentShellBackendSettings</strong></a>(<a href="telemetry.core.chrome.android_browser_backend.html#AndroidBrowserBackendSettings">AndroidBrowserBackendSettings</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.chrome.android_browser_backend.html#ContentShellBackendSettings">ContentShellBackendSettings</a></dd> +<dd><a href="telemetry.core.chrome.android_browser_backend.html#AndroidBrowserBackendSettings">AndroidBrowserBackendSettings</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="ContentShellBackendSettings-GetDevtoolsRemotePort"><strong>GetDevtoolsRemotePort</strong></a>(self)</dt></dl> + +<dl><dt><a name="ContentShellBackendSettings-__init__"><strong>__init__</strong></a>(self, adb, package)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>is_content_shell</strong></dt> +</dl> +<hr> +Methods inherited from <a href="telemetry.core.chrome.android_browser_backend.html#AndroidBrowserBackendSettings">AndroidBrowserBackendSettings</a>:<br> +<dl><dt><a name="ContentShellBackendSettings-PushProfile"><strong>PushProfile</strong></a>(self, _)</dt></dl> + +<dl><dt><a name="ContentShellBackendSettings-RemoveProfile"><strong>RemoveProfile</strong></a>(self)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.chrome.android_browser_backend.html#AndroidBrowserBackendSettings">AndroidBrowserBackendSettings</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="WebviewBackendSettings">class <strong>WebviewBackendSettings</strong></a>(<a href="telemetry.core.chrome.android_browser_backend.html#AndroidBrowserBackendSettings">AndroidBrowserBackendSettings</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.chrome.android_browser_backend.html#WebviewBackendSettings">WebviewBackendSettings</a></dd> +<dd><a href="telemetry.core.chrome.android_browser_backend.html#AndroidBrowserBackendSettings">AndroidBrowserBackendSettings</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="WebviewBackendSettings-GetDevtoolsRemotePort"><strong>GetDevtoolsRemotePort</strong></a>(self)</dt></dl> + +<dl><dt><a name="WebviewBackendSettings-__init__"><strong>__init__</strong></a>(self, adb, package)</dt></dl> + +<hr> +Methods inherited from <a href="telemetry.core.chrome.android_browser_backend.html#AndroidBrowserBackendSettings">AndroidBrowserBackendSettings</a>:<br> +<dl><dt><a name="WebviewBackendSettings-PushProfile"><strong>PushProfile</strong></a>(self, _)</dt></dl> + +<dl><dt><a name="WebviewBackendSettings-RemoveProfile"><strong>RemoveProfile</strong></a>(self)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.chrome.android_browser_backend.html#AndroidBrowserBackendSettings">AndroidBrowserBackendSettings</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>is_content_shell</strong></dt> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.android_browser_finder.html b/tools/telemetry/docs/telemetry.core.chrome.android_browser_finder.html new file mode 100644 index 0000000..d5a4b60 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.android_browser_finder.html @@ -0,0 +1,102 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.android_browser_finder</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.android_browser_finder</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/android_browser_finder.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/android_browser_finder.py</a></font></td></tr></table> + <p><tt>Finds android browsers that can be controlled by telemetry.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.adb_commands.html">telemetry.core.chrome.adb_commands</a><br> +<a href="telemetry.core.chrome.android_browser_backend.html">telemetry.core.chrome.android_browser_backend</a><br> +<a href="telemetry.core.platform.android_platform_backend.html">telemetry.core.platform.android_platform_backend</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.browser.html">telemetry.core.browser</a><br> +<a href="os.html">os</a><br> +<a href="telemetry.core.possible_browser.html">telemetry.core.possible_browser</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.profile_types.html">telemetry.core.profile_types</a><br> +<a href="re.html">re</a><br> +<a href="logging.html">logging</a><br> +</td><td width="25%" valign=top><a href="subprocess.html">subprocess</a><br> +<a href="sys.html">sys</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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.possible_browser.html#PossibleBrowser">telemetry.core.possible_browser.PossibleBrowser</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.android_browser_finder.html#PossibleAndroidBrowser">PossibleAndroidBrowser</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> <br> +<font color="#000000" face="helvetica, arial"><a name="PossibleAndroidBrowser">class <strong>PossibleAndroidBrowser</strong></a>(<a href="telemetry.core.possible_browser.html#PossibleBrowser">telemetry.core.possible_browser.PossibleBrowser</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>A launchable android browser instance.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.chrome.android_browser_finder.html#PossibleAndroidBrowser">PossibleAndroidBrowser</a></dd> +<dd><a href="telemetry.core.possible_browser.html#PossibleBrowser">telemetry.core.possible_browser.PossibleBrowser</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="PossibleAndroidBrowser-Create"><strong>Create</strong></a>(self)</dt></dl> + +<dl><dt><a name="PossibleAndroidBrowser-SupportsOptions"><strong>SupportsOptions</strong></a>(self, options)</dt></dl> + +<dl><dt><a name="PossibleAndroidBrowser-__init__"><strong>__init__</strong></a>(self, browser_type, options, backend_settings)</dt></dl> + +<dl><dt><a name="PossibleAndroidBrowser-__repr__"><strong>__repr__</strong></a>(self)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.possible_browser.html#PossibleBrowser">telemetry.core.possible_browser.PossibleBrowser</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>browser_type</strong></dt> +</dl> +<dl><dt><strong>options</strong></dt> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-FindAllAvailableBrowsers"><strong>FindAllAvailableBrowsers</strong></a>(options, logging<font color="#909090">=<module 'logging' from '/System/Library/Framewor...Versions/2.7/lib/python2.7/logging/__init__.pyc'></font>)</dt><dd><tt>Finds all the desktop browsers available on this machine.</tt></dd></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>ALL_BROWSER_TYPES</strong> = 'android-chromium-testshell,android-content-shell...hrome,android-chrome-dev,android-jb-system-chrome'<br> +<strong>CHROME_PACKAGE_NAMES</strong> = {'android-chrome': 'com.google.android.apps.chrome', 'android-chrome-beta': 'com.chrome.beta', 'android-chrome-dev': 'com.google.android.apps.chrome_dev', 'android-jb-system-chrome': 'com.android.chrome'}<br> +<strong>CHROMIUM_TESTSHELL_PACKAGE</strong> = 'org.chromium.chrome.testshell'<br> +<strong>CONTENT_SHELL_PACKAGE</strong> = 'org.chromium.content_shell_apk'<br> +<strong>WEBVIEW_PACKAGE</strong> = 'com.android.webview.chromium.shell'</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.browser_backend.html b/tools/telemetry/docs/telemetry.core.chrome.browser_backend.html new file mode 100644 index 0000000..2259eff --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.browser_backend.html @@ -0,0 +1,215 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.browser_backend</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.browser_backend</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/browser_backend.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/browser_backend.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.exceptions.html">telemetry.core.exceptions</a><br> +<a href="telemetry.core.chrome.extension_dict_backend.html">telemetry.core.chrome.extension_dict_backend</a><br> +<a href="httplib.html">httplib</a><br> +<a href="json.html">json</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.chrome.misc_web_contents_backend.html">telemetry.core.chrome.misc_web_contents_backend</a><br> +<a href="telemetry.unittest.options_for_unittests.html">telemetry.unittest.options_for_unittests</a><br> +<a href="re.html">re</a><br> +<a href="socket.html">socket</a><br> +</td><td width="25%" valign=top><a href="sys.html">sys</a><br> +<a href="telemetry.core.chrome.tab_list_backend.html">telemetry.core.chrome.tab_list_backend</a><br> +<a href="telemetry.core.chrome.tracing_backend.html">telemetry.core.chrome.tracing_backend</a><br> +<a href="urllib2.html">urllib2</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.user_agent.html">telemetry.core.user_agent</a><br> +<a href="telemetry.core.util.html">telemetry.core.util</a><br> +<a href="telemetry.core.wpr_modes.html">telemetry.core.wpr_modes</a><br> +<a href="telemetry.core.wpr_server.html">telemetry.core.wpr_server</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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">BrowserBackend</a> +</font></dt><dt><font face="helvetica, arial"><a href="telemetry.core.chrome.browser_backend.html#DoNothingForwarder">DoNothingForwarder</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.browser_backend.html#ExtensionsNotSupportedException">ExtensionsNotSupportedException</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> <br> +<font color="#000000" face="helvetica, arial"><a name="BrowserBackend">class <strong>BrowserBackend</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>A base class for browser backends. Provides basic functionality<br> +once a remote-debugger port has been established.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="BrowserBackend-Close"><strong>Close</strong></a>(self)</dt></dl> + +<dl><dt><a name="BrowserBackend-CreateForwarder"><strong>CreateForwarder</strong></a>(self, *port_pairs)</dt></dl> + +<dl><dt><a name="BrowserBackend-GetBrowserStartupArgs"><strong>GetBrowserStartupArgs</strong></a>(self)</dt></dl> + +<dl><dt><a name="BrowserBackend-GetProcessName"><strong>GetProcessName</strong></a>(self, cmd_line)</dt><dd><tt>Returns a user-friendly name for the process of the given |cmd_line|.</tt></dd></dl> + +<dl><dt><a name="BrowserBackend-GetRemotePort"><strong>GetRemotePort</strong></a>(self, _)</dt></dl> + +<dl><dt><a name="BrowserBackend-GetStandardOutput"><strong>GetStandardOutput</strong></a>(self)</dt></dl> + +<dl><dt><a name="BrowserBackend-GetTraceResultAndReset"><strong>GetTraceResultAndReset</strong></a>(self)</dt></dl> + +<dl><dt><a name="BrowserBackend-IsBrowserRunning"><strong>IsBrowserRunning</strong></a>(self)</dt></dl> + +<dl><dt><a name="BrowserBackend-Request"><strong>Request</strong></a>(self, path, timeout<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="BrowserBackend-SetBrowser"><strong>SetBrowser</strong></a>(self, browser)</dt></dl> + +<dl><dt><a name="BrowserBackend-StartTracing"><strong>StartTracing</strong></a>(self, custom_categories<font color="#909090">=None</font>)</dt><dd><tt>custom_categories is an optional string containing a list of<br> +comma separated categories that will be traced instead of the<br> +default category set. Example: use<br> +"webkit,cc,disabled-by-default-cc.debug" to trace only those three<br> +event categories.</tt></dd></dl> + +<dl><dt><a name="BrowserBackend-StopTracing"><strong>StopTracing</strong></a>(self)</dt></dl> + +<dl><dt><a name="BrowserBackend-__init__"><strong>__init__</strong></a>(self, is_content_shell, supports_extensions, options)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>browser</strong></dt> +</dl> +<dl><dt><strong>chrome_branch_number</strong></dt> +</dl> +<dl><dt><strong>extension_dict_backend</strong></dt> +</dl> +<dl><dt><strong>misc_web_contents_backend</strong></dt> +<dd><tt>Access to chrome://oobe/login page which is neither a tab nor an<br> +extension.</tt></dd> +</dl> +<dl><dt><strong>supports_extensions</strong></dt> +<dd><tt>True if this browser backend supports extensions.</tt></dd> +</dl> +<dl><dt><strong>supports_tab_control</strong></dt> +</dl> +<dl><dt><strong>supports_tracing</strong></dt> +</dl> +<dl><dt><strong>tab_list_backend</strong></dt> +</dl> +<dl><dt><strong>wpr_mode</strong></dt> +</dl> +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>WEBPAGEREPLAY_HOST</strong> = '127.0.0.1'</dl> + +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="DoNothingForwarder">class <strong>DoNothingForwarder</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="DoNothingForwarder-Close"><strong>Close</strong></a>(self)</dt></dl> + +<dl><dt><a name="DoNothingForwarder-__init__"><strong>__init__</strong></a>(self, *port_pairs)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>url</strong></dt> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="ExtensionsNotSupportedException">class <strong>ExtensionsNotSupportedException</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.chrome.browser_backend.html#ExtensionsNotSupportedException">ExtensionsNotSupportedException</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><a name="ExtensionsNotSupportedException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionsNotSupportedException-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#ExtensionsNotSupportedException-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><a name="ExtensionsNotSupportedException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionsNotSupportedException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="ExtensionsNotSupportedException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionsNotSupportedException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="ExtensionsNotSupportedException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionsNotSupportedException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="ExtensionsNotSupportedException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionsNotSupportedException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="ExtensionsNotSupportedException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="ExtensionsNotSupportedException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionsNotSupportedException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="ExtensionsNotSupportedException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionsNotSupportedException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="ExtensionsNotSupportedException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="ExtensionsNotSupportedException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionsNotSupportedException-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="ExtensionsNotSupportedException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> + +<hr> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +<dl><dt><strong>message</strong></dt> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.cros_browser_backend.html b/tools/telemetry/docs/telemetry.core.chrome.cros_browser_backend.html new file mode 100644 index 0000000..0e1a682 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.cros_browser_backend.html @@ -0,0 +1,174 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.cros_browser_backend</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.cros_browser_backend</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/cros_browser_backend.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/cros_browser_backend.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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><br> +<a href="telemetry.core.chrome.cros_util.html">telemetry.core.chrome.cros_util</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.exceptions.html">telemetry.core.exceptions</a><br> +<a href="logging.html">logging</a><br> +</td><td width="25%" valign=top><a href="os.html">os</a><br> +<a href="subprocess.html">subprocess</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.core.util</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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.cros_browser_backend.html#SSHForwarder">SSHForwarder</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.cros_browser_backend.html#CrOSBrowserBackend">CrOSBrowserBackend</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> <br> +<font color="#000000" face="helvetica, arial"><a name="CrOSBrowserBackend">class <strong>CrOSBrowserBackend</strong></a>(<a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.chrome.cros_browser_backend.html#CrOSBrowserBackend">CrOSBrowserBackend</a></dd> +<dd><a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="CrOSBrowserBackend-Close"><strong>Close</strong></a>(self)</dt></dl> + +<dl><dt><a name="CrOSBrowserBackend-CreateForwarder"><strong>CreateForwarder</strong></a>(self, *port_pairs)</dt></dl> + +<dl><dt><a name="CrOSBrowserBackend-GetBrowserStartupArgs"><strong>GetBrowserStartupArgs</strong></a>(self)</dt></dl> + +<dl><dt><a name="CrOSBrowserBackend-GetRemotePort"><strong>GetRemotePort</strong></a>(self, _)</dt></dl> + +<dl><dt><a name="CrOSBrowserBackend-GetStandardOutput"><strong>GetStandardOutput</strong></a>(self)</dt></dl> + +<dl><dt><a name="CrOSBrowserBackend-IsBrowserRunning"><strong>IsBrowserRunning</strong></a>(self)</dt></dl> + +<dl><dt><a name="CrOSBrowserBackend-__del__"><strong>__del__</strong></a>(self)</dt></dl> + +<dl><dt><a name="CrOSBrowserBackend-__init__"><strong>__init__</strong></a>(self, browser_type, options, cri, is_guest)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>hwid</strong></dt> +</dl> +<dl><dt><strong>pid</strong></dt> +<dd><tt>Locates the pid of the main chrome browser process.<br> + <br> +Chrome on cros is usually in /opt/google/chrome, but could be in<br> +/usr/local/ for developer workflows - debug chrome is too large to fit on<br> +rootfs.<br> + <br> +Chrome spawns multiple processes for renderers. pids wrap around after they<br> +are exhausted so looking for the smallest pid is not always correct. We<br> +locate the session_manager's pid, and look for the chrome process that's an<br> +immediate child. This is the main browser process.</tt></dd> +</dl> +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>CHROME_PATHS</strong> = ['/opt/google/chrome/chrome ', '/usr/local/opt/google/chrome/chrome ']</dl> + +<hr> +Methods inherited from <a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>:<br> +<dl><dt><a name="CrOSBrowserBackend-GetProcessName"><strong>GetProcessName</strong></a>(self, cmd_line)</dt><dd><tt>Returns a user-friendly name for the process of the given |cmd_line|.</tt></dd></dl> + +<dl><dt><a name="CrOSBrowserBackend-GetTraceResultAndReset"><strong>GetTraceResultAndReset</strong></a>(self)</dt></dl> + +<dl><dt><a name="CrOSBrowserBackend-Request"><strong>Request</strong></a>(self, path, timeout<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="CrOSBrowserBackend-SetBrowser"><strong>SetBrowser</strong></a>(self, browser)</dt></dl> + +<dl><dt><a name="CrOSBrowserBackend-StartTracing"><strong>StartTracing</strong></a>(self, custom_categories<font color="#909090">=None</font>)</dt><dd><tt>custom_categories is an optional string containing a list of<br> +comma separated categories that will be traced instead of the<br> +default category set. Example: use<br> +"webkit,cc,disabled-by-default-cc.debug" to trace only those three<br> +event categories.</tt></dd></dl> + +<dl><dt><a name="CrOSBrowserBackend-StopTracing"><strong>StopTracing</strong></a>(self)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>browser</strong></dt> +</dl> +<dl><dt><strong>chrome_branch_number</strong></dt> +</dl> +<dl><dt><strong>extension_dict_backend</strong></dt> +</dl> +<dl><dt><strong>misc_web_contents_backend</strong></dt> +<dd><tt>Access to chrome://oobe/login page which is neither a tab nor an<br> +extension.</tt></dd> +</dl> +<dl><dt><strong>supports_extensions</strong></dt> +<dd><tt>True if this browser backend supports extensions.</tt></dd> +</dl> +<dl><dt><strong>supports_tab_control</strong></dt> +</dl> +<dl><dt><strong>supports_tracing</strong></dt> +</dl> +<dl><dt><strong>tab_list_backend</strong></dt> +</dl> +<dl><dt><strong>wpr_mode</strong></dt> +</dl> +<hr> +Data and other attributes inherited from <a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>:<br> +<dl><dt><strong>WEBPAGEREPLAY_HOST</strong> = '127.0.0.1'</dl> + +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="SSHForwarder">class <strong>SSHForwarder</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="SSHForwarder-Close"><strong>Close</strong></a>(self)</dt></dl> + +<dl><dt><a name="SSHForwarder-__init__"><strong>__init__</strong></a>(self, cri, forwarding_flag, *port_pairs)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>url</strong></dt> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.cros_browser_finder.html b/tools/telemetry/docs/telemetry.core.chrome.cros_browser_finder.html new file mode 100644 index 0000000..6d75c26 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.cros_browser_finder.html @@ -0,0 +1,96 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.cros_browser_finder</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.cros_browser_finder</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/cros_browser_finder.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/cros_browser_finder.py</a></font></td></tr></table> + <p><tt>Finds CrOS browsers that can be controlled by telemetry.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.browser.html">telemetry.core.browser</a><br> +<a href="telemetry.core.chrome.cros_browser_backend.html">telemetry.core.chrome.cros_browser_backend</a><br> +<a href="telemetry.core.chrome.cros_interface.html">telemetry.core.chrome.cros_interface</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.platform.cros_platform_backend.html">telemetry.core.platform.cros_platform_backend</a><br> +<a href="logging.html">logging</a><br> +<a href="os.html">os</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.possible_browser.html">telemetry.core.possible_browser</a><br> +<a href="telemetry.core.profile_types.html">telemetry.core.profile_types</a><br> +<a href="sys.html">sys</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.possible_browser.html#PossibleBrowser">telemetry.core.possible_browser.PossibleBrowser</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.cros_browser_finder.html#PossibleCrOSBrowser">PossibleCrOSBrowser</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> <br> +<font color="#000000" face="helvetica, arial"><a name="PossibleCrOSBrowser">class <strong>PossibleCrOSBrowser</strong></a>(<a href="telemetry.core.possible_browser.html#PossibleBrowser">telemetry.core.possible_browser.PossibleBrowser</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>A launchable chromeos browser instance.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.chrome.cros_browser_finder.html#PossibleCrOSBrowser">PossibleCrOSBrowser</a></dd> +<dd><a href="telemetry.core.possible_browser.html#PossibleBrowser">telemetry.core.possible_browser.PossibleBrowser</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="PossibleCrOSBrowser-Create"><strong>Create</strong></a>(self)</dt></dl> + +<dl><dt><a name="PossibleCrOSBrowser-SupportsOptions"><strong>SupportsOptions</strong></a>(self, options)</dt></dl> + +<dl><dt><a name="PossibleCrOSBrowser-__init__"><strong>__init__</strong></a>(self, browser_type, options, cri, is_guest)</dt></dl> + +<dl><dt><a name="PossibleCrOSBrowser-__repr__"><strong>__repr__</strong></a>(self)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.possible_browser.html#PossibleBrowser">telemetry.core.possible_browser.PossibleBrowser</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>browser_type</strong></dt> +</dl> +<dl><dt><strong>options</strong></dt> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-FindAllAvailableBrowsers"><strong>FindAllAvailableBrowsers</strong></a>(options)</dt><dd><tt>Finds all available chromeos browsers, locally and remotely.</tt></dd></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>ALL_BROWSER_TYPES</strong> = 'cros-chrome,cros-chrome-guest,system-guest'</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.cros_interface.html b/tools/telemetry/docs/telemetry.core.chrome.cros_interface.html new file mode 100644 index 0000000..e82de40 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.cros_interface.html @@ -0,0 +1,248 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.cros_interface</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.cros_interface</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/cros_interface.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/cros_interface.py</a></font></td></tr></table> + <p><tt>A wrapper around ssh for common operations on a CrOS-based device</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="logging.html">logging</a><br> +<a href="os.html">os</a><br> +</td><td width="25%" valign=top><a href="re.html">re</a><br> +<a href="subprocess.html">subprocess</a><br> +</td><td width="25%" valign=top><a href="tempfile.html">tempfile</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.cros_interface.html#CrOSInterface">CrOSInterface</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.cros_interface.html#LoginException">LoginException</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.cros_interface.html#KeylessLoginRequiredException">KeylessLoginRequiredException</a> +</font></dt></dl> +</dd> +</dl> +</dd> +</dl> + <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="CrOSInterface">class <strong>CrOSInterface</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="CrOSInterface-FileExistsOnDevice"><strong>FileExistsOnDevice</strong></a>(self, file_name, quiet<font color="#909090">=False</font>)</dt></dl> + +<dl><dt><a name="CrOSInterface-FilesystemMountedAt"><strong>FilesystemMountedAt</strong></a>(self, path)</dt><dd><tt>Returns the filesystem mounted at |path|</tt></dd></dl> + +<dl><dt><a name="CrOSInterface-FormSSHCommandLine"><strong>FormSSHCommandLine</strong></a>(self, args, extra_ssh_args<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="CrOSInterface-GetFileContents"><strong>GetFileContents</strong></a>(self, filename)</dt></dl> + +<dl><dt><a name="CrOSInterface-GetRemotePort"><strong>GetRemotePort</strong></a>(self)</dt></dl> + +<dl><dt><a name="CrOSInterface-IsHTTPServerRunningOnPort"><strong>IsHTTPServerRunningOnPort</strong></a>(self, port)</dt></dl> + +<dl><dt><a name="CrOSInterface-IsServiceRunning"><strong>IsServiceRunning</strong></a>(self, service_name)</dt></dl> + +<dl><dt><a name="CrOSInterface-KillAllMatching"><strong>KillAllMatching</strong></a>(self, predicate)</dt></dl> + +<dl><dt><a name="CrOSInterface-ListProcesses"><strong>ListProcesses</strong></a>(self)</dt><dd><tt>Returns a tuple (pid, cmd, ppid) of all processes on the device.</tt></dd></dl> + +<dl><dt><a name="CrOSInterface-PushContents"><strong>PushContents</strong></a>(self, text, remote_filename)</dt></dl> + +<dl><dt><a name="CrOSInterface-PushFile"><strong>PushFile</strong></a>(self, filename, remote_filename)</dt></dl> + +<dl><dt><a name="CrOSInterface-RmRF"><strong>RmRF</strong></a>(self, filename)</dt></dl> + +<dl><dt><a name="CrOSInterface-RunCmdOnDevice"><strong>RunCmdOnDevice</strong></a>(self, args, cwd<font color="#909090">=None</font>, quiet<font color="#909090">=False</font>)</dt></dl> + +<dl><dt><a name="CrOSInterface-TryLogin"><strong>TryLogin</strong></a>(self)</dt></dl> + +<dl><dt><a name="CrOSInterface-__init__"><strong>__init__</strong></a>(self, hostname<font color="#909090">=None</font>, ssh_identity<font color="#909090">=None</font>)</dt><dd><tt># pylint: disable=R0923</tt></dd></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>hostname</strong></dt> +</dl> +<dl><dt><strong>local</strong></dt> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="KeylessLoginRequiredException">class <strong>KeylessLoginRequiredException</strong></a>(<a href="telemetry.core.chrome.cros_interface.html#LoginException">LoginException</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.chrome.cros_interface.html#KeylessLoginRequiredException">KeylessLoginRequiredException</a></dd> +<dd><a href="telemetry.core.chrome.cros_interface.html#LoginException">LoginException</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Data descriptors inherited from <a href="telemetry.core.chrome.cros_interface.html#LoginException">LoginException</a>:<br> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><a name="KeylessLoginRequiredException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#KeylessLoginRequiredException-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#KeylessLoginRequiredException-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><a name="KeylessLoginRequiredException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#KeylessLoginRequiredException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="KeylessLoginRequiredException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#KeylessLoginRequiredException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="KeylessLoginRequiredException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#KeylessLoginRequiredException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="KeylessLoginRequiredException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#KeylessLoginRequiredException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="KeylessLoginRequiredException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="KeylessLoginRequiredException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#KeylessLoginRequiredException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="KeylessLoginRequiredException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#KeylessLoginRequiredException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="KeylessLoginRequiredException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="KeylessLoginRequiredException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#KeylessLoginRequiredException-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="KeylessLoginRequiredException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> + +<hr> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +<dl><dt><strong>message</strong></dt> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="LoginException">class <strong>LoginException</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.chrome.cros_interface.html#LoginException">LoginException</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><a name="LoginException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#LoginException-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#LoginException-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><a name="LoginException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#LoginException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="LoginException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#LoginException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="LoginException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#LoginException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="LoginException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#LoginException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="LoginException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="LoginException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#LoginException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="LoginException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#LoginException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="LoginException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="LoginException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#LoginException-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="LoginException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> + +<hr> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +<dl><dt><strong>message</strong></dt> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-GetAllCmdOutput"><strong>GetAllCmdOutput</strong></a>(args, cwd<font color="#909090">=None</font>, quiet<font color="#909090">=False</font>)</dt><dd><tt>Open a subprocess to execute a program and returns its output.<br> + <br> +Args:<br> + args: A string or a sequence of program arguments. The program to execute is<br> + the string or the first item in the args sequence.<br> + cwd: If not None, the subprocess's current directory will be changed to<br> + |cwd| before it's executed.<br> + <br> +Returns:<br> + Captures and returns the command's stdout.<br> + Prints the command's stderr to logger (which defaults to stdout).</tt></dd></dl> + <dl><dt><a name="-HasSSH"><strong>HasSSH</strong></a>()</dt></dl> + <dl><dt><a name="-RunCmd"><strong>RunCmd</strong></a>(args, cwd<font color="#909090">=None</font>, quiet<font color="#909090">=False</font>)</dt><dd><tt>Opens a subprocess to execute a program and returns its return value.<br> + <br> +Args:<br> + args: A string or a sequence of program arguments. The program to execute is<br> + the string or the first item in the args sequence.<br> + cwd: If not None, the subprocess's current directory will be changed to<br> + |cwd| before it's executed.<br> + <br> +Returns:<br> + Return code from the command execution.</tt></dd></dl> +</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.cros_util.html b/tools/telemetry/docs/telemetry.core.chrome.cros_util.html new file mode 100644 index 0000000..e7994cc --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.cros_util.html @@ -0,0 +1,36 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.cros_util</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.cros_util</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/cros_util.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/cros_util.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.exceptions.html">telemetry.core.exceptions</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.core.util</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-NavigateGuestLogin"><strong>NavigateGuestLogin</strong></a>(browser_backend, cri)</dt><dd><tt>Navigates through oobe login screen as guest</tt></dd></dl> + <dl><dt><a name="-NavigateLogin"><strong>NavigateLogin</strong></a>(browser_backend, cri)</dt><dd><tt>Navigates through oobe login screen</tt></dd></dl> + <dl><dt><a name="-WaitForAccountPicker"><strong>WaitForAccountPicker</strong></a>(oobe)</dt><dd><tt>Waits for the oobe screen to be in the account picker state.</tt></dd></dl> + <dl><dt><a name="-WaitForGuestFsMounted"><strong>WaitForGuestFsMounted</strong></a>(cri)</dt><dd><tt>Waits for /home/chronos/user to be mounted as guestfs</tt></dd></dl> +</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.crx_id.html b/tools/telemetry/docs/telemetry.core.chrome.crx_id.html new file mode 100644 index 0000000..cf6c52a --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.crx_id.html @@ -0,0 +1,41 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.crx_id</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.crx_id</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/crx_id.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/crx_id.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="crx_id.crx_id.html">crx_id.crx_id</a><br> +</td><td width="25%" valign=top><a href="os.html">os</a><br> +</td><td width="25%" valign=top><a href="sys.html">sys</a><br> +</td><td width="25%" valign=top></td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-__init__"><strong>__init__</strong></a>()</dt></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>absolute_import</strong> = _Feature((2, 5, 0, 'alpha', 1), (2, 7, 0, 'alpha', 0), 16384)</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.desktop_browser_backend.html b/tools/telemetry/docs/telemetry.core.chrome.desktop_browser_backend.html new file mode 100644 index 0000000..040b317 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.desktop_browser_backend.html @@ -0,0 +1,140 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.desktop_browser_backend</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.desktop_browser_backend</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/desktop_browser_backend.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/desktop_browser_backend.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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><br> +<a href="telemetry.core.chrome.cros_interface.html">telemetry.core.chrome.cros_interface</a><br> +<a href="telemetry.core.chrome.cros_util.html">telemetry.core.chrome.cros_util</a><br> +</td><td width="25%" valign=top><a href="logging.html">logging</a><br> +<a href="os.html">os</a><br> +<a href="shutil.html">shutil</a><br> +</td><td width="25%" valign=top><a href="subprocess.html">subprocess</a><br> +<a href="sys.html">sys</a><br> +<a href="tempfile.html">tempfile</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.core.util</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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.desktop_browser_backend.html#DesktopBrowserBackend">DesktopBrowserBackend</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> <br> +<font color="#000000" face="helvetica, arial"><a name="DesktopBrowserBackend">class <strong>DesktopBrowserBackend</strong></a>(<a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>The backend for controlling a locally-executed browser instance, on Linux,<br> +Mac or Windows.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.chrome.desktop_browser_backend.html#DesktopBrowserBackend">DesktopBrowserBackend</a></dd> +<dd><a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="DesktopBrowserBackend-Close"><strong>Close</strong></a>(self)</dt></dl> + +<dl><dt><a name="DesktopBrowserBackend-CreateForwarder"><strong>CreateForwarder</strong></a>(self, *port_pairs)</dt></dl> + +<dl><dt><a name="DesktopBrowserBackend-GetBrowserStartupArgs"><strong>GetBrowserStartupArgs</strong></a>(self)</dt></dl> + +<dl><dt><a name="DesktopBrowserBackend-GetStandardOutput"><strong>GetStandardOutput</strong></a>(self)</dt></dl> + +<dl><dt><a name="DesktopBrowserBackend-IsBrowserRunning"><strong>IsBrowserRunning</strong></a>(self)</dt></dl> + +<dl><dt><a name="DesktopBrowserBackend-SetProfileDirectory"><strong>SetProfileDirectory</strong></a>(self, profile_dir)</dt></dl> + +<dl><dt><a name="DesktopBrowserBackend-__del__"><strong>__del__</strong></a>(self)</dt></dl> + +<dl><dt><a name="DesktopBrowserBackend-__init__"><strong>__init__</strong></a>(self, options, executable, is_content_shell, use_login, delete_profile_dir_after_run<font color="#909090">=True</font>)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>pid</strong></dt> +</dl> +<dl><dt><strong>profile_directory</strong></dt> +</dl> +<hr> +Methods inherited from <a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>:<br> +<dl><dt><a name="DesktopBrowserBackend-GetProcessName"><strong>GetProcessName</strong></a>(self, cmd_line)</dt><dd><tt>Returns a user-friendly name for the process of the given |cmd_line|.</tt></dd></dl> + +<dl><dt><a name="DesktopBrowserBackend-GetRemotePort"><strong>GetRemotePort</strong></a>(self, _)</dt></dl> + +<dl><dt><a name="DesktopBrowserBackend-GetTraceResultAndReset"><strong>GetTraceResultAndReset</strong></a>(self)</dt></dl> + +<dl><dt><a name="DesktopBrowserBackend-Request"><strong>Request</strong></a>(self, path, timeout<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="DesktopBrowserBackend-SetBrowser"><strong>SetBrowser</strong></a>(self, browser)</dt></dl> + +<dl><dt><a name="DesktopBrowserBackend-StartTracing"><strong>StartTracing</strong></a>(self, custom_categories<font color="#909090">=None</font>)</dt><dd><tt>custom_categories is an optional string containing a list of<br> +comma separated categories that will be traced instead of the<br> +default category set. Example: use<br> +"webkit,cc,disabled-by-default-cc.debug" to trace only those three<br> +event categories.</tt></dd></dl> + +<dl><dt><a name="DesktopBrowserBackend-StopTracing"><strong>StopTracing</strong></a>(self)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>browser</strong></dt> +</dl> +<dl><dt><strong>chrome_branch_number</strong></dt> +</dl> +<dl><dt><strong>extension_dict_backend</strong></dt> +</dl> +<dl><dt><strong>misc_web_contents_backend</strong></dt> +<dd><tt>Access to chrome://oobe/login page which is neither a tab nor an<br> +extension.</tt></dd> +</dl> +<dl><dt><strong>supports_extensions</strong></dt> +<dd><tt>True if this browser backend supports extensions.</tt></dd> +</dl> +<dl><dt><strong>supports_tab_control</strong></dt> +</dl> +<dl><dt><strong>supports_tracing</strong></dt> +</dl> +<dl><dt><strong>tab_list_backend</strong></dt> +</dl> +<dl><dt><strong>wpr_mode</strong></dt> +</dl> +<hr> +Data and other attributes inherited from <a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>:<br> +<dl><dt><strong>WEBPAGEREPLAY_HOST</strong> = '127.0.0.1'</dl> + +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.desktop_browser_finder.html b/tools/telemetry/docs/telemetry.core.chrome.desktop_browser_finder.html new file mode 100644 index 0000000..687b078 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.desktop_browser_finder.html @@ -0,0 +1,98 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.desktop_browser_finder</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.desktop_browser_finder</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/desktop_browser_finder.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/desktop_browser_finder.py</a></font></td></tr></table> + <p><tt>Finds desktop browsers that can be controlled by telemetry.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.browser.html">telemetry.core.browser</a><br> +<a href="telemetry.core.chrome.desktop_browser_backend.html">telemetry.core.chrome.desktop_browser_backend</a><br> +<a href="telemetry.core.platform.linux_platform_backend.html">telemetry.core.platform.linux_platform_backend</a><br> +</td><td width="25%" valign=top><a href="logging.html">logging</a><br> +<a href="telemetry.core.platform.mac_platform_backend.html">telemetry.core.platform.mac_platform_backend</a><br> +<a href="os.html">os</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.possible_browser.html">telemetry.core.possible_browser</a><br> +<a href="telemetry.core.profile_types.html">telemetry.core.profile_types</a><br> +<a href="subprocess.html">subprocess</a><br> +</td><td width="25%" valign=top><a href="sys.html">sys</a><br> +<a href="telemetry.core.platform.win_platform_backend.html">telemetry.core.platform.win_platform_backend</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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.possible_browser.html#PossibleBrowser">telemetry.core.possible_browser.PossibleBrowser</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.desktop_browser_finder.html#PossibleDesktopBrowser">PossibleDesktopBrowser</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> <br> +<font color="#000000" face="helvetica, arial"><a name="PossibleDesktopBrowser">class <strong>PossibleDesktopBrowser</strong></a>(<a href="telemetry.core.possible_browser.html#PossibleBrowser">telemetry.core.possible_browser.PossibleBrowser</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>A desktop browser that can be controlled.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.chrome.desktop_browser_finder.html#PossibleDesktopBrowser">PossibleDesktopBrowser</a></dd> +<dd><a href="telemetry.core.possible_browser.html#PossibleBrowser">telemetry.core.possible_browser.PossibleBrowser</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="PossibleDesktopBrowser-Create"><strong>Create</strong></a>(self)</dt></dl> + +<dl><dt><a name="PossibleDesktopBrowser-SupportsOptions"><strong>SupportsOptions</strong></a>(self, options)</dt></dl> + +<dl><dt><a name="PossibleDesktopBrowser-__init__"><strong>__init__</strong></a>(self, browser_type, options, executable, is_content_shell, use_login<font color="#909090">=False</font>)</dt></dl> + +<dl><dt><a name="PossibleDesktopBrowser-__repr__"><strong>__repr__</strong></a>(self)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.possible_browser.html#PossibleBrowser">telemetry.core.possible_browser.PossibleBrowser</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>browser_type</strong></dt> +</dl> +<dl><dt><strong>options</strong></dt> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-FindAllAvailableBrowsers"><strong>FindAllAvailableBrowsers</strong></a>(options)</dt><dd><tt>Finds all the desktop browsers available on this machine.</tt></dd></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>ALL_BROWSER_TYPES</strong> = 'exact,release,debug,canary,content-shell-debug,content-shell-release,debug-cros,release-cros,system'</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.extension_dict_backend.html b/tools/telemetry/docs/telemetry.core.chrome.extension_dict_backend.html new file mode 100644 index 0000000..53aac52 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.extension_dict_backend.html @@ -0,0 +1,133 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.extension_dict_backend</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.extension_dict_backend</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/extension_dict_backend.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/extension_dict_backend.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.exceptions.html">telemetry.core.exceptions</a><br> +<a href="telemetry.core.extension_page.html">telemetry.core.extension_page</a><br> +<a href="httplib.html">httplib</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.chrome.inspector_backend.html">telemetry.core.chrome.inspector_backend</a><br> +<a href="json.html">json</a><br> +<a href="re.html">re</a><br> +</td><td width="25%" valign=top><a href="socket.html">socket</a><br> +<a href="urllib2.html">urllib2</a><br> +<a href="weakref.html">weakref</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.extension_dict_backend.html#ExtensionDictBackend">ExtensionDictBackend</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.extension_dict_backend.html#ExtensionNotFoundException">ExtensionNotFoundException</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> <br> +<font color="#000000" face="helvetica, arial"><a name="ExtensionDictBackend">class <strong>ExtensionDictBackend</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="ExtensionDictBackend-__contains__"><strong>__contains__</strong></a>(self, extension_id)</dt></dl> + +<dl><dt><a name="ExtensionDictBackend-__getitem__"><strong>__getitem__</strong></a>(self, extension_id)</dt></dl> + +<dl><dt><a name="ExtensionDictBackend-__init__"><strong>__init__</strong></a>(self, browser_backend)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="ExtensionNotFoundException">class <strong>ExtensionNotFoundException</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.chrome.extension_dict_backend.html#ExtensionNotFoundException">ExtensionNotFoundException</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><a name="ExtensionNotFoundException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionNotFoundException-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#ExtensionNotFoundException-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><a name="ExtensionNotFoundException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionNotFoundException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="ExtensionNotFoundException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionNotFoundException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="ExtensionNotFoundException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionNotFoundException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="ExtensionNotFoundException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionNotFoundException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="ExtensionNotFoundException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="ExtensionNotFoundException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionNotFoundException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="ExtensionNotFoundException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionNotFoundException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="ExtensionNotFoundException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="ExtensionNotFoundException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionNotFoundException-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="ExtensionNotFoundException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> + +<hr> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +<dl><dt><strong>message</strong></dt> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.facebook_credentials_backend.html b/tools/telemetry/docs/telemetry.core.chrome.facebook_credentials_backend.html new file mode 100644 index 0000000..82100dc --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.facebook_credentials_backend.html @@ -0,0 +1,88 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.facebook_credentials_backend</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.facebook_credentials_backend</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/facebook_credentials_backend.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/facebook_credentials_backend.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.form_based_credentials_backend.html">telemetry.core.chrome.form_based_credentials_backend</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.form_based_credentials_backend.html#FormBasedCredentialsBackend">telemetry.core.chrome.form_based_credentials_backend.FormBasedCredentialsBackend</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.facebook_credentials_backend.html#FacebookCredentialsBackend">FacebookCredentialsBackend</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> <br> +<font color="#000000" face="helvetica, arial"><a name="FacebookCredentialsBackend">class <strong>FacebookCredentialsBackend</strong></a>(<a href="telemetry.core.chrome.form_based_credentials_backend.html#FormBasedCredentialsBackend">telemetry.core.chrome.form_based_credentials_backend.FormBasedCredentialsBackend</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.chrome.facebook_credentials_backend.html#FacebookCredentialsBackend">FacebookCredentialsBackend</a></dd> +<dd><a href="telemetry.core.chrome.form_based_credentials_backend.html#FormBasedCredentialsBackend">telemetry.core.chrome.form_based_credentials_backend.FormBasedCredentialsBackend</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="FacebookCredentialsBackend-IsAlreadyLoggedIn"><strong>IsAlreadyLoggedIn</strong></a>(self, tab)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>credentials_type</strong></dt> +</dl> +<dl><dt><strong>login_form_id</strong></dt> +</dl> +<dl><dt><strong>login_input_id</strong></dt> +</dl> +<dl><dt><strong>password_input_id</strong></dt> +</dl> +<dl><dt><strong>url</strong></dt> +</dl> +<hr> +Methods inherited from <a href="telemetry.core.chrome.form_based_credentials_backend.html#FormBasedCredentialsBackend">telemetry.core.chrome.form_based_credentials_backend.FormBasedCredentialsBackend</a>:<br> +<dl><dt><a name="FacebookCredentialsBackend-IsLoggedIn"><strong>IsLoggedIn</strong></a>(self)</dt></dl> + +<dl><dt><a name="FacebookCredentialsBackend-LoginNeeded"><strong>LoginNeeded</strong></a>(self, tab, config)</dt><dd><tt>Logs in to a test account.<br> + <br> +Raises:<br> + RuntimeError: if could not get credential information.</tt></dd></dl> + +<dl><dt><a name="FacebookCredentialsBackend-LoginNoLongerNeeded"><strong>LoginNoLongerNeeded</strong></a>(self, tab)</dt></dl> + +<dl><dt><a name="FacebookCredentialsBackend-__init__"><strong>__init__</strong></a>(self)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.chrome.form_based_credentials_backend.html#FormBasedCredentialsBackend">telemetry.core.chrome.form_based_credentials_backend.FormBasedCredentialsBackend</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.form_based_credentials_backend.html b/tools/telemetry/docs/telemetry.core.chrome.form_based_credentials_backend.html new file mode 100644 index 0000000..c473d59 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.form_based_credentials_backend.html @@ -0,0 +1,79 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.form_based_credentials_backend</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.form_based_credentials_backend</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/form_based_credentials_backend.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/form_based_credentials_backend.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="logging.html">logging</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.core.util</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.form_based_credentials_backend.html#FormBasedCredentialsBackend">FormBasedCredentialsBackend</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> <br> +<font color="#000000" face="helvetica, arial"><a name="FormBasedCredentialsBackend">class <strong>FormBasedCredentialsBackend</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="FormBasedCredentialsBackend-IsAlreadyLoggedIn"><strong>IsAlreadyLoggedIn</strong></a>(self, tab)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackend-IsLoggedIn"><strong>IsLoggedIn</strong></a>(self)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackend-LoginNeeded"><strong>LoginNeeded</strong></a>(self, tab, config)</dt><dd><tt>Logs in to a test account.<br> + <br> +Raises:<br> + RuntimeError: if could not get credential information.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackend-LoginNoLongerNeeded"><strong>LoginNoLongerNeeded</strong></a>(self, tab)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackend-__init__"><strong>__init__</strong></a>(self)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>credentials_type</strong></dt> +</dl> +<dl><dt><strong>login_form_id</strong></dt> +</dl> +<dl><dt><strong>login_input_id</strong></dt> +</dl> +<dl><dt><strong>password_input_id</strong></dt> +</dl> +<dl><dt><strong>url</strong></dt> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.form_based_credentials_backend_unittest_base.html b/tools/telemetry/docs/telemetry.core.chrome.form_based_credentials_backend_unittest_base.html new file mode 100644 index 0000000..514dc6c --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.form_based_credentials_backend_unittest_base.html @@ -0,0 +1,343 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.form_based_credentials_backend_unittest_base</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.form_based_credentials_backend_unittest_base</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/form_based_credentials_backend_unittest_base.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/form_based_credentials_backend_unittest_base.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.browser_finder.html">telemetry.core.browser_finder</a><br> +<a href="logging.html">logging</a><br> +</td><td width="25%" valign=top><a href="telemetry.unittest.options_for_unittests.html">telemetry.unittest.options_for_unittests</a><br> +<a href="os.html">os</a><br> +</td><td width="25%" valign=top><a href="telemetry.unittest.simple_mock.html">telemetry.unittest.simple_mock</a><br> +<a href="unittest.html">unittest</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="unittest.case.html#TestCase">unittest.case.TestCase</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.form_based_credentials_backend_unittest_base.html#FormBasedCredentialsBackendUnitTestBase">FormBasedCredentialsBackendUnitTestBase</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> <br> +<font color="#000000" face="helvetica, arial"><a name="FormBasedCredentialsBackendUnitTestBase">class <strong>FormBasedCredentialsBackendUnitTestBase</strong></a>(<a href="unittest.case.html#TestCase">unittest.case.TestCase</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.chrome.form_based_credentials_backend_unittest_base.html#FormBasedCredentialsBackendUnitTestBase">FormBasedCredentialsBackendUnitTestBase</a></dd> +<dd><a href="unittest.case.html#TestCase">unittest.case.TestCase</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-setUp"><strong>setUp</strong></a>(self)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-testLoginUsingMock"><strong>testLoginUsingMock</strong></a>(self)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-testRealLoginIfPossible"><strong>testRealLoginIfPossible</strong></a>(self)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-testRealLoginWithDontOverrideProfileIfPossible"><strong>testRealLoginWithDontOverrideProfileIfPossible</strong></a>(self)</dt></dl> + +<hr> +Methods inherited from <a href="unittest.case.html#TestCase">unittest.case.TestCase</a>:<br> +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-__call__"><strong>__call__</strong></a>(self, *args, **kwds)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-__eq__"><strong>__eq__</strong></a>(self, other)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-__hash__"><strong>__hash__</strong></a>(self)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-__init__"><strong>__init__</strong></a>(self, methodName<font color="#909090">='runTest'</font>)</dt><dd><tt>Create an instance of the class that will use the named test<br> +method when executed. Raises a ValueError if the instance does<br> +not have a method with the specified name.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-__ne__"><strong>__ne__</strong></a>(self, other)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-__repr__"><strong>__repr__</strong></a>(self)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-__str__"><strong>__str__</strong></a>(self)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-addCleanup"><strong>addCleanup</strong></a>(self, function, *args, **kwargs)</dt><dd><tt>Add a function, with arguments, to be called when the test is<br> +completed. Functions added are called on a LIFO basis and are<br> +called after tearDown on test failure or success.<br> + <br> +Cleanup items are called even if setUp fails (unlike tearDown).</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-addTypeEqualityFunc"><strong>addTypeEqualityFunc</strong></a>(self, typeobj, function)</dt><dd><tt>Add a type specific assertEqual style function to compare a type.<br> + <br> +This method is for use by <a href="unittest.case.html#TestCase">TestCase</a> subclasses that need to register<br> +their own type equality functions to provide nicer error messages.<br> + <br> +Args:<br> + typeobj: The data type to call this function on when both values<br> + are of the same type in <a href="#FormBasedCredentialsBackendUnitTestBase-assertEqual">assertEqual</a>().<br> + function: The callable taking two arguments and an optional<br> + msg= argument that raises self.<strong>failureException</strong> with a<br> + useful error message when the two arguments are not equal.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertAlmostEqual"><strong>assertAlmostEqual</strong></a>(self, first, second, places<font color="#909090">=None</font>, msg<font color="#909090">=None</font>, delta<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero, or by comparing that the<br> +between the two objects is more than the given delta.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).<br> + <br> +If the two objects compare equal then they will automatically<br> +compare almost equal.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertAlmostEquals"><strong>assertAlmostEquals</strong></a> = assertAlmostEqual(self, first, second, places<font color="#909090">=None</font>, msg<font color="#909090">=None</font>, delta<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero, or by comparing that the<br> +between the two objects is more than the given delta.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).<br> + <br> +If the two objects compare equal then they will automatically<br> +compare almost equal.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertDictContainsSubset"><strong>assertDictContainsSubset</strong></a>(self, expected, actual, msg<font color="#909090">=None</font>)</dt><dd><tt>Checks whether actual is a superset of expected.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertDictEqual"><strong>assertDictEqual</strong></a>(self, d1, d2, msg<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertEqual"><strong>assertEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertEquals"><strong>assertEquals</strong></a> = assertEqual(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertFalse"><strong>assertFalse</strong></a>(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Check that the expression is false.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertGreater"><strong>assertGreater</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#FormBasedCredentialsBackendUnitTestBase-assertTrue">assertTrue</a>(a > b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertGreaterEqual"><strong>assertGreaterEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#FormBasedCredentialsBackendUnitTestBase-assertTrue">assertTrue</a>(a >= b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertIn"><strong>assertIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#FormBasedCredentialsBackendUnitTestBase-assertTrue">assertTrue</a>(a in b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertIs"><strong>assertIs</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#FormBasedCredentialsBackendUnitTestBase-assertTrue">assertTrue</a>(a is b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertIsInstance"><strong>assertIsInstance</strong></a>(self, obj, cls, msg<font color="#909090">=None</font>)</dt><dd><tt>Same as <a href="#FormBasedCredentialsBackendUnitTestBase-assertTrue">assertTrue</a>(isinstance(obj, cls)), with a nicer<br> +default message.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertIsNone"><strong>assertIsNone</strong></a>(self, obj, msg<font color="#909090">=None</font>)</dt><dd><tt>Same as <a href="#FormBasedCredentialsBackendUnitTestBase-assertTrue">assertTrue</a>(obj is None), with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertIsNot"><strong>assertIsNot</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#FormBasedCredentialsBackendUnitTestBase-assertTrue">assertTrue</a>(a is not b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertIsNotNone"><strong>assertIsNotNone</strong></a>(self, obj, msg<font color="#909090">=None</font>)</dt><dd><tt>Included for symmetry with assertIsNone.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertItemsEqual"><strong>assertItemsEqual</strong></a>(self, expected_seq, actual_seq, msg<font color="#909090">=None</font>)</dt><dd><tt>An unordered sequence specific comparison. It asserts that<br> +actual_seq and expected_seq have the same element counts.<br> +Equivalent to::<br> + <br> + <a href="#FormBasedCredentialsBackendUnitTestBase-assertEqual">assertEqual</a>(Counter(iter(actual_seq)),<br> + Counter(iter(expected_seq)))<br> + <br> +Asserts that each element has the same count in both sequences.<br> +Example:<br> + - [0, 1, 1] and [1, 0, 1] compare equal.<br> + - [0, 0, 1] and [0, 1] compare unequal.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertLess"><strong>assertLess</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#FormBasedCredentialsBackendUnitTestBase-assertTrue">assertTrue</a>(a < b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertLessEqual"><strong>assertLessEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#FormBasedCredentialsBackendUnitTestBase-assertTrue">assertTrue</a>(a <= b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertListEqual"><strong>assertListEqual</strong></a>(self, list1, list2, msg<font color="#909090">=None</font>)</dt><dd><tt>A list-specific equality assertion.<br> + <br> +Args:<br> + list1: The first list to compare.<br> + list2: The second list to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertMultiLineEqual"><strong>assertMultiLineEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Assert that two multi-line strings are equal.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertNotAlmostEqual"><strong>assertNotAlmostEqual</strong></a>(self, first, second, places<font color="#909090">=None</font>, msg<font color="#909090">=None</font>, delta<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero, or by comparing that the<br> +between the two objects is less than the given delta.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).<br> + <br> +Objects that are equal automatically fail.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertNotAlmostEquals"><strong>assertNotAlmostEquals</strong></a> = assertNotAlmostEqual(self, first, second, places<font color="#909090">=None</font>, msg<font color="#909090">=None</font>, delta<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero, or by comparing that the<br> +between the two objects is less than the given delta.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).<br> + <br> +Objects that are equal automatically fail.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertNotEqual"><strong>assertNotEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertNotEquals"><strong>assertNotEquals</strong></a> = assertNotEqual(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertNotIn"><strong>assertNotIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#FormBasedCredentialsBackendUnitTestBase-assertTrue">assertTrue</a>(a not in b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertNotIsInstance"><strong>assertNotIsInstance</strong></a>(self, obj, cls, msg<font color="#909090">=None</font>)</dt><dd><tt>Included for symmetry with assertIsInstance.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertNotRegexpMatches"><strong>assertNotRegexpMatches</strong></a>(self, text, unexpected_regexp, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test if the text matches the regular expression.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertRaises"><strong>assertRaises</strong></a>(self, excClass, callableObj<font color="#909090">=None</font>, *args, **kwargs)</dt><dd><tt>Fail unless an exception of class excClass is thrown<br> +by callableObj when invoked with arguments args and keyword<br> +arguments kwargs. If a different type of exception is<br> +thrown, it will not be caught, and the test case will be<br> +deemed to have suffered an error, exactly as for an<br> +unexpected exception.<br> + <br> +If called with callableObj omitted or None, will return a<br> +context object used like this::<br> + <br> + with <a href="#FormBasedCredentialsBackendUnitTestBase-assertRaises">assertRaises</a>(SomeException):<br> + do_something()<br> + <br> +The context manager keeps a reference to the exception as<br> +the 'exception' attribute. This allows you to inspect the<br> +exception after the assertion::<br> + <br> + with <a href="#FormBasedCredentialsBackendUnitTestBase-assertRaises">assertRaises</a>(SomeException) as cm:<br> + do_something()<br> + the_exception = cm.exception<br> + <a href="#FormBasedCredentialsBackendUnitTestBase-assertEqual">assertEqual</a>(the_exception.error_code, 3)</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertRaisesRegexp"><strong>assertRaisesRegexp</strong></a>(self, expected_exception, expected_regexp, callable_obj<font color="#909090">=None</font>, *args, **kwargs)</dt><dd><tt>Asserts that the message in a raised exception matches a regexp.<br> + <br> +Args:<br> + expected_exception: Exception class expected to be raised.<br> + expected_regexp: Regexp (re pattern object or string) expected<br> + to be found in error message.<br> + callable_obj: Function to be called.<br> + args: Extra args.<br> + kwargs: Extra kwargs.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertRegexpMatches"><strong>assertRegexpMatches</strong></a>(self, text, expected_regexp, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test unless the text matches the regular expression.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertSequenceEqual"><strong>assertSequenceEqual</strong></a>(self, seq1, seq2, msg<font color="#909090">=None</font>, seq_type<font color="#909090">=None</font>)</dt><dd><tt>An equality assertion for ordered sequences (like lists and tuples).<br> + <br> +For the purposes of this function, a valid ordered sequence type is one<br> +which can be indexed, has a length, and has an equality operator.<br> + <br> +Args:<br> + seq1: The first sequence to compare.<br> + seq2: The second sequence to compare.<br> + seq_type: The expected datatype of the sequences, or None if no<br> + datatype should be enforced.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertSetEqual"><strong>assertSetEqual</strong></a>(self, set1, set2, msg<font color="#909090">=None</font>)</dt><dd><tt>A set-specific equality assertion.<br> + <br> +Args:<br> + set1: The first set to compare.<br> + set2: The second set to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.<br> + <br> +assertSetEqual uses ducktyping to support different types of sets, and<br> +is optimized for sets specifically (parameters must support a<br> +difference method).</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertTrue"><strong>assertTrue</strong></a>(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Check that the expression is true.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assertTupleEqual"><strong>assertTupleEqual</strong></a>(self, tuple1, tuple2, msg<font color="#909090">=None</font>)</dt><dd><tt>A tuple-specific equality assertion.<br> + <br> +Args:<br> + tuple1: The first tuple to compare.<br> + tuple2: The second tuple to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-assert_"><strong>assert_</strong></a> = assertTrue(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Check that the expression is true.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-countTestCases"><strong>countTestCases</strong></a>(self)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-debug"><strong>debug</strong></a>(self)</dt><dd><tt>Run the test without collecting errors in a TestResult</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-defaultTestResult"><strong>defaultTestResult</strong></a>(self)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-doCleanups"><strong>doCleanups</strong></a>(self)</dt><dd><tt>Execute all cleanup functions. Normally called for you after<br> +tearDown.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-fail"><strong>fail</strong></a>(self, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail immediately, with the given message.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-failIf"><strong>failIf</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-failIfAlmostEqual"><strong>failIfAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-failIfEqual"><strong>failIfEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-failUnless"><strong>failUnless</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-failUnlessAlmostEqual"><strong>failUnlessAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-failUnlessEqual"><strong>failUnlessEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-failUnlessRaises"><strong>failUnlessRaises</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-id"><strong>id</strong></a>(self)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-run"><strong>run</strong></a>(self, result<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-shortDescription"><strong>shortDescription</strong></a>(self)</dt><dd><tt>Returns a one-line description of the test, or None if no<br> +description has been provided.<br> + <br> +The default implementation of this method returns the first line of<br> +the specified test method's docstring.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-skipTest"><strong>skipTest</strong></a>(self, reason)</dt><dd><tt>Skip this test.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-tearDown"><strong>tearDown</strong></a>(self)</dt><dd><tt>Hook method for deconstructing the test fixture after testing it.</tt></dd></dl> + +<hr> +Class methods inherited from <a href="unittest.case.html#TestCase">unittest.case.TestCase</a>:<br> +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-setUpClass"><strong>setUpClass</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Hook method for setting up class fixture before running tests in the class.</tt></dd></dl> + +<dl><dt><a name="FormBasedCredentialsBackendUnitTestBase-tearDownClass"><strong>tearDownClass</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Hook method for deconstructing the class fixture after running all tests in the class.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="unittest.case.html#TestCase">unittest.case.TestCase</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Data and other attributes inherited from <a href="unittest.case.html#TestCase">unittest.case.TestCase</a>:<br> +<dl><dt><strong>failureException</strong> = <type 'exceptions.AssertionError'><dd><tt>Assertion failed.</tt></dl> + +<dl><dt><strong>longMessage</strong> = False</dl> + +<dl><dt><strong>maxDiff</strong> = 640</dl> + +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.google_credentials_backend.html b/tools/telemetry/docs/telemetry.core.chrome.google_credentials_backend.html new file mode 100644 index 0000000..7745b4f --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.google_credentials_backend.html @@ -0,0 +1,88 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.google_credentials_backend</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.google_credentials_backend</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/google_credentials_backend.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/google_credentials_backend.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.form_based_credentials_backend.html">telemetry.core.chrome.form_based_credentials_backend</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.form_based_credentials_backend.html#FormBasedCredentialsBackend">telemetry.core.chrome.form_based_credentials_backend.FormBasedCredentialsBackend</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.google_credentials_backend.html#GoogleCredentialsBackend">GoogleCredentialsBackend</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> <br> +<font color="#000000" face="helvetica, arial"><a name="GoogleCredentialsBackend">class <strong>GoogleCredentialsBackend</strong></a>(<a href="telemetry.core.chrome.form_based_credentials_backend.html#FormBasedCredentialsBackend">telemetry.core.chrome.form_based_credentials_backend.FormBasedCredentialsBackend</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.chrome.google_credentials_backend.html#GoogleCredentialsBackend">GoogleCredentialsBackend</a></dd> +<dd><a href="telemetry.core.chrome.form_based_credentials_backend.html#FormBasedCredentialsBackend">telemetry.core.chrome.form_based_credentials_backend.FormBasedCredentialsBackend</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="GoogleCredentialsBackend-IsAlreadyLoggedIn"><strong>IsAlreadyLoggedIn</strong></a>(self, tab)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>credentials_type</strong></dt> +</dl> +<dl><dt><strong>login_form_id</strong></dt> +</dl> +<dl><dt><strong>login_input_id</strong></dt> +</dl> +<dl><dt><strong>password_input_id</strong></dt> +</dl> +<dl><dt><strong>url</strong></dt> +</dl> +<hr> +Methods inherited from <a href="telemetry.core.chrome.form_based_credentials_backend.html#FormBasedCredentialsBackend">telemetry.core.chrome.form_based_credentials_backend.FormBasedCredentialsBackend</a>:<br> +<dl><dt><a name="GoogleCredentialsBackend-IsLoggedIn"><strong>IsLoggedIn</strong></a>(self)</dt></dl> + +<dl><dt><a name="GoogleCredentialsBackend-LoginNeeded"><strong>LoginNeeded</strong></a>(self, tab, config)</dt><dd><tt>Logs in to a test account.<br> + <br> +Raises:<br> + RuntimeError: if could not get credential information.</tt></dd></dl> + +<dl><dt><a name="GoogleCredentialsBackend-LoginNoLongerNeeded"><strong>LoginNoLongerNeeded</strong></a>(self, tab)</dt></dl> + +<dl><dt><a name="GoogleCredentialsBackend-__init__"><strong>__init__</strong></a>(self)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.chrome.form_based_credentials_backend.html#FormBasedCredentialsBackend">telemetry.core.chrome.form_based_credentials_backend.FormBasedCredentialsBackend</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.html b/tools/telemetry/docs/telemetry.core.chrome.html new file mode 100644 index 0000000..6110b0b --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.html @@ -0,0 +1,65 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: package telemetry.core.chrome</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.chrome</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/__init__.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/__init__.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></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.adb_commands.html">adb_commands</a><br> +<a href="telemetry.core.chrome.android_browser_backend.html">android_browser_backend</a><br> +<a href="telemetry.core.chrome.android_browser_finder.html">android_browser_finder</a><br> +<a href="telemetry.core.chrome.android_browser_finder_unittest.html">android_browser_finder_unittest</a><br> +<a href="telemetry.core.chrome.browser_backend.html">browser_backend</a><br> +<a href="telemetry.core.chrome.cros_browser_backend.html">cros_browser_backend</a><br> +<a href="telemetry.core.chrome.cros_browser_finder.html">cros_browser_finder</a><br> +<a href="telemetry.core.chrome.cros_browser_finder_unittest.html">cros_browser_finder_unittest</a><br> +<a href="telemetry.core.chrome.cros_interface.html">cros_interface</a><br> +<a href="telemetry.core.chrome.cros_interface_unittest.html">cros_interface_unittest</a><br> +<a href="telemetry.core.chrome.cros_util.html">cros_util</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.chrome.crx_id.html">crx_id</a><br> +<a href="telemetry.core.chrome.desktop_browser_backend.html">desktop_browser_backend</a><br> +<a href="telemetry.core.chrome.desktop_browser_finder.html">desktop_browser_finder</a><br> +<a href="telemetry.core.chrome.desktop_browser_finder_unittest.html">desktop_browser_finder_unittest</a><br> +<a href="telemetry.core.chrome.extension_dict_backend.html">extension_dict_backend</a><br> +<a href="telemetry.core.chrome.facebook_credentials_backend.html">facebook_credentials_backend</a><br> +<a href="telemetry.core.chrome.facebook_credentials_backend_unittest.html">facebook_credentials_backend_unittest</a><br> +<a href="telemetry.core.chrome.form_based_credentials_backend.html">form_based_credentials_backend</a><br> +<a href="telemetry.core.chrome.form_based_credentials_backend_unittest_base.html">form_based_credentials_backend_unittest_base</a><br> +<a href="telemetry.core.chrome.google_credentials_backend.html">google_credentials_backend</a><br> +<a href="telemetry.core.chrome.google_credentials_backend_unittest.html">google_credentials_backend_unittest</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.chrome.inspector_backend.html">inspector_backend</a><br> +<a href="telemetry.core.chrome.inspector_console.html">inspector_console</a><br> +<a href="telemetry.core.chrome.inspector_console_unittest.html">inspector_console_unittest</a><br> +<a href="telemetry.core.chrome.inspector_memory.html">inspector_memory</a><br> +<a href="telemetry.core.chrome.inspector_memory_unittest.html">inspector_memory_unittest</a><br> +<a href="telemetry.core.chrome.inspector_page.html">inspector_page</a><br> +<a href="telemetry.core.chrome.inspector_page_unittest.html">inspector_page_unittest</a><br> +<a href="telemetry.core.chrome.inspector_runtime.html">inspector_runtime</a><br> +<a href="telemetry.core.chrome.inspector_runtime_unittest.html">inspector_runtime_unittest</a><br> +<a href="telemetry.core.chrome.inspector_timeline.html">inspector_timeline</a><br> +<a href="telemetry.core.chrome.inspector_timeline_unittest.html">inspector_timeline_unittest</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.chrome.misc_web_contents_backend.html">misc_web_contents_backend</a><br> +<a href="telemetry.core.chrome.png_bitmap.html">png_bitmap</a><br> +<a href="telemetry.core.chrome.png_bitmap_unittest.html">png_bitmap_unittest</a><br> +<a href="telemetry.core.chrome.tab_list_backend.html">tab_list_backend</a><br> +<a href="telemetry.core.chrome.trace_result.html">trace_result</a><br> +<a href="telemetry.core.chrome.tracing_backend.html">tracing_backend</a><br> +<a href="telemetry.core.chrome.tracing_backend_unittest.html">tracing_backend_unittest</a><br> +<a href="telemetry.core.chrome.websocket.html">websocket</a><br> +<a href="telemetry.core.chrome.websocket_unittest.html">websocket_unittest</a><br> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.inspector_backend.html b/tools/telemetry/docs/telemetry.core.chrome.inspector_backend.html new file mode 100644 index 0000000..5c565fb --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.inspector_backend.html @@ -0,0 +1,195 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.inspector_backend</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.inspector_backend</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/inspector_backend.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/inspector_backend.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.exceptions.html">telemetry.core.exceptions</a><br> +<a href="telemetry.core.chrome.inspector_console.html">telemetry.core.chrome.inspector_console</a><br> +<a href="telemetry.core.chrome.inspector_memory.html">telemetry.core.chrome.inspector_memory</a><br> +<a href="telemetry.core.chrome.inspector_page.html">telemetry.core.chrome.inspector_page</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.chrome.inspector_runtime.html">telemetry.core.chrome.inspector_runtime</a><br> +<a href="telemetry.core.chrome.inspector_timeline.html">telemetry.core.chrome.inspector_timeline</a><br> +<a href="json.html">json</a><br> +<a href="logging.html">logging</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.chrome.png_bitmap.html">telemetry.core.chrome.png_bitmap</a><br> +<a href="socket.html">socket</a><br> +<a href="sys.html">sys</a><br> +<a href="telemetry.core.util.html">telemetry.core.util</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.chrome.websocket.html">telemetry.core.chrome.websocket</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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.inspector_backend.html#InspectorBackend">InspectorBackend</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.inspector_backend.html#InspectorException">InspectorException</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> <br> +<font color="#000000" face="helvetica, arial"><a name="InspectorBackend">class <strong>InspectorBackend</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="InspectorBackend-Activate"><strong>Activate</strong></a>(self)</dt></dl> + +<dl><dt><a name="InspectorBackend-Close"><strong>Close</strong></a>(self)</dt></dl> + +<dl><dt><a name="InspectorBackend-CollectGarbage"><strong>CollectGarbage</strong></a>(self)</dt></dl> + +<dl><dt><a name="InspectorBackend-Disconnect"><strong>Disconnect</strong></a>(self)</dt></dl> + +<dl><dt><a name="InspectorBackend-DispatchNotifications"><strong>DispatchNotifications</strong></a>(self, timeout<font color="#909090">=10</font>)</dt></dl> + +<dl><dt><a name="InspectorBackend-EvaluateJavaScript"><strong>EvaluateJavaScript</strong></a>(self, expr, timeout)</dt></dl> + +<dl><dt><a name="InspectorBackend-ExecuteJavaScript"><strong>ExecuteJavaScript</strong></a>(self, expr, timeout)</dt></dl> + +<dl><dt><a name="InspectorBackend-GetCookieByName"><strong>GetCookieByName</strong></a>(self, name, timeout)</dt></dl> + +<dl><dt><a name="InspectorBackend-GetDOMStats"><strong>GetDOMStats</strong></a>(self, timeout)</dt></dl> + +<dl><dt><a name="InspectorBackend-Navigate"><strong>Navigate</strong></a>(self, url, script_to_evaluate_on_commit, timeout)</dt></dl> + +<dl><dt><a name="InspectorBackend-PerformActionAndWaitForNavigate"><strong>PerformActionAndWaitForNavigate</strong></a>(self, action_function, timeout)</dt></dl> + +<dl><dt><a name="InspectorBackend-RegisterDomain"><strong>RegisterDomain</strong></a>(self, domain_name, notification_handler, will_close_handler)</dt><dd><tt>Registers a given domain for handling notification methods.<br> + <br> +For example, given inspector_backend:<br> + def OnConsoleNotification(msg):<br> + if msg['method'] == 'Console.messageAdded':<br> + print msg['params']['message']<br> + return<br> + def OnConsoleClose(self):<br> + pass<br> + inspector_backend.<a href="#InspectorBackend-RegisterDomain">RegisterDomain</a>('Console',<br> + OnConsoleNotification, OnConsoleClose)</tt></dd></dl> + +<dl><dt><a name="InspectorBackend-Screenshot"><strong>Screenshot</strong></a>(self, timeout)</dt></dl> + +<dl><dt><a name="InspectorBackend-SendAndIgnoreResponse"><strong>SendAndIgnoreResponse</strong></a>(self, req)</dt></dl> + +<dl><dt><a name="InspectorBackend-StartTimelineRecording"><strong>StartTimelineRecording</strong></a>(self)</dt></dl> + +<dl><dt><a name="InspectorBackend-StopTimelineRecording"><strong>StopTimelineRecording</strong></a>(self)</dt></dl> + +<dl><dt><a name="InspectorBackend-SyncRequest"><strong>SyncRequest</strong></a>(self, req, timeout<font color="#909090">=10</font>)</dt></dl> + +<dl><dt><a name="InspectorBackend-UnregisterDomain"><strong>UnregisterDomain</strong></a>(self, domain_name)</dt><dd><tt>Unregisters a previously registered domain.</tt></dd></dl> + +<dl><dt><a name="InspectorBackend-WaitForDocumentReadyStateToBeComplete"><strong>WaitForDocumentReadyStateToBeComplete</strong></a>(self, timeout)</dt></dl> + +<dl><dt><a name="InspectorBackend-WaitForDocumentReadyStateToBeInteractiveOrBetter"><strong>WaitForDocumentReadyStateToBeInteractiveOrBetter</strong></a>(self, timeout)</dt></dl> + +<dl><dt><a name="InspectorBackend-__del__"><strong>__del__</strong></a>(self)</dt></dl> + +<dl><dt><a name="InspectorBackend-__init__"><strong>__init__</strong></a>(self, browser, browser_backend, debugger_url)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>browser</strong></dt> +</dl> +<dl><dt><strong>message_output_stream</strong></dt> +</dl> +<dl><dt><strong>screenshot_supported</strong></dt> +</dl> +<dl><dt><strong>timeline_model</strong></dt> +</dl> +<dl><dt><strong>url</strong></dt> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="InspectorException">class <strong>InspectorException</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.chrome.inspector_backend.html#InspectorException">InspectorException</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><a name="InspectorException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#InspectorException-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#InspectorException-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><a name="InspectorException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#InspectorException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="InspectorException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#InspectorException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="InspectorException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#InspectorException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="InspectorException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#InspectorException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="InspectorException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="InspectorException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#InspectorException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="InspectorException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#InspectorException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="InspectorException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="InspectorException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#InspectorException-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="InspectorException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> + +<hr> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +<dl><dt><strong>message</strong></dt> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.inspector_console.html b/tools/telemetry/docs/telemetry.core.chrome.inspector_console.html new file mode 100644 index 0000000..39ea04c --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.inspector_console.html @@ -0,0 +1,60 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.inspector_console</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.inspector_console</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/inspector_console.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/inspector_console.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="json.html">json</a><br> +</td><td width="25%" valign=top><a href="logging.html">logging</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.inspector_console.html#InspectorConsole">InspectorConsole</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> <br> +<font color="#000000" face="helvetica, arial"><a name="InspectorConsole">class <strong>InspectorConsole</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="InspectorConsole-__init__"><strong>__init__</strong></a>(self, inspector_backend)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>message_output_stream</strong></dt> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.inspector_memory.html b/tools/telemetry/docs/telemetry.core.chrome.inspector_memory.html new file mode 100644 index 0000000..076975f --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.inspector_memory.html @@ -0,0 +1,133 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.inspector_memory</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.inspector_memory</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/inspector_memory.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/inspector_memory.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="json.html">json</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.inspector_memory.html#InspectorMemory">InspectorMemory</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.inspector_memory.html#InspectorMemoryException">InspectorMemoryException</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> <br> +<font color="#000000" face="helvetica, arial"><a name="InspectorMemory">class <strong>InspectorMemory</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Communicates with the remote inspector's Memory domain.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="InspectorMemory-GetDOMCounters"><strong>GetDOMCounters</strong></a>(self, timeout)</dt><dd><tt>Retrieves DOM element counts.<br> + <br> +Args:<br> + timeout: The number of seconds to wait for the inspector backend to<br> + service the request before timing out.<br> + <br> +Returns:<br> + A dictionary containing the counts associated with "nodes", "documents",<br> + and "jsEventListeners".</tt></dd></dl> + +<dl><dt><a name="InspectorMemory-__init__"><strong>__init__</strong></a>(self, inspector_backend)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="InspectorMemoryException">class <strong>InspectorMemoryException</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.chrome.inspector_memory.html#InspectorMemoryException">InspectorMemoryException</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><a name="InspectorMemoryException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#InspectorMemoryException-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#InspectorMemoryException-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><a name="InspectorMemoryException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#InspectorMemoryException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="InspectorMemoryException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#InspectorMemoryException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="InspectorMemoryException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#InspectorMemoryException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="InspectorMemoryException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#InspectorMemoryException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="InspectorMemoryException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="InspectorMemoryException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#InspectorMemoryException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="InspectorMemoryException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#InspectorMemoryException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="InspectorMemoryException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="InspectorMemoryException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#InspectorMemoryException-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="InspectorMemoryException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> + +<hr> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +<dl><dt><strong>message</strong></dt> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.inspector_page.html b/tools/telemetry/docs/telemetry.core.chrome.inspector_page.html new file mode 100644 index 0000000..d7693f2 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.inspector_page.html @@ -0,0 +1,74 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.inspector_page</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.inspector_page</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/inspector_page.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/inspector_page.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="json.html">json</a><br> +</td><td width="25%" valign=top><a href="logging.html">logging</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.core.util</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.inspector_page.html#InspectorPage">InspectorPage</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> <br> +<font color="#000000" face="helvetica, arial"><a name="InspectorPage">class <strong>InspectorPage</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="InspectorPage-CollectGarbage"><strong>CollectGarbage</strong></a>(self, timeout<font color="#909090">=60</font>)</dt></dl> + +<dl><dt><a name="InspectorPage-GetCookieByName"><strong>GetCookieByName</strong></a>(self, name, timeout<font color="#909090">=60</font>)</dt><dd><tt>Returns the value of the cookie by the given |name|.</tt></dd></dl> + +<dl><dt><a name="InspectorPage-Navigate"><strong>Navigate</strong></a>(self, url, script_to_evaluate_on_commit<font color="#909090">=None</font>, timeout<font color="#909090">=60</font>)</dt><dd><tt>Navigates to |url|.<br> + <br> +If |script_to_evaluate_on_commit| is given, the script source string will be<br> +evaluated when the navigation is committed. This is after the context of<br> +the page exists, but before any script on the page itself has executed.</tt></dd></dl> + +<dl><dt><a name="InspectorPage-PerformActionAndWaitForNavigate"><strong>PerformActionAndWaitForNavigate</strong></a>(self, action_function, timeout<font color="#909090">=60</font>)</dt><dd><tt>Executes action_function, and waits for the navigation to complete.<br> + <br> +action_function is expect to result in a navigation. This function returns<br> +when the navigation is complete or when the timeout has been exceeded.</tt></dd></dl> + +<dl><dt><a name="InspectorPage-__init__"><strong>__init__</strong></a>(self, inspector_backend)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.inspector_runtime.html b/tools/telemetry/docs/telemetry.core.chrome.inspector_runtime.html new file mode 100644 index 0000000..90aca69 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.inspector_runtime.html @@ -0,0 +1,72 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.inspector_runtime</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.inspector_runtime</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/inspector_runtime.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/inspector_runtime.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.exceptions.html">telemetry.core.exceptions</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.inspector_runtime.html#InspectorRuntime">InspectorRuntime</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> <br> +<font color="#000000" face="helvetica, arial"><a name="InspectorRuntime">class <strong>InspectorRuntime</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="InspectorRuntime-Evaluate"><strong>Evaluate</strong></a>(self, expr, timeout<font color="#909090">=60</font>)</dt><dd><tt>Evalutes expr in javascript and returns the JSONized result.<br> + <br> +Consider using Execute for cases where the result of the expression is not<br> +needed.<br> + <br> +If evaluation throws in javascript, a python EvaluateException will<br> +be raised.<br> + <br> +If the result of the evaluation cannot be JSONized, then an<br> +EvaluationException will be raised.</tt></dd></dl> + +<dl><dt><a name="InspectorRuntime-Execute"><strong>Execute</strong></a>(self, expr, timeout<font color="#909090">=60</font>)</dt><dd><tt>Executes expr in javascript. Does not return the result.<br> + <br> +If the expression failed to evaluate, EvaluateException will be raised.</tt></dd></dl> + +<dl><dt><a name="InspectorRuntime-__init__"><strong>__init__</strong></a>(self, inspector_backend)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.inspector_timeline.html b/tools/telemetry/docs/telemetry.core.chrome.inspector_timeline.html new file mode 100644 index 0000000..cdcfb73 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.inspector_timeline.html @@ -0,0 +1,133 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.inspector_timeline</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.inspector_timeline</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/inspector_timeline.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/inspector_timeline.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.timeline.model.html">telemetry.core.timeline.model</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.inspector_timeline.html#InspectorTimeline">InspectorTimeline</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.inspector_timeline.html#TabBackendException">TabBackendException</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> <br> +<font color="#000000" face="helvetica, arial"><a name="InspectorTimeline">class <strong>InspectorTimeline</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Implementation of dev tools timeline.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="InspectorTimeline-Start"><strong>Start</strong></a>(self)</dt></dl> + +<dl><dt><a name="InspectorTimeline-Stop"><strong>Stop</strong></a>(self)</dt></dl> + +<dl><dt><a name="InspectorTimeline-__init__"><strong>__init__</strong></a>(self, inspector_backend)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>timeline_model</strong></dt> +</dl> +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>Recorder</strong> = <class 'telemetry.core.chrome.inspector_timeline.Recorder'><dd><tt>Utility class to Start / Stop recording timeline.</tt></dl> + +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="TabBackendException">class <strong>TabBackendException</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.chrome.inspector_timeline.html#TabBackendException">TabBackendException</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><a name="TabBackendException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#TabBackendException-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#TabBackendException-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><a name="TabBackendException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#TabBackendException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="TabBackendException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#TabBackendException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="TabBackendException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#TabBackendException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="TabBackendException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#TabBackendException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="TabBackendException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="TabBackendException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#TabBackendException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="TabBackendException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#TabBackendException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="TabBackendException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="TabBackendException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#TabBackendException-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="TabBackendException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> + +<hr> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +<dl><dt><strong>message</strong></dt> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.misc_web_contents_backend.html b/tools/telemetry/docs/telemetry.core.chrome.misc_web_contents_backend.html new file mode 100644 index 0000000..8b89a5e --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.misc_web_contents_backend.html @@ -0,0 +1,68 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.misc_web_contents_backend</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.misc_web_contents_backend</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/misc_web_contents_backend.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/misc_web_contents_backend.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.exceptions.html">telemetry.core.exceptions</a><br> +<a href="httplib.html">httplib</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.chrome.inspector_backend.html">telemetry.core.chrome.inspector_backend</a><br> +<a href="json.html">json</a><br> +</td><td width="25%" valign=top><a href="socket.html">socket</a><br> +<a href="urllib2.html">urllib2</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.web_contents.html">telemetry.core.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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.misc_web_contents_backend.html#MiscWebContentsBackend">MiscWebContentsBackend</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> <br> +<font color="#000000" face="helvetica, arial"><a name="MiscWebContentsBackend">class <strong>MiscWebContentsBackend</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Provides acccess to chrome://oobe/login page, which is neither an extension<br> +nor a tab.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="MiscWebContentsBackend-GetOobe"><strong>GetOobe</strong></a>(self)</dt></dl> + +<dl><dt><a name="MiscWebContentsBackend-__init__"><strong>__init__</strong></a>(self, browser_backend)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.png_bitmap.html b/tools/telemetry/docs/telemetry.core.chrome.png_bitmap.html new file mode 100644 index 0000000..d311c93 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.png_bitmap.html @@ -0,0 +1,107 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.png_bitmap</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.png_bitmap</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/png_bitmap.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/png_bitmap.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="base64.html">base64</a><br> +</td><td width="25%" valign=top><a href="os.html">os</a><br> +</td><td width="25%" valign=top><a href="png.html">png</a><br> +</td><td width="25%" valign=top><a href="sys.html">sys</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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.png_bitmap.html#PngBitmap">PngBitmap</a> +</font></dt><dt><font face="helvetica, arial"><a href="telemetry.core.chrome.png_bitmap.html#PngColor">PngColor</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> <br> +<font color="#000000" face="helvetica, arial"><a name="PngBitmap">class <strong>PngBitmap</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Utilities for parsing and inspecting inspecting a PNG<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="PngBitmap-GetPixelColor"><strong>GetPixelColor</strong></a>(self, x, y)</dt><dd><tt>Returns a <a href="#PngColor">PngColor</a> for the pixel at (x, y)</tt></dd></dl> + +<dl><dt><a name="PngBitmap-WriteFile"><strong>WriteFile</strong></a>(self, path)</dt></dl> + +<dl><dt><a name="PngBitmap-__init__"><strong>__init__</strong></a>(self, base64_png)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>height</strong></dt> +<dd><tt>Height of the snapshot</tt></dd> +</dl> +<dl><dt><strong>width</strong></dt> +<dd><tt>Width of the snapshot</tt></dd> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="PngColor">class <strong>PngColor</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Encapsulates an RGB color retreived from a <a href="#PngBitmap">PngBitmap</a><br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="PngColor-AssertIsRGB"><strong>AssertIsRGB</strong></a>(self, r, g, b, tolerance<font color="#909090">=0</font>)</dt></dl> + +<dl><dt><a name="PngColor-AssertIsRGBA"><strong>AssertIsRGBA</strong></a>(self, r, g, b, a, tolerance<font color="#909090">=0</font>)</dt></dl> + +<dl><dt><a name="PngColor-IsEqual"><strong>IsEqual</strong></a>(self, expected_color, tolerance<font color="#909090">=0</font>)</dt><dd><tt>Verifies that the color is within a given tolerance of<br> +the expected color</tt></dd></dl> + +<dl><dt><a name="PngColor-__init__"><strong>__init__</strong></a>(self, r, g, b, a<font color="#909090">=255</font>)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>PNG_PATH</strong> = '/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/../../../third_party/png'</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.tab_list_backend.html b/tools/telemetry/docs/telemetry.core.chrome.tab_list_backend.html new file mode 100644 index 0000000..5a7ca5c --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.tab_list_backend.html @@ -0,0 +1,85 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.tab_list_backend</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.tab_list_backend</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/tab_list_backend.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/tab_list_backend.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.exceptions.html">telemetry.core.exceptions</a><br> +<a href="httplib.html">httplib</a><br> +<a href="telemetry.core.chrome.inspector_backend.html">telemetry.core.chrome.inspector_backend</a><br> +</td><td width="25%" valign=top><a href="json.html">json</a><br> +<a href="socket.html">socket</a><br> +<a href="telemetry.core.tab.html">telemetry.core.tab</a><br> +</td><td width="25%" valign=top><a href="urllib2.html">urllib2</a><br> +<a href="telemetry.core.util.html">telemetry.core.util</a><br> +<a href="weakref.html">weakref</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.tab_list_backend.html#TabListBackend">TabListBackend</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> <br> +<font color="#000000" face="helvetica, arial"><a name="TabListBackend">class <strong>TabListBackend</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="TabListBackend-ActivateTab"><strong>ActivateTab</strong></a>(self, debugger_url, timeout<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="TabListBackend-CloseTab"><strong>CloseTab</strong></a>(self, debugger_url, timeout<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="TabListBackend-DoesDebuggerUrlExist"><strong>DoesDebuggerUrlExist</strong></a>(self, url)</dt></dl> + +<dl><dt><a name="TabListBackend-Get"><strong>Get</strong></a>(self, index, ret)</dt><dd><tt>Returns self[index] if it exists, or ret if index is out of bounds.</tt></dd></dl> + +<dl><dt><a name="TabListBackend-GetTabUrl"><strong>GetTabUrl</strong></a>(self, debugger_url)</dt></dl> + +<dl><dt><a name="TabListBackend-Init"><strong>Init</strong></a>(self)</dt></dl> + +<dl><dt><a name="TabListBackend-New"><strong>New</strong></a>(self, timeout)</dt></dl> + +<dl><dt><a name="TabListBackend-__getitem__"><strong>__getitem__</strong></a>(self, index)</dt></dl> + +<dl><dt><a name="TabListBackend-__init__"><strong>__init__</strong></a>(self, browser_backend)</dt></dl> + +<dl><dt><a name="TabListBackend-__iter__"><strong>__iter__</strong></a>(self)</dt></dl> + +<dl><dt><a name="TabListBackend-__len__"><strong>__len__</strong></a>(self)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.trace_result.html b/tools/telemetry/docs/telemetry.core.chrome.trace_result.html new file mode 100644 index 0000000..e080fe9 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.trace_result.html @@ -0,0 +1,54 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.trace_result</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.trace_result</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/trace_result.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/trace_result.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ee77aa"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.trace_result.html#TraceResult">TraceResult</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> <br> +<font color="#000000" face="helvetica, arial"><a name="TraceResult">class <strong>TraceResult</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="TraceResult-AsTimelineModel"><strong>AsTimelineModel</strong></a>(self)</dt><dd><tt>Parses the trace result into a timeline model for in-memory<br> +manipulation.</tt></dd></dl> + +<dl><dt><a name="TraceResult-Serialize"><strong>Serialize</strong></a>(self, f)</dt><dd><tt>Serializes the trace result to a file-like <a href="__builtin__.html#object">object</a></tt></dd></dl> + +<dl><dt><a name="TraceResult-__init__"><strong>__init__</strong></a>(self, impl)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.tracing_backend.html b/tools/telemetry/docs/telemetry.core.chrome.tracing_backend.html new file mode 100644 index 0000000..c9da2ea --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.tracing_backend.html @@ -0,0 +1,160 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.tracing_backend</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.tracing_backend</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/tracing_backend.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/tracing_backend.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="cStringIO.html">cStringIO</a><br> +<a href="json.html">json</a><br> +<a href="logging.html">logging</a><br> +</td><td width="25%" valign=top><a href="socket.html">socket</a><br> +<a href="threading.html">threading</a><br> +<a href="telemetry.core.timeline.trace_event_importer.html">telemetry.core.timeline.trace_event_importer</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.chrome.trace_result.html">telemetry.core.chrome.trace_result</a><br> +<a href="telemetry.core.util.html">telemetry.core.util</a><br> +<a href="telemetry.core.chrome.websocket.html">telemetry.core.chrome.websocket</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.tracing_backend.html#TraceResultImpl">TraceResultImpl</a> +</font></dt><dt><font face="helvetica, arial"><a href="telemetry.core.chrome.tracing_backend.html#TracingBackend">TracingBackend</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.tracing_backend.html#TracingUnsupportedException">TracingUnsupportedException</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> <br> +<font color="#000000" face="helvetica, arial"><a name="TraceResultImpl">class <strong>TraceResultImpl</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="TraceResultImpl-AsTimelineModel"><strong>AsTimelineModel</strong></a>(self)</dt></dl> + +<dl><dt><a name="TraceResultImpl-Serialize"><strong>Serialize</strong></a>(self, f)</dt></dl> + +<dl><dt><a name="TraceResultImpl-__init__"><strong>__init__</strong></a>(self, tracing_data)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="TracingBackend">class <strong>TracingBackend</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="TracingBackend-BeginTracing"><strong>BeginTracing</strong></a>(self, custom_categories<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="TracingBackend-Close"><strong>Close</strong></a>(self)</dt></dl> + +<dl><dt><a name="TracingBackend-EndTracing"><strong>EndTracing</strong></a>(self)</dt></dl> + +<dl><dt><a name="TracingBackend-GetTraceResultAndReset"><strong>GetTraceResultAndReset</strong></a>(self)</dt></dl> + +<dl><dt><a name="TracingBackend-__init__"><strong>__init__</strong></a>(self, devtools_port)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="TracingUnsupportedException">class <strong>TracingUnsupportedException</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.chrome.tracing_backend.html#TracingUnsupportedException">TracingUnsupportedException</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><a name="TracingUnsupportedException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#TracingUnsupportedException-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#TracingUnsupportedException-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><a name="TracingUnsupportedException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#TracingUnsupportedException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="TracingUnsupportedException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#TracingUnsupportedException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="TracingUnsupportedException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#TracingUnsupportedException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="TracingUnsupportedException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#TracingUnsupportedException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="TracingUnsupportedException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="TracingUnsupportedException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#TracingUnsupportedException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="TracingUnsupportedException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#TracingUnsupportedException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="TracingUnsupportedException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="TracingUnsupportedException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#TracingUnsupportedException-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="TracingUnsupportedException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> + +<hr> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +<dl><dt><strong>message</strong></dt> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.websocket.html b/tools/telemetry/docs/telemetry.core.chrome.websocket.html new file mode 100644 index 0000000..7c3fe54 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.websocket.html @@ -0,0 +1,40 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.chrome.websocket</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.websocket</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/websocket.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/websocket.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="os.html">os</a><br> +</td><td width="25%" valign=top><a href="sys.html">sys</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-__init__"><strong>__init__</strong></a>()</dt></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>absolute_import</strong> = _Feature((2, 5, 0, 'alpha', 1), (2, 7, 0, 'alpha', 0), 16384)</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.discover.html b/tools/telemetry/docs/telemetry.core.discover.html new file mode 100644 index 0000000..b78fb91 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.discover.html @@ -0,0 +1,59 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.discover</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.discover</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/discover.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/discover.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="fnmatch.html">fnmatch</a><br> +<a href="inspect.html">inspect</a><br> +</td><td width="25%" valign=top><a href="logging.html">logging</a><br> +<a href="os.html">os</a><br> +</td><td width="25%" valign=top><a href="re.html">re</a><br> +<a href="traceback.html">traceback</a><br> +</td><td width="25%" valign=top></td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-DiscoverClasses"><strong>DiscoverClasses</strong></a>(start_dir, top_level_dir, base_class, pattern<font color="#909090">='*'</font>, import_error_should_raise<font color="#909090">=True</font>)</dt><dd><tt>Discover all classes in |start_dir| which subclass |base_class|.<br> + <br> +Args:<br> + start_dir: The directory to recursively search.<br> + top_level_dir: The top level of the package, for importing.<br> + base_class: The base class to search for.<br> + pattern: Unix shell-style pattern for filtering the filenames to import.<br> + import_error_should_raise: If false, then import errors are logged but do<br> + not stop discovery.<br> + <br> +Returns:<br> + dict of {module_name: class}.</tt></dd></dl> + <dl><dt><a name="-DiscoverModules"><strong>DiscoverModules</strong></a>(start_dir, top_level_dir, pattern<font color="#909090">='*'</font>, import_error_should_raise<font color="#909090">=True</font>)</dt><dd><tt>Discover all modules in |start_dir| which match |pattern|.<br> + <br> +Args:<br> + start_dir: The directory to recursively search.<br> + top_level_dir: The top level of the package, for importing.<br> + pattern: Unix shell-style pattern for filtering the filenames to import.<br> + import_error_should_raise: If false, then import errors are logged but do<br> + not stop discovery.<br> + <br> +Returns:<br> + list of modules.</tt></dd></dl> +</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.exceptions.html b/tools/telemetry/docs/telemetry.core.exceptions.html new file mode 100644 index 0000000..92c4e1e --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.exceptions.html @@ -0,0 +1,338 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.exceptions</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.exceptions</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/exceptions.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/exceptions.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ee77aa"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.exceptions.html#BrowserGoneException">BrowserGoneException</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.exceptions.html#BrowserConnectionGoneException">BrowserConnectionGoneException</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="telemetry.core.exceptions.html#EvaluateException">EvaluateException</a> +</font></dt><dt><font face="helvetica, arial"><a href="telemetry.core.exceptions.html#LoginException">LoginException</a> +</font></dt><dt><font face="helvetica, arial"><a href="telemetry.core.exceptions.html#TabCrashException">TabCrashException</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> <br> +<font color="#000000" face="helvetica, arial"><a name="BrowserConnectionGoneException">class <strong>BrowserConnectionGoneException</strong></a>(<a href="telemetry.core.exceptions.html#BrowserGoneException">BrowserGoneException</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.exceptions.html#BrowserConnectionGoneException">BrowserConnectionGoneException</a></dd> +<dd><a href="telemetry.core.exceptions.html#BrowserGoneException">BrowserGoneException</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Data descriptors inherited from <a href="telemetry.core.exceptions.html#BrowserGoneException">BrowserGoneException</a>:<br> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><a name="BrowserConnectionGoneException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserConnectionGoneException-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#BrowserConnectionGoneException-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><a name="BrowserConnectionGoneException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserConnectionGoneException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="BrowserConnectionGoneException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserConnectionGoneException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="BrowserConnectionGoneException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserConnectionGoneException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="BrowserConnectionGoneException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserConnectionGoneException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="BrowserConnectionGoneException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="BrowserConnectionGoneException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserConnectionGoneException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="BrowserConnectionGoneException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserConnectionGoneException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="BrowserConnectionGoneException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="BrowserConnectionGoneException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserConnectionGoneException-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="BrowserConnectionGoneException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> + +<hr> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +<dl><dt><strong>message</strong></dt> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="BrowserGoneException">class <strong>BrowserGoneException</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Represents a crash of the entire browser.<br> + <br> +In this state, all bets are pretty much off.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.exceptions.html#BrowserGoneException">BrowserGoneException</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><a name="BrowserGoneException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserGoneException-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#BrowserGoneException-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><a name="BrowserGoneException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserGoneException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="BrowserGoneException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserGoneException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="BrowserGoneException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserGoneException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="BrowserGoneException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserGoneException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="BrowserGoneException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="BrowserGoneException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserGoneException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="BrowserGoneException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserGoneException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="BrowserGoneException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="BrowserGoneException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserGoneException-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="BrowserGoneException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> + +<hr> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +<dl><dt><strong>message</strong></dt> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="EvaluateException">class <strong>EvaluateException</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.exceptions.html#EvaluateException">EvaluateException</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><a name="EvaluateException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#EvaluateException-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#EvaluateException-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><a name="EvaluateException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#EvaluateException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="EvaluateException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#EvaluateException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="EvaluateException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#EvaluateException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="EvaluateException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#EvaluateException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="EvaluateException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="EvaluateException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#EvaluateException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="EvaluateException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#EvaluateException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="EvaluateException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="EvaluateException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#EvaluateException-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="EvaluateException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> + +<hr> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +<dl><dt><strong>message</strong></dt> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="LoginException">class <strong>LoginException</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.exceptions.html#LoginException">LoginException</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><a name="LoginException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#LoginException-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#LoginException-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><a name="LoginException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#LoginException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="LoginException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#LoginException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="LoginException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#LoginException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="LoginException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#LoginException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="LoginException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="LoginException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#LoginException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="LoginException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#LoginException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="LoginException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="LoginException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#LoginException-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="LoginException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> + +<hr> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +<dl><dt><strong>message</strong></dt> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="TabCrashException">class <strong>TabCrashException</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Represents a crash of the current tab, but not the overall browser.<br> + <br> +In this state, the tab is gone, but the underlying browser is still alive.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.exceptions.html#TabCrashException">TabCrashException</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><a name="TabCrashException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#TabCrashException-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#TabCrashException-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><a name="TabCrashException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#TabCrashException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="TabCrashException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#TabCrashException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="TabCrashException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#TabCrashException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="TabCrashException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#TabCrashException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="TabCrashException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="TabCrashException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#TabCrashException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="TabCrashException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#TabCrashException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="TabCrashException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="TabCrashException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#TabCrashException-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="TabCrashException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> + +<hr> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +<dl><dt><strong>message</strong></dt> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.extension_dict.html b/tools/telemetry/docs/telemetry.core.extension_dict.html new file mode 100644 index 0000000..162c184 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.extension_dict.html @@ -0,0 +1,64 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.extension_dict</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.extension_dict</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/extension_dict.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/extension_dict.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.extension_to_load.html">telemetry.core.extension_to_load</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.extension_dict.html#ExtensionDict">ExtensionDict</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> <br> +<font color="#000000" face="helvetica, arial"><a name="ExtensionDict">class <strong>ExtensionDict</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Dictionary of ExtensionPage instances, with extension_id as key<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="ExtensionDict-__contains__"><strong>__contains__</strong></a>(self, load_extension)</dt><dd><tt>Checks if this ExtensionToLoad instance has been loaded</tt></dd></dl> + +<dl><dt><a name="ExtensionDict-__getitem__"><strong>__getitem__</strong></a>(self, load_extension)</dt><dd><tt>Given an ExtensionToLoad instance, returns the corresponding<br> +ExtensionPage instance.</tt></dd></dl> + +<dl><dt><a name="ExtensionDict-__init__"><strong>__init__</strong></a>(self, extension_dict_backend)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.extension_page.html b/tools/telemetry/docs/telemetry.core.extension_page.html new file mode 100644 index 0000000..8891159 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.extension_page.html @@ -0,0 +1,103 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.extension_page</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.extension_page</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/extension_page.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/extension_page.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.web_contents.html">telemetry.core.web_contents</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.web_contents.html#WebContents">telemetry.core.web_contents.WebContents</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.extension_page.html#ExtensionPage">ExtensionPage</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> <br> +<font color="#000000" face="helvetica, arial"><a name="ExtensionPage">class <strong>ExtensionPage</strong></a>(<a href="telemetry.core.web_contents.html#WebContents">telemetry.core.web_contents.WebContents</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Represents a an extension page in the browser<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.extension_page.html#ExtensionPage">ExtensionPage</a></dd> +<dd><a href="telemetry.core.web_contents.html#WebContents">telemetry.core.web_contents.WebContents</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="ExtensionPage-__del__"><strong>__del__</strong></a>(self)</dt></dl> + +<dl><dt><a name="ExtensionPage-__init__"><strong>__init__</strong></a>(self, inspector_backend)</dt></dl> + +<hr> +Methods inherited from <a href="telemetry.core.web_contents.html#WebContents">telemetry.core.web_contents.WebContents</a>:<br> +<dl><dt><a name="ExtensionPage-Close"><strong>Close</strong></a>(self)</dt><dd><tt>Closes this page.<br> + <br> +Not all browsers or browser versions support this method.<br> +Be sure to check browser.supports_tab_control.</tt></dd></dl> + +<dl><dt><a name="ExtensionPage-Disconnect"><strong>Disconnect</strong></a>(self)</dt></dl> + +<dl><dt><a name="ExtensionPage-EvaluateJavaScript"><strong>EvaluateJavaScript</strong></a>(self, expr, timeout<font color="#909090">=60</font>)</dt><dd><tt>Evalutes expr in JavaScript and returns the JSONized result.<br> + <br> +Consider using ExecuteJavaScript for cases where the result of the<br> +expression is not needed.<br> + <br> +If evaluation throws in JavaScript, a Python EvaluateException will<br> +be raised.<br> + <br> +If the result of the evaluation cannot be JSONized, then an<br> +EvaluationException will be raised.</tt></dd></dl> + +<dl><dt><a name="ExtensionPage-ExecuteJavaScript"><strong>ExecuteJavaScript</strong></a>(self, expr, timeout<font color="#909090">=60</font>)</dt><dd><tt>Executes expr in JavaScript. Does not return the result.<br> + <br> +If the expression failed to evaluate, EvaluateException will be raised.</tt></dd></dl> + +<dl><dt><a name="ExtensionPage-StartTimelineRecording"><strong>StartTimelineRecording</strong></a>(self)</dt></dl> + +<dl><dt><a name="ExtensionPage-StopTimelineRecording"><strong>StopTimelineRecording</strong></a>(self)</dt></dl> + +<dl><dt><a name="ExtensionPage-WaitForDocumentReadyStateToBeComplete"><strong>WaitForDocumentReadyStateToBeComplete</strong></a>(self, timeout<font color="#909090">=60</font>)</dt></dl> + +<dl><dt><a name="ExtensionPage-WaitForDocumentReadyStateToBeInteractiveOrBetter"><strong>WaitForDocumentReadyStateToBeInteractiveOrBetter</strong></a>(self, timeout<font color="#909090">=60</font>)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.web_contents.html#WebContents">telemetry.core.web_contents.WebContents</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>message_output_stream</strong></dt> +</dl> +<dl><dt><strong>timeline_model</strong></dt> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.extension_to_load.html b/tools/telemetry/docs/telemetry.core.extension_to_load.html new file mode 100644 index 0000000..8935b0a --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.extension_to_load.html @@ -0,0 +1,194 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.extension_to_load</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.extension_to_load</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/extension_to_load.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/extension_to_load.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.crx_id.html">telemetry.core.chrome.crx_id</a><br> +</td><td width="25%" valign=top><a href="os.html">os</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.extension_to_load.html#ExtensionToLoad">ExtensionToLoad</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.extension_to_load.html#ExtensionPathNonExistentException">ExtensionPathNonExistentException</a> +</font></dt><dt><font face="helvetica, arial"><a href="telemetry.core.extension_to_load.html#MissingPublicKeyException">MissingPublicKeyException</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> <br> +<font color="#000000" face="helvetica, arial"><a name="ExtensionPathNonExistentException">class <strong>ExtensionPathNonExistentException</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.extension_to_load.html#ExtensionPathNonExistentException">ExtensionPathNonExistentException</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><a name="ExtensionPathNonExistentException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionPathNonExistentException-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#ExtensionPathNonExistentException-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><a name="ExtensionPathNonExistentException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionPathNonExistentException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="ExtensionPathNonExistentException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionPathNonExistentException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="ExtensionPathNonExistentException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionPathNonExistentException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="ExtensionPathNonExistentException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionPathNonExistentException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="ExtensionPathNonExistentException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="ExtensionPathNonExistentException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionPathNonExistentException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="ExtensionPathNonExistentException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionPathNonExistentException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="ExtensionPathNonExistentException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="ExtensionPathNonExistentException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionPathNonExistentException-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="ExtensionPathNonExistentException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> + +<hr> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +<dl><dt><strong>message</strong></dt> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="ExtensionToLoad">class <strong>ExtensionToLoad</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="ExtensionToLoad-__init__"><strong>__init__</strong></a>(self, path, browser_type, is_component<font color="#909090">=False</font>)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>extension_id</strong></dt> +<dd><tt>Unique extension id of this extension.</tt></dd> +</dl> +<dl><dt><strong>is_component</strong></dt> +<dd><tt>Whether this extension should be loaded as a component extension.</tt></dd> +</dl> +<dl><dt><strong>local_path</strong></dt> +<dd><tt>Path to extension destination directory, for remote instances of<br> +chrome</tt></dd> +</dl> +<dl><dt><strong>path</strong></dt> +<dd><tt>Path to extension source directory.</tt></dd> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="MissingPublicKeyException">class <strong>MissingPublicKeyException</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.extension_to_load.html#MissingPublicKeyException">MissingPublicKeyException</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><a name="MissingPublicKeyException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingPublicKeyException-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#MissingPublicKeyException-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><a name="MissingPublicKeyException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingPublicKeyException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="MissingPublicKeyException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingPublicKeyException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="MissingPublicKeyException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingPublicKeyException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="MissingPublicKeyException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingPublicKeyException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="MissingPublicKeyException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="MissingPublicKeyException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingPublicKeyException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="MissingPublicKeyException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingPublicKeyException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="MissingPublicKeyException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="MissingPublicKeyException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingPublicKeyException-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="MissingPublicKeyException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> + +<hr> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +<dl><dt><strong>message</strong></dt> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.html b/tools/telemetry/docs/telemetry.core.html new file mode 100644 index 0000000..d2372ac --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.html @@ -0,0 +1,57 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: package telemetry.core</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.core</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/__init__.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/__init__.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></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.browser.html">browser</a><br> +<a href="telemetry.core.browser_credentials.html">browser_credentials</a><br> +<a href="telemetry.core.browser_credentials_unittest.html">browser_credentials_unittest</a><br> +<a href="telemetry.core.browser_finder.html">browser_finder</a><br> +<a href="telemetry.core.browser_options.html">browser_options</a><br> +<a href="telemetry.core.browser_options_unittest.html">browser_options_unittest</a><br> +<a href="telemetry.core.browser_unittest.html">browser_unittest</a><br> +<a href="telemetry.core.chrome.html"><strong>chrome</strong> (package)</a><br> +<a href="telemetry.core.discover.html">discover</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.discover_unittest.html">discover_unittest</a><br> +<a href="telemetry.core.exceptions.html">exceptions</a><br> +<a href="telemetry.core.extension_dict.html">extension_dict</a><br> +<a href="telemetry.core.extension_page.html">extension_page</a><br> +<a href="telemetry.core.extension_to_load.html">extension_to_load</a><br> +<a href="telemetry.core.extension_unittest.html">extension_unittest</a><br> +<a href="telemetry.core.memory_cache_http_server.html">memory_cache_http_server</a><br> +<a href="telemetry.core.platform.html"><strong>platform</strong> (package)</a><br> +<a href="telemetry.core.possible_browser.html">possible_browser</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.profile_creator.html">profile_creator</a><br> +<a href="telemetry.core.profile_types.html">profile_types</a><br> +<a href="telemetry.core.profile_types_unittest.html">profile_types_unittest</a><br> +<a href="telemetry.core.tab.html">tab</a><br> +<a href="telemetry.core.tab_list.html">tab_list</a><br> +<a href="telemetry.core.tab_unittest.html">tab_unittest</a><br> +<a href="telemetry.core.temporary_http_server.html">temporary_http_server</a><br> +<a href="telemetry.core.temporary_http_server_unittest.html">temporary_http_server_unittest</a><br> +<a href="telemetry.core.timeline.html"><strong>timeline</strong> (package)</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.user_agent.html">user_agent</a><br> +<a href="telemetry.core.user_agent_unittest.html">user_agent_unittest</a><br> +<a href="telemetry.core.util.html">util</a><br> +<a href="telemetry.core.util_unittest.html">util_unittest</a><br> +<a href="telemetry.core.web_contents.html">web_contents</a><br> +<a href="telemetry.core.wpr_modes.html">wpr_modes</a><br> +<a href="telemetry.core.wpr_server.html">wpr_server</a><br> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.memory_cache_http_server.html b/tools/telemetry/docs/telemetry.core.memory_cache_http_server.html new file mode 100644 index 0000000..a3d6ee6 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.memory_cache_http_server.html @@ -0,0 +1,559 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.memory_cache_http_server</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.memory_cache_http_server</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/memory_cache_http_server.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/memory_cache_http_server.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="BaseHTTPServer.html">BaseHTTPServer</a><br> +<a href="SimpleHTTPServer.html">SimpleHTTPServer</a><br> +</td><td width="25%" valign=top><a href="SocketServer.html">SocketServer</a><br> +<a href="mimetypes.html">mimetypes</a><br> +</td><td width="25%" valign=top><a href="os.html">os</a><br> +<a href="sys.html">sys</a><br> +</td><td width="25%" valign=top><a href="zlib.html">zlib</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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="BaseHTTPServer.html#HTTPServer">BaseHTTPServer.HTTPServer</a>(<a href="SocketServer.html#TCPServer">SocketServer.TCPServer</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.memory_cache_http_server.html#MemoryCacheHTTPServer">MemoryCacheHTTPServer</a>(<a href="SocketServer.html#ThreadingMixIn">SocketServer.ThreadingMixIn</a>, <a href="BaseHTTPServer.html#HTTPServer">BaseHTTPServer.HTTPServer</a>) +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="SimpleHTTPServer.html#SimpleHTTPRequestHandler">SimpleHTTPServer.SimpleHTTPRequestHandler</a>(<a href="BaseHTTPServer.html#BaseHTTPRequestHandler">BaseHTTPServer.BaseHTTPRequestHandler</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.memory_cache_http_server.html#MemoryCacheHTTPRequestHandler">MemoryCacheHTTPRequestHandler</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="SocketServer.html#ThreadingMixIn">SocketServer.ThreadingMixIn</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.memory_cache_http_server.html#MemoryCacheHTTPServer">MemoryCacheHTTPServer</a>(<a href="SocketServer.html#ThreadingMixIn">SocketServer.ThreadingMixIn</a>, <a href="BaseHTTPServer.html#HTTPServer">BaseHTTPServer.HTTPServer</a>) +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="__builtin__.html#tuple">__builtin__.tuple</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.memory_cache_http_server.html#ByteRange">ByteRange</a> +</font></dt><dt><font face="helvetica, arial"><a href="telemetry.core.memory_cache_http_server.html#ResourceAndRange">ResourceAndRange</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> <br> +<font color="#000000" face="helvetica, arial"><a name="ByteRange">class <strong>ByteRange</strong></a>(<a href="__builtin__.html#tuple">__builtin__.tuple</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt><a href="#ByteRange">ByteRange</a>(from_byte, to_byte)<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.memory_cache_http_server.html#ByteRange">ByteRange</a></dd> +<dd><a href="__builtin__.html#tuple">__builtin__.tuple</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="ByteRange-__getnewargs__"><strong>__getnewargs__</strong></a>(self)</dt><dd><tt>Return self as a plain <a href="__builtin__.html#tuple">tuple</a>. Used by copy and pickle.</tt></dd></dl> + +<dl><dt><a name="ByteRange-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Return a nicely formatted representation string</tt></dd></dl> + +<dl><dt><a name="ByteRange-_asdict"><strong>_asdict</strong></a>(self)</dt><dd><tt>Return a new OrderedDict which maps field names to their values</tt></dd></dl> + +<dl><dt><a name="ByteRange-_replace"><strong>_replace</strong></a>(_self, **kwds)</dt><dd><tt>Return a new <a href="#ByteRange">ByteRange</a> object replacing specified fields with new values</tt></dd></dl> + +<hr> +Class methods defined here:<br> +<dl><dt><a name="ByteRange-_make"><strong>_make</strong></a>(cls, iterable, new<font color="#909090">=<built-in method __new__ of type object></font>, len<font color="#909090">=<built-in function len></font>)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Make a new <a href="#ByteRange">ByteRange</a> object from a sequence or iterable</tt></dd></dl> + +<hr> +Static methods defined here:<br> +<dl><dt><a name="ByteRange-__new__"><strong>__new__</strong></a>(_cls, from_byte, to_byte)</dt><dd><tt>Create new instance of <a href="#ByteRange">ByteRange</a>(from_byte, to_byte)</tt></dd></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>from_byte</strong></dt> +<dd><tt>Alias for field number 0</tt></dd> +</dl> +<dl><dt><strong>to_byte</strong></dt> +<dd><tt>Alias for field number 1</tt></dd> +</dl> +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>_fields</strong> = ('from_byte', 'to_byte')</dl> + +<hr> +Methods inherited from <a href="__builtin__.html#tuple">__builtin__.tuple</a>:<br> +<dl><dt><a name="ByteRange-__add__"><strong>__add__</strong></a>(...)</dt><dd><tt>x.<a href="#ByteRange-__add__">__add__</a>(y) <==> x+y</tt></dd></dl> + +<dl><dt><a name="ByteRange-__contains__"><strong>__contains__</strong></a>(...)</dt><dd><tt>x.<a href="#ByteRange-__contains__">__contains__</a>(y) <==> y in x</tt></dd></dl> + +<dl><dt><a name="ByteRange-__eq__"><strong>__eq__</strong></a>(...)</dt><dd><tt>x.<a href="#ByteRange-__eq__">__eq__</a>(y) <==> x==y</tt></dd></dl> + +<dl><dt><a name="ByteRange-__ge__"><strong>__ge__</strong></a>(...)</dt><dd><tt>x.<a href="#ByteRange-__ge__">__ge__</a>(y) <==> x>=y</tt></dd></dl> + +<dl><dt><a name="ByteRange-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#ByteRange-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="ByteRange-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#ByteRange-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="ByteRange-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#ByteRange-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="ByteRange-__gt__"><strong>__gt__</strong></a>(...)</dt><dd><tt>x.<a href="#ByteRange-__gt__">__gt__</a>(y) <==> x>y</tt></dd></dl> + +<dl><dt><a name="ByteRange-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#ByteRange-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl> + +<dl><dt><a name="ByteRange-__iter__"><strong>__iter__</strong></a>(...)</dt><dd><tt>x.<a href="#ByteRange-__iter__">__iter__</a>() <==> iter(x)</tt></dd></dl> + +<dl><dt><a name="ByteRange-__le__"><strong>__le__</strong></a>(...)</dt><dd><tt>x.<a href="#ByteRange-__le__">__le__</a>(y) <==> x<=y</tt></dd></dl> + +<dl><dt><a name="ByteRange-__len__"><strong>__len__</strong></a>(...)</dt><dd><tt>x.<a href="#ByteRange-__len__">__len__</a>() <==> len(x)</tt></dd></dl> + +<dl><dt><a name="ByteRange-__lt__"><strong>__lt__</strong></a>(...)</dt><dd><tt>x.<a href="#ByteRange-__lt__">__lt__</a>(y) <==> x<y</tt></dd></dl> + +<dl><dt><a name="ByteRange-__mul__"><strong>__mul__</strong></a>(...)</dt><dd><tt>x.<a href="#ByteRange-__mul__">__mul__</a>(n) <==> x*n</tt></dd></dl> + +<dl><dt><a name="ByteRange-__ne__"><strong>__ne__</strong></a>(...)</dt><dd><tt>x.<a href="#ByteRange-__ne__">__ne__</a>(y) <==> x!=y</tt></dd></dl> + +<dl><dt><a name="ByteRange-__rmul__"><strong>__rmul__</strong></a>(...)</dt><dd><tt>x.<a href="#ByteRange-__rmul__">__rmul__</a>(n) <==> n*x</tt></dd></dl> + +<dl><dt><a name="ByteRange-__sizeof__"><strong>__sizeof__</strong></a>(...)</dt><dd><tt>T.<a href="#ByteRange-__sizeof__">__sizeof__</a>() -- size of T in memory, in bytes</tt></dd></dl> + +<dl><dt><a name="ByteRange-count"><strong>count</strong></a>(...)</dt><dd><tt>T.<a href="#ByteRange-count">count</a>(value) -> integer -- return number of occurrences of value</tt></dd></dl> + +<dl><dt><a name="ByteRange-index"><strong>index</strong></a>(...)</dt><dd><tt>T.<a href="#ByteRange-index">index</a>(value, [start, [stop]]) -> integer -- return first index of value.<br> +Raises ValueError if the value is not present.</tt></dd></dl> + +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="MemoryCacheHTTPRequestHandler">class <strong>MemoryCacheHTTPRequestHandler</strong></a>(<a href="SimpleHTTPServer.html#SimpleHTTPRequestHandler">SimpleHTTPServer.SimpleHTTPRequestHandler</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.memory_cache_http_server.html#MemoryCacheHTTPRequestHandler">MemoryCacheHTTPRequestHandler</a></dd> +<dd><a href="SimpleHTTPServer.html#SimpleHTTPRequestHandler">SimpleHTTPServer.SimpleHTTPRequestHandler</a></dd> +<dd><a href="BaseHTTPServer.html#BaseHTTPRequestHandler">BaseHTTPServer.BaseHTTPRequestHandler</a></dd> +<dd><a href="SocketServer.html#StreamRequestHandler">SocketServer.StreamRequestHandler</a></dd> +<dd><a href="SocketServer.html#BaseRequestHandler">SocketServer.BaseRequestHandler</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="MemoryCacheHTTPRequestHandler-GetByteRange"><strong>GetByteRange</strong></a>(self, total_num_of_bytes)</dt><dd><tt>Parse the header and get the range values specified.<br> + <br> +Args:<br> + total_num_of_bytes: Total # of bytes in requested resource,<br> + used to calculate upper range limit.<br> +Returns:<br> + A <a href="#ByteRange">ByteRange</a> namedtuple object with the requested byte-range values.<br> + If no Range is explicitly requested or there is a failure parsing,<br> + return None.<br> + Special case: If range specified is in the format "N-", return N-N.<br> + If upper range limit is greater than total # of bytes, return upper index.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPRequestHandler-SendHead"><strong>SendHead</strong></a>(self)</dt></dl> + +<dl><dt><a name="MemoryCacheHTTPRequestHandler-do_GET"><strong>do_GET</strong></a>(self)</dt><dd><tt>Serve a GET request.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPRequestHandler-do_HEAD"><strong>do_HEAD</strong></a>(self)</dt><dd><tt>Serve a HEAD request.</tt></dd></dl> + +<hr> +Methods inherited from <a href="SimpleHTTPServer.html#SimpleHTTPRequestHandler">SimpleHTTPServer.SimpleHTTPRequestHandler</a>:<br> +<dl><dt><a name="MemoryCacheHTTPRequestHandler-copyfile"><strong>copyfile</strong></a>(self, source, outputfile)</dt><dd><tt>Copy all data between two file objects.<br> + <br> +The SOURCE argument is a file object open for reading<br> +(or anything with a read() method) and the DESTINATION<br> +argument is a file object open for writing (or<br> +anything with a write() method).<br> + <br> +The only reason for overriding this would be to change<br> +the block size or perhaps to replace newlines by CRLF<br> +-- note however that this the default server uses this<br> +to copy binary data as well.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPRequestHandler-guess_type"><strong>guess_type</strong></a>(self, path)</dt><dd><tt>Guess the type of a file.<br> + <br> +Argument is a PATH (a filename).<br> + <br> +Return value is a string of the form type/subtype,<br> +usable for a MIME Content-type header.<br> + <br> +The default implementation looks the file's extension<br> +up in the table self.<strong>extensions_map</strong>, using application/octet-stream<br> +as a default; however it would be permissible (if<br> +slow) to look inside the data to make a better guess.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPRequestHandler-list_directory"><strong>list_directory</strong></a>(self, path)</dt><dd><tt>Helper to produce a directory listing (absent index.html).<br> + <br> +Return value is either a file object, or None (indicating an<br> +error). In either case, the headers are sent, making the<br> +interface the same as for <a href="#MemoryCacheHTTPRequestHandler-send_head">send_head</a>().</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPRequestHandler-send_head"><strong>send_head</strong></a>(self)</dt><dd><tt>Common code for GET and HEAD commands.<br> + <br> +This sends the response code and MIME headers.<br> + <br> +Return value is either a file object (which has to be copied<br> +to the outputfile by the caller unless the command was HEAD,<br> +and must be closed by the caller under all circumstances), or<br> +None, in which case the caller has nothing further to do.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPRequestHandler-translate_path"><strong>translate_path</strong></a>(self, path)</dt><dd><tt>Translate a /-separated PATH to the local filename syntax.<br> + <br> +Components that mean special things to the local file system<br> +(e.g. drive or directory names) are ignored. (XXX They should<br> +probably be diagnosed.)</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="SimpleHTTPServer.html#SimpleHTTPRequestHandler">SimpleHTTPServer.SimpleHTTPRequestHandler</a>:<br> +<dl><dt><strong>extensions_map</strong> = {'': 'application/octet-stream', '.123': 'application/vnd.lotus-1-2-3', '.3dml': 'text/vnd.in3d.3dml', '.3g2': 'video/3gpp2', '.3gp': 'video/3gpp', '.7z': 'application/x-7z-compressed', '.a': 'application/octet-stream', '.aab': 'application/x-authorware-bin', '.aac': 'audio/x-aac', '.aam': 'application/x-authorware-map', ...}</dl> + +<dl><dt><strong>server_version</strong> = 'SimpleHTTP/0.6'</dl> + +<hr> +Methods inherited from <a href="BaseHTTPServer.html#BaseHTTPRequestHandler">BaseHTTPServer.BaseHTTPRequestHandler</a>:<br> +<dl><dt><a name="MemoryCacheHTTPRequestHandler-address_string"><strong>address_string</strong></a>(self)</dt><dd><tt>Return the client address formatted for logging.<br> + <br> +This version looks up the full hostname using gethostbyaddr(),<br> +and tries to find a name that contains at least one dot.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPRequestHandler-date_time_string"><strong>date_time_string</strong></a>(self, timestamp<font color="#909090">=None</font>)</dt><dd><tt>Return the current date and time formatted for a message header.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPRequestHandler-end_headers"><strong>end_headers</strong></a>(self)</dt><dd><tt>Send the blank line ending the MIME headers.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPRequestHandler-handle"><strong>handle</strong></a>(self)</dt><dd><tt>Handle multiple requests if necessary.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPRequestHandler-handle_one_request"><strong>handle_one_request</strong></a>(self)</dt><dd><tt>Handle a single HTTP request.<br> + <br> +You normally don't need to override this method; see the class<br> +__doc__ string for information on how to handle specific HTTP<br> +commands such as GET and POST.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPRequestHandler-log_date_time_string"><strong>log_date_time_string</strong></a>(self)</dt><dd><tt>Return the current time formatted for logging.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPRequestHandler-log_error"><strong>log_error</strong></a>(self, format, *args)</dt><dd><tt>Log an error.<br> + <br> +This is called when a request cannot be fulfilled. By<br> +default it passes the message on to <a href="#MemoryCacheHTTPRequestHandler-log_message">log_message</a>().<br> + <br> +Arguments are the same as for <a href="#MemoryCacheHTTPRequestHandler-log_message">log_message</a>().<br> + <br> +XXX This should go to the separate error log.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPRequestHandler-log_message"><strong>log_message</strong></a>(self, format, *args)</dt><dd><tt>Log an arbitrary message.<br> + <br> +This is used by all other logging functions. Override<br> +it if you have specific logging wishes.<br> + <br> +The first argument, FORMAT, is a format string for the<br> +message to be logged. If the format string contains<br> +any % escapes requiring parameters, they should be<br> +specified as subsequent arguments (it's just like<br> +printf!).<br> + <br> +The client host and current date/time are prefixed to<br> +every message.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPRequestHandler-log_request"><strong>log_request</strong></a>(self, code<font color="#909090">='-'</font>, size<font color="#909090">='-'</font>)</dt><dd><tt>Log an accepted request.<br> + <br> +This is called by <a href="#MemoryCacheHTTPRequestHandler-send_response">send_response</a>().</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPRequestHandler-parse_request"><strong>parse_request</strong></a>(self)</dt><dd><tt>Parse a request (internal).<br> + <br> +The request should be stored in self.<strong>raw_requestline</strong>; the results<br> +are in self.<strong>command</strong>, self.<strong>path</strong>, self.<strong>request_version</strong> and<br> +self.<strong>headers</strong>.<br> + <br> +Return True for success, False for failure; on failure, an<br> +error is sent back.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPRequestHandler-send_error"><strong>send_error</strong></a>(self, code, message<font color="#909090">=None</font>)</dt><dd><tt>Send and log an error reply.<br> + <br> +Arguments are the error code, and a detailed message.<br> +The detailed message defaults to the short entry matching the<br> +response code.<br> + <br> +This sends an error response (so it must be called before any<br> +output has been generated), logs the error, and finally sends<br> +a piece of HTML explaining the error to the user.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPRequestHandler-send_header"><strong>send_header</strong></a>(self, keyword, value)</dt><dd><tt>Send a MIME header.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPRequestHandler-send_response"><strong>send_response</strong></a>(self, code, message<font color="#909090">=None</font>)</dt><dd><tt>Send the response header and log the response code.<br> + <br> +Also send two standard headers with the server software<br> +version and the current date.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPRequestHandler-version_string"><strong>version_string</strong></a>(self)</dt><dd><tt>Return the server software version string.</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="BaseHTTPServer.html#BaseHTTPRequestHandler">BaseHTTPServer.BaseHTTPRequestHandler</a>:<br> +<dl><dt><strong>MessageClass</strong> = <class mimetools.Message></dl> + +<dl><dt><strong>default_request_version</strong> = 'HTTP/0.9'</dl> + +<dl><dt><strong>error_content_type</strong> = 'text/html'</dl> + +<dl><dt><strong>error_message_format</strong> = '<head><font color="#c040c0">\n</font><title>Error response</title><font color="#c040c0">\n</font></head><font color="#c040c0">\n</font><bo...ode explanation: %(code)s = %(explain)s.<font color="#c040c0">\n</font></body><font color="#c040c0">\n</font>'</dl> + +<dl><dt><strong>monthname</strong> = [None, 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']</dl> + +<dl><dt><strong>protocol_version</strong> = 'HTTP/1.0'</dl> + +<dl><dt><strong>responses</strong> = {100: ('Continue', 'Request received, please continue'), 101: ('Switching Protocols', 'Switching to new protocol; obey Upgrade header'), 200: ('OK', 'Request fulfilled, document follows'), 201: ('Created', 'Document created, URL follows'), 202: ('Accepted', 'Request accepted, processing continues off-line'), 203: ('Non-Authoritative Information', 'Request fulfilled from cache'), 204: ('No Content', 'Request fulfilled, nothing follows'), 205: ('Reset Content', 'Clear input form for further input.'), 206: ('Partial Content', 'Partial content follows.'), 300: ('Multiple Choices', 'Object has several resources -- see URI list'), ...}</dl> + +<dl><dt><strong>sys_version</strong> = 'Python/2.7.2'</dl> + +<dl><dt><strong>weekdayname</strong> = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']</dl> + +<hr> +Methods inherited from <a href="SocketServer.html#StreamRequestHandler">SocketServer.StreamRequestHandler</a>:<br> +<dl><dt><a name="MemoryCacheHTTPRequestHandler-finish"><strong>finish</strong></a>(self)</dt></dl> + +<dl><dt><a name="MemoryCacheHTTPRequestHandler-setup"><strong>setup</strong></a>(self)</dt></dl> + +<hr> +Data and other attributes inherited from <a href="SocketServer.html#StreamRequestHandler">SocketServer.StreamRequestHandler</a>:<br> +<dl><dt><strong>disable_nagle_algorithm</strong> = False</dl> + +<dl><dt><strong>rbufsize</strong> = -1</dl> + +<dl><dt><strong>timeout</strong> = None</dl> + +<dl><dt><strong>wbufsize</strong> = 0</dl> + +<hr> +Methods inherited from <a href="SocketServer.html#BaseRequestHandler">SocketServer.BaseRequestHandler</a>:<br> +<dl><dt><a name="MemoryCacheHTTPRequestHandler-__init__"><strong>__init__</strong></a>(self, request, client_address, server)</dt></dl> + +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="MemoryCacheHTTPServer">class <strong>MemoryCacheHTTPServer</strong></a>(<a href="SocketServer.html#ThreadingMixIn">SocketServer.ThreadingMixIn</a>, <a href="BaseHTTPServer.html#HTTPServer">BaseHTTPServer.HTTPServer</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.memory_cache_http_server.html#MemoryCacheHTTPServer">MemoryCacheHTTPServer</a></dd> +<dd><a href="SocketServer.html#ThreadingMixIn">SocketServer.ThreadingMixIn</a></dd> +<dd><a href="BaseHTTPServer.html#HTTPServer">BaseHTTPServer.HTTPServer</a></dd> +<dd><a href="SocketServer.html#TCPServer">SocketServer.TCPServer</a></dd> +<dd><a href="SocketServer.html#BaseServer">SocketServer.BaseServer</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="MemoryCacheHTTPServer-AddDirectoryToResourceMap"><strong>AddDirectoryToResourceMap</strong></a>(self, cwd)</dt><dd><tt>Loads all files in cwd into the in-memory resource map.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPServer-AddFileToResourceMap"><strong>AddFileToResourceMap</strong></a>(self, file_path)</dt><dd><tt>Loads file_path into the in-memory resource map.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPServer-__init__"><strong>__init__</strong></a>(self, host_port, handler, paths)</dt></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>request_queue_size</strong> = 128</dl> + +<hr> +Methods inherited from <a href="SocketServer.html#ThreadingMixIn">SocketServer.ThreadingMixIn</a>:<br> +<dl><dt><a name="MemoryCacheHTTPServer-process_request"><strong>process_request</strong></a>(self, request, client_address)</dt><dd><tt>Start a new thread to process the request.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPServer-process_request_thread"><strong>process_request_thread</strong></a>(self, request, client_address)</dt><dd><tt>Same as in BaseServer but as a thread.<br> + <br> +In addition, exception handling is done here.</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="SocketServer.html#ThreadingMixIn">SocketServer.ThreadingMixIn</a>:<br> +<dl><dt><strong>daemon_threads</strong> = False</dl> + +<hr> +Methods inherited from <a href="BaseHTTPServer.html#HTTPServer">BaseHTTPServer.HTTPServer</a>:<br> +<dl><dt><a name="MemoryCacheHTTPServer-server_bind"><strong>server_bind</strong></a>(self)</dt><dd><tt>Override server_bind to store the server name.</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="BaseHTTPServer.html#HTTPServer">BaseHTTPServer.HTTPServer</a>:<br> +<dl><dt><strong>allow_reuse_address</strong> = 1</dl> + +<hr> +Methods inherited from <a href="SocketServer.html#TCPServer">SocketServer.TCPServer</a>:<br> +<dl><dt><a name="MemoryCacheHTTPServer-close_request"><strong>close_request</strong></a>(self, request)</dt><dd><tt>Called to clean up an individual request.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPServer-fileno"><strong>fileno</strong></a>(self)</dt><dd><tt>Return socket file number.<br> + <br> +Interface required by select().</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPServer-get_request"><strong>get_request</strong></a>(self)</dt><dd><tt>Get the request and client address from the socket.<br> + <br> +May be overridden.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPServer-server_activate"><strong>server_activate</strong></a>(self)</dt><dd><tt>Called by constructor to activate the server.<br> + <br> +May be overridden.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPServer-server_close"><strong>server_close</strong></a>(self)</dt><dd><tt>Called to clean-up the server.<br> + <br> +May be overridden.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPServer-shutdown_request"><strong>shutdown_request</strong></a>(self, request)</dt><dd><tt>Called to shutdown and close an individual request.</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="SocketServer.html#TCPServer">SocketServer.TCPServer</a>:<br> +<dl><dt><strong>address_family</strong> = 2</dl> + +<dl><dt><strong>socket_type</strong> = 1</dl> + +<hr> +Methods inherited from <a href="SocketServer.html#BaseServer">SocketServer.BaseServer</a>:<br> +<dl><dt><a name="MemoryCacheHTTPServer-finish_request"><strong>finish_request</strong></a>(self, request, client_address)</dt><dd><tt>Finish one request by instantiating RequestHandlerClass.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPServer-handle_error"><strong>handle_error</strong></a>(self, request, client_address)</dt><dd><tt>Handle an error gracefully. May be overridden.<br> + <br> +The default is to print a traceback and continue.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPServer-handle_request"><strong>handle_request</strong></a>(self)</dt><dd><tt>Handle one request, possibly blocking.<br> + <br> +Respects self.<strong>timeout</strong>.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPServer-handle_timeout"><strong>handle_timeout</strong></a>(self)</dt><dd><tt>Called if no new request arrives within self.<strong>timeout</strong>.<br> + <br> +Overridden by ForkingMixIn.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPServer-serve_forever"><strong>serve_forever</strong></a>(self, poll_interval<font color="#909090">=0.5</font>)</dt><dd><tt>Handle one request at a time until shutdown.<br> + <br> +Polls for shutdown every poll_interval seconds. Ignores<br> +self.<strong>timeout</strong>. If you need to do periodic tasks, do them in<br> +another thread.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPServer-shutdown"><strong>shutdown</strong></a>(self)</dt><dd><tt>Stops the serve_forever loop.<br> + <br> +Blocks until the loop has finished. This must be called while<br> +<a href="#MemoryCacheHTTPServer-serve_forever">serve_forever</a>() is running in another thread, or it will<br> +deadlock.</tt></dd></dl> + +<dl><dt><a name="MemoryCacheHTTPServer-verify_request"><strong>verify_request</strong></a>(self, request, client_address)</dt><dd><tt>Verify the request. May be overridden.<br> + <br> +Return True if we should proceed with this request.</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="SocketServer.html#BaseServer">SocketServer.BaseServer</a>:<br> +<dl><dt><strong>timeout</strong> = None</dl> + +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="ResourceAndRange">class <strong>ResourceAndRange</strong></a>(<a href="__builtin__.html#tuple">__builtin__.tuple</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt><a href="#ResourceAndRange">ResourceAndRange</a>(resource, byte_range)<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.memory_cache_http_server.html#ResourceAndRange">ResourceAndRange</a></dd> +<dd><a href="__builtin__.html#tuple">__builtin__.tuple</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="ResourceAndRange-__getnewargs__"><strong>__getnewargs__</strong></a>(self)</dt><dd><tt>Return self as a plain <a href="__builtin__.html#tuple">tuple</a>. Used by copy and pickle.</tt></dd></dl> + +<dl><dt><a name="ResourceAndRange-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Return a nicely formatted representation string</tt></dd></dl> + +<dl><dt><a name="ResourceAndRange-_asdict"><strong>_asdict</strong></a>(self)</dt><dd><tt>Return a new OrderedDict which maps field names to their values</tt></dd></dl> + +<dl><dt><a name="ResourceAndRange-_replace"><strong>_replace</strong></a>(_self, **kwds)</dt><dd><tt>Return a new <a href="#ResourceAndRange">ResourceAndRange</a> object replacing specified fields with new values</tt></dd></dl> + +<hr> +Class methods defined here:<br> +<dl><dt><a name="ResourceAndRange-_make"><strong>_make</strong></a>(cls, iterable, new<font color="#909090">=<built-in method __new__ of type object></font>, len<font color="#909090">=<built-in function len></font>)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Make a new <a href="#ResourceAndRange">ResourceAndRange</a> object from a sequence or iterable</tt></dd></dl> + +<hr> +Static methods defined here:<br> +<dl><dt><a name="ResourceAndRange-__new__"><strong>__new__</strong></a>(_cls, resource, byte_range)</dt><dd><tt>Create new instance of <a href="#ResourceAndRange">ResourceAndRange</a>(resource, byte_range)</tt></dd></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>byte_range</strong></dt> +<dd><tt>Alias for field number 1</tt></dd> +</dl> +<dl><dt><strong>resource</strong></dt> +<dd><tt>Alias for field number 0</tt></dd> +</dl> +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>_fields</strong> = ('resource', 'byte_range')</dl> + +<hr> +Methods inherited from <a href="__builtin__.html#tuple">__builtin__.tuple</a>:<br> +<dl><dt><a name="ResourceAndRange-__add__"><strong>__add__</strong></a>(...)</dt><dd><tt>x.<a href="#ResourceAndRange-__add__">__add__</a>(y) <==> x+y</tt></dd></dl> + +<dl><dt><a name="ResourceAndRange-__contains__"><strong>__contains__</strong></a>(...)</dt><dd><tt>x.<a href="#ResourceAndRange-__contains__">__contains__</a>(y) <==> y in x</tt></dd></dl> + +<dl><dt><a name="ResourceAndRange-__eq__"><strong>__eq__</strong></a>(...)</dt><dd><tt>x.<a href="#ResourceAndRange-__eq__">__eq__</a>(y) <==> x==y</tt></dd></dl> + +<dl><dt><a name="ResourceAndRange-__ge__"><strong>__ge__</strong></a>(...)</dt><dd><tt>x.<a href="#ResourceAndRange-__ge__">__ge__</a>(y) <==> x>=y</tt></dd></dl> + +<dl><dt><a name="ResourceAndRange-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#ResourceAndRange-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="ResourceAndRange-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#ResourceAndRange-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="ResourceAndRange-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#ResourceAndRange-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="ResourceAndRange-__gt__"><strong>__gt__</strong></a>(...)</dt><dd><tt>x.<a href="#ResourceAndRange-__gt__">__gt__</a>(y) <==> x>y</tt></dd></dl> + +<dl><dt><a name="ResourceAndRange-__hash__"><strong>__hash__</strong></a>(...)</dt><dd><tt>x.<a href="#ResourceAndRange-__hash__">__hash__</a>() <==> hash(x)</tt></dd></dl> + +<dl><dt><a name="ResourceAndRange-__iter__"><strong>__iter__</strong></a>(...)</dt><dd><tt>x.<a href="#ResourceAndRange-__iter__">__iter__</a>() <==> iter(x)</tt></dd></dl> + +<dl><dt><a name="ResourceAndRange-__le__"><strong>__le__</strong></a>(...)</dt><dd><tt>x.<a href="#ResourceAndRange-__le__">__le__</a>(y) <==> x<=y</tt></dd></dl> + +<dl><dt><a name="ResourceAndRange-__len__"><strong>__len__</strong></a>(...)</dt><dd><tt>x.<a href="#ResourceAndRange-__len__">__len__</a>() <==> len(x)</tt></dd></dl> + +<dl><dt><a name="ResourceAndRange-__lt__"><strong>__lt__</strong></a>(...)</dt><dd><tt>x.<a href="#ResourceAndRange-__lt__">__lt__</a>(y) <==> x<y</tt></dd></dl> + +<dl><dt><a name="ResourceAndRange-__mul__"><strong>__mul__</strong></a>(...)</dt><dd><tt>x.<a href="#ResourceAndRange-__mul__">__mul__</a>(n) <==> x*n</tt></dd></dl> + +<dl><dt><a name="ResourceAndRange-__ne__"><strong>__ne__</strong></a>(...)</dt><dd><tt>x.<a href="#ResourceAndRange-__ne__">__ne__</a>(y) <==> x!=y</tt></dd></dl> + +<dl><dt><a name="ResourceAndRange-__rmul__"><strong>__rmul__</strong></a>(...)</dt><dd><tt>x.<a href="#ResourceAndRange-__rmul__">__rmul__</a>(n) <==> n*x</tt></dd></dl> + +<dl><dt><a name="ResourceAndRange-__sizeof__"><strong>__sizeof__</strong></a>(...)</dt><dd><tt>T.<a href="#ResourceAndRange-__sizeof__">__sizeof__</a>() -- size of T in memory, in bytes</tt></dd></dl> + +<dl><dt><a name="ResourceAndRange-count"><strong>count</strong></a>(...)</dt><dd><tt>T.<a href="#ResourceAndRange-count">count</a>(value) -> integer -- return number of occurrences of value</tt></dd></dl> + +<dl><dt><a name="ResourceAndRange-index"><strong>index</strong></a>(...)</dt><dd><tt>T.<a href="#ResourceAndRange-index">index</a>(value, [start, [stop]]) -> integer -- return first index of value.<br> +Raises ValueError if the value is not present.</tt></dd></dl> + +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-Main"><strong>Main</strong></a>()</dt></dl> +</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.android_platform_backend.html b/tools/telemetry/docs/telemetry.core.platform.android_platform_backend.html new file mode 100644 index 0000000..7a857a9 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.android_platform_backend.html @@ -0,0 +1,102 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.platform.android_platform_backend</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.platform.html"><font color="#ffffff">platform</font></a>.android_platform_backend</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/android_platform_backend.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/android_platform_backend.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="logging.html">logging</a><br> +<a href="os.html">os</a><br> +</td><td width="25%" valign=top><a href="pylib.perf_tests_helper.html">pylib.perf_tests_helper</a><br> +<a href="telemetry.core.platform.html">telemetry.core.platform</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.platform.platform_backend.html">telemetry.core.platform.platform_backend</a><br> +<a href="pylib.surface_stats_collector.html">pylib.surface_stats_collector</a><br> +</td><td width="25%" valign=top><a href="sys.html">sys</a><br> +<a href="pylib.thermal_throttle.html">pylib.thermal_throttle</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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.android_platform_backend.html#AndroidPlatformBackend">AndroidPlatformBackend</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> <br> +<font color="#000000" face="helvetica, arial"><a name="AndroidPlatformBackend">class <strong>AndroidPlatformBackend</strong></a>(<a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.platform.android_platform_backend.html#AndroidPlatformBackend">AndroidPlatformBackend</a></dd> +<dd><a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="AndroidPlatformBackend-CanMonitorThermalThrottling"><strong>CanMonitorThermalThrottling</strong></a>(self)</dt></dl> + +<dl><dt><a name="AndroidPlatformBackend-GetChildPids"><strong>GetChildPids</strong></a>(self, pid)</dt></dl> + +<dl><dt><a name="AndroidPlatformBackend-GetCommandLine"><strong>GetCommandLine</strong></a>(self, pid)</dt></dl> + +<dl><dt><a name="AndroidPlatformBackend-GetIOStats"><strong>GetIOStats</strong></a>(self, pid)</dt></dl> + +<dl><dt><a name="AndroidPlatformBackend-GetMemoryStats"><strong>GetMemoryStats</strong></a>(self, pid)</dt></dl> + +<dl><dt><a name="AndroidPlatformBackend-GetOSName"><strong>GetOSName</strong></a>(self)</dt></dl> + +<dl><dt><a name="AndroidPlatformBackend-GetRawDisplayFrameRateMeasurements"><strong>GetRawDisplayFrameRateMeasurements</strong></a>(self)</dt></dl> + +<dl><dt><a name="AndroidPlatformBackend-GetSystemCommitCharge"><strong>GetSystemCommitCharge</strong></a>(self)</dt></dl> + +<dl><dt><a name="AndroidPlatformBackend-HasBeenThermallyThrottled"><strong>HasBeenThermallyThrottled</strong></a>(self)</dt></dl> + +<dl><dt><a name="AndroidPlatformBackend-IsRawDisplayFrameRateSupported"><strong>IsRawDisplayFrameRateSupported</strong></a>(self)</dt></dl> + +<dl><dt><a name="AndroidPlatformBackend-IsThermallyThrottled"><strong>IsThermallyThrottled</strong></a>(self)</dt></dl> + +<dl><dt><a name="AndroidPlatformBackend-SetFullPerformanceModeEnabled"><strong>SetFullPerformanceModeEnabled</strong></a>(self, enabled)</dt></dl> + +<dl><dt><a name="AndroidPlatformBackend-StartRawDisplayFrameRateMeasurement"><strong>StartRawDisplayFrameRateMeasurement</strong></a>(self)</dt></dl> + +<dl><dt><a name="AndroidPlatformBackend-StopRawDisplayFrameRateMeasurement"><strong>StopRawDisplayFrameRateMeasurement</strong></a>(self)</dt></dl> + +<dl><dt><a name="AndroidPlatformBackend-__init__"><strong>__init__</strong></a>(self, adb, no_performance_mode)</dt></dl> + +<hr> +Methods inherited from <a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a>:<br> +<dl><dt><a name="AndroidPlatformBackend-GetOSVersionName"><strong>GetOSVersionName</strong></a>(self)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.cros_platform_backend.html b/tools/telemetry/docs/telemetry.core.platform.cros_platform_backend.html new file mode 100644 index 0000000..8c7959c --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.cros_platform_backend.html @@ -0,0 +1,101 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.platform.cros_platform_backend</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.platform.html"><font color="#ffffff">platform</font></a>.cros_platform_backend</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/cros_platform_backend.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/cros_platform_backend.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.platform.linux_platform_backend.html">telemetry.core.platform.linux_platform_backend</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.linux_platform_backend.html#LinuxPlatformBackend">telemetry.core.platform.linux_platform_backend.LinuxPlatformBackend</a>(<a href="telemetry.core.platform.posix_platform_backend.html#PosixPlatformBackend">telemetry.core.platform.posix_platform_backend.PosixPlatformBackend</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.cros_platform_backend.html#CrosPlatformBackend">CrosPlatformBackend</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> <br> +<font color="#000000" face="helvetica, arial"><a name="CrosPlatformBackend">class <strong>CrosPlatformBackend</strong></a>(<a href="telemetry.core.platform.linux_platform_backend.html#LinuxPlatformBackend">telemetry.core.platform.linux_platform_backend.LinuxPlatformBackend</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.platform.cros_platform_backend.html#CrosPlatformBackend">CrosPlatformBackend</a></dd> +<dd><a href="telemetry.core.platform.linux_platform_backend.html#LinuxPlatformBackend">telemetry.core.platform.linux_platform_backend.LinuxPlatformBackend</a></dd> +<dd><a href="telemetry.core.platform.posix_platform_backend.html#PosixPlatformBackend">telemetry.core.platform.posix_platform_backend.PosixPlatformBackend</a></dd> +<dd><a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="CrosPlatformBackend-GetOSName"><strong>GetOSName</strong></a>(self)</dt></dl> + +<dl><dt><a name="CrosPlatformBackend-GetRawDisplayFrameRateMeasurements"><strong>GetRawDisplayFrameRateMeasurements</strong></a>(self)</dt></dl> + +<dl><dt><a name="CrosPlatformBackend-HasBeenThermallyThrottled"><strong>HasBeenThermallyThrottled</strong></a>(self)</dt></dl> + +<dl><dt><a name="CrosPlatformBackend-IsThermallyThrottled"><strong>IsThermallyThrottled</strong></a>(self)</dt></dl> + +<dl><dt><a name="CrosPlatformBackend-StartRawDisplayFrameRateMeasurement"><strong>StartRawDisplayFrameRateMeasurement</strong></a>(self)</dt></dl> + +<dl><dt><a name="CrosPlatformBackend-StopRawDisplayFrameRateMeasurement"><strong>StopRawDisplayFrameRateMeasurement</strong></a>(self)</dt></dl> + +<dl><dt><a name="CrosPlatformBackend-__init__"><strong>__init__</strong></a>(self, cri)</dt></dl> + +<hr> +Methods inherited from <a href="telemetry.core.platform.linux_platform_backend.html#LinuxPlatformBackend">telemetry.core.platform.linux_platform_backend.LinuxPlatformBackend</a>:<br> +<dl><dt><a name="CrosPlatformBackend-GetIOStats"><strong>GetIOStats</strong></a>(self, pid)</dt></dl> + +<dl><dt><a name="CrosPlatformBackend-GetMemoryStats"><strong>GetMemoryStats</strong></a>(self, pid)</dt></dl> + +<dl><dt><a name="CrosPlatformBackend-GetSystemCommitCharge"><strong>GetSystemCommitCharge</strong></a>(self)</dt></dl> + +<hr> +Methods inherited from <a href="telemetry.core.platform.posix_platform_backend.html#PosixPlatformBackend">telemetry.core.platform.posix_platform_backend.PosixPlatformBackend</a>:<br> +<dl><dt><a name="CrosPlatformBackend-GetChildPids"><strong>GetChildPids</strong></a>(self, pid)</dt><dd><tt>Returns a list of child pids of |pid|.</tt></dd></dl> + +<dl><dt><a name="CrosPlatformBackend-GetCommandLine"><strong>GetCommandLine</strong></a>(self, pid)</dt></dl> + +<hr> +Methods inherited from <a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a>:<br> +<dl><dt><a name="CrosPlatformBackend-CanMonitorThermalThrottling"><strong>CanMonitorThermalThrottling</strong></a>(self)</dt></dl> + +<dl><dt><a name="CrosPlatformBackend-GetOSVersionName"><strong>GetOSVersionName</strong></a>(self)</dt></dl> + +<dl><dt><a name="CrosPlatformBackend-IsRawDisplayFrameRateSupported"><strong>IsRawDisplayFrameRateSupported</strong></a>(self)</dt></dl> + +<dl><dt><a name="CrosPlatformBackend-SetFullPerformanceModeEnabled"><strong>SetFullPerformanceModeEnabled</strong></a>(self, enabled)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.html b/tools/telemetry/docs/telemetry.core.platform.html new file mode 100644 index 0000000..4a9d9b6 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.html @@ -0,0 +1,108 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: package telemetry.core.platform</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.platform</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/__init__.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/__init__.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></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.platform.android_platform_backend.html">android_platform_backend</a><br> +<a href="telemetry.core.platform.cros_platform_backend.html">cros_platform_backend</a><br> +<a href="telemetry.core.platform.linux_platform_backend.html">linux_platform_backend</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.platform.mac_platform_backend.html">mac_platform_backend</a><br> +<a href="telemetry.core.platform.platform_backend.html">platform_backend</a><br> +<a href="telemetry.core.platform.posix_platform_backend.html">posix_platform_backend</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.platform.posix_platform_backend_unittest.html">posix_platform_backend_unittest</a><br> +<a href="telemetry.core.platform.profiler.html"><strong>profiler</strong> (package)</a><br> +<a href="telemetry.core.platform.win_platform_backend.html">win_platform_backend</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.html#Platform">Platform</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> <br> +<font color="#000000" face="helvetica, arial"><a name="Platform">class <strong>Platform</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>The platform that the target browser is running on.<br> + <br> +Provides a limited interface to interact with the platform itself, where<br> +possible. It's important to note that platforms may not provide a specific<br> +API, so check with IsFooBar() for availability.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="Platform-CanMonitorThermalThrottling"><strong>CanMonitorThermalThrottling</strong></a>(self)</dt><dd><tt>Platforms may be able to detect thermal throttling.<br> + <br> +Some fan-less computers go into a reduced performance mode when their heat<br> +exceeds a certain threshold. Performance tests in particular should use this<br> +API to detect if this has happened and interpret results accordingly.</tt></dd></dl> + +<dl><dt><a name="Platform-GetOSName"><strong>GetOSName</strong></a>(self)</dt><dd><tt>Returns a string description of the <a href="#Platform">Platform</a> OS.<br> + <br> +Examples: WIN, MAC, LINUX, CHROMEOS</tt></dd></dl> + +<dl><dt><a name="Platform-GetOSVersionName"><strong>GetOSVersionName</strong></a>(self)</dt><dd><tt>Returns a string description of the <a href="#Platform">Platform</a> OS version.<br> + <br> +Examples: VISTA, WIN7, LION, MOUNTAINLION</tt></dd></dl> + +<dl><dt><a name="Platform-GetRawDisplayFrameRateMeasurements"><strong>GetRawDisplayFrameRateMeasurements</strong></a>(self)</dt><dd><tt>Returns a list of RawDisplayFrameRateMeasurement.</tt></dd></dl> + +<dl><dt><a name="Platform-HasBeenThermallyThrottled"><strong>HasBeenThermallyThrottled</strong></a>(self)</dt><dd><tt>Returns True if the device has been thermally throttled.</tt></dd></dl> + +<dl><dt><a name="Platform-IsRawDisplayFrameRateSupported"><strong>IsRawDisplayFrameRateSupported</strong></a>(self)</dt><dd><tt>Platforms may be able to collect GL surface stats.</tt></dd></dl> + +<dl><dt><a name="Platform-IsThermallyThrottled"><strong>IsThermallyThrottled</strong></a>(self)</dt><dd><tt>Returns True if the device is currently thermally throttled.</tt></dd></dl> + +<dl><dt><a name="Platform-SetFullPerformanceModeEnabled"><strong>SetFullPerformanceModeEnabled</strong></a>(self, enabled)</dt><dd><tt>Platforms may tweak their CPU governor, system status, etc.<br> + <br> +Most platforms can operate in a battery saving mode. While good for battery<br> +life, this can cause confusing performance results and add noise. Turning<br> +full performance mode on disables these features, which is useful for<br> +performance testing.</tt></dd></dl> + +<dl><dt><a name="Platform-StartRawDisplayFrameRateMeasurement"><strong>StartRawDisplayFrameRateMeasurement</strong></a>(self)</dt><dd><tt>Start measuring GL surface stats.</tt></dd></dl> + +<dl><dt><a name="Platform-StopRawDisplayFrameRateMeasurement"><strong>StopRawDisplayFrameRateMeasurement</strong></a>(self)</dt><dd><tt>Stop measuring GL surface stats.</tt></dd></dl> + +<dl><dt><a name="Platform-__init__"><strong>__init__</strong></a>(self, platform_backend)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>RawDisplayFrameRateMeasurement</strong> = <class 'telemetry.core.platform.RawDisplayFrameRateMeasurement'></dl> + +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.linux_platform_backend.html b/tools/telemetry/docs/telemetry.core.platform.linux_platform_backend.html new file mode 100644 index 0000000..208e90e --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.linux_platform_backend.html @@ -0,0 +1,97 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.platform.linux_platform_backend</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.platform.html"><font color="#ffffff">platform</font></a>.linux_platform_backend</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/linux_platform_backend.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/linux_platform_backend.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.platform.posix_platform_backend.html">telemetry.core.platform.posix_platform_backend</a><br> +</td><td width="25%" valign=top><a href="resource.html">resource</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.posix_platform_backend.html#PosixPlatformBackend">telemetry.core.platform.posix_platform_backend.PosixPlatformBackend</a>(<a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.linux_platform_backend.html#LinuxPlatformBackend">LinuxPlatformBackend</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> <br> +<font color="#000000" face="helvetica, arial"><a name="LinuxPlatformBackend">class <strong>LinuxPlatformBackend</strong></a>(<a href="telemetry.core.platform.posix_platform_backend.html#PosixPlatformBackend">telemetry.core.platform.posix_platform_backend.PosixPlatformBackend</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.platform.linux_platform_backend.html#LinuxPlatformBackend">LinuxPlatformBackend</a></dd> +<dd><a href="telemetry.core.platform.posix_platform_backend.html#PosixPlatformBackend">telemetry.core.platform.posix_platform_backend.PosixPlatformBackend</a></dd> +<dd><a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="LinuxPlatformBackend-GetIOStats"><strong>GetIOStats</strong></a>(self, pid)</dt></dl> + +<dl><dt><a name="LinuxPlatformBackend-GetMemoryStats"><strong>GetMemoryStats</strong></a>(self, pid)</dt></dl> + +<dl><dt><a name="LinuxPlatformBackend-GetOSName"><strong>GetOSName</strong></a>(self)</dt></dl> + +<dl><dt><a name="LinuxPlatformBackend-GetRawDisplayFrameRateMeasurements"><strong>GetRawDisplayFrameRateMeasurements</strong></a>(self)</dt></dl> + +<dl><dt><a name="LinuxPlatformBackend-GetSystemCommitCharge"><strong>GetSystemCommitCharge</strong></a>(self)</dt></dl> + +<dl><dt><a name="LinuxPlatformBackend-HasBeenThermallyThrottled"><strong>HasBeenThermallyThrottled</strong></a>(self)</dt></dl> + +<dl><dt><a name="LinuxPlatformBackend-IsThermallyThrottled"><strong>IsThermallyThrottled</strong></a>(self)</dt></dl> + +<dl><dt><a name="LinuxPlatformBackend-StartRawDisplayFrameRateMeasurement"><strong>StartRawDisplayFrameRateMeasurement</strong></a>(self)</dt></dl> + +<dl><dt><a name="LinuxPlatformBackend-StopRawDisplayFrameRateMeasurement"><strong>StopRawDisplayFrameRateMeasurement</strong></a>(self)</dt></dl> + +<hr> +Methods inherited from <a href="telemetry.core.platform.posix_platform_backend.html#PosixPlatformBackend">telemetry.core.platform.posix_platform_backend.PosixPlatformBackend</a>:<br> +<dl><dt><a name="LinuxPlatformBackend-GetChildPids"><strong>GetChildPids</strong></a>(self, pid)</dt><dd><tt>Returns a list of child pids of |pid|.</tt></dd></dl> + +<dl><dt><a name="LinuxPlatformBackend-GetCommandLine"><strong>GetCommandLine</strong></a>(self, pid)</dt></dl> + +<hr> +Methods inherited from <a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a>:<br> +<dl><dt><a name="LinuxPlatformBackend-CanMonitorThermalThrottling"><strong>CanMonitorThermalThrottling</strong></a>(self)</dt></dl> + +<dl><dt><a name="LinuxPlatformBackend-GetOSVersionName"><strong>GetOSVersionName</strong></a>(self)</dt></dl> + +<dl><dt><a name="LinuxPlatformBackend-IsRawDisplayFrameRateSupported"><strong>IsRawDisplayFrameRateSupported</strong></a>(self)</dt></dl> + +<dl><dt><a name="LinuxPlatformBackend-SetFullPerformanceModeEnabled"><strong>SetFullPerformanceModeEnabled</strong></a>(self, enabled)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.mac_platform_backend.html b/tools/telemetry/docs/telemetry.core.platform.mac_platform_backend.html new file mode 100644 index 0000000..00a8064 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.mac_platform_backend.html @@ -0,0 +1,98 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.platform.mac_platform_backend</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.platform.html"><font color="#ffffff">platform</font></a>.mac_platform_backend</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/mac_platform_backend.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/mac_platform_backend.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="os.html">os</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.platform.posix_platform_backend.html">telemetry.core.platform.posix_platform_backend</a><br> +</td><td width="25%" valign=top><a href="resource.html">resource</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.posix_platform_backend.html#PosixPlatformBackend">telemetry.core.platform.posix_platform_backend.PosixPlatformBackend</a>(<a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.mac_platform_backend.html#MacPlatformBackend">MacPlatformBackend</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> <br> +<font color="#000000" face="helvetica, arial"><a name="MacPlatformBackend">class <strong>MacPlatformBackend</strong></a>(<a href="telemetry.core.platform.posix_platform_backend.html#PosixPlatformBackend">telemetry.core.platform.posix_platform_backend.PosixPlatformBackend</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.platform.mac_platform_backend.html#MacPlatformBackend">MacPlatformBackend</a></dd> +<dd><a href="telemetry.core.platform.posix_platform_backend.html#PosixPlatformBackend">telemetry.core.platform.posix_platform_backend.PosixPlatformBackend</a></dd> +<dd><a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="MacPlatformBackend-GetMemoryStats"><strong>GetMemoryStats</strong></a>(self, pid)</dt></dl> + +<dl><dt><a name="MacPlatformBackend-GetOSName"><strong>GetOSName</strong></a>(self)</dt></dl> + +<dl><dt><a name="MacPlatformBackend-GetOSVersionName"><strong>GetOSVersionName</strong></a>(self)</dt></dl> + +<dl><dt><a name="MacPlatformBackend-GetRawDisplayFrameRateMeasurements"><strong>GetRawDisplayFrameRateMeasurements</strong></a>(self)</dt></dl> + +<dl><dt><a name="MacPlatformBackend-GetSystemCommitCharge"><strong>GetSystemCommitCharge</strong></a>(self)</dt></dl> + +<dl><dt><a name="MacPlatformBackend-HasBeenThermallyThrottled"><strong>HasBeenThermallyThrottled</strong></a>(self)</dt></dl> + +<dl><dt><a name="MacPlatformBackend-IsThermallyThrottled"><strong>IsThermallyThrottled</strong></a>(self)</dt></dl> + +<dl><dt><a name="MacPlatformBackend-StartRawDisplayFrameRateMeasurement"><strong>StartRawDisplayFrameRateMeasurement</strong></a>(self)</dt></dl> + +<dl><dt><a name="MacPlatformBackend-StopRawDisplayFrameRateMeasurement"><strong>StopRawDisplayFrameRateMeasurement</strong></a>(self)</dt></dl> + +<hr> +Methods inherited from <a href="telemetry.core.platform.posix_platform_backend.html#PosixPlatformBackend">telemetry.core.platform.posix_platform_backend.PosixPlatformBackend</a>:<br> +<dl><dt><a name="MacPlatformBackend-GetChildPids"><strong>GetChildPids</strong></a>(self, pid)</dt><dd><tt>Returns a list of child pids of |pid|.</tt></dd></dl> + +<dl><dt><a name="MacPlatformBackend-GetCommandLine"><strong>GetCommandLine</strong></a>(self, pid)</dt></dl> + +<hr> +Methods inherited from <a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a>:<br> +<dl><dt><a name="MacPlatformBackend-CanMonitorThermalThrottling"><strong>CanMonitorThermalThrottling</strong></a>(self)</dt></dl> + +<dl><dt><a name="MacPlatformBackend-GetIOStats"><strong>GetIOStats</strong></a>(self, pid)</dt></dl> + +<dl><dt><a name="MacPlatformBackend-IsRawDisplayFrameRateSupported"><strong>IsRawDisplayFrameRateSupported</strong></a>(self)</dt></dl> + +<dl><dt><a name="MacPlatformBackend-SetFullPerformanceModeEnabled"><strong>SetFullPerformanceModeEnabled</strong></a>(self, enabled)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.platform_backend.html b/tools/telemetry/docs/telemetry.core.platform.platform_backend.html new file mode 100644 index 0000000..410d5ff --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.platform_backend.html @@ -0,0 +1,77 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.platform.platform_backend</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.platform.html"><font color="#ffffff">platform</font></a>.platform_backend</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/platform_backend.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/platform_backend.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ee77aa"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.platform_backend.html#PlatformBackend">PlatformBackend</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> <br> +<font color="#000000" face="helvetica, arial"><a name="PlatformBackend">class <strong>PlatformBackend</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="PlatformBackend-CanMonitorThermalThrottling"><strong>CanMonitorThermalThrottling</strong></a>(self)</dt></dl> + +<dl><dt><a name="PlatformBackend-GetChildPids"><strong>GetChildPids</strong></a>(self, pid)</dt></dl> + +<dl><dt><a name="PlatformBackend-GetCommandLine"><strong>GetCommandLine</strong></a>(self, pid)</dt></dl> + +<dl><dt><a name="PlatformBackend-GetIOStats"><strong>GetIOStats</strong></a>(self, pid)</dt></dl> + +<dl><dt><a name="PlatformBackend-GetMemoryStats"><strong>GetMemoryStats</strong></a>(self, pid)</dt></dl> + +<dl><dt><a name="PlatformBackend-GetOSName"><strong>GetOSName</strong></a>(self)</dt></dl> + +<dl><dt><a name="PlatformBackend-GetOSVersionName"><strong>GetOSVersionName</strong></a>(self)</dt></dl> + +<dl><dt><a name="PlatformBackend-GetRawDisplayFrameRateMeasurements"><strong>GetRawDisplayFrameRateMeasurements</strong></a>(self)</dt></dl> + +<dl><dt><a name="PlatformBackend-GetSystemCommitCharge"><strong>GetSystemCommitCharge</strong></a>(self)</dt></dl> + +<dl><dt><a name="PlatformBackend-HasBeenThermallyThrottled"><strong>HasBeenThermallyThrottled</strong></a>(self)</dt></dl> + +<dl><dt><a name="PlatformBackend-IsRawDisplayFrameRateSupported"><strong>IsRawDisplayFrameRateSupported</strong></a>(self)</dt></dl> + +<dl><dt><a name="PlatformBackend-IsThermallyThrottled"><strong>IsThermallyThrottled</strong></a>(self)</dt></dl> + +<dl><dt><a name="PlatformBackend-SetFullPerformanceModeEnabled"><strong>SetFullPerformanceModeEnabled</strong></a>(self, enabled)</dt></dl> + +<dl><dt><a name="PlatformBackend-StartRawDisplayFrameRateMeasurement"><strong>StartRawDisplayFrameRateMeasurement</strong></a>(self)</dt><dd><tt># pylint: disable=W0613</tt></dd></dl> + +<dl><dt><a name="PlatformBackend-StopRawDisplayFrameRateMeasurement"><strong>StopRawDisplayFrameRateMeasurement</strong></a>(self)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.posix_platform_backend.html b/tools/telemetry/docs/telemetry.core.platform.posix_platform_backend.html new file mode 100644 index 0000000..517dc8a --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.posix_platform_backend.html @@ -0,0 +1,94 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.platform.posix_platform_backend</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.platform.html"><font color="#ffffff">platform</font></a>.posix_platform_backend</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/posix_platform_backend.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/posix_platform_backend.py</a></font></td></tr></table> + <p><tt># Copyright 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.platform.platform_backend.html">telemetry.core.platform.platform_backend</a><br> +</td><td width="25%" valign=top><a href="subprocess.html">subprocess</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.posix_platform_backend.html#PosixPlatformBackend">PosixPlatformBackend</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> <br> +<font color="#000000" face="helvetica, arial"><a name="PosixPlatformBackend">class <strong>PosixPlatformBackend</strong></a>(<a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.platform.posix_platform_backend.html#PosixPlatformBackend">PosixPlatformBackend</a></dd> +<dd><a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="PosixPlatformBackend-GetChildPids"><strong>GetChildPids</strong></a>(self, pid)</dt><dd><tt>Returns a list of child pids of |pid|.</tt></dd></dl> + +<dl><dt><a name="PosixPlatformBackend-GetCommandLine"><strong>GetCommandLine</strong></a>(self, pid)</dt></dl> + +<hr> +Methods inherited from <a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a>:<br> +<dl><dt><a name="PosixPlatformBackend-CanMonitorThermalThrottling"><strong>CanMonitorThermalThrottling</strong></a>(self)</dt></dl> + +<dl><dt><a name="PosixPlatformBackend-GetIOStats"><strong>GetIOStats</strong></a>(self, pid)</dt></dl> + +<dl><dt><a name="PosixPlatformBackend-GetMemoryStats"><strong>GetMemoryStats</strong></a>(self, pid)</dt></dl> + +<dl><dt><a name="PosixPlatformBackend-GetOSName"><strong>GetOSName</strong></a>(self)</dt></dl> + +<dl><dt><a name="PosixPlatformBackend-GetOSVersionName"><strong>GetOSVersionName</strong></a>(self)</dt></dl> + +<dl><dt><a name="PosixPlatformBackend-GetRawDisplayFrameRateMeasurements"><strong>GetRawDisplayFrameRateMeasurements</strong></a>(self)</dt></dl> + +<dl><dt><a name="PosixPlatformBackend-GetSystemCommitCharge"><strong>GetSystemCommitCharge</strong></a>(self)</dt></dl> + +<dl><dt><a name="PosixPlatformBackend-HasBeenThermallyThrottled"><strong>HasBeenThermallyThrottled</strong></a>(self)</dt></dl> + +<dl><dt><a name="PosixPlatformBackend-IsRawDisplayFrameRateSupported"><strong>IsRawDisplayFrameRateSupported</strong></a>(self)</dt></dl> + +<dl><dt><a name="PosixPlatformBackend-IsThermallyThrottled"><strong>IsThermallyThrottled</strong></a>(self)</dt></dl> + +<dl><dt><a name="PosixPlatformBackend-SetFullPerformanceModeEnabled"><strong>SetFullPerformanceModeEnabled</strong></a>(self, enabled)</dt></dl> + +<dl><dt><a name="PosixPlatformBackend-StartRawDisplayFrameRateMeasurement"><strong>StartRawDisplayFrameRateMeasurement</strong></a>(self)</dt><dd><tt># pylint: disable=W0613</tt></dd></dl> + +<dl><dt><a name="PosixPlatformBackend-StopRawDisplayFrameRateMeasurement"><strong>StopRawDisplayFrameRateMeasurement</strong></a>(self)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.profiler.html b/tools/telemetry/docs/telemetry.core.platform.profiler.html new file mode 100644 index 0000000..4823462 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.profiler.html @@ -0,0 +1,72 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: package telemetry.core.platform.profiler</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.platform.html"><font color="#ffffff">platform</font></a>.profiler</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/profiler/__init__.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/profiler/__init__.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></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.platform.profiler.iprofiler_profiler.html">iprofiler_profiler</a><br> +<a href="telemetry.core.platform.profiler.java_heap_profiler.html">java_heap_profiler</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.platform.profiler.perf_profiler.html">perf_profiler</a><br> +<a href="telemetry.core.platform.profiler.profiler_finder.html">profiler_finder</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.platform.profiler.sample_profiler.html">sample_profiler</a><br> +<a href="telemetry.core.platform.profiler.tcmalloc_heap_profiler.html">tcmalloc_heap_profiler</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.profiler.html#Profiler">Profiler</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> <br> +<font color="#000000" face="helvetica, arial"><a name="Profiler">class <strong>Profiler</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>A sampling profiler provided by the platform.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="Profiler-CollectProfile"><strong>CollectProfile</strong></a>(self)</dt><dd><tt>Collect the profile from the profiler.</tt></dd></dl> + +<dl><dt><a name="Profiler-__init__"><strong>__init__</strong></a>(self, browser_backend, platform_backend, output_path)</dt></dl> + +<hr> +Class methods defined here:<br> +<dl><dt><a name="Profiler-is_supported"><strong>is_supported</strong></a>(cls, options)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>True iff this profiler is currently supported by the platform.</tt></dd></dl> + +<dl><dt><a name="Profiler-name"><strong>name</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>User-friendly name of this profiler.</tt></dd></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.profiler.iprofiler_profiler.html b/tools/telemetry/docs/telemetry.core.platform.profiler.iprofiler_profiler.html new file mode 100644 index 0000000..adcdcd3 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.profiler.iprofiler_profiler.html @@ -0,0 +1,76 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.platform.profiler.iprofiler_profiler</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.platform.html"><font color="#ffffff">platform</font></a>.<a href="telemetry.core.platform.profiler.html"><font color="#ffffff">profiler</font></a>.iprofiler_profiler</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/profiler/iprofiler_profiler.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/profiler/iprofiler_profiler.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="os.html">os</a><br> +<a href="pexpect.html">pexpect</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.platform.profiler.html">telemetry.core.platform.profiler</a><br> +<a href="signal.html">signal</a><br> +</td><td width="25%" valign=top><a href="sys.html">sys</a><br> +<a href="telemetry.core.util.html">telemetry.core.util</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.profiler.html#Profiler">telemetry.core.platform.profiler.Profiler</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.profiler.iprofiler_profiler.html#IprofilerProfiler">IprofilerProfiler</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> <br> +<font color="#000000" face="helvetica, arial"><a name="IprofilerProfiler">class <strong>IprofilerProfiler</strong></a>(<a href="telemetry.core.platform.profiler.html#Profiler">telemetry.core.platform.profiler.Profiler</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.platform.profiler.iprofiler_profiler.html#IprofilerProfiler">IprofilerProfiler</a></dd> +<dd><a href="telemetry.core.platform.profiler.html#Profiler">telemetry.core.platform.profiler.Profiler</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="IprofilerProfiler-CollectProfile"><strong>CollectProfile</strong></a>(self)</dt></dl> + +<dl><dt><a name="IprofilerProfiler-__init__"><strong>__init__</strong></a>(self, browser_backend, platform_backend, output_path)</dt></dl> + +<hr> +Class methods defined here:<br> +<dl><dt><a name="IprofilerProfiler-is_supported"><strong>is_supported</strong></a>(cls, options)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl> + +<dl><dt><a name="IprofilerProfiler-name"><strong>name</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.platform.profiler.html#Profiler">telemetry.core.platform.profiler.Profiler</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.profiler.java_heap_profiler.html b/tools/telemetry/docs/telemetry.core.platform.profiler.java_heap_profiler.html new file mode 100644 index 0000000..84fbdc0 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.profiler.java_heap_profiler.html @@ -0,0 +1,77 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.platform.profiler.java_heap_profiler</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.platform.html"><font color="#ffffff">platform</font></a>.<a href="telemetry.core.platform.profiler.html"><font color="#ffffff">profiler</font></a>.java_heap_profiler</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/profiler/java_heap_profiler.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/profiler/java_heap_profiler.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="os.html">os</a><br> +<a href="telemetry.core.platform.profiler.html">telemetry.core.platform.profiler</a><br> +</td><td width="25%" valign=top><a href="subprocess.html">subprocess</a><br> +<a href="threading.html">threading</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.core.util</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.profiler.html#Profiler">telemetry.core.platform.profiler.Profiler</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.profiler.java_heap_profiler.html#JavaHeapProfiler">JavaHeapProfiler</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> <br> +<font color="#000000" face="helvetica, arial"><a name="JavaHeapProfiler">class <strong>JavaHeapProfiler</strong></a>(<a href="telemetry.core.platform.profiler.html#Profiler">telemetry.core.platform.profiler.Profiler</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Android-specific, trigger and fetch java heap dumps.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.platform.profiler.java_heap_profiler.html#JavaHeapProfiler">JavaHeapProfiler</a></dd> +<dd><a href="telemetry.core.platform.profiler.html#Profiler">telemetry.core.platform.profiler.Profiler</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="JavaHeapProfiler-CollectProfile"><strong>CollectProfile</strong></a>(self)</dt></dl> + +<dl><dt><a name="JavaHeapProfiler-__init__"><strong>__init__</strong></a>(self, browser_backend, platform_backend, output_path)</dt></dl> + +<hr> +Class methods defined here:<br> +<dl><dt><a name="JavaHeapProfiler-is_supported"><strong>is_supported</strong></a>(cls, options)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl> + +<dl><dt><a name="JavaHeapProfiler-name"><strong>name</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.platform.profiler.html#Profiler">telemetry.core.platform.profiler.Profiler</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.profiler.perf_profiler.html b/tools/telemetry/docs/telemetry.core.platform.profiler.perf_profiler.html new file mode 100644 index 0000000..00d904c --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.profiler.perf_profiler.html @@ -0,0 +1,75 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.platform.profiler.perf_profiler</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.platform.html"><font color="#ffffff">platform</font></a>.<a href="telemetry.core.platform.profiler.html"><font color="#ffffff">profiler</font></a>.perf_profiler</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/profiler/perf_profiler.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/profiler/perf_profiler.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.platform.profiler.html">telemetry.core.platform.profiler</a><br> +<a href="signal.html">signal</a><br> +</td><td width="25%" valign=top><a href="subprocess.html">subprocess</a><br> +<a href="sys.html">sys</a><br> +</td><td width="25%" valign=top><a href="tempfile.html">tempfile</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.profiler.html#Profiler">telemetry.core.platform.profiler.Profiler</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.profiler.perf_profiler.html#PerfProfiler">PerfProfiler</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> <br> +<font color="#000000" face="helvetica, arial"><a name="PerfProfiler">class <strong>PerfProfiler</strong></a>(<a href="telemetry.core.platform.profiler.html#Profiler">telemetry.core.platform.profiler.Profiler</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.platform.profiler.perf_profiler.html#PerfProfiler">PerfProfiler</a></dd> +<dd><a href="telemetry.core.platform.profiler.html#Profiler">telemetry.core.platform.profiler.Profiler</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="PerfProfiler-CollectProfile"><strong>CollectProfile</strong></a>(self)</dt></dl> + +<dl><dt><a name="PerfProfiler-__init__"><strong>__init__</strong></a>(self, browser_backend, platform_backend, output_path)</dt></dl> + +<hr> +Class methods defined here:<br> +<dl><dt><a name="PerfProfiler-is_supported"><strong>is_supported</strong></a>(cls, options)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl> + +<dl><dt><a name="PerfProfiler-name"><strong>name</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.platform.profiler.html#Profiler">telemetry.core.platform.profiler.Profiler</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.profiler.profiler_finder.html b/tools/telemetry/docs/telemetry.core.platform.profiler.profiler_finder.html new file mode 100644 index 0000000..23af808 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.profiler.profiler_finder.html @@ -0,0 +1,37 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.platform.profiler.profiler_finder</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.platform.html"><font color="#ffffff">platform</font></a>.<a href="telemetry.core.platform.profiler.html"><font color="#ffffff">profiler</font></a>.profiler_finder</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/profiler/profiler_finder.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/profiler/profiler_finder.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.platform.profiler.iprofiler_profiler.html">telemetry.core.platform.profiler.iprofiler_profiler</a><br> +<a href="telemetry.core.platform.profiler.java_heap_profiler.html">telemetry.core.platform.profiler.java_heap_profiler</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.platform.profiler.perf_profiler.html">telemetry.core.platform.profiler.perf_profiler</a><br> +<a href="telemetry.core.platform.profiler.sample_profiler.html">telemetry.core.platform.profiler.sample_profiler</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.platform.profiler.tcmalloc_heap_profiler.html">telemetry.core.platform.profiler.tcmalloc_heap_profiler</a><br> +</td><td width="25%" valign=top></td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-FindProfiler"><strong>FindProfiler</strong></a>(name)</dt></dl> + <dl><dt><a name="-GetAllAvailableProfilers"><strong>GetAllAvailableProfilers</strong></a>()</dt></dl> +</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.profiler.sample_profiler.html b/tools/telemetry/docs/telemetry.core.platform.profiler.sample_profiler.html new file mode 100644 index 0000000..5323b00 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.profiler.sample_profiler.html @@ -0,0 +1,76 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.platform.profiler.sample_profiler</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.platform.html"><font color="#ffffff">platform</font></a>.<a href="telemetry.core.platform.profiler.html"><font color="#ffffff">profiler</font></a>.sample_profiler</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/profiler/sample_profiler.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/profiler/sample_profiler.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.platform.profiler.html">telemetry.core.platform.profiler</a><br> +<a href="signal.html">signal</a><br> +</td><td width="25%" valign=top><a href="subprocess.html">subprocess</a><br> +<a href="sys.html">sys</a><br> +</td><td width="25%" valign=top><a href="tempfile.html">tempfile</a><br> +<a href="telemetry.core.util.html">telemetry.core.util</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.profiler.html#Profiler">telemetry.core.platform.profiler.Profiler</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.profiler.sample_profiler.html#SampleProfiler">SampleProfiler</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> <br> +<font color="#000000" face="helvetica, arial"><a name="SampleProfiler">class <strong>SampleProfiler</strong></a>(<a href="telemetry.core.platform.profiler.html#Profiler">telemetry.core.platform.profiler.Profiler</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.platform.profiler.sample_profiler.html#SampleProfiler">SampleProfiler</a></dd> +<dd><a href="telemetry.core.platform.profiler.html#Profiler">telemetry.core.platform.profiler.Profiler</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="SampleProfiler-CollectProfile"><strong>CollectProfile</strong></a>(self)</dt></dl> + +<dl><dt><a name="SampleProfiler-__init__"><strong>__init__</strong></a>(self, browser_backend, platform_backend, output_path)</dt></dl> + +<hr> +Class methods defined here:<br> +<dl><dt><a name="SampleProfiler-is_supported"><strong>is_supported</strong></a>(cls, options)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl> + +<dl><dt><a name="SampleProfiler-name"><strong>name</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.platform.profiler.html#Profiler">telemetry.core.platform.profiler.Profiler</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.profiler.tcmalloc_heap_profiler.html b/tools/telemetry/docs/telemetry.core.platform.profiler.tcmalloc_heap_profiler.html new file mode 100644 index 0000000..b1f53a7 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.profiler.tcmalloc_heap_profiler.html @@ -0,0 +1,76 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.platform.profiler.tcmalloc_heap_profiler</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.platform.html"><font color="#ffffff">platform</font></a>.<a href="telemetry.core.platform.profiler.html"><font color="#ffffff">profiler</font></a>.tcmalloc_heap_profiler</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/profiler/tcmalloc_heap_profiler.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/profiler/tcmalloc_heap_profiler.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="logging.html">logging</a><br> +</td><td width="25%" valign=top><a href="os.html">os</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.platform.profiler.html">telemetry.core.platform.profiler</a><br> +</td><td width="25%" valign=top><a href="sys.html">sys</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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.profiler.html#Profiler">telemetry.core.platform.profiler.Profiler</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.profiler.tcmalloc_heap_profiler.html#TCMallocHeapProfiler">TCMallocHeapProfiler</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> <br> +<font color="#000000" face="helvetica, arial"><a name="TCMallocHeapProfiler">class <strong>TCMallocHeapProfiler</strong></a>(<a href="telemetry.core.platform.profiler.html#Profiler">telemetry.core.platform.profiler.Profiler</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>A Factory to instantiate the platform-specific profiler.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.platform.profiler.tcmalloc_heap_profiler.html#TCMallocHeapProfiler">TCMallocHeapProfiler</a></dd> +<dd><a href="telemetry.core.platform.profiler.html#Profiler">telemetry.core.platform.profiler.Profiler</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="TCMallocHeapProfiler-CollectProfile"><strong>CollectProfile</strong></a>(self)</dt></dl> + +<dl><dt><a name="TCMallocHeapProfiler-__init__"><strong>__init__</strong></a>(self, browser_backend, platform_backend, output_path)</dt></dl> + +<hr> +Class methods defined here:<br> +<dl><dt><a name="TCMallocHeapProfiler-is_supported"><strong>is_supported</strong></a>(cls, options)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl> + +<dl><dt><a name="TCMallocHeapProfiler-name"><strong>name</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.platform.profiler.html#Profiler">telemetry.core.platform.profiler.Profiler</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.win_platform_backend.html b/tools/telemetry/docs/telemetry.core.platform.win_platform_backend.html new file mode 100644 index 0000000..870229f --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.win_platform_backend.html @@ -0,0 +1,108 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.platform.win_platform_backend</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.platform.html"><font color="#ffffff">platform</font></a>.win_platform_backend</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/win_platform_backend.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/win_platform_backend.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="collections.html">collections</a><br> +<a href="ctypes.html">ctypes</a><br> +</td><td width="25%" valign=top><a href="os.html">os</a><br> +<a href="telemetry.core.platform.platform_backend.html">telemetry.core.platform.platform_backend</a><br> +</td><td width="25%" valign=top><a href="re.html">re</a><br> +<a href="subprocess.html">subprocess</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.platform.win_platform_backend.html#WinPlatformBackend">WinPlatformBackend</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> <br> +<font color="#000000" face="helvetica, arial"><a name="WinPlatformBackend">class <strong>WinPlatformBackend</strong></a>(<a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.platform.win_platform_backend.html#WinPlatformBackend">WinPlatformBackend</a></dd> +<dd><a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="WinPlatformBackend-GetChildPids"><strong>GetChildPids</strong></a>(self, pid)</dt><dd><tt>Retunds a list of child pids of |pid|.</tt></dd></dl> + +<dl><dt><a name="WinPlatformBackend-GetCommandLine"><strong>GetCommandLine</strong></a>(self, pid)</dt></dl> + +<dl><dt><a name="WinPlatformBackend-GetIOStats"><strong>GetIOStats</strong></a>(self, pid)</dt></dl> + +<dl><dt><a name="WinPlatformBackend-GetMemoryStats"><strong>GetMemoryStats</strong></a>(self, pid)</dt></dl> + +<dl><dt><a name="WinPlatformBackend-GetOSName"><strong>GetOSName</strong></a>(self)</dt></dl> + +<dl><dt><a name="WinPlatformBackend-GetOSVersionName"><strong>GetOSVersionName</strong></a>(self)</dt></dl> + +<dl><dt><a name="WinPlatformBackend-GetRawDisplayFrameRateMeasurements"><strong>GetRawDisplayFrameRateMeasurements</strong></a>(self)</dt></dl> + +<dl><dt><a name="WinPlatformBackend-GetSystemCommitCharge"><strong>GetSystemCommitCharge</strong></a>(self)</dt></dl> + +<dl><dt><a name="WinPlatformBackend-HasBeenThermallyThrottled"><strong>HasBeenThermallyThrottled</strong></a>(self)</dt></dl> + +<dl><dt><a name="WinPlatformBackend-IsThermallyThrottled"><strong>IsThermallyThrottled</strong></a>(self)</dt></dl> + +<dl><dt><a name="WinPlatformBackend-StartRawDisplayFrameRateMeasurement"><strong>StartRawDisplayFrameRateMeasurement</strong></a>(self)</dt><dd><tt># pylint: disable=W0613</tt></dd></dl> + +<dl><dt><a name="WinPlatformBackend-StopRawDisplayFrameRateMeasurement"><strong>StopRawDisplayFrameRateMeasurement</strong></a>(self)</dt></dl> + +<hr> +Methods inherited from <a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a>:<br> +<dl><dt><a name="WinPlatformBackend-CanMonitorThermalThrottling"><strong>CanMonitorThermalThrottling</strong></a>(self)</dt></dl> + +<dl><dt><a name="WinPlatformBackend-IsRawDisplayFrameRateSupported"><strong>IsRawDisplayFrameRateSupported</strong></a>(self)</dt></dl> + +<dl><dt><a name="WinPlatformBackend-SetFullPerformanceModeEnabled"><strong>SetFullPerformanceModeEnabled</strong></a>(self, enabled)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.platform.platform_backend.html#PlatformBackend">telemetry.core.platform.platform_backend.PlatformBackend</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>pywintypes</strong> = None<br> +<strong>win32api</strong> = None<br> +<strong>win32con</strong> = None<br> +<strong>win32process</strong> = None</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.possible_browser.html b/tools/telemetry/docs/telemetry.core.possible_browser.html new file mode 100644 index 0000000..8a3ed8bd --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.possible_browser.html @@ -0,0 +1,63 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.possible_browser</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.possible_browser</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/possible_browser.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/possible_browser.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ee77aa"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.possible_browser.html#PossibleBrowser">PossibleBrowser</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> <br> +<font color="#000000" face="helvetica, arial"><a name="PossibleBrowser">class <strong>PossibleBrowser</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>A browser that can be controlled.<br> + <br> +Call <a href="#PossibleBrowser-Create">Create</a>() to launch the browser and begin manipulating it..<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="PossibleBrowser-Create"><strong>Create</strong></a>(self)</dt></dl> + +<dl><dt><a name="PossibleBrowser-SupportsOptions"><strong>SupportsOptions</strong></a>(self, options)</dt><dd><tt>Tests for extension support.</tt></dd></dl> + +<dl><dt><a name="PossibleBrowser-__init__"><strong>__init__</strong></a>(self, browser_type, options)</dt></dl> + +<dl><dt><a name="PossibleBrowser-__repr__"><strong>__repr__</strong></a>(self)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>browser_type</strong></dt> +</dl> +<dl><dt><strong>options</strong></dt> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.profile_creator.html b/tools/telemetry/docs/telemetry.core.profile_creator.html new file mode 100644 index 0000000..35386fc --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.profile_creator.html @@ -0,0 +1,53 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.profile_creator</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.profile_creator</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/profile_creator.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/profile_creator.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ee77aa"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.profile_creator.html#ProfileCreator">ProfileCreator</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> <br> +<font color="#000000" face="helvetica, arial"><a name="ProfileCreator">class <strong>ProfileCreator</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Base class for an <a href="__builtin__.html#object">object</a> that constructs a Chrome profile.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="ProfileCreator-CreateProfile"><strong>CreateProfile</strong></a>(self)</dt><dd><tt>Fill in the profile in question.</tt></dd></dl> + +<dl><dt><a name="ProfileCreator-__init__"><strong>__init__</strong></a>(self, browser)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.profile_types.html b/tools/telemetry/docs/telemetry.core.profile_types.html new file mode 100644 index 0000000..fedff7b --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.profile_types.html @@ -0,0 +1,51 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.profile_types</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.profile_types</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/profile_types.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/profile_types.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.discover.html">telemetry.core.discover</a><br> +</td><td width="25%" valign=top><a href="os.html">os</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.profile_creator.html">telemetry.core.profile_creator</a><br> +</td><td width="25%" valign=top></td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-ClearProfieCreatorsForTests"><strong>ClearProfieCreatorsForTests</strong></a>()</dt><dd><tt>Clears the discovered profile creator objects. Used for unit tests.</tt></dd></dl> + <dl><dt><a name="-FindProfileCreators"><strong>FindProfileCreators</strong></a>(profile_creators_dir)</dt><dd><tt>Discover all the ProfileCreator objects in |profile_creators_dir|.</tt></dd></dl> + <dl><dt><a name="-GetProfileCreator"><strong>GetProfileCreator</strong></a>(profile_type)</dt><dd><tt>Returns the profile creator object corresponding to the |profile_type|<br> +string.</tt></dd></dl> + <dl><dt><a name="-GetProfileDir"><strong>GetProfileDir</strong></a>(profile_type)</dt><dd><tt>Given a |profile_type| (as returned by <a href="#-GetProfileTypes">GetProfileTypes</a>()), return the<br> +directory to use for that profile or None if the profile needs to be generated<br> +or doesn't need a profile directory (e.g. using the browser default profile).</tt></dd></dl> + <dl><dt><a name="-GetProfileTypes"><strong>GetProfileTypes</strong></a>()</dt><dd><tt>Returns a list of all command line options that can be specified for<br> +profile type.</tt></dd></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>BASE_PROFILE_TYPES</strong> = ['clean', 'default']<br> +<strong>PROFILE_CREATORS</strong> = {}<br> +<strong>PROFILE_TYPE_MAPPING</strong> = {'power_user': 'chrome/test/data/extensions/profiles/extension_webrequest', 'typical_user': 'chrome/test/data/extensions/profiles/content_scripts1'}</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.tab.html b/tools/telemetry/docs/telemetry.core.tab.html new file mode 100644 index 0000000..1fba4ac --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.tab.html @@ -0,0 +1,166 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.tab</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.tab</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/tab.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/tab.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.web_contents.html">telemetry.core.web_contents</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.web_contents.html#WebContents">telemetry.core.web_contents.WebContents</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.tab.html#Tab">Tab</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> <br> +<font color="#000000" face="helvetica, arial"><a name="Tab">class <strong>Tab</strong></a>(<a href="telemetry.core.web_contents.html#WebContents">telemetry.core.web_contents.WebContents</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Represents a tab in the browser<br> + <br> +The important parts of the <a href="#Tab">Tab</a> object are in the runtime and page objects.<br> +E.g.:<br> + # Navigates the tab to a given url.<br> + tab.<a href="#Tab-Navigate">Navigate</a>('<a href="http://www.google.com/">http://www.google.com/</a>')<br> + <br> + # Evaluates 1+1 in the tab's JavaScript context.<br> + tab.Evaluate('1+1')<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.tab.html#Tab">Tab</a></dd> +<dd><a href="telemetry.core.web_contents.html#WebContents">telemetry.core.web_contents.WebContents</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="Tab-Activate"><strong>Activate</strong></a>(self)</dt><dd><tt>Brings this tab to the foreground asynchronously.<br> + <br> +Not all browsers or browser versions support this method.<br> +Be sure to check browser.supports_tab_control.<br> + <br> +Please note: this is asynchronous. There is a delay between this call<br> +and the page's documentVisibilityState becoming 'visible', and yet more<br> +delay until the actual tab is visible to the user. None of these delays<br> +are included in this call.</tt></dd></dl> + +<dl><dt><a name="Tab-CollectGarbage"><strong>CollectGarbage</strong></a>(self)</dt></dl> + +<dl><dt><a name="Tab-GetCookieByName"><strong>GetCookieByName</strong></a>(self, name, timeout<font color="#909090">=60</font>)</dt><dd><tt>Returns the value of the cookie by the given |name|.</tt></dd></dl> + +<dl><dt><a name="Tab-Navigate"><strong>Navigate</strong></a>(self, url, script_to_evaluate_on_commit<font color="#909090">=None</font>, timeout<font color="#909090">=60</font>)</dt><dd><tt>Navigates to url.<br> + <br> +If |script_to_evaluate_on_commit| is given, the script source string will be<br> +evaluated when the navigation is committed. This is after the context of<br> +the page exists, but before any script on the page itself has executed.</tt></dd></dl> + +<dl><dt><a name="Tab-PerformActionAndWaitForNavigate"><strong>PerformActionAndWaitForNavigate</strong></a>(self, action_function, timeout<font color="#909090">=60</font>)</dt><dd><tt>Executes action_function, and waits for the navigation to complete.<br> + <br> +action_function must be a Python function that results in a navigation.<br> +This function returns when the navigation is complete or when<br> +the timeout has been exceeded.</tt></dd></dl> + +<dl><dt><a name="Tab-Screenshot"><strong>Screenshot</strong></a>(self, timeout<font color="#909090">=60</font>)</dt><dd><tt>Capture a screenshot of the window for rendering validation</tt></dd></dl> + +<dl><dt><a name="Tab-__del__"><strong>__del__</strong></a>(self)</dt></dl> + +<dl><dt><a name="Tab-__init__"><strong>__init__</strong></a>(self, inspector_backend)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>browser</strong></dt> +<dd><tt>The browser in which this tab resides.</tt></dd> +</dl> +<dl><dt><strong>dom_stats</strong></dt> +<dd><tt>A dictionary populated with measured DOM statistics.<br> + <br> +Currently this dictionary contains:<br> +{<br> + 'document_count': integer,<br> + 'node_count': integer,<br> + 'event_listener_count': integer<br> +}</tt></dd> +</dl> +<dl><dt><strong>screenshot_supported</strong></dt> +<dd><tt>True if the browser instance is capable of capturing screenshots</tt></dd> +</dl> +<dl><dt><strong>url</strong></dt> +</dl> +<hr> +Methods inherited from <a href="telemetry.core.web_contents.html#WebContents">telemetry.core.web_contents.WebContents</a>:<br> +<dl><dt><a name="Tab-Close"><strong>Close</strong></a>(self)</dt><dd><tt>Closes this page.<br> + <br> +Not all browsers or browser versions support this method.<br> +Be sure to check browser.supports_tab_control.</tt></dd></dl> + +<dl><dt><a name="Tab-Disconnect"><strong>Disconnect</strong></a>(self)</dt></dl> + +<dl><dt><a name="Tab-EvaluateJavaScript"><strong>EvaluateJavaScript</strong></a>(self, expr, timeout<font color="#909090">=60</font>)</dt><dd><tt>Evalutes expr in JavaScript and returns the JSONized result.<br> + <br> +Consider using ExecuteJavaScript for cases where the result of the<br> +expression is not needed.<br> + <br> +If evaluation throws in JavaScript, a Python EvaluateException will<br> +be raised.<br> + <br> +If the result of the evaluation cannot be JSONized, then an<br> +EvaluationException will be raised.</tt></dd></dl> + +<dl><dt><a name="Tab-ExecuteJavaScript"><strong>ExecuteJavaScript</strong></a>(self, expr, timeout<font color="#909090">=60</font>)</dt><dd><tt>Executes expr in JavaScript. Does not return the result.<br> + <br> +If the expression failed to evaluate, EvaluateException will be raised.</tt></dd></dl> + +<dl><dt><a name="Tab-StartTimelineRecording"><strong>StartTimelineRecording</strong></a>(self)</dt></dl> + +<dl><dt><a name="Tab-StopTimelineRecording"><strong>StopTimelineRecording</strong></a>(self)</dt></dl> + +<dl><dt><a name="Tab-WaitForDocumentReadyStateToBeComplete"><strong>WaitForDocumentReadyStateToBeComplete</strong></a>(self, timeout<font color="#909090">=60</font>)</dt></dl> + +<dl><dt><a name="Tab-WaitForDocumentReadyStateToBeInteractiveOrBetter"><strong>WaitForDocumentReadyStateToBeInteractiveOrBetter</strong></a>(self, timeout<font color="#909090">=60</font>)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.web_contents.html#WebContents">telemetry.core.web_contents.WebContents</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>message_output_stream</strong></dt> +</dl> +<dl><dt><strong>timeline_model</strong></dt> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>DEFAULT_TAB_TIMEOUT</strong> = 60</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.tab_list.html b/tools/telemetry/docs/telemetry.core.tab_list.html new file mode 100644 index 0000000..91bffab --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.tab_list.html @@ -0,0 +1,61 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.tab_list</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.tab_list</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/tab_list.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/tab_list.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ee77aa"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.tab_list.html#TabList">TabList</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> <br> +<font color="#000000" face="helvetica, arial"><a name="TabList">class <strong>TabList</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="TabList-New"><strong>New</strong></a>(self, timeout<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="TabList-__getitem__"><strong>__getitem__</strong></a>(self, index)</dt></dl> + +<dl><dt><a name="TabList-__init__"><strong>__init__</strong></a>(self, tab_list_backend)</dt></dl> + +<dl><dt><a name="TabList-__iter__"><strong>__iter__</strong></a>(self)</dt></dl> + +<dl><dt><a name="TabList-__len__"><strong>__len__</strong></a>(self)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.temporary_http_server.html b/tools/telemetry/docs/telemetry.core.temporary_http_server.html new file mode 100644 index 0000000..01e0aec --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.temporary_http_server.html @@ -0,0 +1,76 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.temporary_http_server</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.temporary_http_server</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/temporary_http_server.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/temporary_http_server.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="os.html">os</a><br> +<a href="socket.html">socket</a><br> +</td><td width="25%" valign=top><a href="subprocess.html">subprocess</a><br> +<a href="sys.html">sys</a><br> +</td><td width="25%" valign=top><a href="urlparse.html">urlparse</a><br> +<a href="telemetry.core.util.html">telemetry.core.util</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.temporary_http_server.html#TemporaryHTTPServer">TemporaryHTTPServer</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> <br> +<font color="#000000" face="helvetica, arial"><a name="TemporaryHTTPServer">class <strong>TemporaryHTTPServer</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="TemporaryHTTPServer-Close"><strong>Close</strong></a>(self)</dt></dl> + +<dl><dt><a name="TemporaryHTTPServer-UrlOf"><strong>UrlOf</strong></a>(self, path)</dt></dl> + +<dl><dt><a name="TemporaryHTTPServer-__del__"><strong>__del__</strong></a>(self)</dt></dl> + +<dl><dt><a name="TemporaryHTTPServer-__enter__"><strong>__enter__</strong></a>(self)</dt></dl> + +<dl><dt><a name="TemporaryHTTPServer-__exit__"><strong>__exit__</strong></a>(self, *args)</dt></dl> + +<dl><dt><a name="TemporaryHTTPServer-__init__"><strong>__init__</strong></a>(self, browser_backend, paths)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>paths</strong></dt> +</dl> +<dl><dt><strong>url</strong></dt> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.timeline.event.html b/tools/telemetry/docs/telemetry.core.timeline.event.html new file mode 100644 index 0000000..9bd02cf --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.timeline.event.html @@ -0,0 +1,60 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.timeline.event</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.timeline.html"><font color="#ffffff">timeline</font></a>.event</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/timeline/event.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/timeline/event.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ee77aa"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.timeline.event.html#TimelineEvent">TimelineEvent</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> <br> +<font color="#000000" face="helvetica, arial"><a name="TimelineEvent">class <strong>TimelineEvent</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Represents a timeline event.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="TimelineEvent-GetAllChildrenRecursive"><strong>GetAllChildrenRecursive</strong></a>(self, include_self<font color="#909090">=False</font>)</dt></dl> + +<dl><dt><a name="TimelineEvent-__init__"><strong>__init__</strong></a>(self, name, start, duration, args<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="TimelineEvent-__repr__"><strong>__repr__</strong></a>(self)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>end</strong></dt> +</dl> +<dl><dt><strong>self_time</strong></dt> +<dd><tt>Time spent in this function less any time spent in child events.</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.timeline.html b/tools/telemetry/docs/telemetry.core.timeline.html new file mode 100644 index 0000000..dfa2405 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.timeline.html @@ -0,0 +1,29 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: package telemetry.core.timeline</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.timeline</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/timeline/__init__.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/timeline/__init__.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></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.timeline.event.html">event</a><br> +<a href="telemetry.core.timeline.event_unittest.html">event_unittest</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.timeline.importer.html">importer</a><br> +<a href="telemetry.core.timeline.inspector_importer.html">inspector_importer</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.timeline.inspector_importer_unittest.html">inspector_importer_unittest</a><br> +<a href="telemetry.core.timeline.model.html">model</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.timeline.model_unittest.html">model_unittest</a><br> +<a href="telemetry.core.timeline.trace_event_importer.html">trace_event_importer</a><br> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.timeline.importer.html b/tools/telemetry/docs/telemetry.core.timeline.importer.html new file mode 100644 index 0000000..24bb405 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.timeline.importer.html @@ -0,0 +1,61 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.timeline.importer</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.timeline.html"><font color="#ffffff">timeline</font></a>.importer</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/timeline/importer.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/timeline/importer.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ee77aa"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.timeline.importer.html#TimelineImporter">TimelineImporter</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> <br> +<font color="#000000" face="helvetica, arial"><a name="TimelineImporter">class <strong>TimelineImporter</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Interface for classes that can add events to<br> +a timeline model from raw event data.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="TimelineImporter-FinalizeImport"><strong>FinalizeImport</strong></a>(self)</dt><dd><tt>Called after all other importers for the model are run.</tt></dd></dl> + +<dl><dt><a name="TimelineImporter-ImportEvents"><strong>ImportEvents</strong></a>(self)</dt><dd><tt>Processes the event data and creates and adds<br> +new timeline events to the model</tt></dd></dl> + +<dl><dt><a name="TimelineImporter-__init__"><strong>__init__</strong></a>(self, model, event_data, import_priority<font color="#909090">=0</font>)</dt></dl> + +<hr> +Static methods defined here:<br> +<dl><dt><a name="TimelineImporter-CanImport"><strong>CanImport</strong></a>(event_data)</dt><dd><tt>Returns true if the importer can process the given event data.</tt></dd></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.timeline.inspector_importer.html b/tools/telemetry/docs/telemetry.core.timeline.inspector_importer.html new file mode 100644 index 0000000..52f4b51 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.timeline.inspector_importer.html @@ -0,0 +1,74 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.timeline.inspector_importer</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.timeline.html"><font color="#ffffff">timeline</font></a>.inspector_importer</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/timeline/inspector_importer.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/timeline/inspector_importer.py</a></font></td></tr></table> + <p><tt>Imports event data obtained from the inspector's timeline.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.timeline.importer.html">telemetry.core.timeline.importer</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.timeline.event.html">telemetry.core.timeline.event</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.timeline.importer.html#TimelineImporter">telemetry.core.timeline.importer.TimelineImporter</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.timeline.inspector_importer.html#InspectorTimelineImporter">InspectorTimelineImporter</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> <br> +<font color="#000000" face="helvetica, arial"><a name="InspectorTimelineImporter">class <strong>InspectorTimelineImporter</strong></a>(<a href="telemetry.core.timeline.importer.html#TimelineImporter">telemetry.core.timeline.importer.TimelineImporter</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.timeline.inspector_importer.html#InspectorTimelineImporter">InspectorTimelineImporter</a></dd> +<dd><a href="telemetry.core.timeline.importer.html#TimelineImporter">telemetry.core.timeline.importer.TimelineImporter</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="InspectorTimelineImporter-FinalizeImport"><strong>FinalizeImport</strong></a>(self)</dt></dl> + +<dl><dt><a name="InspectorTimelineImporter-ImportEvents"><strong>ImportEvents</strong></a>(self)</dt></dl> + +<dl><dt><a name="InspectorTimelineImporter-__init__"><strong>__init__</strong></a>(self, model, event_data)</dt></dl> + +<hr> +Static methods defined here:<br> +<dl><dt><a name="InspectorTimelineImporter-CanImport"><strong>CanImport</strong></a>(event_data)</dt><dd><tt>Checks if event_data is from the inspector timeline. We assume<br> +that if the first event is a valid inspector event, we can import the<br> +entire list.</tt></dd></dl> + +<dl><dt><a name="InspectorTimelineImporter-RawEventToTimelineEvent"><strong>RawEventToTimelineEvent</strong></a>(raw_inspector_event)</dt><dd><tt>Converts raw_inspector_event to TimelineEvent.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.timeline.importer.html#TimelineImporter">telemetry.core.timeline.importer.TimelineImporter</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.timeline.model.html b/tools/telemetry/docs/telemetry.core.timeline.model.html new file mode 100644 index 0000000..22e80ce --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.timeline.model.html @@ -0,0 +1,68 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.timeline.model</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.timeline.html"><font color="#ffffff">timeline</font></a>.model</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/timeline/model.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/timeline/model.py</a></font></td></tr></table> + <p><tt>A container for timeline-based events and traces and can handle importing<br> +raw event data from different sources. This model closely resembles that in the<br> +trace_viewer project:<br> +https://code.google.com/p/trace-viewer/</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.timeline.inspector_importer.html">telemetry.core.timeline.inspector_importer</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.timeline.model.html#TimelineModel">TimelineModel</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> <br> +<font color="#000000" face="helvetica, arial"><a name="TimelineModel">class <strong>TimelineModel</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="TimelineModel-AddEvent"><strong>AddEvent</strong></a>(self, event)</dt></dl> + +<dl><dt><a name="TimelineModel-DidFinishRecording"><strong>DidFinishRecording</strong></a>(self)</dt></dl> + +<dl><dt><a name="TimelineModel-GetAllEvents"><strong>GetAllEvents</strong></a>(self)</dt></dl> + +<dl><dt><a name="TimelineModel-GetAllOfName"><strong>GetAllOfName</strong></a>(self, name)</dt></dl> + +<dl><dt><a name="TimelineModel-ImportTraces"><strong>ImportTraces</strong></a>(self, traces)</dt></dl> + +<dl><dt><a name="TimelineModel-__init__"><strong>__init__</strong></a>(self)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.timeline.trace_event_importer.html b/tools/telemetry/docs/telemetry.core.timeline.trace_event_importer.html new file mode 100644 index 0000000..dcf8dfd --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.timeline.trace_event_importer.html @@ -0,0 +1,33 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.timeline.trace_event_importer</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.<a href="telemetry.core.timeline.html"><font color="#ffffff">timeline</font></a>.trace_event_importer</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/timeline/trace_event_importer.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/timeline/trace_event_importer.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="json.html">json</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.timeline.model.html">telemetry.core.timeline.model</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-Import"><strong>Import</strong></a>(data)</dt></dl> +</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.user_agent.html b/tools/telemetry/docs/telemetry.core.user_agent.html new file mode 100644 index 0000000..eb69745 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.user_agent.html @@ -0,0 +1,33 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.user_agent</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.user_agent</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/user_agent.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/user_agent.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-GetChromeUserAgentArgumentFromType"><strong>GetChromeUserAgentArgumentFromType</strong></a>(user_agent_type)</dt><dd><tt>Returns a chrome user agent based on a user agent type.<br> +This is derived from:<br> +https://developers.google.com/chrome/mobile/docs/user-agent</tt></dd></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>UA_TYPE_MAPPING</strong> = {'desktop': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_3) A...TML, like Gecko) Chrome/25.0.1364.2 Safari/537.22', 'mobile': 'Mozilla/5.0 (Linux; Android 4.0.4; Galaxy Nexus ... Gecko) Chrome/18.0.1025.133 Mobile Safari/535.19', 'tablet': 'Mozilla/5.0 (Linux; Android 4.0.4; Galaxy Nexus ...L, like Gecko) Chrome/18.0.1025.133 Safari/535.19'}</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.util.html b/tools/telemetry/docs/telemetry.core.util.html new file mode 100644 index 0000000..a2537ce --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.util.html @@ -0,0 +1,138 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.util</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.util</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/util.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/util.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="inspect.html">inspect</a><br> +</td><td width="25%" valign=top><a href="os.html">os</a><br> +</td><td width="25%" valign=top><a href="socket.html">socket</a><br> +</td><td width="25%" valign=top><a href="time.html">time</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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.util.html#PortPair">PortPair</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.util.html#TimeoutException">TimeoutException</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> <br> +<font color="#000000" face="helvetica, arial"><a name="PortPair">class <strong>PortPair</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="PortPair-__init__"><strong>__init__</strong></a>(self, local_port, remote_port)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="TimeoutException">class <strong>TimeoutException</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.util.html#TimeoutException">TimeoutException</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><a name="TimeoutException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#TimeoutException-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#TimeoutException-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><a name="TimeoutException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#TimeoutException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="TimeoutException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#TimeoutException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="TimeoutException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#TimeoutException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="TimeoutException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#TimeoutException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="TimeoutException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="TimeoutException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#TimeoutException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="TimeoutException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#TimeoutException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="TimeoutException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="TimeoutException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#TimeoutException-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="TimeoutException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> + +<hr> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +<dl><dt><strong>message</strong></dt> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-CloseConnections"><strong>CloseConnections</strong></a>(tab)</dt><dd><tt>Closes all TCP sockets held open by the browser.</tt></dd></dl> + <dl><dt><a name="-FindElementAndPerformAction"><strong>FindElementAndPerformAction</strong></a>(tab, text, callback_code)</dt><dd><tt>JavaScript snippet for finding an element with a given text on a page.</tt></dd></dl> + <dl><dt><a name="-GetAvailableLocalPort"><strong>GetAvailableLocalPort</strong></a>()</dt></dl> + <dl><dt><a name="-GetChromiumSrcDir"><strong>GetChromiumSrcDir</strong></a>()</dt></dl> + <dl><dt><a name="-GetTelemetryDir"><strong>GetTelemetryDir</strong></a>()</dt></dl> + <dl><dt><a name="-GetUnittestDataDir"><strong>GetUnittestDataDir</strong></a>()</dt></dl> + <dl><dt><a name="-WaitFor"><strong>WaitFor</strong></a>(condition, timeout, poll_interval<font color="#909090">=0.1</font>, pass_time_left_to_func<font color="#909090">=False</font>)</dt></dl> +</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.web_contents.html b/tools/telemetry/docs/telemetry.core.web_contents.html new file mode 100644 index 0000000..7bd421a --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.web_contents.html @@ -0,0 +1,94 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.web_contents</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.web_contents</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/web_contents.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/web_contents.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ee77aa"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.web_contents.html#WebContents">WebContents</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> <br> +<font color="#000000" face="helvetica, arial"><a name="WebContents">class <strong>WebContents</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Represents web contents in the browser<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="WebContents-Close"><strong>Close</strong></a>(self)</dt><dd><tt>Closes this page.<br> + <br> +Not all browsers or browser versions support this method.<br> +Be sure to check browser.supports_tab_control.</tt></dd></dl> + +<dl><dt><a name="WebContents-Disconnect"><strong>Disconnect</strong></a>(self)</dt></dl> + +<dl><dt><a name="WebContents-EvaluateJavaScript"><strong>EvaluateJavaScript</strong></a>(self, expr, timeout<font color="#909090">=60</font>)</dt><dd><tt>Evalutes expr in JavaScript and returns the JSONized result.<br> + <br> +Consider using ExecuteJavaScript for cases where the result of the<br> +expression is not needed.<br> + <br> +If evaluation throws in JavaScript, a Python EvaluateException will<br> +be raised.<br> + <br> +If the result of the evaluation cannot be JSONized, then an<br> +EvaluationException will be raised.</tt></dd></dl> + +<dl><dt><a name="WebContents-ExecuteJavaScript"><strong>ExecuteJavaScript</strong></a>(self, expr, timeout<font color="#909090">=60</font>)</dt><dd><tt>Executes expr in JavaScript. Does not return the result.<br> + <br> +If the expression failed to evaluate, EvaluateException will be raised.</tt></dd></dl> + +<dl><dt><a name="WebContents-StartTimelineRecording"><strong>StartTimelineRecording</strong></a>(self)</dt></dl> + +<dl><dt><a name="WebContents-StopTimelineRecording"><strong>StopTimelineRecording</strong></a>(self)</dt></dl> + +<dl><dt><a name="WebContents-WaitForDocumentReadyStateToBeComplete"><strong>WaitForDocumentReadyStateToBeComplete</strong></a>(self, timeout<font color="#909090">=60</font>)</dt></dl> + +<dl><dt><a name="WebContents-WaitForDocumentReadyStateToBeInteractiveOrBetter"><strong>WaitForDocumentReadyStateToBeInteractiveOrBetter</strong></a>(self, timeout<font color="#909090">=60</font>)</dt></dl> + +<dl><dt><a name="WebContents-__del__"><strong>__del__</strong></a>(self)</dt></dl> + +<dl><dt><a name="WebContents-__init__"><strong>__init__</strong></a>(self, inspector_backend)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>message_output_stream</strong></dt> +</dl> +<dl><dt><strong>timeline_model</strong></dt> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>DEFAULT_WEB_CONTENTS_TIMEOUT</strong> = 60</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.wpr_modes.html b/tools/telemetry/docs/telemetry.core.wpr_modes.html new file mode 100644 index 0000000..dac4835 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.wpr_modes.html @@ -0,0 +1,25 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.wpr_modes</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.wpr_modes</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/wpr_modes.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/wpr_modes.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>WPR_OFF</strong> = 'wpr-off'<br> +<strong>WPR_RECORD</strong> = 'wpr-record'<br> +<strong>WPR_REPLAY</strong> = 'wpr-replay'</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.wpr_server.html b/tools/telemetry/docs/telemetry.core.wpr_server.html new file mode 100644 index 0000000..7677b22 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.wpr_server.html @@ -0,0 +1,74 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.core.wpr_server</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <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>.wpr_server</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/wpr_server.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/wpr_server.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="os.html">os</a><br> +</td><td width="25%" valign=top><a href="sys.html">sys</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.core.util</a><br> +</td><td width="25%" valign=top><a href="webpagereplay.html">webpagereplay</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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.wpr_server.html#ReplayServer">ReplayServer</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> <br> +<font color="#000000" face="helvetica, arial"><a name="ReplayServer">class <strong>ReplayServer</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="ReplayServer-Close"><strong>Close</strong></a>(self)</dt></dl> + +<dl><dt><a name="ReplayServer-__enter__"><strong>__enter__</strong></a>(self)</dt></dl> + +<dl><dt><a name="ReplayServer-__exit__"><strong>__exit__</strong></a>(self, *args)</dt></dl> + +<dl><dt><a name="ReplayServer-__init__"><strong>__init__</strong></a>(self, browser_backend, path, is_record_mode, is_append_mode, webpagereplay_host, webpagereplay_local_http_port, webpagereplay_local_https_port, webpagereplay_remote_http_port, webpagereplay_remote_https_port)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-GetChromeFlags"><strong>GetChromeFlags</strong></a>(replay_host, http_port, https_port)</dt></dl> +</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.html b/tools/telemetry/docs/telemetry.html new file mode 100644 index 0000000..5f3b8f0 --- /dev/null +++ b/tools/telemetry/docs/telemetry.html @@ -0,0 +1,481 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: package telemetry</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>telemetry</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/__init__.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/__init__.py</a></font></td></tr></table> + <p><tt>A library for cross-platform browser tests.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></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.html"><strong>core</strong> (package)</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.html"><strong>page</strong> (package)</a><br> +</td><td width="25%" valign=top><a href="telemetry.unittest.html"><strong>unittest</strong> (package)</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.browser.html#Browser">telemetry.core.browser.Browser</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="optparse.html#Values">optparse.Values</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.browser_options.html#BrowserOptions">telemetry.core.browser_options.BrowserOptions</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="telemetry.core.web_contents.html#WebContents">telemetry.core.web_contents.WebContents</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.core.tab.html#Tab">telemetry.core.tab.Tab</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_measurement.html#PageMeasurement">telemetry.page.page_measurement.PageMeasurement</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> <br> +<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> + +<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.<br> + <br> +To create a browser instance, use browser_finder.FindBrowser.<br> + <br> +Be sure to clean up after yourself by calling <a href="#Browser-Close">Close</a>() when you are done with<br> +the browser. Or better yet:<br> + browser_to_create = FindBrowser(options)<br> + with browser_to_create.Create() as browser:<br> + ... do all your operations on browser here<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="Browser-Close"><strong>Close</strong></a>(self)</dt><dd><tt>Closes this browser.</tt></dd></dl> + +<dl><dt><a name="Browser-GetStandardOutput"><strong>GetStandardOutput</strong></a>(self)</dt></dl> + +<dl><dt><a name="Browser-GetTraceResultAndReset"><strong>GetTraceResultAndReset</strong></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"><strong>SetHTTPServerDirectories</strong></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"><strong>SetReplayArchivePath</strong></a>(self, archive_path, append_to_existing_wpr<font color="#909090">=False</font>)</dt></dl> + +<dl><dt><a name="Browser-StartProfiling"><strong>StartProfiling</strong></a>(self, options, base_output_file)</dt><dd><tt>Starts profiling using |options|.profiler_tool. Results are saved to<br> +|base_output_file|.<process_name>.</tt></dd></dl> + +<dl><dt><a name="Browser-StartTracing"><strong>StartTracing</strong></a>(self, custom_categories<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="Browser-StopProfiling"><strong>StopProfiling</strong></a>(self)</dt><dd><tt>Stops all active profilers and saves their results.</tt></dd></dl> + +<dl><dt><a name="Browser-StopTracing"><strong>StopTracing</strong></a>(self)</dt></dl> + +<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> + +<dl><dt><a name="Browser-__init__"><strong>__init__</strong></a>(self, backend, platform_backend)</dt></dl> + +<dl><dt><a name="Browser-is_profiler_active"><strong>is_profiler_active</strong></a>(self, profiler_name)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>browser_type</strong></dt> +</dl> +<dl><dt><strong>extensions</strong></dt> +<dd><tt>Returns the extension dictionary if it exists.</tt></dd> +</dl> +<dl><dt><strong>http_server</strong></dt> +</dl> +<dl><dt><strong>io_stats</strong></dt> +<dd><tt>Returns a dict of IO statistics for the browser:<br> +{ 'Browser': {<br> + 'ReadOperationCount': W,<br> + 'WriteOperationCount': X,<br> + 'ReadTransferCount': Y,<br> + 'WriteTransferCount': Z<br> + },<br> + 'Gpu': {<br> + 'ReadOperationCount': W,<br> + 'WriteOperationCount': X,<br> + 'ReadTransferCount': Y,<br> + 'WriteTransferCount': Z<br> + },<br> + 'Renderer': {<br> + 'ReadOperationCount': W,<br> + 'WriteOperationCount': X,<br> + 'ReadTransferCount': Y,<br> + 'WriteTransferCount': Z<br> + }<br> +}</tt></dd> +</dl> +<dl><dt><strong>is_content_shell</strong></dt> +<dd><tt>Returns whether this browser is a content shell, only.</tt></dd> +</dl> +<dl><dt><strong>memory_stats</strong></dt> +<dd><tt>Returns a dict of memory statistics for the browser:<br> +{ 'Browser': {<br> + 'VM': S,<br> + 'VMPeak': T,<br> + 'WorkingSetSize': U,<br> + 'WorkingSetSizePeak': V,<br> + 'ProportionalSetSize': W,<br> + 'PrivateDirty': X<br> + },<br> + 'Gpu': {<br> + 'VM': S,<br> + 'VMPeak': T,<br> + 'WorkingSetSize': U,<br> + 'WorkingSetSizePeak': V,<br> + 'ProportionalSetSize': W,<br> + 'PrivateDirty': X<br> + },<br> + 'Renderer': {<br> + 'VM': S,<br> + 'VMPeak': T,<br> + 'WorkingSetSize': U,<br> + 'WorkingSetSizePeak': V,<br> + 'ProportionalSetSize': W,<br> + 'PrivateDirty': X<br> + },<br> + 'SystemCommitCharge': Y,<br> + 'ProcessCount': Z,<br> +}<br> +Any of the above keys may be missing on a per-platform basis.</tt></dd> +</dl> +<dl><dt><strong>platform</strong></dt> +</dl> +<dl><dt><strong>supports_extensions</strong></dt> +</dl> +<dl><dt><strong>supports_tab_control</strong></dt> +</dl> +<dl><dt><strong>supports_tracing</strong></dt> +</dl> +<dl><dt><strong>tabs</strong></dt> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="BrowserOptions">class <strong>BrowserOptions</strong></a>(<a href="optparse.html#Values">optparse.Values</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Options to be used for discovering and launching a browser.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="BrowserOptions-AppendExtraBrowserArg"><strong>AppendExtraBrowserArg</strong></a>(self, arg)</dt></dl> + +<dl><dt><a name="BrowserOptions-Copy"><strong>Copy</strong></a>(self)</dt></dl> + +<dl><dt><a name="BrowserOptions-CreateParser"><strong>CreateParser</strong></a>(self, *args, **kwargs)</dt></dl> + +<dl><dt><a name="BrowserOptions-__init__"><strong>__init__</strong></a>(self, browser_type<font color="#909090">=None</font>)</dt></dl> + +<hr> +Methods inherited from <a href="optparse.html#Values">optparse.Values</a>:<br> +<dl><dt><a name="BrowserOptions-__cmp__"><strong>__cmp__</strong></a>(self, other)</dt></dl> + +<dl><dt><a name="BrowserOptions-__repr__"><strong>__repr__</strong></a> = _repr(self)</dt></dl> + +<dl><dt><a name="BrowserOptions-__str__"><strong>__str__</strong></a>(self)</dt></dl> + +<dl><dt><a name="BrowserOptions-ensure_value"><strong>ensure_value</strong></a>(self, attr, value)</dt></dl> + +<dl><dt><a name="BrowserOptions-read_file"><strong>read_file</strong></a>(self, filename, mode<font color="#909090">='careful'</font>)</dt></dl> + +<dl><dt><a name="BrowserOptions-read_module"><strong>read_module</strong></a>(self, modname, mode<font color="#909090">='careful'</font>)</dt></dl> + +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="PageMeasurement">class <strong>PageMeasurement</strong></a>(<a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Glue code for running a measurement across a set of pages.<br> + <br> +To use this, subclass from the measurement and override MeasurePage. For<br> +example:<br> + <br> + class BodyChildElementMeasurement(<a href="#PageMeasurement">PageMeasurement</a>):<br> + def <a href="#PageMeasurement-MeasurePage">MeasurePage</a>(self, page, tab, results):<br> + body_child_count = tab.EvaluateJavaScript(<br> + 'document.body.children.length')<br> + results.Add('body_children', 'count', body_child_count)<br> + <br> + if __name__ == '__main__':<br> + page_measurement.Main(BodyChildElementMeasurement())<br> + <br> +To add test-specific options:<br> + <br> + class BodyChildElementMeasurement(<a href="#PageMeasurement">PageMeasurement</a>):<br> + def <a href="#PageMeasurement-AddCommandLineOptions">AddCommandLineOptions</a>(parser):<br> + parser.add_option('--element', action='store', default='body')<br> + <br> + def <a href="#PageMeasurement-MeasurePage">MeasurePage</a>(self, page, tab, results):<br> + body_child_count = tab.EvaluateJavaScript(<br> + 'document.querySelector('%s').children.length')<br> + results.Add('children', 'count', child_count)<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.page.page_measurement.html#PageMeasurement">PageMeasurement</a></dd> +<dd><a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="PageMeasurement-AddOutputOptions"><strong>AddOutputOptions</strong></a>(self, parser)</dt></dl> + +<dl><dt><a name="PageMeasurement-MeasurePage"><strong>MeasurePage</strong></a>(self, page, tab, results)</dt><dd><tt>Override to actually measure the page's performance.<br> + <br> +page is a page_set.Page<br> +tab is an instance of telemetry.core.<a href="#Tab">Tab</a><br> + <br> +Should call results.Add(name, units, value) for each result, or raise an<br> +exception on failure. The name and units of each Add() call must be<br> +the same across all iterations. The name 'url' must not be used.<br> + <br> +Prefer field names that are in accordance with python variable style. E.g.<br> +field_name.<br> + <br> +Put together:<br> + <br> + def <a href="#PageMeasurement-MeasurePage">MeasurePage</a>(self, page, tab, results):<br> + res = tab.EvaluateJavaScript('2+2')<br> + if res != 4:<br> + raise Exception('Oh, wow.')<br> + results.Add('two_plus_two', 'count', res)</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-PrepareResults"><strong>PrepareResults</strong></a>(self, options)</dt></dl> + +<dl><dt><a name="PageMeasurement-__init__"><strong>__init__</strong></a>(self, action_name_to_run<font color="#909090">=''</font>, needs_browser_restart_after_each_run<font color="#909090">=False</font>, discard_first_result<font color="#909090">=False</font>)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>output_format_choices</strong></dt> +</dl> +<dl><dt><strong>results_are_the_same_on_every_page</strong></dt> +<dd><tt>By default, measurements are assumed to output the same values for every<br> +page. This allows incremental output, for example in CSV. If, however, the<br> +measurement discovers what values it can report as it goes, and those values<br> +may vary from page to page, you need to override this function and return<br> +False. Output will not appear in this mode until the entire pageset has<br> +run.</tt></dd> +</dl> +<hr> +Methods inherited from <a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>:<br> +<dl><dt><a name="PageMeasurement-AddCommandLineOptions"><strong>AddCommandLineOptions</strong></a>(self, parser)</dt><dd><tt>Override to expose command-line options for this test.<br> + <br> +The provided parser is an optparse.OptionParser instance and accepts all<br> +normal results. The parsed options are available in Run as<br> +self.<strong>options</strong>.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-CanRunForPage"><strong>CanRunForPage</strong></a>(self, page)</dt><dd><tt>Override to customize if the test can be ran for the given page.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-CreatePageSet"><strong>CreatePageSet</strong></a>(self, args, options)</dt><dd><tt>Override to make this test generate its own page set instead of<br> +allowing arbitrary page sets entered from the command-line.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-CustomizeBrowserOptions"><strong>CustomizeBrowserOptions</strong></a>(self, options)</dt><dd><tt>Override to add test-specific options to the <a href="#BrowserOptions">BrowserOptions</a> <a href="__builtin__.html#object">object</a></tt></dd></dl> + +<dl><dt><a name="PageMeasurement-CustomizeBrowserOptionsForPage"><strong>CustomizeBrowserOptionsForPage</strong></a>(self, page, options)</dt><dd><tt>Add options specific to the test and the given page.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-DidNavigateToPage"><strong>DidNavigateToPage</strong></a>(self, page, tab)</dt><dd><tt>Override to do operations right after the page is navigated, but before<br> +any waiting for completion has occurred.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-DidRunAction"><strong>DidRunAction</strong></a>(self, page, tab, action)</dt><dd><tt>Override to do operations after running the action on the page.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-DidRunPageSet"><strong>DidRunPageSet</strong></a>(self, tab, results)</dt><dd><tt>Override to do operations after page set is completed, but before browser<br> +is torn down.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-DidStartHTTPServer"><strong>DidStartHTTPServer</strong></a>(self, tab)</dt><dd><tt>Override to do operations after the HTTP server is started.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-NeedsBrowserRestartAfterEachRun"><strong>NeedsBrowserRestartAfterEachRun</strong></a>(self, tab)</dt><dd><tt>Override to specify browser restart after each run.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-Run"><strong>Run</strong></a>(self, options, page, tab, results)</dt></dl> + +<dl><dt><a name="PageMeasurement-SetUpBrowser"><strong>SetUpBrowser</strong></a>(self, browser)</dt><dd><tt>Override to customize the browser right after it has launched.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-WillNavigateToPage"><strong>WillNavigateToPage</strong></a>(self, page, tab)</dt><dd><tt>Override to do operations before the page is navigated.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-WillRunAction"><strong>WillRunAction</strong></a>(self, page, tab, action)</dt><dd><tt>Override to do operations before running the action on the page.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-WillRunPageSet"><strong>WillRunPageSet</strong></a>(self, tab)</dt><dd><tt>Override to do operations before the page set is navigated.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>action_name_to_run</strong></dt> +</dl> +<dl><dt><strong>discard_first_result</strong></dt> +<dd><tt>When set to True, the first run of the test is discarded. This is<br> +useful for cases where it's desirable to have some test resource cached so<br> +the first run of the test can warm things up.</tt></dd> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="Tab">class <strong>Tab</strong></a>(<a href="telemetry.core.web_contents.html#WebContents">telemetry.core.web_contents.WebContents</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Represents a tab in the browser<br> + <br> +The important parts of the <a href="#Tab">Tab</a> <a href="__builtin__.html#object">object</a> are in the runtime and page objects.<br> +E.g.:<br> + # Navigates the tab to a given url.<br> + tab.<a href="#Tab-Navigate">Navigate</a>('<a href="http://www.google.com/">http://www.google.com/</a>')<br> + <br> + # Evaluates 1+1 in the tab's JavaScript context.<br> + tab.Evaluate('1+1')<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.core.tab.html#Tab">Tab</a></dd> +<dd><a href="telemetry.core.web_contents.html#WebContents">telemetry.core.web_contents.WebContents</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="Tab-Activate"><strong>Activate</strong></a>(self)</dt><dd><tt>Brings this tab to the foreground asynchronously.<br> + <br> +Not all browsers or browser versions support this method.<br> +Be sure to check browser.supports_tab_control.<br> + <br> +Please note: this is asynchronous. There is a delay between this call<br> +and the page's documentVisibilityState becoming 'visible', and yet more<br> +delay until the actual tab is visible to the user. None of these delays<br> +are included in this call.</tt></dd></dl> + +<dl><dt><a name="Tab-CollectGarbage"><strong>CollectGarbage</strong></a>(self)</dt></dl> + +<dl><dt><a name="Tab-GetCookieByName"><strong>GetCookieByName</strong></a>(self, name, timeout<font color="#909090">=60</font>)</dt><dd><tt>Returns the value of the cookie by the given |name|.</tt></dd></dl> + +<dl><dt><a name="Tab-Navigate"><strong>Navigate</strong></a>(self, url, script_to_evaluate_on_commit<font color="#909090">=None</font>, timeout<font color="#909090">=60</font>)</dt><dd><tt>Navigates to url.<br> + <br> +If |script_to_evaluate_on_commit| is given, the script source string will be<br> +evaluated when the navigation is committed. This is after the context of<br> +the page exists, but before any script on the page itself has executed.</tt></dd></dl> + +<dl><dt><a name="Tab-PerformActionAndWaitForNavigate"><strong>PerformActionAndWaitForNavigate</strong></a>(self, action_function, timeout<font color="#909090">=60</font>)</dt><dd><tt>Executes action_function, and waits for the navigation to complete.<br> + <br> +action_function must be a Python function that results in a navigation.<br> +This function returns when the navigation is complete or when<br> +the timeout has been exceeded.</tt></dd></dl> + +<dl><dt><a name="Tab-Screenshot"><strong>Screenshot</strong></a>(self, timeout<font color="#909090">=60</font>)</dt><dd><tt>Capture a screenshot of the window for rendering validation</tt></dd></dl> + +<dl><dt><a name="Tab-__del__"><strong>__del__</strong></a>(self)</dt></dl> + +<dl><dt><a name="Tab-__init__"><strong>__init__</strong></a>(self, inspector_backend)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>browser</strong></dt> +<dd><tt>The browser in which this tab resides.</tt></dd> +</dl> +<dl><dt><strong>dom_stats</strong></dt> +<dd><tt>A dictionary populated with measured DOM statistics.<br> + <br> +Currently this dictionary contains:<br> +{<br> + 'document_count': integer,<br> + 'node_count': integer,<br> + 'event_listener_count': integer<br> +}</tt></dd> +</dl> +<dl><dt><strong>screenshot_supported</strong></dt> +<dd><tt>True if the browser instance is capable of capturing screenshots</tt></dd> +</dl> +<dl><dt><strong>url</strong></dt> +</dl> +<hr> +Methods inherited from <a href="telemetry.core.web_contents.html#WebContents">telemetry.core.web_contents.WebContents</a>:<br> +<dl><dt><a name="Tab-Close"><strong>Close</strong></a>(self)</dt><dd><tt>Closes this page.<br> + <br> +Not all browsers or browser versions support this method.<br> +Be sure to check browser.supports_tab_control.</tt></dd></dl> + +<dl><dt><a name="Tab-Disconnect"><strong>Disconnect</strong></a>(self)</dt></dl> + +<dl><dt><a name="Tab-EvaluateJavaScript"><strong>EvaluateJavaScript</strong></a>(self, expr, timeout<font color="#909090">=60</font>)</dt><dd><tt>Evalutes expr in JavaScript and returns the JSONized result.<br> + <br> +Consider using ExecuteJavaScript for cases where the result of the<br> +expression is not needed.<br> + <br> +If evaluation throws in JavaScript, a Python EvaluateException will<br> +be raised.<br> + <br> +If the result of the evaluation cannot be JSONized, then an<br> +EvaluationException will be raised.</tt></dd></dl> + +<dl><dt><a name="Tab-ExecuteJavaScript"><strong>ExecuteJavaScript</strong></a>(self, expr, timeout<font color="#909090">=60</font>)</dt><dd><tt>Executes expr in JavaScript. Does not return the result.<br> + <br> +If the expression failed to evaluate, EvaluateException will be raised.</tt></dd></dl> + +<dl><dt><a name="Tab-StartTimelineRecording"><strong>StartTimelineRecording</strong></a>(self)</dt></dl> + +<dl><dt><a name="Tab-StopTimelineRecording"><strong>StopTimelineRecording</strong></a>(self)</dt></dl> + +<dl><dt><a name="Tab-WaitForDocumentReadyStateToBeComplete"><strong>WaitForDocumentReadyStateToBeComplete</strong></a>(self, timeout<font color="#909090">=60</font>)</dt></dl> + +<dl><dt><a name="Tab-WaitForDocumentReadyStateToBeInteractiveOrBetter"><strong>WaitForDocumentReadyStateToBeInteractiveOrBetter</strong></a>(self, timeout<font color="#909090">=60</font>)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.core.web_contents.html#WebContents">telemetry.core.web_contents.WebContents</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>message_output_stream</strong></dt> +</dl> +<dl><dt><strong>timeline_model</strong></dt> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-RunPage"><strong>RunPage</strong></a> = Run(test, page_set, options)</dt><dd><tt>Runs a given test against a given page_set with the given options.</tt></dd></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>__all__</strong> = ['Browser', 'BrowserOptions', 'PageMeasurement', 'RunPage', 'Tab']</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.actions.all_page_actions.html b/tools/telemetry/docs/telemetry.page.actions.all_page_actions.html new file mode 100644 index 0000000..2c94152 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.actions.all_page_actions.html @@ -0,0 +1,36 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.actions.all_page_actions</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.<a href="telemetry.page.actions.html"><font color="#ffffff">actions</font></a>.all_page_actions</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/all_page_actions.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/all_page_actions.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.discover.html">telemetry.core.discover</a><br> +</td><td width="25%" valign=top><a href="os.html">os</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.actions.page_action.html">telemetry.page.actions.page_action</a><br> +</td><td width="25%" valign=top></td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-FindClassWithName"><strong>FindClassWithName</strong></a>(name)</dt></dl> + <dl><dt><a name="-GetAllClasses"><strong>GetAllClasses</strong></a>()</dt></dl> + <dl><dt><a name="-RegisterClassForTest"><strong>RegisterClassForTest</strong></a>(name, clazz)</dt></dl> +</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.actions.click_element.html b/tools/telemetry/docs/telemetry.page.actions.click_element.html new file mode 100644 index 0000000..b6b227c --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.actions.click_element.html @@ -0,0 +1,99 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.actions.click_element</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.<a href="telemetry.page.actions.html"><font color="#ffffff">actions</font></a>.click_element</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/click_element.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/click_element.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.exceptions.html">telemetry.core.exceptions</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.actions.page_action.html">telemetry.page.actions.page_action</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.page.html">telemetry.page.page</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.core.util</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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.actions.click_element.html#ClickElementAction">ClickElementAction</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> <br> +<font color="#000000" face="helvetica, arial"><a name="ClickElementAction">class <strong>ClickElementAction</strong></a>(<a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.page.actions.click_element.html#ClickElementAction">ClickElementAction</a></dd> +<dd><a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="ClickElementAction-RunAction"><strong>RunAction</strong></a>(self, page, tab, previous_action)</dt></dl> + +<dl><dt><a name="ClickElementAction-__init__"><strong>__init__</strong></a>(self, attributes<font color="#909090">=None</font>)</dt></dl> + +<hr> +Methods inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:<br> +<dl><dt><a name="ClickElementAction-BindMeasurementJavaScript"><strong>BindMeasurementJavaScript</strong></a>(self, tab, start_js, stop_js)</dt><dd><tt>Let this action determine when measurements should start and stop.<br> + <br> +A measurement can call this method to provide the action<br> +with JavaScript code that starts and stops measurements. The action<br> +determines when to execute the provided JavaScript code, for more accurate<br> +timings.<br> + <br> +Args:<br> + tab: The tab to do everything on.<br> + start_js: JavaScript code that starts measurements.<br> + stop_js: JavaScript code that stops measurements.</tt></dd></dl> + +<dl><dt><a name="ClickElementAction-CanBeBound"><strong>CanBeBound</strong></a>(self)</dt><dd><tt>If this class implements BindMeasurementJavaScript, override CanBeBound<br> +to return True so that a test knows it can bind measurements.</tt></dd></dl> + +<dl><dt><a name="ClickElementAction-CleanUp"><strong>CleanUp</strong></a>(self, page, tab)</dt></dl> + +<dl><dt><a name="ClickElementAction-CustomizeBrowserOptions"><strong>CustomizeBrowserOptions</strong></a>(self, options)</dt><dd><tt>Override to add action-specific options to the BrowserOptions<br> +object.</tt></dd></dl> + +<dl><dt><a name="ClickElementAction-RunsPreviousAction"><strong>RunsPreviousAction</strong></a>(self)</dt><dd><tt>Some actions require some initialization to be performed before the<br> +previous action. For example, wait for href change needs to record the old<br> +href before the previous action changes it. Therefore, we allow actions to<br> +run the previous action. An action that does this should override this to<br> +return True in order to prevent the previous action from being run twice.</tt></dd></dl> + +<dl><dt><a name="ClickElementAction-WillRunAction"><strong>WillRunAction</strong></a>(self, page, tab)</dt><dd><tt>Override to do action-specific setup before<br> +Test.WillRunAction is called.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.actions.html b/tools/telemetry/docs/telemetry.page.actions.html new file mode 100644 index 0000000..838387b --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.actions.html @@ -0,0 +1,31 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: package telemetry.page.actions</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.actions</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/__init__.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/__init__.py</a></font></td></tr></table> + <p></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></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.page.actions.all_page_actions.html">all_page_actions</a><br> +<a href="telemetry.page.actions.click_element.html">click_element</a><br> +<a href="telemetry.page.actions.click_element_unittest.html">click_element_unittest</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.actions.js_collect_garbage.html">js_collect_garbage</a><br> +<a href="telemetry.page.actions.page_action.html">page_action</a><br> +<a href="telemetry.page.actions.reload.html">reload</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.actions.scroll.html">scroll</a><br> +<a href="telemetry.page.actions.scroll_unittest.html">scroll_unittest</a><br> +<a href="telemetry.page.actions.wait.html">wait</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.actions.wait_unittest.html">wait_unittest</a><br> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.actions.js_collect_garbage.html b/tools/telemetry/docs/telemetry.page.actions.js_collect_garbage.html new file mode 100644 index 0000000..774a784 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.actions.js_collect_garbage.html @@ -0,0 +1,96 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.actions.js_collect_garbage</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.<a href="telemetry.page.actions.html"><font color="#ffffff">actions</font></a>.js_collect_garbage</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/js_collect_garbage.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/js_collect_garbage.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.page.actions.page_action.html">telemetry.page.actions.page_action</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.actions.js_collect_garbage.html#JsCollectGarbageAction">JsCollectGarbageAction</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> <br> +<font color="#000000" face="helvetica, arial"><a name="JsCollectGarbageAction">class <strong>JsCollectGarbageAction</strong></a>(<a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.page.actions.js_collect_garbage.html#JsCollectGarbageAction">JsCollectGarbageAction</a></dd> +<dd><a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="JsCollectGarbageAction-RunAction"><strong>RunAction</strong></a>(self, page, tab, previous_action)</dt></dl> + +<dl><dt><a name="JsCollectGarbageAction-__init__"><strong>__init__</strong></a>(self, attributes<font color="#909090">=None</font>)</dt></dl> + +<hr> +Methods inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:<br> +<dl><dt><a name="JsCollectGarbageAction-BindMeasurementJavaScript"><strong>BindMeasurementJavaScript</strong></a>(self, tab, start_js, stop_js)</dt><dd><tt>Let this action determine when measurements should start and stop.<br> + <br> +A measurement can call this method to provide the action<br> +with JavaScript code that starts and stops measurements. The action<br> +determines when to execute the provided JavaScript code, for more accurate<br> +timings.<br> + <br> +Args:<br> + tab: The tab to do everything on.<br> + start_js: JavaScript code that starts measurements.<br> + stop_js: JavaScript code that stops measurements.</tt></dd></dl> + +<dl><dt><a name="JsCollectGarbageAction-CanBeBound"><strong>CanBeBound</strong></a>(self)</dt><dd><tt>If this class implements BindMeasurementJavaScript, override CanBeBound<br> +to return True so that a test knows it can bind measurements.</tt></dd></dl> + +<dl><dt><a name="JsCollectGarbageAction-CleanUp"><strong>CleanUp</strong></a>(self, page, tab)</dt></dl> + +<dl><dt><a name="JsCollectGarbageAction-CustomizeBrowserOptions"><strong>CustomizeBrowserOptions</strong></a>(self, options)</dt><dd><tt>Override to add action-specific options to the BrowserOptions<br> +object.</tt></dd></dl> + +<dl><dt><a name="JsCollectGarbageAction-RunsPreviousAction"><strong>RunsPreviousAction</strong></a>(self)</dt><dd><tt>Some actions require some initialization to be performed before the<br> +previous action. For example, wait for href change needs to record the old<br> +href before the previous action changes it. Therefore, we allow actions to<br> +run the previous action. An action that does this should override this to<br> +return True in order to prevent the previous action from being run twice.</tt></dd></dl> + +<dl><dt><a name="JsCollectGarbageAction-WillRunAction"><strong>WillRunAction</strong></a>(self, page, tab)</dt><dd><tt>Override to do action-specific setup before<br> +Test.WillRunAction is called.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.actions.page_action.html b/tools/telemetry/docs/telemetry.page.actions.page_action.html new file mode 100644 index 0000000..4ca1b52 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.actions.page_action.html @@ -0,0 +1,205 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.actions.page_action</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.<a href="telemetry.page.actions.html"><font color="#ffffff">actions</font></a>.page_action</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/page_action.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/page_action.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ee77aa"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.actions.page_action.html#PageAction">PageAction</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.actions.page_action.html#PageActionFailed">PageActionFailed</a> +</font></dt><dt><font face="helvetica, arial"><a href="telemetry.page.actions.page_action.html#PageActionNotSupported">PageActionNotSupported</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> <br> +<font color="#000000" face="helvetica, arial"><a name="PageAction">class <strong>PageAction</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Represents an action that a user might try to perform to a page.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="PageAction-BindMeasurementJavaScript"><strong>BindMeasurementJavaScript</strong></a>(self, tab, start_js, stop_js)</dt><dd><tt>Let this action determine when measurements should start and stop.<br> + <br> +A measurement can call this method to provide the action<br> +with JavaScript code that starts and stops measurements. The action<br> +determines when to execute the provided JavaScript code, for more accurate<br> +timings.<br> + <br> +Args:<br> + tab: The tab to do everything on.<br> + start_js: JavaScript code that starts measurements.<br> + stop_js: JavaScript code that stops measurements.</tt></dd></dl> + +<dl><dt><a name="PageAction-CanBeBound"><strong>CanBeBound</strong></a>(self)</dt><dd><tt>If this class implements BindMeasurementJavaScript, override CanBeBound<br> +to return True so that a test knows it can bind measurements.</tt></dd></dl> + +<dl><dt><a name="PageAction-CleanUp"><strong>CleanUp</strong></a>(self, page, tab)</dt></dl> + +<dl><dt><a name="PageAction-CustomizeBrowserOptions"><strong>CustomizeBrowserOptions</strong></a>(self, options)</dt><dd><tt>Override to add action-specific options to the BrowserOptions<br> +<a href="__builtin__.html#object">object</a>.</tt></dd></dl> + +<dl><dt><a name="PageAction-RunAction"><strong>RunAction</strong></a>(self, page, tab, previous_action)</dt></dl> + +<dl><dt><a name="PageAction-RunsPreviousAction"><strong>RunsPreviousAction</strong></a>(self)</dt><dd><tt>Some actions require some initialization to be performed before the<br> +previous action. For example, wait for href change needs to record the old<br> +href before the previous action changes it. Therefore, we allow actions to<br> +run the previous action. An action that does this should override this to<br> +return True in order to prevent the previous action from being run twice.</tt></dd></dl> + +<dl><dt><a name="PageAction-WillRunAction"><strong>WillRunAction</strong></a>(self, page, tab)</dt><dd><tt>Override to do action-specific setup before<br> +Test.WillRunAction is called.</tt></dd></dl> + +<dl><dt><a name="PageAction-__init__"><strong>__init__</strong></a>(self, attributes<font color="#909090">=None</font>)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="PageActionFailed">class <strong>PageActionFailed</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.page.actions.page_action.html#PageActionFailed">PageActionFailed</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><a name="PageActionFailed-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#PageActionFailed-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><a name="PageActionFailed-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="PageActionFailed-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="PageActionFailed-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="PageActionFailed-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="PageActionFailed-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="PageActionFailed-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="PageActionFailed-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="PageActionFailed-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="PageActionFailed-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="PageActionFailed-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> + +<hr> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +<dl><dt><strong>message</strong></dt> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="PageActionNotSupported">class <strong>PageActionNotSupported</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.page.actions.page_action.html#PageActionNotSupported">PageActionNotSupported</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><a name="PageActionNotSupported-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#PageActionNotSupported-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><a name="PageActionNotSupported-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="PageActionNotSupported-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="PageActionNotSupported-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="PageActionNotSupported-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="PageActionNotSupported-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="PageActionNotSupported-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="PageActionNotSupported-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="PageActionNotSupported-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="PageActionNotSupported-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="PageActionNotSupported-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> + +<hr> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +<dl><dt><strong>message</strong></dt> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.actions.reload.html b/tools/telemetry/docs/telemetry.page.actions.reload.html new file mode 100644 index 0000000..64ee4fd --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.actions.reload.html @@ -0,0 +1,97 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.actions.reload</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.<a href="telemetry.page.actions.html"><font color="#ffffff">actions</font></a>.reload</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/reload.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/reload.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.page.actions.page_action.html">telemetry.page.actions.page_action</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.page.html">telemetry.page.page</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.actions.reload.html#ReloadAction">ReloadAction</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> <br> +<font color="#000000" face="helvetica, arial"><a name="ReloadAction">class <strong>ReloadAction</strong></a>(<a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.page.actions.reload.html#ReloadAction">ReloadAction</a></dd> +<dd><a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="ReloadAction-RunAction"><strong>RunAction</strong></a>(self, page, tab, previous_action)</dt></dl> + +<dl><dt><a name="ReloadAction-__init__"><strong>__init__</strong></a>(self, attributes<font color="#909090">=None</font>)</dt></dl> + +<hr> +Methods inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:<br> +<dl><dt><a name="ReloadAction-BindMeasurementJavaScript"><strong>BindMeasurementJavaScript</strong></a>(self, tab, start_js, stop_js)</dt><dd><tt>Let this action determine when measurements should start and stop.<br> + <br> +A measurement can call this method to provide the action<br> +with JavaScript code that starts and stops measurements. The action<br> +determines when to execute the provided JavaScript code, for more accurate<br> +timings.<br> + <br> +Args:<br> + tab: The tab to do everything on.<br> + start_js: JavaScript code that starts measurements.<br> + stop_js: JavaScript code that stops measurements.</tt></dd></dl> + +<dl><dt><a name="ReloadAction-CanBeBound"><strong>CanBeBound</strong></a>(self)</dt><dd><tt>If this class implements BindMeasurementJavaScript, override CanBeBound<br> +to return True so that a test knows it can bind measurements.</tt></dd></dl> + +<dl><dt><a name="ReloadAction-CleanUp"><strong>CleanUp</strong></a>(self, page, tab)</dt></dl> + +<dl><dt><a name="ReloadAction-CustomizeBrowserOptions"><strong>CustomizeBrowserOptions</strong></a>(self, options)</dt><dd><tt>Override to add action-specific options to the BrowserOptions<br> +object.</tt></dd></dl> + +<dl><dt><a name="ReloadAction-RunsPreviousAction"><strong>RunsPreviousAction</strong></a>(self)</dt><dd><tt>Some actions require some initialization to be performed before the<br> +previous action. For example, wait for href change needs to record the old<br> +href before the previous action changes it. Therefore, we allow actions to<br> +run the previous action. An action that does this should override this to<br> +return True in order to prevent the previous action from being run twice.</tt></dd></dl> + +<dl><dt><a name="ReloadAction-WillRunAction"><strong>WillRunAction</strong></a>(self, page, tab)</dt><dd><tt>Override to do action-specific setup before<br> +Test.WillRunAction is called.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.actions.scroll.html b/tools/telemetry/docs/telemetry.page.actions.scroll.html new file mode 100644 index 0000000..6f24a5a --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.actions.scroll.html @@ -0,0 +1,86 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.actions.scroll</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.<a href="telemetry.page.actions.html"><font color="#ffffff">actions</font></a>.scroll</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/scroll.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/scroll.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="os.html">os</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.actions.page_action.html">telemetry.page.actions.page_action</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.core.util</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.actions.scroll.html#ScrollAction">ScrollAction</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> <br> +<font color="#000000" face="helvetica, arial"><a name="ScrollAction">class <strong>ScrollAction</strong></a>(<a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.page.actions.scroll.html#ScrollAction">ScrollAction</a></dd> +<dd><a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="ScrollAction-BindMeasurementJavaScript"><strong>BindMeasurementJavaScript</strong></a>(self, tab, start_js, stop_js)</dt></dl> + +<dl><dt><a name="ScrollAction-CanBeBound"><strong>CanBeBound</strong></a>(self)</dt></dl> + +<dl><dt><a name="ScrollAction-RunAction"><strong>RunAction</strong></a>(self, page, tab, previous_action)</dt></dl> + +<dl><dt><a name="ScrollAction-WillRunAction"><strong>WillRunAction</strong></a>(self, page, tab)</dt></dl> + +<dl><dt><a name="ScrollAction-__init__"><strong>__init__</strong></a>(self, attributes<font color="#909090">=None</font>)</dt></dl> + +<hr> +Methods inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:<br> +<dl><dt><a name="ScrollAction-CleanUp"><strong>CleanUp</strong></a>(self, page, tab)</dt></dl> + +<dl><dt><a name="ScrollAction-CustomizeBrowserOptions"><strong>CustomizeBrowserOptions</strong></a>(self, options)</dt><dd><tt>Override to add action-specific options to the BrowserOptions<br> +object.</tt></dd></dl> + +<dl><dt><a name="ScrollAction-RunsPreviousAction"><strong>RunsPreviousAction</strong></a>(self)</dt><dd><tt>Some actions require some initialization to be performed before the<br> +previous action. For example, wait for href change needs to record the old<br> +href before the previous action changes it. Therefore, we allow actions to<br> +run the previous action. An action that does this should override this to<br> +return True in order to prevent the previous action from being run twice.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.actions.wait.html b/tools/telemetry/docs/telemetry.page.actions.wait.html new file mode 100644 index 0000000..1219cca --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.actions.wait.html @@ -0,0 +1,98 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.actions.wait</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.<a href="telemetry.page.actions.html"><font color="#ffffff">actions</font></a>.wait</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/wait.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/wait.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.page.actions.page_action.html">telemetry.page.actions.page_action</a><br> +</td><td width="25%" valign=top><a href="time.html">time</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.core.util</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.actions.wait.html#WaitAction">WaitAction</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> <br> +<font color="#000000" face="helvetica, arial"><a name="WaitAction">class <strong>WaitAction</strong></a>(<a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.page.actions.wait.html#WaitAction">WaitAction</a></dd> +<dd><a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="WaitAction-RunAction"><strong>RunAction</strong></a>(self, page, tab, previous_action)</dt></dl> + +<dl><dt><a name="WaitAction-RunsPreviousAction"><strong>RunsPreviousAction</strong></a>(self)</dt></dl> + +<dl><dt><a name="WaitAction-__init__"><strong>__init__</strong></a>(self, attributes<font color="#909090">=None</font>)</dt></dl> + +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>DEFAULT_TIMEOUT</strong> = 60</dl> + +<hr> +Methods inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:<br> +<dl><dt><a name="WaitAction-BindMeasurementJavaScript"><strong>BindMeasurementJavaScript</strong></a>(self, tab, start_js, stop_js)</dt><dd><tt>Let this action determine when measurements should start and stop.<br> + <br> +A measurement can call this method to provide the action<br> +with JavaScript code that starts and stops measurements. The action<br> +determines when to execute the provided JavaScript code, for more accurate<br> +timings.<br> + <br> +Args:<br> + tab: The tab to do everything on.<br> + start_js: JavaScript code that starts measurements.<br> + stop_js: JavaScript code that stops measurements.</tt></dd></dl> + +<dl><dt><a name="WaitAction-CanBeBound"><strong>CanBeBound</strong></a>(self)</dt><dd><tt>If this class implements BindMeasurementJavaScript, override CanBeBound<br> +to return True so that a test knows it can bind measurements.</tt></dd></dl> + +<dl><dt><a name="WaitAction-CleanUp"><strong>CleanUp</strong></a>(self, page, tab)</dt></dl> + +<dl><dt><a name="WaitAction-CustomizeBrowserOptions"><strong>CustomizeBrowserOptions</strong></a>(self, options)</dt><dd><tt>Override to add action-specific options to the BrowserOptions<br> +object.</tt></dd></dl> + +<dl><dt><a name="WaitAction-WillRunAction"><strong>WillRunAction</strong></a>(self, page, tab)</dt><dd><tt>Override to do action-specific setup before<br> +Test.WillRunAction is called.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.block_page_measurement_results.html b/tools/telemetry/docs/telemetry.page.block_page_measurement_results.html new file mode 100644 index 0000000..1c5fe72 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.block_page_measurement_results.html @@ -0,0 +1,144 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.block_page_measurement_results</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.block_page_measurement_results</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/block_page_measurement_results.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/block_page_measurement_results.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="os.html">os</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.page_measurement_results.html">telemetry.page.page_measurement_results</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a>(<a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.block_page_measurement_results.html#BlockPageMeasurementResults">BlockPageMeasurementResults</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> <br> +<font color="#000000" face="helvetica, arial"><a name="BlockPageMeasurementResults">class <strong>BlockPageMeasurementResults</strong></a>(<a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.page.block_page_measurement_results.html#BlockPageMeasurementResults">BlockPageMeasurementResults</a></dd> +<dd><a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a></dd> +<dd><a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a></dd> +<dd><a href="unittest.result.html#TestResult">unittest.result.TestResult</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="BlockPageMeasurementResults-DidMeasurePage"><strong>DidMeasurePage</strong></a>(self)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-__init__"><strong>__init__</strong></a>(self, output_file)</dt></dl> + +<hr> +Methods inherited from <a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a>:<br> +<dl><dt><a name="BlockPageMeasurementResults-Add"><strong>Add</strong></a>(self, trace_name, units, value, chart_name<font color="#909090">=None</font>, data_type<font color="#909090">='default'</font>)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-AddSummary"><strong>AddSummary</strong></a>(self, trace_name, units, value, chart_name<font color="#909090">=None</font>, data_type<font color="#909090">='default'</font>)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-WillMeasurePage"><strong>WillMeasurePage</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-__getitem__"><strong>__getitem__</strong></a>(self, i)</dt><dd><tt>Shorthand for self.<strong>page_results</strong>[i]</tt></dd></dl> + +<dl><dt><a name="BlockPageMeasurementResults-__len__"><strong>__len__</strong></a>(self)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a>:<br> +<dl><dt><strong>all_measurements_that_have_been_seen</strong></dt> +</dl> +<dl><dt><strong>page_results</strong></dt> +</dl> +<dl><dt><strong>values_for_current_page</strong></dt> +</dl> +<hr> +Methods inherited from <a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a>:<br> +<dl><dt><a name="BlockPageMeasurementResults-AddError"><strong>AddError</strong></a>(self, page, err)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-AddErrorMessage"><strong>AddErrorMessage</strong></a>(self, page, message)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-AddFailure"><strong>AddFailure</strong></a>(self, page, err)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-AddFailureMessage"><strong>AddFailureMessage</strong></a>(self, page, message)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-AddSkip"><strong>AddSkip</strong></a>(self, page, reason)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-AddSuccess"><strong>AddSuccess</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-PrintSummary"><strong>PrintSummary</strong></a>(self)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-StartTest"><strong>StartTest</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-StopTest"><strong>StopTest</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-addSkip"><strong>addSkip</strong></a>(self, test, reason)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-addSuccess"><strong>addSuccess</strong></a>(self, test)</dt></dl> + +<hr> +Methods inherited from <a href="unittest.result.html#TestResult">unittest.result.TestResult</a>:<br> +<dl><dt><a name="BlockPageMeasurementResults-__repr__"><strong>__repr__</strong></a>(self)</dt></dl> + +<dl><dt><a name="BlockPageMeasurementResults-addError"><strong>addError</strong></a>(self, *args, **kw)</dt><dd><tt>Called when an error has occurred. 'err' is a tuple of values as<br> +returned by sys.exc_info().</tt></dd></dl> + +<dl><dt><a name="BlockPageMeasurementResults-addExpectedFailure"><strong>addExpectedFailure</strong></a>(self, test, err)</dt><dd><tt>Called when an expected failure/error occured.</tt></dd></dl> + +<dl><dt><a name="BlockPageMeasurementResults-addFailure"><strong>addFailure</strong></a>(self, *args, **kw)</dt><dd><tt>Called when an error has occurred. 'err' is a tuple of values as<br> +returned by sys.exc_info().</tt></dd></dl> + +<dl><dt><a name="BlockPageMeasurementResults-addUnexpectedSuccess"><strong>addUnexpectedSuccess</strong></a>(self, *args, **kw)</dt><dd><tt>Called when a test was expected to fail, but succeed.</tt></dd></dl> + +<dl><dt><a name="BlockPageMeasurementResults-printErrors"><strong>printErrors</strong></a>(self)</dt><dd><tt>Called by TestRunner after test run</tt></dd></dl> + +<dl><dt><a name="BlockPageMeasurementResults-startTest"><strong>startTest</strong></a>(self, test)</dt><dd><tt>Called when the given test is about to be run</tt></dd></dl> + +<dl><dt><a name="BlockPageMeasurementResults-startTestRun"><strong>startTestRun</strong></a>(self)</dt><dd><tt>Called once before any tests are executed.<br> + <br> +See startTest for a method called before each test.</tt></dd></dl> + +<dl><dt><a name="BlockPageMeasurementResults-stop"><strong>stop</strong></a>(self)</dt><dd><tt>Indicates that the tests should be aborted</tt></dd></dl> + +<dl><dt><a name="BlockPageMeasurementResults-stopTest"><strong>stopTest</strong></a>(self, test)</dt><dd><tt>Called when the given test has been run</tt></dd></dl> + +<dl><dt><a name="BlockPageMeasurementResults-stopTestRun"><strong>stopTestRun</strong></a>(self)</dt><dd><tt>Called once after all tests are executed.<br> + <br> +See stopTest for a method called after each test.</tt></dd></dl> + +<dl><dt><a name="BlockPageMeasurementResults-wasSuccessful"><strong>wasSuccessful</strong></a>(self)</dt><dd><tt>Tells whether or not this result was a success</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="unittest.result.html#TestResult">unittest.result.TestResult</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.buildbot_page_measurement_results.html b/tools/telemetry/docs/telemetry.page.buildbot_page_measurement_results.html new file mode 100644 index 0000000..f112805 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.buildbot_page_measurement_results.html @@ -0,0 +1,147 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.buildbot_page_measurement_results</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.buildbot_page_measurement_results</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/buildbot_page_measurement_results.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/buildbot_page_measurement_results.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.page.page_measurement_results.html">telemetry.page.page_measurement_results</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.perf_tests_helper.html">telemetry.page.perf_tests_helper</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a>(<a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.buildbot_page_measurement_results.html#BuildbotPageMeasurementResults">BuildbotPageMeasurementResults</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> <br> +<font color="#000000" face="helvetica, arial"><a name="BuildbotPageMeasurementResults">class <strong>BuildbotPageMeasurementResults</strong></a>(<a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.page.buildbot_page_measurement_results.html#BuildbotPageMeasurementResults">BuildbotPageMeasurementResults</a></dd> +<dd><a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a></dd> +<dd><a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a></dd> +<dd><a href="unittest.result.html#TestResult">unittest.result.TestResult</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="BuildbotPageMeasurementResults-PrintSummary"><strong>PrintSummary</strong></a>(self)</dt><dd><tt>Print summary data in a format expected by buildbot for perf dashboards.<br> + <br> +If any failed pages exist, only output individual page results for<br> +non-failing pages, and do not output any average data.</tt></dd></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-__init__"><strong>__init__</strong></a>(self, trace_tag<font color="#909090">=''</font>)</dt></dl> + +<hr> +Methods inherited from <a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a>:<br> +<dl><dt><a name="BuildbotPageMeasurementResults-Add"><strong>Add</strong></a>(self, trace_name, units, value, chart_name<font color="#909090">=None</font>, data_type<font color="#909090">='default'</font>)</dt></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-AddSummary"><strong>AddSummary</strong></a>(self, trace_name, units, value, chart_name<font color="#909090">=None</font>, data_type<font color="#909090">='default'</font>)</dt></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-DidMeasurePage"><strong>DidMeasurePage</strong></a>(self)</dt></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-WillMeasurePage"><strong>WillMeasurePage</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-__getitem__"><strong>__getitem__</strong></a>(self, i)</dt><dd><tt>Shorthand for self.<strong>page_results</strong>[i]</tt></dd></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-__len__"><strong>__len__</strong></a>(self)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a>:<br> +<dl><dt><strong>all_measurements_that_have_been_seen</strong></dt> +</dl> +<dl><dt><strong>page_results</strong></dt> +</dl> +<dl><dt><strong>values_for_current_page</strong></dt> +</dl> +<hr> +Methods inherited from <a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a>:<br> +<dl><dt><a name="BuildbotPageMeasurementResults-AddError"><strong>AddError</strong></a>(self, page, err)</dt></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-AddErrorMessage"><strong>AddErrorMessage</strong></a>(self, page, message)</dt></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-AddFailure"><strong>AddFailure</strong></a>(self, page, err)</dt></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-AddFailureMessage"><strong>AddFailureMessage</strong></a>(self, page, message)</dt></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-AddSkip"><strong>AddSkip</strong></a>(self, page, reason)</dt></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-AddSuccess"><strong>AddSuccess</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-StartTest"><strong>StartTest</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-StopTest"><strong>StopTest</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-addSkip"><strong>addSkip</strong></a>(self, test, reason)</dt></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-addSuccess"><strong>addSuccess</strong></a>(self, test)</dt></dl> + +<hr> +Methods inherited from <a href="unittest.result.html#TestResult">unittest.result.TestResult</a>:<br> +<dl><dt><a name="BuildbotPageMeasurementResults-__repr__"><strong>__repr__</strong></a>(self)</dt></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-addError"><strong>addError</strong></a>(self, *args, **kw)</dt><dd><tt>Called when an error has occurred. 'err' is a tuple of values as<br> +returned by sys.exc_info().</tt></dd></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-addExpectedFailure"><strong>addExpectedFailure</strong></a>(self, test, err)</dt><dd><tt>Called when an expected failure/error occured.</tt></dd></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-addFailure"><strong>addFailure</strong></a>(self, *args, **kw)</dt><dd><tt>Called when an error has occurred. 'err' is a tuple of values as<br> +returned by sys.exc_info().</tt></dd></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-addUnexpectedSuccess"><strong>addUnexpectedSuccess</strong></a>(self, *args, **kw)</dt><dd><tt>Called when a test was expected to fail, but succeed.</tt></dd></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-printErrors"><strong>printErrors</strong></a>(self)</dt><dd><tt>Called by TestRunner after test run</tt></dd></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-startTest"><strong>startTest</strong></a>(self, test)</dt><dd><tt>Called when the given test is about to be run</tt></dd></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-startTestRun"><strong>startTestRun</strong></a>(self)</dt><dd><tt>Called once before any tests are executed.<br> + <br> +See startTest for a method called before each test.</tt></dd></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-stop"><strong>stop</strong></a>(self)</dt><dd><tt>Indicates that the tests should be aborted</tt></dd></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-stopTest"><strong>stopTest</strong></a>(self, test)</dt><dd><tt>Called when the given test has been run</tt></dd></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-stopTestRun"><strong>stopTestRun</strong></a>(self)</dt><dd><tt>Called once after all tests are executed.<br> + <br> +See stopTest for a method called after each test.</tt></dd></dl> + +<dl><dt><a name="BuildbotPageMeasurementResults-wasSuccessful"><strong>wasSuccessful</strong></a>(self)</dt><dd><tt>Tells whether or not this result was a success</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="unittest.result.html#TestResult">unittest.result.TestResult</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.csv_page_measurement_results.html b/tools/telemetry/docs/telemetry.page.csv_page_measurement_results.html new file mode 100644 index 0000000..8036083 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.csv_page_measurement_results.html @@ -0,0 +1,144 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.csv_page_measurement_results</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.csv_page_measurement_results</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/csv_page_measurement_results.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/csv_page_measurement_results.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="csv.html">csv</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.page_measurement_results.html">telemetry.page.page_measurement_results</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a>(<a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.csv_page_measurement_results.html#CsvPageMeasurementResults">CsvPageMeasurementResults</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> <br> +<font color="#000000" face="helvetica, arial"><a name="CsvPageMeasurementResults">class <strong>CsvPageMeasurementResults</strong></a>(<a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.page.csv_page_measurement_results.html#CsvPageMeasurementResults">CsvPageMeasurementResults</a></dd> +<dd><a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a></dd> +<dd><a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a></dd> +<dd><a href="unittest.result.html#TestResult">unittest.result.TestResult</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="CsvPageMeasurementResults-DidMeasurePage"><strong>DidMeasurePage</strong></a>(self)</dt></dl> + +<dl><dt><a name="CsvPageMeasurementResults-PrintSummary"><strong>PrintSummary</strong></a>(self)</dt></dl> + +<dl><dt><a name="CsvPageMeasurementResults-__init__"><strong>__init__</strong></a>(self, output_stream, output_after_every_page, trace_tag<font color="#909090">=''</font>)</dt></dl> + +<hr> +Methods inherited from <a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a>:<br> +<dl><dt><a name="CsvPageMeasurementResults-Add"><strong>Add</strong></a>(self, trace_name, units, value, chart_name<font color="#909090">=None</font>, data_type<font color="#909090">='default'</font>)</dt></dl> + +<dl><dt><a name="CsvPageMeasurementResults-AddSummary"><strong>AddSummary</strong></a>(self, trace_name, units, value, chart_name<font color="#909090">=None</font>, data_type<font color="#909090">='default'</font>)</dt></dl> + +<dl><dt><a name="CsvPageMeasurementResults-WillMeasurePage"><strong>WillMeasurePage</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="CsvPageMeasurementResults-__getitem__"><strong>__getitem__</strong></a>(self, i)</dt><dd><tt>Shorthand for self.<strong>page_results</strong>[i]</tt></dd></dl> + +<dl><dt><a name="CsvPageMeasurementResults-__len__"><strong>__len__</strong></a>(self)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">telemetry.page.page_measurement_results.PageMeasurementResults</a>:<br> +<dl><dt><strong>all_measurements_that_have_been_seen</strong></dt> +</dl> +<dl><dt><strong>page_results</strong></dt> +</dl> +<dl><dt><strong>values_for_current_page</strong></dt> +</dl> +<hr> +Methods inherited from <a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a>:<br> +<dl><dt><a name="CsvPageMeasurementResults-AddError"><strong>AddError</strong></a>(self, page, err)</dt></dl> + +<dl><dt><a name="CsvPageMeasurementResults-AddErrorMessage"><strong>AddErrorMessage</strong></a>(self, page, message)</dt></dl> + +<dl><dt><a name="CsvPageMeasurementResults-AddFailure"><strong>AddFailure</strong></a>(self, page, err)</dt></dl> + +<dl><dt><a name="CsvPageMeasurementResults-AddFailureMessage"><strong>AddFailureMessage</strong></a>(self, page, message)</dt></dl> + +<dl><dt><a name="CsvPageMeasurementResults-AddSkip"><strong>AddSkip</strong></a>(self, page, reason)</dt></dl> + +<dl><dt><a name="CsvPageMeasurementResults-AddSuccess"><strong>AddSuccess</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="CsvPageMeasurementResults-StartTest"><strong>StartTest</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="CsvPageMeasurementResults-StopTest"><strong>StopTest</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="CsvPageMeasurementResults-addSkip"><strong>addSkip</strong></a>(self, test, reason)</dt></dl> + +<dl><dt><a name="CsvPageMeasurementResults-addSuccess"><strong>addSuccess</strong></a>(self, test)</dt></dl> + +<hr> +Methods inherited from <a href="unittest.result.html#TestResult">unittest.result.TestResult</a>:<br> +<dl><dt><a name="CsvPageMeasurementResults-__repr__"><strong>__repr__</strong></a>(self)</dt></dl> + +<dl><dt><a name="CsvPageMeasurementResults-addError"><strong>addError</strong></a>(self, *args, **kw)</dt><dd><tt>Called when an error has occurred. 'err' is a tuple of values as<br> +returned by sys.exc_info().</tt></dd></dl> + +<dl><dt><a name="CsvPageMeasurementResults-addExpectedFailure"><strong>addExpectedFailure</strong></a>(self, test, err)</dt><dd><tt>Called when an expected failure/error occured.</tt></dd></dl> + +<dl><dt><a name="CsvPageMeasurementResults-addFailure"><strong>addFailure</strong></a>(self, *args, **kw)</dt><dd><tt>Called when an error has occurred. 'err' is a tuple of values as<br> +returned by sys.exc_info().</tt></dd></dl> + +<dl><dt><a name="CsvPageMeasurementResults-addUnexpectedSuccess"><strong>addUnexpectedSuccess</strong></a>(self, *args, **kw)</dt><dd><tt>Called when a test was expected to fail, but succeed.</tt></dd></dl> + +<dl><dt><a name="CsvPageMeasurementResults-printErrors"><strong>printErrors</strong></a>(self)</dt><dd><tt>Called by TestRunner after test run</tt></dd></dl> + +<dl><dt><a name="CsvPageMeasurementResults-startTest"><strong>startTest</strong></a>(self, test)</dt><dd><tt>Called when the given test is about to be run</tt></dd></dl> + +<dl><dt><a name="CsvPageMeasurementResults-startTestRun"><strong>startTestRun</strong></a>(self)</dt><dd><tt>Called once before any tests are executed.<br> + <br> +See startTest for a method called before each test.</tt></dd></dl> + +<dl><dt><a name="CsvPageMeasurementResults-stop"><strong>stop</strong></a>(self)</dt><dd><tt>Indicates that the tests should be aborted</tt></dd></dl> + +<dl><dt><a name="CsvPageMeasurementResults-stopTest"><strong>stopTest</strong></a>(self, test)</dt><dd><tt>Called when the given test has been run</tt></dd></dl> + +<dl><dt><a name="CsvPageMeasurementResults-stopTestRun"><strong>stopTestRun</strong></a>(self)</dt><dd><tt>Called once after all tests are executed.<br> + <br> +See stopTest for a method called after each test.</tt></dd></dl> + +<dl><dt><a name="CsvPageMeasurementResults-wasSuccessful"><strong>wasSuccessful</strong></a>(self)</dt><dd><tt>Tells whether or not this result was a success</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="unittest.result.html#TestResult">unittest.result.TestResult</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.gtest_test_results.html b/tools/telemetry/docs/telemetry.page.gtest_test_results.html new file mode 100644 index 0000000..5e4b69ec --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.gtest_test_results.html @@ -0,0 +1,125 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.gtest_test_results</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.gtest_test_results</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/gtest_test_results.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/gtest_test_results.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.page.page_test_results.html">telemetry.page.page_test_results</a><br> +</td><td width="25%" valign=top><a href="sys.html">sys</a><br> +</td><td width="25%" valign=top><a href="time.html">time</a><br> +</td><td width="25%" valign=top><a href="unittest.html">unittest</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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a>(<a href="unittest.result.html#TestResult">unittest.result.TestResult</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.gtest_test_results.html#GTestTestResults">GTestTestResults</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> <br> +<font color="#000000" face="helvetica, arial"><a name="GTestTestResults">class <strong>GTestTestResults</strong></a>(<a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.page.gtest_test_results.html#GTestTestResults">GTestTestResults</a></dd> +<dd><a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a></dd> +<dd><a href="unittest.result.html#TestResult">unittest.result.TestResult</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="GTestTestResults-PrintSummary"><strong>PrintSummary</strong></a>(self)</dt></dl> + +<dl><dt><a name="GTestTestResults-__init__"><strong>__init__</strong></a>(self)</dt></dl> + +<dl><dt><a name="GTestTestResults-addError"><strong>addError</strong></a>(self, test, err)</dt></dl> + +<dl><dt><a name="GTestTestResults-addFailure"><strong>addFailure</strong></a>(self, test, err)</dt></dl> + +<dl><dt><a name="GTestTestResults-addSuccess"><strong>addSuccess</strong></a>(self, test)</dt></dl> + +<dl><dt><a name="GTestTestResults-startTest"><strong>startTest</strong></a>(self, test)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>num_errors</strong></dt> +</dl> +<hr> +Methods inherited from <a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a>:<br> +<dl><dt><a name="GTestTestResults-AddError"><strong>AddError</strong></a>(self, page, err)</dt></dl> + +<dl><dt><a name="GTestTestResults-AddErrorMessage"><strong>AddErrorMessage</strong></a>(self, page, message)</dt></dl> + +<dl><dt><a name="GTestTestResults-AddFailure"><strong>AddFailure</strong></a>(self, page, err)</dt></dl> + +<dl><dt><a name="GTestTestResults-AddFailureMessage"><strong>AddFailureMessage</strong></a>(self, page, message)</dt></dl> + +<dl><dt><a name="GTestTestResults-AddSkip"><strong>AddSkip</strong></a>(self, page, reason)</dt></dl> + +<dl><dt><a name="GTestTestResults-AddSuccess"><strong>AddSuccess</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="GTestTestResults-StartTest"><strong>StartTest</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="GTestTestResults-StopTest"><strong>StopTest</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="GTestTestResults-addSkip"><strong>addSkip</strong></a>(self, test, reason)</dt></dl> + +<hr> +Methods inherited from <a href="unittest.result.html#TestResult">unittest.result.TestResult</a>:<br> +<dl><dt><a name="GTestTestResults-__repr__"><strong>__repr__</strong></a>(self)</dt></dl> + +<dl><dt><a name="GTestTestResults-addExpectedFailure"><strong>addExpectedFailure</strong></a>(self, test, err)</dt><dd><tt>Called when an expected failure/error occured.</tt></dd></dl> + +<dl><dt><a name="GTestTestResults-addUnexpectedSuccess"><strong>addUnexpectedSuccess</strong></a>(self, *args, **kw)</dt><dd><tt>Called when a test was expected to fail, but succeed.</tt></dd></dl> + +<dl><dt><a name="GTestTestResults-printErrors"><strong>printErrors</strong></a>(self)</dt><dd><tt>Called by TestRunner after test run</tt></dd></dl> + +<dl><dt><a name="GTestTestResults-startTestRun"><strong>startTestRun</strong></a>(self)</dt><dd><tt>Called once before any tests are executed.<br> + <br> +See startTest for a method called before each test.</tt></dd></dl> + +<dl><dt><a name="GTestTestResults-stop"><strong>stop</strong></a>(self)</dt><dd><tt>Indicates that the tests should be aborted</tt></dd></dl> + +<dl><dt><a name="GTestTestResults-stopTest"><strong>stopTest</strong></a>(self, test)</dt><dd><tt>Called when the given test has been run</tt></dd></dl> + +<dl><dt><a name="GTestTestResults-stopTestRun"><strong>stopTestRun</strong></a>(self)</dt><dd><tt>Called once after all tests are executed.<br> + <br> +See stopTest for a method called after each test.</tt></dd></dl> + +<dl><dt><a name="GTestTestResults-wasSuccessful"><strong>wasSuccessful</strong></a>(self)</dt><dd><tt>Tells whether or not this result was a success</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="unittest.result.html#TestResult">unittest.result.TestResult</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.html b/tools/telemetry/docs/telemetry.page.html new file mode 100644 index 0000000..37a13ff --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.html @@ -0,0 +1,54 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: package telemetry.page</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.page</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/__init__.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/__init__.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></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.page.actions.html"><strong>actions</strong> (package)</a><br> +<a href="telemetry.page.block_page_measurement_results.html">block_page_measurement_results</a><br> +<a href="telemetry.page.block_page_measurement_results_unittest.html">block_page_measurement_results_unittest</a><br> +<a href="telemetry.page.buildbot_page_measurement_results.html">buildbot_page_measurement_results</a><br> +<a href="telemetry.page.buildbot_page_measurement_results_unittest.html">buildbot_page_measurement_results_unittest</a><br> +<a href="telemetry.page.csv_page_measurement_results.html">csv_page_measurement_results</a><br> +<a href="telemetry.page.csv_page_measurement_results_unittest.html">csv_page_measurement_results_unittest</a><br> +<a href="telemetry.page.failure.html">failure</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.gtest_test_results.html">gtest_test_results</a><br> +<a href="telemetry.page.page.html">page</a><br> +<a href="telemetry.page.page_filter.html">page_filter</a><br> +<a href="telemetry.page.page_measurement.html">page_measurement</a><br> +<a href="telemetry.page.page_measurement_results.html">page_measurement_results</a><br> +<a href="telemetry.page.page_measurement_results_unittest.html">page_measurement_results_unittest</a><br> +<a href="telemetry.page.page_measurement_runner.html">page_measurement_runner</a><br> +<a href="telemetry.page.page_measurement_unittest.html">page_measurement_unittest</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.page_measurement_unittest_base.html">page_measurement_unittest_base</a><br> +<a href="telemetry.page.page_measurement_value.html">page_measurement_value</a><br> +<a href="telemetry.page.page_runner.html">page_runner</a><br> +<a href="telemetry.page.page_runner_unittest.html">page_runner_unittest</a><br> +<a href="telemetry.page.page_set.html">page_set</a><br> +<a href="telemetry.page.page_set_archive_info.html">page_set_archive_info</a><br> +<a href="telemetry.page.page_set_archive_info_unittest.html">page_set_archive_info_unittest</a><br> +<a href="telemetry.page.page_set_unittest.html">page_set_unittest</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.page_test.html">page_test</a><br> +<a href="telemetry.page.page_test_results.html">page_test_results</a><br> +<a href="telemetry.page.page_test_runner.html">page_test_runner</a><br> +<a href="telemetry.page.page_test_unittest.html">page_test_unittest</a><br> +<a href="telemetry.page.page_unittest.html">page_unittest</a><br> +<a href="telemetry.page.perf_tests_helper.html">perf_tests_helper</a><br> +<a href="telemetry.page.record_wpr.html">record_wpr</a><br> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page.html b/tools/telemetry/docs/telemetry.page.page.html new file mode 100644 index 0000000..4167e01 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page.html @@ -0,0 +1,79 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.page</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.page</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="os.html">os</a><br> +<a href="re.html">re</a><br> +</td><td width="25%" valign=top><a href="time.html">time</a><br> +<a href="urlparse.html">urlparse</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.core.util</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page.html#Page">Page</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> <br> +<font color="#000000" face="helvetica, arial"><a name="Page">class <strong>Page</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="Page-WaitToLoad"><strong>WaitToLoad</strong></a>(self, tab, timeout, poll_interval<font color="#909090">=0.1</font>)</dt></dl> + +<dl><dt><a name="Page-__getattr__"><strong>__getattr__</strong></a>(self, name)</dt></dl> + +<dl><dt><a name="Page-__init__"><strong>__init__</strong></a>(self, url, page_set, attributes<font color="#909090">=None</font>, base_dir<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="Page-__str__"><strong>__str__</strong></a>(self)</dt></dl> + +<hr> +Static methods defined here:<br> +<dl><dt><a name="Page-WaitForPageToLoad"><strong>WaitForPageToLoad</strong></a>(obj, tab, timeout, poll_interval<font color="#909090">=0.1</font>)</dt><dd><tt>Waits for various wait conditions present in obj.</tt></dd></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>archive_path</strong></dt> +</dl> +<dl><dt><strong>display_url</strong></dt> +</dl> +<dl><dt><strong>serving_dirs_and_file</strong></dt> +</dl> +<dl><dt><strong>url_as_file_safe_name</strong></dt> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_filter.html b/tools/telemetry/docs/telemetry.page.page_filter.html new file mode 100644 index 0000000..aff8de7 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_filter.html @@ -0,0 +1,66 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.page_filter</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.page_filter</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_filter.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_filter.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="optparse.html">optparse</a><br> +</td><td width="25%" valign=top><a href="re.html">re</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_filter.html#PageFilter">PageFilter</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> <br> +<font color="#000000" face="helvetica, arial"><a name="PageFilter">class <strong>PageFilter</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Filters pages in the page set based on command line flags.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="PageFilter-IsSelected"><strong>IsSelected</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="PageFilter-__init__"><strong>__init__</strong></a>(self, options)</dt></dl> + +<hr> +Static methods defined here:<br> +<dl><dt><a name="PageFilter-AddCommandLineOptions"><strong>AddCommandLineOptions</strong></a>(parser)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_measurement.html b/tools/telemetry/docs/telemetry.page.page_measurement.html new file mode 100644 index 0000000..e0ad33f --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_measurement.html @@ -0,0 +1,244 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.page_measurement</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.page_measurement</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_measurement.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_measurement.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.page.block_page_measurement_results.html">telemetry.page.block_page_measurement_results</a><br> +<a href="telemetry.page.buildbot_page_measurement_results.html">telemetry.page.buildbot_page_measurement_results</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.csv_page_measurement_results.html">telemetry.page.csv_page_measurement_results</a><br> +<a href="os.html">os</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.page_measurement_results.html">telemetry.page.page_measurement_results</a><br> +<a href="telemetry.page.page_test.html">telemetry.page.page_test</a><br> +</td><td width="25%" valign=top><a href="sys.html">sys</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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_test.html#Failure">telemetry.page.page_test.Failure</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_measurement.html#MeasurementFailure">MeasurementFailure</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_measurement.html#PageMeasurement">PageMeasurement</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> <br> +<font color="#000000" face="helvetica, arial"><a name="MeasurementFailure">class <strong>MeasurementFailure</strong></a>(<a href="telemetry.page.page_test.html#Failure">telemetry.page.page_test.Failure</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Exception that can be thrown from MeasurePage to indicate an undesired but<br> +designed-for problem.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.page.page_measurement.html#MeasurementFailure">MeasurementFailure</a></dd> +<dd><a href="telemetry.page.page_test.html#Failure">telemetry.page.page_test.Failure</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Data descriptors inherited from <a href="telemetry.page.page_test.html#Failure">telemetry.page.page_test.Failure</a>:<br> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><a name="MeasurementFailure-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#MeasurementFailure-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#MeasurementFailure-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><a name="MeasurementFailure-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#MeasurementFailure-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="MeasurementFailure-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#MeasurementFailure-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="MeasurementFailure-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#MeasurementFailure-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="MeasurementFailure-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#MeasurementFailure-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="MeasurementFailure-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="MeasurementFailure-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#MeasurementFailure-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="MeasurementFailure-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#MeasurementFailure-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="MeasurementFailure-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="MeasurementFailure-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#MeasurementFailure-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="MeasurementFailure-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> + +<hr> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +<dl><dt><strong>message</strong></dt> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="PageMeasurement">class <strong>PageMeasurement</strong></a>(<a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>Glue code for running a measurement across a set of pages.<br> + <br> +To use this, subclass from the measurement and override MeasurePage. For<br> +example:<br> + <br> + class BodyChildElementMeasurement(<a href="#PageMeasurement">PageMeasurement</a>):<br> + def <a href="#PageMeasurement-MeasurePage">MeasurePage</a>(self, page, tab, results):<br> + body_child_count = tab.EvaluateJavaScript(<br> + 'document.body.children.length')<br> + results.Add('body_children', 'count', body_child_count)<br> + <br> + if __name__ == '__main__':<br> + page_measurement.Main(BodyChildElementMeasurement())<br> + <br> +To add test-specific options:<br> + <br> + class BodyChildElementMeasurement(<a href="#PageMeasurement">PageMeasurement</a>):<br> + def <a href="#PageMeasurement-AddCommandLineOptions">AddCommandLineOptions</a>(parser):<br> + parser.add_option('--element', action='store', default='body')<br> + <br> + def <a href="#PageMeasurement-MeasurePage">MeasurePage</a>(self, page, tab, results):<br> + body_child_count = tab.EvaluateJavaScript(<br> + 'document.querySelector('%s').children.length')<br> + results.Add('children', 'count', child_count)<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.page.page_measurement.html#PageMeasurement">PageMeasurement</a></dd> +<dd><a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="PageMeasurement-AddOutputOptions"><strong>AddOutputOptions</strong></a>(self, parser)</dt></dl> + +<dl><dt><a name="PageMeasurement-MeasurePage"><strong>MeasurePage</strong></a>(self, page, tab, results)</dt><dd><tt>Override to actually measure the page's performance.<br> + <br> +page is a page_set.Page<br> +tab is an instance of telemetry.core.Tab<br> + <br> +Should call results.Add(name, units, value) for each result, or raise an<br> +exception on failure. The name and units of each Add() call must be<br> +the same across all iterations. The name 'url' must not be used.<br> + <br> +Prefer field names that are in accordance with python variable style. E.g.<br> +field_name.<br> + <br> +Put together:<br> + <br> + def <a href="#PageMeasurement-MeasurePage">MeasurePage</a>(self, page, tab, results):<br> + res = tab.EvaluateJavaScript('2+2')<br> + if res != 4:<br> + raise Exception('Oh, wow.')<br> + results.Add('two_plus_two', 'count', res)</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-PrepareResults"><strong>PrepareResults</strong></a>(self, options)</dt></dl> + +<dl><dt><a name="PageMeasurement-__init__"><strong>__init__</strong></a>(self, action_name_to_run<font color="#909090">=''</font>, needs_browser_restart_after_each_run<font color="#909090">=False</font>, discard_first_result<font color="#909090">=False</font>)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>output_format_choices</strong></dt> +</dl> +<dl><dt><strong>results_are_the_same_on_every_page</strong></dt> +<dd><tt>By default, measurements are assumed to output the same values for every<br> +page. This allows incremental output, for example in CSV. If, however, the<br> +measurement discovers what values it can report as it goes, and those values<br> +may vary from page to page, you need to override this function and return<br> +False. Output will not appear in this mode until the entire pageset has<br> +run.</tt></dd> +</dl> +<hr> +Methods inherited from <a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>:<br> +<dl><dt><a name="PageMeasurement-AddCommandLineOptions"><strong>AddCommandLineOptions</strong></a>(self, parser)</dt><dd><tt>Override to expose command-line options for this test.<br> + <br> +The provided parser is an optparse.OptionParser instance and accepts all<br> +normal results. The parsed options are available in Run as<br> +self.<strong>options</strong>.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-CanRunForPage"><strong>CanRunForPage</strong></a>(self, page)</dt><dd><tt>Override to customize if the test can be ran for the given page.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-CreatePageSet"><strong>CreatePageSet</strong></a>(self, args, options)</dt><dd><tt>Override to make this test generate its own page set instead of<br> +allowing arbitrary page sets entered from the command-line.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-CustomizeBrowserOptions"><strong>CustomizeBrowserOptions</strong></a>(self, options)</dt><dd><tt>Override to add test-specific options to the BrowserOptions object</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-CustomizeBrowserOptionsForPage"><strong>CustomizeBrowserOptionsForPage</strong></a>(self, page, options)</dt><dd><tt>Add options specific to the test and the given page.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-DidNavigateToPage"><strong>DidNavigateToPage</strong></a>(self, page, tab)</dt><dd><tt>Override to do operations right after the page is navigated, but before<br> +any waiting for completion has occurred.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-DidRunAction"><strong>DidRunAction</strong></a>(self, page, tab, action)</dt><dd><tt>Override to do operations after running the action on the page.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-DidRunPageSet"><strong>DidRunPageSet</strong></a>(self, tab, results)</dt><dd><tt>Override to do operations after page set is completed, but before browser<br> +is torn down.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-DidStartHTTPServer"><strong>DidStartHTTPServer</strong></a>(self, tab)</dt><dd><tt>Override to do operations after the HTTP server is started.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-NeedsBrowserRestartAfterEachRun"><strong>NeedsBrowserRestartAfterEachRun</strong></a>(self, tab)</dt><dd><tt>Override to specify browser restart after each run.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-Run"><strong>Run</strong></a>(self, options, page, tab, results)</dt></dl> + +<dl><dt><a name="PageMeasurement-SetUpBrowser"><strong>SetUpBrowser</strong></a>(self, browser)</dt><dd><tt>Override to customize the browser right after it has launched.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-WillNavigateToPage"><strong>WillNavigateToPage</strong></a>(self, page, tab)</dt><dd><tt>Override to do operations before the page is navigated.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-WillRunAction"><strong>WillRunAction</strong></a>(self, page, tab, action)</dt><dd><tt>Override to do operations before running the action on the page.</tt></dd></dl> + +<dl><dt><a name="PageMeasurement-WillRunPageSet"><strong>WillRunPageSet</strong></a>(self, tab)</dt><dd><tt>Override to do operations before the page set is navigated.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>action_name_to_run</strong></dt> +</dl> +<dl><dt><strong>discard_first_result</strong></dt> +<dd><tt>When set to True, the first run of the test is discarded. This is<br> +useful for cases where it's desirable to have some test resource cached so<br> +the first run of the test can warm things up.</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_measurement_results.html b/tools/telemetry/docs/telemetry.page.page_measurement_results.html new file mode 100644 index 0000000..e23749f --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_measurement_results.html @@ -0,0 +1,177 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.page_measurement_results</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.page_measurement_results</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_measurement_results.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_measurement_results.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.page.page_measurement_value.html">telemetry.page.page_measurement_value</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.page_test_results.html">telemetry.page.page_test_results</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_measurement_results.html#ValuesForSinglePage">ValuesForSinglePage</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a>(<a href="unittest.result.html#TestResult">unittest.result.TestResult</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">PageMeasurementResults</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> <br> +<font color="#000000" face="helvetica, arial"><a name="PageMeasurementResults">class <strong>PageMeasurementResults</strong></a>(<a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.page.page_measurement_results.html#PageMeasurementResults">PageMeasurementResults</a></dd> +<dd><a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a></dd> +<dd><a href="unittest.result.html#TestResult">unittest.result.TestResult</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="PageMeasurementResults-Add"><strong>Add</strong></a>(self, trace_name, units, value, chart_name<font color="#909090">=None</font>, data_type<font color="#909090">='default'</font>)</dt></dl> + +<dl><dt><a name="PageMeasurementResults-AddSummary"><strong>AddSummary</strong></a>(self, trace_name, units, value, chart_name<font color="#909090">=None</font>, data_type<font color="#909090">='default'</font>)</dt></dl> + +<dl><dt><a name="PageMeasurementResults-DidMeasurePage"><strong>DidMeasurePage</strong></a>(self)</dt></dl> + +<dl><dt><a name="PageMeasurementResults-WillMeasurePage"><strong>WillMeasurePage</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="PageMeasurementResults-__getitem__"><strong>__getitem__</strong></a>(self, i)</dt><dd><tt>Shorthand for self.<strong>page_results</strong>[i]</tt></dd></dl> + +<dl><dt><a name="PageMeasurementResults-__init__"><strong>__init__</strong></a>(self, trace_tag<font color="#909090">=''</font>)</dt></dl> + +<dl><dt><a name="PageMeasurementResults-__len__"><strong>__len__</strong></a>(self)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>all_measurements_that_have_been_seen</strong></dt> +</dl> +<dl><dt><strong>page_results</strong></dt> +</dl> +<dl><dt><strong>values_for_current_page</strong></dt> +</dl> +<hr> +Methods inherited from <a href="telemetry.page.page_test_results.html#PageTestResults">telemetry.page.page_test_results.PageTestResults</a>:<br> +<dl><dt><a name="PageMeasurementResults-AddError"><strong>AddError</strong></a>(self, page, err)</dt></dl> + +<dl><dt><a name="PageMeasurementResults-AddErrorMessage"><strong>AddErrorMessage</strong></a>(self, page, message)</dt></dl> + +<dl><dt><a name="PageMeasurementResults-AddFailure"><strong>AddFailure</strong></a>(self, page, err)</dt></dl> + +<dl><dt><a name="PageMeasurementResults-AddFailureMessage"><strong>AddFailureMessage</strong></a>(self, page, message)</dt></dl> + +<dl><dt><a name="PageMeasurementResults-AddSkip"><strong>AddSkip</strong></a>(self, page, reason)</dt></dl> + +<dl><dt><a name="PageMeasurementResults-AddSuccess"><strong>AddSuccess</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="PageMeasurementResults-PrintSummary"><strong>PrintSummary</strong></a>(self)</dt></dl> + +<dl><dt><a name="PageMeasurementResults-StartTest"><strong>StartTest</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="PageMeasurementResults-StopTest"><strong>StopTest</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="PageMeasurementResults-addSkip"><strong>addSkip</strong></a>(self, test, reason)</dt></dl> + +<dl><dt><a name="PageMeasurementResults-addSuccess"><strong>addSuccess</strong></a>(self, test)</dt></dl> + +<hr> +Methods inherited from <a href="unittest.result.html#TestResult">unittest.result.TestResult</a>:<br> +<dl><dt><a name="PageMeasurementResults-__repr__"><strong>__repr__</strong></a>(self)</dt></dl> + +<dl><dt><a name="PageMeasurementResults-addError"><strong>addError</strong></a>(self, *args, **kw)</dt><dd><tt>Called when an error has occurred. 'err' is a tuple of values as<br> +returned by sys.exc_info().</tt></dd></dl> + +<dl><dt><a name="PageMeasurementResults-addExpectedFailure"><strong>addExpectedFailure</strong></a>(self, test, err)</dt><dd><tt>Called when an expected failure/error occured.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementResults-addFailure"><strong>addFailure</strong></a>(self, *args, **kw)</dt><dd><tt>Called when an error has occurred. 'err' is a tuple of values as<br> +returned by sys.exc_info().</tt></dd></dl> + +<dl><dt><a name="PageMeasurementResults-addUnexpectedSuccess"><strong>addUnexpectedSuccess</strong></a>(self, *args, **kw)</dt><dd><tt>Called when a test was expected to fail, but succeed.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementResults-printErrors"><strong>printErrors</strong></a>(self)</dt><dd><tt>Called by TestRunner after test run</tt></dd></dl> + +<dl><dt><a name="PageMeasurementResults-startTest"><strong>startTest</strong></a>(self, test)</dt><dd><tt>Called when the given test is about to be run</tt></dd></dl> + +<dl><dt><a name="PageMeasurementResults-startTestRun"><strong>startTestRun</strong></a>(self)</dt><dd><tt>Called once before any tests are executed.<br> + <br> +See startTest for a method called before each test.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementResults-stop"><strong>stop</strong></a>(self)</dt><dd><tt>Indicates that the tests should be aborted</tt></dd></dl> + +<dl><dt><a name="PageMeasurementResults-stopTest"><strong>stopTest</strong></a>(self, test)</dt><dd><tt>Called when the given test has been run</tt></dd></dl> + +<dl><dt><a name="PageMeasurementResults-stopTestRun"><strong>stopTestRun</strong></a>(self)</dt><dd><tt>Called once after all tests are executed.<br> + <br> +See stopTest for a method called after each test.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementResults-wasSuccessful"><strong>wasSuccessful</strong></a>(self)</dt><dd><tt>Tells whether or not this result was a success</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="unittest.result.html#TestResult">unittest.result.TestResult</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="ValuesForSinglePage">class <strong>ValuesForSinglePage</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="ValuesForSinglePage-AddValue"><strong>AddValue</strong></a>(self, value)</dt></dl> + +<dl><dt><a name="ValuesForSinglePage-FindValueByMeasurementName"><strong>FindValueByMeasurementName</strong></a>(self, measurement_name)</dt></dl> + +<dl><dt><a name="ValuesForSinglePage-FindValueByTraceName"><strong>FindValueByTraceName</strong></a>(self, trace_name)</dt></dl> + +<dl><dt><a name="ValuesForSinglePage-__contains__"><strong>__contains__</strong></a>(self, trace_name)</dt></dl> + +<dl><dt><a name="ValuesForSinglePage-__getitem__"><strong>__getitem__</strong></a>(self, trace_name)</dt></dl> + +<dl><dt><a name="ValuesForSinglePage-__init__"><strong>__init__</strong></a>(self, page)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>measurement_names</strong></dt> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_measurement_runner.html b/tools/telemetry/docs/telemetry.page.page_measurement_runner.html new file mode 100644 index 0000000..e0b8bb8 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_measurement_runner.html @@ -0,0 +1,107 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.page_measurement_runner</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.page_measurement_runner</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_measurement_runner.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_measurement_runner.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.page.page_measurement.html">telemetry.page.page_measurement</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.page_test_runner.html">telemetry.page.page_test_runner</a><br> +</td><td width="25%" valign=top><a href="sys.html">sys</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_test_runner.html#PageTestRunner">telemetry.page.page_test_runner.PageTestRunner</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_measurement_runner.html#PageMeasurementRunner">PageMeasurementRunner</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> <br> +<font color="#000000" face="helvetica, arial"><a name="PageMeasurementRunner">class <strong>PageMeasurementRunner</strong></a>(<a href="telemetry.page.page_test_runner.html#PageTestRunner">telemetry.page.page_test_runner.PageTestRunner</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.page.page_measurement_runner.html#PageMeasurementRunner">PageMeasurementRunner</a></dd> +<dd><a href="telemetry.page.page_test_runner.html#PageTestRunner">telemetry.page.page_test_runner.PageTestRunner</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>test_class</strong></dt> +</dl> +<dl><dt><strong>test_class_name</strong></dt> +</dl> +<hr> +Methods inherited from <a href="telemetry.page.page_test_runner.html#PageTestRunner">telemetry.page.page_test_runner.PageTestRunner</a>:<br> +<dl><dt><a name="PageMeasurementRunner-FindTestConstructors"><strong>FindTestConstructors</strong></a>(self, test_dir)</dt></dl> + +<dl><dt><a name="PageMeasurementRunner-FindTestName"><strong>FindTestName</strong></a>(self, test_constructors, args)</dt><dd><tt>Find the test name in an arbitrary argument list.<br> + <br> +We can't use the optparse parser, because the test may add its own<br> +command-line options. If the user passed in any of those, the<br> +optparse parsing will fail.<br> + <br> +Returns:<br> + test_name or None</tt></dd></dl> + +<dl><dt><a name="PageMeasurementRunner-GetModernizedTestName"><strong>GetModernizedTestName</strong></a>(self, arg)</dt><dd><tt>Sometimes tests change names but buildbots keep calling the old name.<br> + <br> +If arg matches an old test name, return the new test name instead.<br> +Otherwise, return the arg.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementRunner-GetPageSet"><strong>GetPageSet</strong></a>(self, test, page_set_filenames)</dt></dl> + +<dl><dt><a name="PageMeasurementRunner-ParseCommandLine"><strong>ParseCommandLine</strong></a>(self, args, test_dir, profile_creators_dir, page_set_filenames)</dt></dl> + +<dl><dt><a name="PageMeasurementRunner-PrintParseError"><strong>PrintParseError</strong></a>(self, message)</dt></dl> + +<dl><dt><a name="PageMeasurementRunner-Run"><strong>Run</strong></a>(self, test_dir, profile_creators_dir, page_set_filenames)</dt></dl> + +<dl><dt><a name="PageMeasurementRunner-__init__"><strong>__init__</strong></a>(self)</dt></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.page.page_test_runner.html#PageTestRunner">telemetry.page.page_test_runner.PageTestRunner</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-Main"><strong>Main</strong></a>(measurement_dir, profile_creators_dir, page_set_filenames)</dt><dd><tt>Turns a PageMeasurement into a command-line program.<br> + <br> +Args:<br> + measurement_dir: Path to directory containing PageMeasurements.<br> + profile_creators_dir: Path to directory containing ProfileCreators.</tt></dd></dl> +</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_measurement_unittest_base.html b/tools/telemetry/docs/telemetry.page.page_measurement_unittest_base.html new file mode 100644 index 0000000..3c3867d --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_measurement_unittest_base.html @@ -0,0 +1,346 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.page_measurement_unittest_base</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.page_measurement_unittest_base</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_measurement_unittest_base.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_measurement_unittest_base.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.unittest.options_for_unittests.html">telemetry.unittest.options_for_unittests</a><br> +<a href="os.html">os</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.page.html">telemetry.page.page</a><br> +<a href="telemetry.page.page_runner.html">telemetry.page.page_runner</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.page_set.html">telemetry.page.page_set</a><br> +<a href="unittest.html">unittest</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="unittest.case.html#TestCase">unittest.case.TestCase</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_measurement_unittest_base.html#PageMeasurementUnitTestBase">PageMeasurementUnitTestBase</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> <br> +<font color="#000000" face="helvetica, arial"><a name="PageMeasurementUnitTestBase">class <strong>PageMeasurementUnitTestBase</strong></a>(<a href="unittest.case.html#TestCase">unittest.case.TestCase</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>unittest.<a href="unittest.case.html#TestCase">TestCase</a>-derived class to help in the construction of unit tests<br> +for a measurement.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.page.page_measurement_unittest_base.html#PageMeasurementUnitTestBase">PageMeasurementUnitTestBase</a></dd> +<dd><a href="unittest.case.html#TestCase">unittest.case.TestCase</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="PageMeasurementUnitTestBase-CreatePageSet"><strong>CreatePageSet</strong></a>(self, test_filename)</dt></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-CreatePageSetFromFileInUnittestDataDir"><strong>CreatePageSetFromFileInUnittestDataDir</strong></a>(self, test_filename)</dt></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-RunMeasurement"><strong>RunMeasurement</strong></a>(self, measurement, ps, options<font color="#909090">=None</font>)</dt><dd><tt>Runs a measurement against a pageset, returning the rows its outputs.</tt></dd></dl> + +<hr> +Methods inherited from <a href="unittest.case.html#TestCase">unittest.case.TestCase</a>:<br> +<dl><dt><a name="PageMeasurementUnitTestBase-__call__"><strong>__call__</strong></a>(self, *args, **kwds)</dt></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-__eq__"><strong>__eq__</strong></a>(self, other)</dt></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-__hash__"><strong>__hash__</strong></a>(self)</dt></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-__init__"><strong>__init__</strong></a>(self, methodName<font color="#909090">='runTest'</font>)</dt><dd><tt>Create an instance of the class that will use the named test<br> +method when executed. Raises a ValueError if the instance does<br> +not have a method with the specified name.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-__ne__"><strong>__ne__</strong></a>(self, other)</dt></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-__repr__"><strong>__repr__</strong></a>(self)</dt></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-__str__"><strong>__str__</strong></a>(self)</dt></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-addCleanup"><strong>addCleanup</strong></a>(self, function, *args, **kwargs)</dt><dd><tt>Add a function, with arguments, to be called when the test is<br> +completed. Functions added are called on a LIFO basis and are<br> +called after tearDown on test failure or success.<br> + <br> +Cleanup items are called even if setUp fails (unlike tearDown).</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-addTypeEqualityFunc"><strong>addTypeEqualityFunc</strong></a>(self, typeobj, function)</dt><dd><tt>Add a type specific assertEqual style function to compare a type.<br> + <br> +This method is for use by <a href="unittest.case.html#TestCase">TestCase</a> subclasses that need to register<br> +their own type equality functions to provide nicer error messages.<br> + <br> +Args:<br> + typeobj: The data type to call this function on when both values<br> + are of the same type in <a href="#PageMeasurementUnitTestBase-assertEqual">assertEqual</a>().<br> + function: The callable taking two arguments and an optional<br> + msg= argument that raises self.<strong>failureException</strong> with a<br> + useful error message when the two arguments are not equal.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertAlmostEqual"><strong>assertAlmostEqual</strong></a>(self, first, second, places<font color="#909090">=None</font>, msg<font color="#909090">=None</font>, delta<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero, or by comparing that the<br> +between the two objects is more than the given delta.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).<br> + <br> +If the two objects compare equal then they will automatically<br> +compare almost equal.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertAlmostEquals"><strong>assertAlmostEquals</strong></a> = assertAlmostEqual(self, first, second, places<font color="#909090">=None</font>, msg<font color="#909090">=None</font>, delta<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero, or by comparing that the<br> +between the two objects is more than the given delta.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).<br> + <br> +If the two objects compare equal then they will automatically<br> +compare almost equal.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertDictContainsSubset"><strong>assertDictContainsSubset</strong></a>(self, expected, actual, msg<font color="#909090">=None</font>)</dt><dd><tt>Checks whether actual is a superset of expected.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertDictEqual"><strong>assertDictEqual</strong></a>(self, d1, d2, msg<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertEqual"><strong>assertEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertEquals"><strong>assertEquals</strong></a> = assertEqual(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertFalse"><strong>assertFalse</strong></a>(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Check that the expression is false.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertGreater"><strong>assertGreater</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#PageMeasurementUnitTestBase-assertTrue">assertTrue</a>(a > b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertGreaterEqual"><strong>assertGreaterEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#PageMeasurementUnitTestBase-assertTrue">assertTrue</a>(a >= b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertIn"><strong>assertIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#PageMeasurementUnitTestBase-assertTrue">assertTrue</a>(a in b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertIs"><strong>assertIs</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#PageMeasurementUnitTestBase-assertTrue">assertTrue</a>(a is b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertIsInstance"><strong>assertIsInstance</strong></a>(self, obj, cls, msg<font color="#909090">=None</font>)</dt><dd><tt>Same as <a href="#PageMeasurementUnitTestBase-assertTrue">assertTrue</a>(isinstance(obj, cls)), with a nicer<br> +default message.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertIsNone"><strong>assertIsNone</strong></a>(self, obj, msg<font color="#909090">=None</font>)</dt><dd><tt>Same as <a href="#PageMeasurementUnitTestBase-assertTrue">assertTrue</a>(obj is None), with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertIsNot"><strong>assertIsNot</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#PageMeasurementUnitTestBase-assertTrue">assertTrue</a>(a is not b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertIsNotNone"><strong>assertIsNotNone</strong></a>(self, obj, msg<font color="#909090">=None</font>)</dt><dd><tt>Included for symmetry with assertIsNone.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertItemsEqual"><strong>assertItemsEqual</strong></a>(self, expected_seq, actual_seq, msg<font color="#909090">=None</font>)</dt><dd><tt>An unordered sequence specific comparison. It asserts that<br> +actual_seq and expected_seq have the same element counts.<br> +Equivalent to::<br> + <br> + <a href="#PageMeasurementUnitTestBase-assertEqual">assertEqual</a>(Counter(iter(actual_seq)),<br> + Counter(iter(expected_seq)))<br> + <br> +Asserts that each element has the same count in both sequences.<br> +Example:<br> + - [0, 1, 1] and [1, 0, 1] compare equal.<br> + - [0, 0, 1] and [0, 1] compare unequal.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertLess"><strong>assertLess</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#PageMeasurementUnitTestBase-assertTrue">assertTrue</a>(a < b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertLessEqual"><strong>assertLessEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#PageMeasurementUnitTestBase-assertTrue">assertTrue</a>(a <= b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertListEqual"><strong>assertListEqual</strong></a>(self, list1, list2, msg<font color="#909090">=None</font>)</dt><dd><tt>A list-specific equality assertion.<br> + <br> +Args:<br> + list1: The first list to compare.<br> + list2: The second list to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertMultiLineEqual"><strong>assertMultiLineEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Assert that two multi-line strings are equal.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertNotAlmostEqual"><strong>assertNotAlmostEqual</strong></a>(self, first, second, places<font color="#909090">=None</font>, msg<font color="#909090">=None</font>, delta<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero, or by comparing that the<br> +between the two objects is less than the given delta.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).<br> + <br> +Objects that are equal automatically fail.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertNotAlmostEquals"><strong>assertNotAlmostEquals</strong></a> = assertNotAlmostEqual(self, first, second, places<font color="#909090">=None</font>, msg<font color="#909090">=None</font>, delta<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero, or by comparing that the<br> +between the two objects is less than the given delta.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).<br> + <br> +Objects that are equal automatically fail.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertNotEqual"><strong>assertNotEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertNotEquals"><strong>assertNotEquals</strong></a> = assertNotEqual(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertNotIn"><strong>assertNotIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#PageMeasurementUnitTestBase-assertTrue">assertTrue</a>(a not in b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertNotIsInstance"><strong>assertNotIsInstance</strong></a>(self, obj, cls, msg<font color="#909090">=None</font>)</dt><dd><tt>Included for symmetry with assertIsInstance.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertNotRegexpMatches"><strong>assertNotRegexpMatches</strong></a>(self, text, unexpected_regexp, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test if the text matches the regular expression.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertRaises"><strong>assertRaises</strong></a>(self, excClass, callableObj<font color="#909090">=None</font>, *args, **kwargs)</dt><dd><tt>Fail unless an exception of class excClass is thrown<br> +by callableObj when invoked with arguments args and keyword<br> +arguments kwargs. If a different type of exception is<br> +thrown, it will not be caught, and the test case will be<br> +deemed to have suffered an error, exactly as for an<br> +unexpected exception.<br> + <br> +If called with callableObj omitted or None, will return a<br> +context object used like this::<br> + <br> + with <a href="#PageMeasurementUnitTestBase-assertRaises">assertRaises</a>(SomeException):<br> + do_something()<br> + <br> +The context manager keeps a reference to the exception as<br> +the 'exception' attribute. This allows you to inspect the<br> +exception after the assertion::<br> + <br> + with <a href="#PageMeasurementUnitTestBase-assertRaises">assertRaises</a>(SomeException) as cm:<br> + do_something()<br> + the_exception = cm.exception<br> + <a href="#PageMeasurementUnitTestBase-assertEqual">assertEqual</a>(the_exception.error_code, 3)</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertRaisesRegexp"><strong>assertRaisesRegexp</strong></a>(self, expected_exception, expected_regexp, callable_obj<font color="#909090">=None</font>, *args, **kwargs)</dt><dd><tt>Asserts that the message in a raised exception matches a regexp.<br> + <br> +Args:<br> + expected_exception: Exception class expected to be raised.<br> + expected_regexp: Regexp (re pattern object or string) expected<br> + to be found in error message.<br> + callable_obj: Function to be called.<br> + args: Extra args.<br> + kwargs: Extra kwargs.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertRegexpMatches"><strong>assertRegexpMatches</strong></a>(self, text, expected_regexp, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test unless the text matches the regular expression.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertSequenceEqual"><strong>assertSequenceEqual</strong></a>(self, seq1, seq2, msg<font color="#909090">=None</font>, seq_type<font color="#909090">=None</font>)</dt><dd><tt>An equality assertion for ordered sequences (like lists and tuples).<br> + <br> +For the purposes of this function, a valid ordered sequence type is one<br> +which can be indexed, has a length, and has an equality operator.<br> + <br> +Args:<br> + seq1: The first sequence to compare.<br> + seq2: The second sequence to compare.<br> + seq_type: The expected datatype of the sequences, or None if no<br> + datatype should be enforced.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertSetEqual"><strong>assertSetEqual</strong></a>(self, set1, set2, msg<font color="#909090">=None</font>)</dt><dd><tt>A set-specific equality assertion.<br> + <br> +Args:<br> + set1: The first set to compare.<br> + set2: The second set to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.<br> + <br> +assertSetEqual uses ducktyping to support different types of sets, and<br> +is optimized for sets specifically (parameters must support a<br> +difference method).</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertTrue"><strong>assertTrue</strong></a>(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Check that the expression is true.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assertTupleEqual"><strong>assertTupleEqual</strong></a>(self, tuple1, tuple2, msg<font color="#909090">=None</font>)</dt><dd><tt>A tuple-specific equality assertion.<br> + <br> +Args:<br> + tuple1: The first tuple to compare.<br> + tuple2: The second tuple to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-assert_"><strong>assert_</strong></a> = assertTrue(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Check that the expression is true.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-countTestCases"><strong>countTestCases</strong></a>(self)</dt></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-debug"><strong>debug</strong></a>(self)</dt><dd><tt>Run the test without collecting errors in a TestResult</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-defaultTestResult"><strong>defaultTestResult</strong></a>(self)</dt></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-doCleanups"><strong>doCleanups</strong></a>(self)</dt><dd><tt>Execute all cleanup functions. Normally called for you after<br> +tearDown.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-fail"><strong>fail</strong></a>(self, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail immediately, with the given message.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-failIf"><strong>failIf</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-failIfAlmostEqual"><strong>failIfAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-failIfEqual"><strong>failIfEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-failUnless"><strong>failUnless</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-failUnlessAlmostEqual"><strong>failUnlessAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-failUnlessEqual"><strong>failUnlessEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-failUnlessRaises"><strong>failUnlessRaises</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-id"><strong>id</strong></a>(self)</dt></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-run"><strong>run</strong></a>(self, result<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-setUp"><strong>setUp</strong></a>(self)</dt><dd><tt>Hook method for setting up the test fixture before exercising it.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-shortDescription"><strong>shortDescription</strong></a>(self)</dt><dd><tt>Returns a one-line description of the test, or None if no<br> +description has been provided.<br> + <br> +The default implementation of this method returns the first line of<br> +the specified test method's docstring.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-skipTest"><strong>skipTest</strong></a>(self, reason)</dt><dd><tt>Skip this test.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-tearDown"><strong>tearDown</strong></a>(self)</dt><dd><tt>Hook method for deconstructing the test fixture after testing it.</tt></dd></dl> + +<hr> +Class methods inherited from <a href="unittest.case.html#TestCase">unittest.case.TestCase</a>:<br> +<dl><dt><a name="PageMeasurementUnitTestBase-setUpClass"><strong>setUpClass</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Hook method for setting up class fixture before running tests in the class.</tt></dd></dl> + +<dl><dt><a name="PageMeasurementUnitTestBase-tearDownClass"><strong>tearDownClass</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Hook method for deconstructing the class fixture after running all tests in the class.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="unittest.case.html#TestCase">unittest.case.TestCase</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Data and other attributes inherited from <a href="unittest.case.html#TestCase">unittest.case.TestCase</a>:<br> +<dl><dt><strong>failureException</strong> = <type 'exceptions.AssertionError'><dd><tt>Assertion failed.</tt></dl> + +<dl><dt><strong>longMessage</strong> = False</dl> + +<dl><dt><strong>maxDiff</strong> = 640</dl> + +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_measurement_value.html b/tools/telemetry/docs/telemetry.page.page_measurement_value.html new file mode 100644 index 0000000..4765a62 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_measurement_value.html @@ -0,0 +1,61 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.page_measurement_value</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.page_measurement_value</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_measurement_value.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_measurement_value.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.page.perf_tests_helper.html">telemetry.page.perf_tests_helper</a><br> +</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_measurement_value.html#PageMeasurementValue">PageMeasurementValue</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> <br> +<font color="#000000" face="helvetica, arial"><a name="PageMeasurementValue">class <strong>PageMeasurementValue</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="PageMeasurementValue-__init__"><strong>__init__</strong></a>(self, trace_name, units, value, chart_name, data_type)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>measurement_name</strong></dt> +</dl> +<dl><dt><strong>output_value</strong></dt> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_runner.html b/tools/telemetry/docs/telemetry.page.page_runner.html new file mode 100644 index 0000000..84d5844 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_runner.html @@ -0,0 +1,84 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.page_runner</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.page_runner</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_runner.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_runner.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.browser_finder.html">telemetry.core.browser_finder</a><br> +<a href="codecs.html">codecs</a><br> +<a href="telemetry.core.exceptions.html">telemetry.core.exceptions</a><br> +<a href="glob.html">glob</a><br> +</td><td width="25%" valign=top><a href="logging.html">logging</a><br> +<a href="os.html">os</a><br> +<a href="telemetry.page.page_filter.html">telemetry.page.page_filter</a><br> +<a href="telemetry.page.page_test.html">telemetry.page.page_test</a><br> +</td><td width="25%" valign=top><a href="random.html">random</a><br> +<a href="sys.html">sys</a><br> +<a href="time.html">time</a><br> +<a href="traceback.html">traceback</a><br> +</td><td width="25%" valign=top><a href="urlparse.html">urlparse</a><br> +<a href="telemetry.core.util.html">telemetry.core.util</a><br> +<a href="telemetry.core.wpr_modes.html">telemetry.core.wpr_modes</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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_runner.html#PageState">PageState</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> <br> +<font color="#000000" face="helvetica, arial"><a name="PageState">class <strong>PageState</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="PageState-CleanUpPage"><strong>CleanUpPage</strong></a>(self, page, tab)</dt></dl> + +<dl><dt><a name="PageState-PreparePage"><strong>PreparePage</strong></a>(self, test, page, tab)</dt></dl> + +<dl><dt><a name="PageState-__init__"><strong>__init__</strong></a>(self)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-AddCommandLineOptions"><strong>AddCommandLineOptions</strong></a>(parser)</dt></dl> + <dl><dt><a name="-Run"><strong>Run</strong></a>(test, page_set, options)</dt><dd><tt>Runs a given test against a given page_set with the given options.</tt></dd></dl> +</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_set.html b/tools/telemetry/docs/telemetry.page.page_set.html new file mode 100644 index 0000000..a930673 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_set.html @@ -0,0 +1,82 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.page_set</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.page_set</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_set.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_set.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="csv.html">csv</a><br> +<a href="json.html">json</a><br> +</td><td width="25%" valign=top><a href="os.html">os</a><br> +<a href="telemetry.page.page.html">telemetry.page.page</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.page_set_archive_info.html">telemetry.page.page_set_archive_info</a><br> +<a href="urlparse.html">urlparse</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_set.html#PageSet">PageSet</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> <br> +<font color="#000000" face="helvetica, arial"><a name="PageSet">class <strong>PageSet</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="PageSet-ContainsOnlyFileURLs"><strong>ContainsOnlyFileURLs</strong></a>(self)</dt></dl> + +<dl><dt><a name="PageSet-ReorderPageSet"><strong>ReorderPageSet</strong></a>(self, results_file)</dt><dd><tt>Reorders this page set based on the results of a past run.</tt></dd></dl> + +<dl><dt><a name="PageSet-WprFilePathForPage"><strong>WprFilePathForPage</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="PageSet-__getitem__"><strong>__getitem__</strong></a>(self, key)</dt></dl> + +<dl><dt><a name="PageSet-__init__"><strong>__init__</strong></a>(self, file_path<font color="#909090">=''</font>, attributes<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="PageSet-__iter__"><strong>__iter__</strong></a>(self)</dt></dl> + +<dl><dt><a name="PageSet-__len__"><strong>__len__</strong></a>(self)</dt></dl> + +<dl><dt><a name="PageSet-__setitem__"><strong>__setitem__</strong></a>(self, key, value)</dt></dl> + +<hr> +Class methods defined here:<br> +<dl><dt><a name="PageSet-FromDict"><strong>FromDict</strong></a>(cls, data, file_path)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl> + +<dl><dt><a name="PageSet-FromFile"><strong>FromFile</strong></a>(cls, file_path)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_set_archive_info.html b/tools/telemetry/docs/telemetry.page.page_set_archive_info.html new file mode 100644 index 0000000..873400b --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_set_archive_info.html @@ -0,0 +1,71 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.page_set_archive_info</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.page_set_archive_info</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_set_archive_info.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_set_archive_info.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="json.html">json</a><br> +<a href="logging.html">logging</a><br> +</td><td width="25%" valign=top><a href="os.html">os</a><br> +<a href="re.html">re</a><br> +</td><td width="25%" valign=top><a href="shutil.html">shutil</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_set_archive_info.html#PageSetArchiveInfo">PageSetArchiveInfo</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> <br> +<font color="#000000" face="helvetica, arial"><a name="PageSetArchiveInfo">class <strong>PageSetArchiveInfo</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="PageSetArchiveInfo-AddNewTemporaryRecording"><strong>AddNewTemporaryRecording</strong></a>(self, temp_target_wpr_file_path)</dt></dl> + +<dl><dt><a name="PageSetArchiveInfo-AddRecordedPages"><strong>AddRecordedPages</strong></a>(self, urls)</dt></dl> + +<dl><dt><a name="PageSetArchiveInfo-WprFilePathForPage"><strong>WprFilePathForPage</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="PageSetArchiveInfo-__init__"><strong>__init__</strong></a>(self, archive_data_file_path, page_set_file_path, data)</dt></dl> + +<hr> +Class methods defined here:<br> +<dl><dt><a name="PageSetArchiveInfo-FromFile"><strong>FromFile</strong></a>(cls, file_path, page_set_file_path)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_test.html b/tools/telemetry/docs/telemetry.page.page_test.html new file mode 100644 index 0000000..5d78d3e --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_test.html @@ -0,0 +1,190 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.page_test</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.page_test</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_test.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_test.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.page.actions.all_page_actions.html">telemetry.page.actions.all_page_actions</a><br> +<a href="telemetry.page.gtest_test_results.html">telemetry.page.gtest_test_results</a><br> +</td><td width="25%" valign=top><a href="logging.html">logging</a><br> +<a href="telemetry.page.actions.page_action.html">telemetry.page.actions.page_action</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.page_test_results.html">telemetry.page.page_test_results</a><br> +<a href="telemetry.core.util.html">telemetry.core.util</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_test.html#PageTest">PageTest</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_test.html#Failure">Failure</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> <br> +<font color="#000000" face="helvetica, arial"><a name="Failure">class <strong>Failure</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt><a href="exceptions.html#Exception">Exception</a> that can be thrown from PageMeasurement to indicate an<br> +undesired but designed-for problem.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.page.page_test.html#Failure">Failure</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><a name="Failure-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> + +<hr> +Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#Failure-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> + +<hr> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><a name="Failure-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> + +<dl><dt><a name="Failure-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> + +<dl><dt><a name="Failure-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="Failure-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + +<dl><dt><a name="Failure-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> + +<dl><dt><a name="Failure-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> + +<dl><dt><a name="Failure-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> + +<dl><dt><a name="Failure-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> + +<dl><dt><a name="Failure-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__str__">__str__</a>() <==> str(x)</tt></dd></dl> + +<dl><dt><a name="Failure-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> + +<hr> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +</dl> +<dl><dt><strong>args</strong></dt> +</dl> +<dl><dt><strong>message</strong></dt> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="PageTest">class <strong>PageTest</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt>A class styled on unittest.TestCase for creating page-specific tests.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="PageTest-AddCommandLineOptions"><strong>AddCommandLineOptions</strong></a>(self, parser)</dt><dd><tt>Override to expose command-line options for this test.<br> + <br> +The provided parser is an optparse.OptionParser instance and accepts all<br> +normal results. The parsed options are available in Run as<br> +self.<strong>options</strong>.</tt></dd></dl> + +<dl><dt><a name="PageTest-AddOutputOptions"><strong>AddOutputOptions</strong></a>(self, parser)</dt></dl> + +<dl><dt><a name="PageTest-CanRunForPage"><strong>CanRunForPage</strong></a>(self, page)</dt><dd><tt>Override to customize if the test can be ran for the given page.</tt></dd></dl> + +<dl><dt><a name="PageTest-CreatePageSet"><strong>CreatePageSet</strong></a>(self, args, options)</dt><dd><tt>Override to make this test generate its own page set instead of<br> +allowing arbitrary page sets entered from the command-line.</tt></dd></dl> + +<dl><dt><a name="PageTest-CustomizeBrowserOptions"><strong>CustomizeBrowserOptions</strong></a>(self, options)</dt><dd><tt>Override to add test-specific options to the BrowserOptions <a href="__builtin__.html#object">object</a></tt></dd></dl> + +<dl><dt><a name="PageTest-CustomizeBrowserOptionsForPage"><strong>CustomizeBrowserOptionsForPage</strong></a>(self, page, options)</dt><dd><tt>Add options specific to the test and the given page.</tt></dd></dl> + +<dl><dt><a name="PageTest-DidNavigateToPage"><strong>DidNavigateToPage</strong></a>(self, page, tab)</dt><dd><tt>Override to do operations right after the page is navigated, but before<br> +any waiting for completion has occurred.</tt></dd></dl> + +<dl><dt><a name="PageTest-DidRunAction"><strong>DidRunAction</strong></a>(self, page, tab, action)</dt><dd><tt>Override to do operations after running the action on the page.</tt></dd></dl> + +<dl><dt><a name="PageTest-DidRunPageSet"><strong>DidRunPageSet</strong></a>(self, tab, results)</dt><dd><tt>Override to do operations after page set is completed, but before browser<br> +is torn down.</tt></dd></dl> + +<dl><dt><a name="PageTest-DidStartHTTPServer"><strong>DidStartHTTPServer</strong></a>(self, tab)</dt><dd><tt>Override to do operations after the HTTP server is started.</tt></dd></dl> + +<dl><dt><a name="PageTest-NeedsBrowserRestartAfterEachRun"><strong>NeedsBrowserRestartAfterEachRun</strong></a>(self, tab)</dt><dd><tt>Override to specify browser restart after each run.</tt></dd></dl> + +<dl><dt><a name="PageTest-PrepareResults"><strong>PrepareResults</strong></a>(self, options)</dt></dl> + +<dl><dt><a name="PageTest-Run"><strong>Run</strong></a>(self, options, page, tab, results)</dt></dl> + +<dl><dt><a name="PageTest-SetUpBrowser"><strong>SetUpBrowser</strong></a>(self, browser)</dt><dd><tt>Override to customize the browser right after it has launched.</tt></dd></dl> + +<dl><dt><a name="PageTest-WillNavigateToPage"><strong>WillNavigateToPage</strong></a>(self, page, tab)</dt><dd><tt>Override to do operations before the page is navigated.</tt></dd></dl> + +<dl><dt><a name="PageTest-WillRunAction"><strong>WillRunAction</strong></a>(self, page, tab, action)</dt><dd><tt>Override to do operations before running the action on the page.</tt></dd></dl> + +<dl><dt><a name="PageTest-WillRunPageSet"><strong>WillRunPageSet</strong></a>(self, tab)</dt><dd><tt>Override to do operations before the page set is navigated.</tt></dd></dl> + +<dl><dt><a name="PageTest-__init__"><strong>__init__</strong></a>(self, test_method_name, action_name_to_run<font color="#909090">=''</font>, needs_browser_restart_after_each_run<font color="#909090">=False</font>, discard_first_result<font color="#909090">=False</font>)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>action_name_to_run</strong></dt> +</dl> +<dl><dt><strong>discard_first_result</strong></dt> +<dd><tt>When set to True, the first run of the test is discarded. This is<br> +useful for cases where it's desirable to have some test resource cached so<br> +the first run of the test can warm things up.</tt></dd> +</dl> +<dl><dt><strong>output_format_choices</strong></dt> +<dd><tt>Allowed output formats. The default is the first item in the list.</tt></dd> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-GetCompoundActionFromPage"><strong>GetCompoundActionFromPage</strong></a>(page, action_name)</dt></dl> +</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_test_results.html b/tools/telemetry/docs/telemetry.page.page_test_results.html new file mode 100644 index 0000000..cd7849e --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_test_results.html @@ -0,0 +1,120 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.page_test_results</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.page_test_results</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_test_results.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_test_results.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2013 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="logging.html">logging</a><br> +</td><td width="25%" valign=top><a href="sys.html">sys</a><br> +</td><td width="25%" valign=top><a href="traceback.html">traceback</a><br> +</td><td width="25%" valign=top><a href="unittest.html">unittest</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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="unittest.result.html#TestResult">unittest.result.TestResult</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_test_results.html#PageTestResults">PageTestResults</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> <br> +<font color="#000000" face="helvetica, arial"><a name="PageTestResults">class <strong>PageTestResults</strong></a>(<a href="unittest.result.html#TestResult">unittest.result.TestResult</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.page.page_test_results.html#PageTestResults">PageTestResults</a></dd> +<dd><a href="unittest.result.html#TestResult">unittest.result.TestResult</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="PageTestResults-AddError"><strong>AddError</strong></a>(self, page, err)</dt></dl> + +<dl><dt><a name="PageTestResults-AddErrorMessage"><strong>AddErrorMessage</strong></a>(self, page, message)</dt></dl> + +<dl><dt><a name="PageTestResults-AddFailure"><strong>AddFailure</strong></a>(self, page, err)</dt></dl> + +<dl><dt><a name="PageTestResults-AddFailureMessage"><strong>AddFailureMessage</strong></a>(self, page, message)</dt></dl> + +<dl><dt><a name="PageTestResults-AddSkip"><strong>AddSkip</strong></a>(self, page, reason)</dt></dl> + +<dl><dt><a name="PageTestResults-AddSuccess"><strong>AddSuccess</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="PageTestResults-PrintSummary"><strong>PrintSummary</strong></a>(self)</dt></dl> + +<dl><dt><a name="PageTestResults-StartTest"><strong>StartTest</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="PageTestResults-StopTest"><strong>StopTest</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="PageTestResults-__init__"><strong>__init__</strong></a>(self)</dt></dl> + +<dl><dt><a name="PageTestResults-addSkip"><strong>addSkip</strong></a>(self, test, reason)</dt></dl> + +<dl><dt><a name="PageTestResults-addSuccess"><strong>addSuccess</strong></a>(self, test)</dt></dl> + +<hr> +Methods inherited from <a href="unittest.result.html#TestResult">unittest.result.TestResult</a>:<br> +<dl><dt><a name="PageTestResults-__repr__"><strong>__repr__</strong></a>(self)</dt></dl> + +<dl><dt><a name="PageTestResults-addError"><strong>addError</strong></a>(self, *args, **kw)</dt><dd><tt>Called when an error has occurred. 'err' is a tuple of values as<br> +returned by sys.exc_info().</tt></dd></dl> + +<dl><dt><a name="PageTestResults-addExpectedFailure"><strong>addExpectedFailure</strong></a>(self, test, err)</dt><dd><tt>Called when an expected failure/error occured.</tt></dd></dl> + +<dl><dt><a name="PageTestResults-addFailure"><strong>addFailure</strong></a>(self, *args, **kw)</dt><dd><tt>Called when an error has occurred. 'err' is a tuple of values as<br> +returned by sys.exc_info().</tt></dd></dl> + +<dl><dt><a name="PageTestResults-addUnexpectedSuccess"><strong>addUnexpectedSuccess</strong></a>(self, *args, **kw)</dt><dd><tt>Called when a test was expected to fail, but succeed.</tt></dd></dl> + +<dl><dt><a name="PageTestResults-printErrors"><strong>printErrors</strong></a>(self)</dt><dd><tt>Called by TestRunner after test run</tt></dd></dl> + +<dl><dt><a name="PageTestResults-startTest"><strong>startTest</strong></a>(self, test)</dt><dd><tt>Called when the given test is about to be run</tt></dd></dl> + +<dl><dt><a name="PageTestResults-startTestRun"><strong>startTestRun</strong></a>(self)</dt><dd><tt>Called once before any tests are executed.<br> + <br> +See startTest for a method called before each test.</tt></dd></dl> + +<dl><dt><a name="PageTestResults-stop"><strong>stop</strong></a>(self)</dt><dd><tt>Indicates that the tests should be aborted</tt></dd></dl> + +<dl><dt><a name="PageTestResults-stopTest"><strong>stopTest</strong></a>(self, test)</dt><dd><tt>Called when the given test has been run</tt></dd></dl> + +<dl><dt><a name="PageTestResults-stopTestRun"><strong>stopTestRun</strong></a>(self)</dt><dd><tt>Called once after all tests are executed.<br> + <br> +See stopTest for a method called after each test.</tt></dd></dl> + +<dl><dt><a name="PageTestResults-wasSuccessful"><strong>wasSuccessful</strong></a>(self)</dt><dd><tt>Tells whether or not this result was a success</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="unittest.result.html#TestResult">unittest.result.TestResult</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_test_runner.html b/tools/telemetry/docs/telemetry.page.page_test_runner.html new file mode 100644 index 0000000..bf6d768 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_test_runner.html @@ -0,0 +1,104 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.page_test_runner</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.page_test_runner</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_test_runner.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_test_runner.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.browser_options.html">telemetry.core.browser_options</a><br> +<a href="telemetry.core.discover.html">telemetry.core.discover</a><br> +</td><td width="25%" valign=top><a href="os.html">os</a><br> +<a href="telemetry.page.page_runner.html">telemetry.page.page_runner</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.page_set.html">telemetry.page.page_set</a><br> +<a href="telemetry.page.page_test.html">telemetry.page.page_test</a><br> +</td><td width="25%" valign=top><a href="telemetry.core.profile_types.html">telemetry.core.profile_types</a><br> +<a href="sys.html">sys</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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_test_runner.html#PageTestRunner">PageTestRunner</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> <br> +<font color="#000000" face="helvetica, arial"><a name="PageTestRunner">class <strong>PageTestRunner</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="PageTestRunner-FindTestConstructors"><strong>FindTestConstructors</strong></a>(self, test_dir)</dt></dl> + +<dl><dt><a name="PageTestRunner-FindTestName"><strong>FindTestName</strong></a>(self, test_constructors, args)</dt><dd><tt>Find the test name in an arbitrary argument list.<br> + <br> +We can't use the optparse parser, because the test may add its own<br> +command-line options. If the user passed in any of those, the<br> +optparse parsing will fail.<br> + <br> +Returns:<br> + test_name or None</tt></dd></dl> + +<dl><dt><a name="PageTestRunner-GetModernizedTestName"><strong>GetModernizedTestName</strong></a>(self, arg)</dt><dd><tt>Sometimes tests change names but buildbots keep calling the old name.<br> + <br> +If arg matches an old test name, return the new test name instead.<br> +Otherwise, return the arg.</tt></dd></dl> + +<dl><dt><a name="PageTestRunner-GetPageSet"><strong>GetPageSet</strong></a>(self, test, page_set_filenames)</dt></dl> + +<dl><dt><a name="PageTestRunner-ParseCommandLine"><strong>ParseCommandLine</strong></a>(self, args, test_dir, profile_creators_dir, page_set_filenames)</dt></dl> + +<dl><dt><a name="PageTestRunner-PrintParseError"><strong>PrintParseError</strong></a>(self, message)</dt></dl> + +<dl><dt><a name="PageTestRunner-Run"><strong>Run</strong></a>(self, test_dir, profile_creators_dir, page_set_filenames)</dt></dl> + +<dl><dt><a name="PageTestRunner-__init__"><strong>__init__</strong></a>(self)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>test_class</strong></dt> +</dl> +<dl><dt><strong>test_class_name</strong></dt> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-Main"><strong>Main</strong></a>(test_dir, profile_creators_dir, page_set_filenames)</dt><dd><tt>Turns a PageTest into a command-line program.<br> + <br> +Args:<br> + test_dir: Path to directory containing PageTests.<br> + profile_creators_dir: Path to a directory containing ProfileCreators</tt></dd></dl> +</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.perf_tests_helper.html b/tools/telemetry/docs/telemetry.page.perf_tests_helper.html new file mode 100644 index 0000000..0017ea5 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.perf_tests_helper.html @@ -0,0 +1,41 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.perf_tests_helper</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.perf_tests_helper</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/perf_tests_helper.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/perf_tests_helper.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="os.html">os</a><br> +</td><td width="25%" valign=top><a href="pylib.perf_tests_helper.html">pylib.perf_tests_helper</a><br> +</td><td width="25%" valign=top><a href="sys.html">sys</a><br> +</td><td width="25%" valign=top></td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-__init__"><strong>__init__</strong></a>()</dt></dl> +</td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>absolute_import</strong> = _Feature((2, 5, 0, 'alpha', 1), (2, 7, 0, 'alpha', 0), 16384)</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.record_wpr.html b/tools/telemetry/docs/telemetry.page.record_wpr.html new file mode 100644 index 0000000..0893900 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.record_wpr.html @@ -0,0 +1,137 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.page.record_wpr</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.record_wpr</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/record_wpr.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/record_wpr.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.browser_finder.html">telemetry.core.browser_finder</a><br> +<a href="telemetry.core.browser_options.html">telemetry.core.browser_options</a><br> +<a href="telemetry.core.discover.html">telemetry.core.discover</a><br> +<a href="logging.html">logging</a><br> +</td><td width="25%" valign=top><a href="os.html">os</a><br> +<a href="telemetry.page.page_measurement.html">telemetry.page.page_measurement</a><br> +<a href="telemetry.page.page_runner.html">telemetry.page.page_runner</a><br> +<a href="telemetry.page.page_set.html">telemetry.page.page_set</a><br> +</td><td width="25%" valign=top><a href="telemetry.page.page_test.html">telemetry.page.page_test</a><br> +<a href="telemetry.page.page_test_results.html">telemetry.page.page_test_results</a><br> +<a href="sys.html">sys</a><br> +<a href="tempfile.html">tempfile</a><br> +</td><td width="25%" valign=top><a href="time.html">time</a><br> +<a href="telemetry.core.wpr_modes.html">telemetry.core.wpr_modes</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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.page.record_wpr.html#RecordPage">RecordPage</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> <br> +<font color="#000000" face="helvetica, arial"><a name="RecordPage">class <strong>RecordPage</strong></a>(<a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.page.record_wpr.html#RecordPage">RecordPage</a></dd> +<dd><a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="RecordPage-CanRunForPage"><strong>CanRunForPage</strong></a>(self, page)</dt></dl> + +<dl><dt><a name="RecordPage-CustomizeBrowserOptionsForPage"><strong>CustomizeBrowserOptionsForPage</strong></a>(self, page, options)</dt></dl> + +<dl><dt><a name="RecordPage-Run"><strong>Run</strong></a>(self, options, page, tab, results)</dt></dl> + +<dl><dt><a name="RecordPage-__init__"><strong>__init__</strong></a>(self, measurements)</dt></dl> + +<hr> +Methods inherited from <a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>:<br> +<dl><dt><a name="RecordPage-AddCommandLineOptions"><strong>AddCommandLineOptions</strong></a>(self, parser)</dt><dd><tt>Override to expose command-line options for this test.<br> + <br> +The provided parser is an optparse.OptionParser instance and accepts all<br> +normal results. The parsed options are available in Run as<br> +self.<strong>options</strong>.</tt></dd></dl> + +<dl><dt><a name="RecordPage-AddOutputOptions"><strong>AddOutputOptions</strong></a>(self, parser)</dt></dl> + +<dl><dt><a name="RecordPage-CreatePageSet"><strong>CreatePageSet</strong></a>(self, args, options)</dt><dd><tt>Override to make this test generate its own page set instead of<br> +allowing arbitrary page sets entered from the command-line.</tt></dd></dl> + +<dl><dt><a name="RecordPage-CustomizeBrowserOptions"><strong>CustomizeBrowserOptions</strong></a>(self, options)</dt><dd><tt>Override to add test-specific options to the BrowserOptions object</tt></dd></dl> + +<dl><dt><a name="RecordPage-DidNavigateToPage"><strong>DidNavigateToPage</strong></a>(self, page, tab)</dt><dd><tt>Override to do operations right after the page is navigated, but before<br> +any waiting for completion has occurred.</tt></dd></dl> + +<dl><dt><a name="RecordPage-DidRunAction"><strong>DidRunAction</strong></a>(self, page, tab, action)</dt><dd><tt>Override to do operations after running the action on the page.</tt></dd></dl> + +<dl><dt><a name="RecordPage-DidRunPageSet"><strong>DidRunPageSet</strong></a>(self, tab, results)</dt><dd><tt>Override to do operations after page set is completed, but before browser<br> +is torn down.</tt></dd></dl> + +<dl><dt><a name="RecordPage-DidStartHTTPServer"><strong>DidStartHTTPServer</strong></a>(self, tab)</dt><dd><tt>Override to do operations after the HTTP server is started.</tt></dd></dl> + +<dl><dt><a name="RecordPage-NeedsBrowserRestartAfterEachRun"><strong>NeedsBrowserRestartAfterEachRun</strong></a>(self, tab)</dt><dd><tt>Override to specify browser restart after each run.</tt></dd></dl> + +<dl><dt><a name="RecordPage-PrepareResults"><strong>PrepareResults</strong></a>(self, options)</dt></dl> + +<dl><dt><a name="RecordPage-SetUpBrowser"><strong>SetUpBrowser</strong></a>(self, browser)</dt><dd><tt>Override to customize the browser right after it has launched.</tt></dd></dl> + +<dl><dt><a name="RecordPage-WillNavigateToPage"><strong>WillNavigateToPage</strong></a>(self, page, tab)</dt><dd><tt>Override to do operations before the page is navigated.</tt></dd></dl> + +<dl><dt><a name="RecordPage-WillRunAction"><strong>WillRunAction</strong></a>(self, page, tab, action)</dt><dd><tt>Override to do operations before running the action on the page.</tt></dd></dl> + +<dl><dt><a name="RecordPage-WillRunPageSet"><strong>WillRunPageSet</strong></a>(self, tab)</dt><dd><tt>Override to do operations before the page set is navigated.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<dl><dt><strong>action_name_to_run</strong></dt> +</dl> +<dl><dt><strong>discard_first_result</strong></dt> +<dd><tt>When set to True, the first run of the test is discarded. This is<br> +useful for cases where it's desirable to have some test resource cached so<br> +the first run of the test can warm things up.</tt></dd> +</dl> +<dl><dt><strong>output_format_choices</strong></dt> +<dd><tt>Allowed output formats. The default is the first item in the list.</tt></dd> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-Main"><strong>Main</strong></a>(measurement_dir)</dt></dl> +</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.unittest.gtest_testrunner.html b/tools/telemetry/docs/telemetry.unittest.gtest_testrunner.html new file mode 100644 index 0000000..9108b9a --- /dev/null +++ b/tools/telemetry/docs/telemetry.unittest.gtest_testrunner.html @@ -0,0 +1,121 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.unittest.gtest_testrunner</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.unittest.html"><font color="#ffffff">unittest</font></a>.gtest_testrunner</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/unittest/gtest_testrunner.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/unittest/gtest_testrunner.py</a></font></td></tr></table> + <p><tt>Implements a unittest TestRunner with GTest output.<br> + <br> +This output is ported from gtest.cc's PrettyUnitTestResultPrinter, but<br> +designed to be a drop-in replacement for unittest's TextTestRunner.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.page.gtest_test_results.html">telemetry.page.gtest_test_results</a><br> +</td><td width="25%" valign=top><a href="time.html">time</a><br> +</td><td width="25%" valign=top><a href="unittest.html">unittest</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.unittest.gtest_testrunner.html#GTestTestRunner">GTestTestRunner</a> +</font></dt></dl> +</dd> +<dt><font face="helvetica, arial"><a href="unittest.suite.html#TestSuite">unittest.suite.TestSuite</a>(<a href="unittest.suite.html#BaseTestSuite">unittest.suite.BaseTestSuite</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.unittest.gtest_testrunner.html#GTestTestSuite">GTestTestSuite</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> <br> +<font color="#000000" face="helvetica, arial"><a name="GTestTestRunner">class <strong>GTestTestRunner</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="GTestTestRunner-__init__"><strong>__init__</strong></a>(self, print_result_after_run<font color="#909090">=True</font>, runner<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="GTestTestRunner-run"><strong>run</strong></a>(self, test)</dt><dd><tt>Run the given test case or test suite.</tt></dd></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="GTestTestSuite">class <strong>GTestTestSuite</strong></a>(<a href="unittest.suite.html#TestSuite">unittest.suite.TestSuite</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.unittest.gtest_testrunner.html#GTestTestSuite">GTestTestSuite</a></dd> +<dd><a href="unittest.suite.html#TestSuite">unittest.suite.TestSuite</a></dd> +<dd><a href="unittest.suite.html#BaseTestSuite">unittest.suite.BaseTestSuite</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="GTestTestSuite-__call__"><strong>__call__</strong></a>(self, *args, **kwargs)</dt></dl> + +<hr> +Methods inherited from <a href="unittest.suite.html#TestSuite">unittest.suite.TestSuite</a>:<br> +<dl><dt><a name="GTestTestSuite-debug"><strong>debug</strong></a>(self)</dt><dd><tt>Run the tests without collecting errors in a TestResult</tt></dd></dl> + +<dl><dt><a name="GTestTestSuite-run"><strong>run</strong></a>(self, result, debug<font color="#909090">=False</font>)</dt></dl> + +<hr> +Methods inherited from <a href="unittest.suite.html#BaseTestSuite">unittest.suite.BaseTestSuite</a>:<br> +<dl><dt><a name="GTestTestSuite-__eq__"><strong>__eq__</strong></a>(self, other)</dt></dl> + +<dl><dt><a name="GTestTestSuite-__init__"><strong>__init__</strong></a>(self, tests<font color="#909090">=()</font>)</dt></dl> + +<dl><dt><a name="GTestTestSuite-__iter__"><strong>__iter__</strong></a>(self)</dt></dl> + +<dl><dt><a name="GTestTestSuite-__ne__"><strong>__ne__</strong></a>(self, other)</dt></dl> + +<dl><dt><a name="GTestTestSuite-__repr__"><strong>__repr__</strong></a>(self)</dt></dl> + +<dl><dt><a name="GTestTestSuite-addTest"><strong>addTest</strong></a>(self, test)</dt></dl> + +<dl><dt><a name="GTestTestSuite-addTests"><strong>addTests</strong></a>(self, tests)</dt></dl> + +<dl><dt><a name="GTestTestSuite-countTestCases"><strong>countTestCases</strong></a>(self)</dt></dl> + +<hr> +Data descriptors inherited from <a href="unittest.suite.html#BaseTestSuite">unittest.suite.BaseTestSuite</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Data and other attributes inherited from <a href="unittest.suite.html#BaseTestSuite">unittest.suite.BaseTestSuite</a>:<br> +<dl><dt><strong>__hash__</strong> = None</dl> + +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.unittest.html b/tools/telemetry/docs/telemetry.unittest.html new file mode 100644 index 0000000..803475f --- /dev/null +++ b/tools/telemetry/docs/telemetry.unittest.html @@ -0,0 +1,41 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: package telemetry.unittest</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.unittest</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/unittest/__init__.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/unittest/__init__.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></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.unittest.gtest_testrunner.html">gtest_testrunner</a><br> +<a href="telemetry.unittest.options_for_unittests.html">options_for_unittests</a><br> +</td><td width="25%" valign=top><a href="telemetry.unittest.run_tests.html">run_tests</a><br> +<a href="telemetry.unittest.simple_mock.html">simple_mock</a><br> +</td><td width="25%" valign=top><a href="telemetry.unittest.simple_mock_unittest.html">simple_mock_unittest</a><br> +<a href="telemetry.unittest.system_stub.html">system_stub</a><br> +</td><td width="25%" valign=top><a href="telemetry.unittest.tab_test_case.html">tab_test_case</a><br> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-DisabledTest"><strong>DisabledTest</strong></a>(func)</dt></dl> + <dl><dt><a name="-RequiresBrowserOfType"><strong>RequiresBrowserOfType</strong></a>(*types)</dt><dd><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></dd></dl> +</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.unittest.options_for_unittests.html b/tools/telemetry/docs/telemetry.unittest.options_for_unittests.html new file mode 100644 index 0000000..87c5a76 --- /dev/null +++ b/tools/telemetry/docs/telemetry.unittest.options_for_unittests.html @@ -0,0 +1,31 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.unittest.options_for_unittests</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.unittest.html"><font color="#ffffff">unittest</font></a>.options_for_unittests</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/unittest/options_for_unittests.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/unittest/options_for_unittests.py</a></font></td></tr></table> + <p><tt>This module provides the global variable options_for_unittests.<br> + <br> +This is set to a BrowserOptions object by the test harness, or None<br> +if unit tests are not running.<br> + <br> +This allows multiple unit tests to use a specific<br> +browser, in face of multiple options.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-AreSet"><strong>AreSet</strong></a>()</dt></dl> + <dl><dt><a name="-GetBrowserType"><strong>GetBrowserType</strong></a>()</dt></dl> + <dl><dt><a name="-GetCopy"><strong>GetCopy</strong></a>()</dt></dl> + <dl><dt><a name="-Set"><strong>Set</strong></a>(options, browser_type)</dt></dl> +</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.unittest.run_tests.html b/tools/telemetry/docs/telemetry.unittest.run_tests.html new file mode 100644 index 0000000..4b3e0614 --- /dev/null +++ b/tools/telemetry/docs/telemetry.unittest.run_tests.html @@ -0,0 +1,42 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.unittest.run_tests</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.unittest.html"><font color="#ffffff">unittest</font></a>.run_tests</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/unittest/run_tests.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/unittest/run_tests.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.browser_options.html">telemetry.core.browser_options</a><br> +<a href="telemetry.core.discover.html">telemetry.core.discover</a><br> +</td><td width="25%" valign=top><a href="telemetry.unittest.gtest_testrunner.html">telemetry.unittest.gtest_testrunner</a><br> +<a href="logging.html">logging</a><br> +</td><td width="25%" valign=top><a href="telemetry.unittest.options_for_unittests.html">telemetry.unittest.options_for_unittests</a><br> +<a href="os.html">os</a><br> +</td><td width="25%" valign=top><a href="sys.html">sys</a><br> +<a href="unittest.html">unittest</a><br> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#eeaa77"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> + +<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt><a name="-Discover"><strong>Discover</strong></a>(start_dir, top_level_dir<font color="#909090">=None</font>, pattern<font color="#909090">='test*.py'</font>)</dt></dl> + <dl><dt><a name="-DiscoverAndRunTests"><strong>DiscoverAndRunTests</strong></a>(dir_name, args, top_level_dir, runner<font color="#909090">=None</font>, run_disabled_tests<font color="#909090">=False</font>)</dt></dl> + <dl><dt><a name="-FilterSuite"><strong>FilterSuite</strong></a>(suite, predicate)</dt></dl> + <dl><dt><a name="-Main"><strong>Main</strong></a>(args, start_dir, top_level_dir, runner<font color="#909090">=None</font>)</dt><dd><tt>Unit test suite that collects all test cases for telemetry.</tt></dd></dl> +</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.unittest.simple_mock.html b/tools/telemetry/docs/telemetry.unittest.simple_mock.html new file mode 100644 index 0000000..662e668 --- /dev/null +++ b/tools/telemetry/docs/telemetry.unittest.simple_mock.html @@ -0,0 +1,106 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.unittest.simple_mock</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.unittest.html"><font color="#ffffff">unittest</font></a>.simple_mock</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/unittest/simple_mock.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/unittest/simple_mock.py</a></font></td></tr></table> + <p><tt>A very very simple mock <a href="__builtin__.html#object">object</a> harness.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ee77aa"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.unittest.simple_mock.html#MockFunctionCall">MockFunctionCall</a> +</font></dt><dt><font face="helvetica, arial"><a href="telemetry.unittest.simple_mock.html#MockObject">MockObject</a> +</font></dt><dt><font face="helvetica, arial"><a href="telemetry.unittest.simple_mock.html#MockTrace">MockTrace</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> <br> +<font color="#000000" face="helvetica, arial"><a name="MockFunctionCall">class <strong>MockFunctionCall</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="MockFunctionCall-VerifyEquals"><strong>VerifyEquals</strong></a>(self, got)</dt></dl> + +<dl><dt><a name="MockFunctionCall-WhenCalled"><strong>WhenCalled</strong></a>(self, handler)</dt></dl> + +<dl><dt><a name="MockFunctionCall-WillReturn"><strong>WillReturn</strong></a>(self, value)</dt></dl> + +<dl><dt><a name="MockFunctionCall-WithArgs"><strong>WithArgs</strong></a>(self, *args)</dt></dl> + +<dl><dt><a name="MockFunctionCall-__init__"><strong>__init__</strong></a>(self, name)</dt></dl> + +<dl><dt><a name="MockFunctionCall-__repr__"><strong>__repr__</strong></a>(self)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="MockObject">class <strong>MockObject</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="MockObject-ExpectCall"><strong>ExpectCall</strong></a>(self, func_name, *args)</dt></dl> + +<dl><dt><a name="MockObject-__init__"><strong>__init__</strong></a>(self, parent_mock<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="MockObject-__setattr__"><strong>__setattr__</strong></a>(self, name, value)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="MockTrace">class <strong>MockTrace</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="MockTrace-__init__"><strong>__init__</strong></a>(self)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>DONT_CARE</strong> = ''</td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.unittest.system_stub.html b/tools/telemetry/docs/telemetry.unittest.system_stub.html new file mode 100644 index 0000000..cd380c7 --- /dev/null +++ b/tools/telemetry/docs/telemetry.unittest.system_stub.html @@ -0,0 +1,164 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.unittest.system_stub</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.unittest.html"><font color="#ffffff">unittest</font></a>.system_stub</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/unittest/system_stub.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/unittest/system_stub.py</a></font></td></tr></table> + <p><tt>Provides stubs for os, sys and subprocess for testing<br> + <br> +This test allows one to test code that itself uses os, sys, and subprocess.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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="os.html">os</a><br> +</td><td width="25%" valign=top><a href="re.html">re</a><br> +</td><td width="25%" valign=top><a href="sys.html">sys</a><br> +</td><td width="25%" valign=top><a href="shlex.html">shlex</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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.unittest.system_stub.html#AdbCommandsModuleStub">AdbCommandsModuleStub</a> +</font></dt><dt><font face="helvetica, arial"><a href="telemetry.unittest.system_stub.html#OsModuleStub">OsModuleStub</a> +</font></dt><dt><font face="helvetica, arial"><a href="telemetry.unittest.system_stub.html#Override">Override</a> +</font></dt><dt><font face="helvetica, arial"><a href="telemetry.unittest.system_stub.html#SubprocessModuleStub">SubprocessModuleStub</a> +</font></dt><dt><font face="helvetica, arial"><a href="telemetry.unittest.system_stub.html#SysModuleStub">SysModuleStub</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> <br> +<font color="#000000" face="helvetica, arial"><a name="AdbCommandsModuleStub">class <strong>AdbCommandsModuleStub</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="AdbCommandsModuleStub-GetAttachedDevices"><strong>GetAttachedDevices</strong></a>(self)</dt></dl> + +<dl><dt><a name="AdbCommandsModuleStub-__init__"><strong>__init__</strong></a>(self)</dt></dl> + +<hr> +Static methods defined here:<br> +<dl><dt><a name="AdbCommandsModuleStub-HasForwarder"><strong>HasForwarder</strong></a>(_<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="AdbCommandsModuleStub-IsAndroidSupported"><strong>IsAndroidSupported</strong></a>()</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>AdbCommandsStub</strong> = <class 'telemetry.unittest.system_stub.AdbCommandsStub'></dl> + +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="OsModuleStub">class <strong>OsModuleStub</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="OsModuleStub-__init__"><strong>__init__</strong></a>(self, sys_module<font color="#909090">=<module 'sys' (built-in)></font>)</dt></dl> + +<dl><dt><a name="OsModuleStub-getenv"><strong>getenv</strong></a>(self, name)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>OsPathModuleStub</strong> = <class 'telemetry.unittest.system_stub.OsPathModuleStub'></dl> + +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="Override">class <strong>Override</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="Override-Restore"><strong>Restore</strong></a>(self)</dt></dl> + +<dl><dt><a name="Override-__del__"><strong>__del__</strong></a>(self)</dt></dl> + +<dl><dt><a name="Override-__init__"><strong>__init__</strong></a>(self, base_module, module_list)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="SubprocessModuleStub">class <strong>SubprocessModuleStub</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="SubprocessModuleStub-__init__"><strong>__init__</strong></a>(self)</dt></dl> + +<dl><dt><a name="SubprocessModuleStub-call"><strong>call</strong></a>(self, *args, **kwargs)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Data and other attributes defined here:<br> +<dl><dt><strong>PopenStub</strong> = <class 'telemetry.unittest.system_stub.PopenStub'></dl> + +</td></tr></table> <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="SysModuleStub">class <strong>SysModuleStub</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%">Methods defined here:<br> +<dl><dt><a name="SysModuleStub-__init__"><strong>__init__</strong></a>(self)</dt></dl> + +<hr> +Data descriptors defined here:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.unittest.tab_test_case.html b/tools/telemetry/docs/telemetry.unittest.tab_test_case.html new file mode 100644 index 0000000..8709440 --- /dev/null +++ b/tools/telemetry/docs/telemetry.unittest.tab_test_case.html @@ -0,0 +1,334 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.unittest.tab_test_case</title> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.unittest.html"><font color="#ffffff">unittest</font></a>.tab_test_case</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/unittest/tab_test_case.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/unittest/tab_test_case.py</a></font></td></tr></table> + <p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.browser_finder.html">telemetry.core.browser_finder</a><br> +</td><td width="25%" valign=top><a href="telemetry.unittest.options_for_unittests.html">telemetry.unittest.options_for_unittests</a><br> +</td><td width="25%" valign=top><a href="unittest.html">unittest</a><br> +</td><td width="25%" valign=top></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> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="unittest.case.html#TestCase">unittest.case.TestCase</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.unittest.tab_test_case.html#TabTestCase">TabTestCase</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> <br> +<font color="#000000" face="helvetica, arial"><a name="TabTestCase">class <strong>TabTestCase</strong></a>(<a href="unittest.case.html#TestCase">unittest.case.TestCase</a>)</font></td></tr> + +<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.unittest.tab_test_case.html#TabTestCase">TabTestCase</a></dd> +<dd><a href="unittest.case.html#TestCase">unittest.case.TestCase</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="TabTestCase-CustomizeBrowserOptions"><strong>CustomizeBrowserOptions</strong></a>(self, options)</dt><dd><tt>Override to add test-specific options to the BrowserOptions object</tt></dd></dl> + +<dl><dt><a name="TabTestCase-__init__"><strong>__init__</strong></a>(self, *args)</dt></dl> + +<dl><dt><a name="TabTestCase-setUp"><strong>setUp</strong></a>(self)</dt></dl> + +<dl><dt><a name="TabTestCase-tearDown"><strong>tearDown</strong></a>(self)</dt></dl> + +<hr> +Methods inherited from <a href="unittest.case.html#TestCase">unittest.case.TestCase</a>:<br> +<dl><dt><a name="TabTestCase-__call__"><strong>__call__</strong></a>(self, *args, **kwds)</dt></dl> + +<dl><dt><a name="TabTestCase-__eq__"><strong>__eq__</strong></a>(self, other)</dt></dl> + +<dl><dt><a name="TabTestCase-__hash__"><strong>__hash__</strong></a>(self)</dt></dl> + +<dl><dt><a name="TabTestCase-__ne__"><strong>__ne__</strong></a>(self, other)</dt></dl> + +<dl><dt><a name="TabTestCase-__repr__"><strong>__repr__</strong></a>(self)</dt></dl> + +<dl><dt><a name="TabTestCase-__str__"><strong>__str__</strong></a>(self)</dt></dl> + +<dl><dt><a name="TabTestCase-addCleanup"><strong>addCleanup</strong></a>(self, function, *args, **kwargs)</dt><dd><tt>Add a function, with arguments, to be called when the test is<br> +completed. Functions added are called on a LIFO basis and are<br> +called after tearDown on test failure or success.<br> + <br> +Cleanup items are called even if setUp fails (unlike tearDown).</tt></dd></dl> + +<dl><dt><a name="TabTestCase-addTypeEqualityFunc"><strong>addTypeEqualityFunc</strong></a>(self, typeobj, function)</dt><dd><tt>Add a type specific assertEqual style function to compare a type.<br> + <br> +This method is for use by <a href="unittest.case.html#TestCase">TestCase</a> subclasses that need to register<br> +their own type equality functions to provide nicer error messages.<br> + <br> +Args:<br> + typeobj: The data type to call this function on when both values<br> + are of the same type in <a href="#TabTestCase-assertEqual">assertEqual</a>().<br> + function: The callable taking two arguments and an optional<br> + msg= argument that raises self.<strong>failureException</strong> with a<br> + useful error message when the two arguments are not equal.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertAlmostEqual"><strong>assertAlmostEqual</strong></a>(self, first, second, places<font color="#909090">=None</font>, msg<font color="#909090">=None</font>, delta<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero, or by comparing that the<br> +between the two objects is more than the given delta.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).<br> + <br> +If the two objects compare equal then they will automatically<br> +compare almost equal.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertAlmostEquals"><strong>assertAlmostEquals</strong></a> = assertAlmostEqual(self, first, second, places<font color="#909090">=None</font>, msg<font color="#909090">=None</font>, delta<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero, or by comparing that the<br> +between the two objects is more than the given delta.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).<br> + <br> +If the two objects compare equal then they will automatically<br> +compare almost equal.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertDictContainsSubset"><strong>assertDictContainsSubset</strong></a>(self, expected, actual, msg<font color="#909090">=None</font>)</dt><dd><tt>Checks whether actual is a superset of expected.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertDictEqual"><strong>assertDictEqual</strong></a>(self, d1, d2, msg<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="TabTestCase-assertEqual"><strong>assertEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertEquals"><strong>assertEquals</strong></a> = assertEqual(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertFalse"><strong>assertFalse</strong></a>(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Check that the expression is false.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertGreater"><strong>assertGreater</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TabTestCase-assertTrue">assertTrue</a>(a > b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertGreaterEqual"><strong>assertGreaterEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TabTestCase-assertTrue">assertTrue</a>(a >= b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertIn"><strong>assertIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TabTestCase-assertTrue">assertTrue</a>(a in b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertIs"><strong>assertIs</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TabTestCase-assertTrue">assertTrue</a>(a is b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertIsInstance"><strong>assertIsInstance</strong></a>(self, obj, cls, msg<font color="#909090">=None</font>)</dt><dd><tt>Same as <a href="#TabTestCase-assertTrue">assertTrue</a>(isinstance(obj, cls)), with a nicer<br> +default message.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertIsNone"><strong>assertIsNone</strong></a>(self, obj, msg<font color="#909090">=None</font>)</dt><dd><tt>Same as <a href="#TabTestCase-assertTrue">assertTrue</a>(obj is None), with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertIsNot"><strong>assertIsNot</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TabTestCase-assertTrue">assertTrue</a>(a is not b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertIsNotNone"><strong>assertIsNotNone</strong></a>(self, obj, msg<font color="#909090">=None</font>)</dt><dd><tt>Included for symmetry with assertIsNone.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertItemsEqual"><strong>assertItemsEqual</strong></a>(self, expected_seq, actual_seq, msg<font color="#909090">=None</font>)</dt><dd><tt>An unordered sequence specific comparison. It asserts that<br> +actual_seq and expected_seq have the same element counts.<br> +Equivalent to::<br> + <br> + <a href="#TabTestCase-assertEqual">assertEqual</a>(Counter(iter(actual_seq)),<br> + Counter(iter(expected_seq)))<br> + <br> +Asserts that each element has the same count in both sequences.<br> +Example:<br> + - [0, 1, 1] and [1, 0, 1] compare equal.<br> + - [0, 0, 1] and [0, 1] compare unequal.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertLess"><strong>assertLess</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TabTestCase-assertTrue">assertTrue</a>(a < b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertLessEqual"><strong>assertLessEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TabTestCase-assertTrue">assertTrue</a>(a <= b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertListEqual"><strong>assertListEqual</strong></a>(self, list1, list2, msg<font color="#909090">=None</font>)</dt><dd><tt>A list-specific equality assertion.<br> + <br> +Args:<br> + list1: The first list to compare.<br> + list2: The second list to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertMultiLineEqual"><strong>assertMultiLineEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Assert that two multi-line strings are equal.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertNotAlmostEqual"><strong>assertNotAlmostEqual</strong></a>(self, first, second, places<font color="#909090">=None</font>, msg<font color="#909090">=None</font>, delta<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero, or by comparing that the<br> +between the two objects is less than the given delta.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).<br> + <br> +Objects that are equal automatically fail.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertNotAlmostEquals"><strong>assertNotAlmostEquals</strong></a> = assertNotAlmostEqual(self, first, second, places<font color="#909090">=None</font>, msg<font color="#909090">=None</font>, delta<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by their<br> +difference rounded to the given number of decimal places<br> +(default 7) and comparing to zero, or by comparing that the<br> +between the two objects is less than the given delta.<br> + <br> +Note that decimal places (from zero) are usually not the same<br> +as significant digits (measured from the most signficant digit).<br> + <br> +Objects that are equal automatically fail.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertNotEqual"><strong>assertNotEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertNotEquals"><strong>assertNotEquals</strong></a> = assertNotEqual(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by the '=='<br> +operator.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertNotIn"><strong>assertNotIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#TabTestCase-assertTrue">assertTrue</a>(a not in b), but with a nicer default message.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertNotIsInstance"><strong>assertNotIsInstance</strong></a>(self, obj, cls, msg<font color="#909090">=None</font>)</dt><dd><tt>Included for symmetry with assertIsInstance.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertNotRegexpMatches"><strong>assertNotRegexpMatches</strong></a>(self, text, unexpected_regexp, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test if the text matches the regular expression.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertRaises"><strong>assertRaises</strong></a>(self, excClass, callableObj<font color="#909090">=None</font>, *args, **kwargs)</dt><dd><tt>Fail unless an exception of class excClass is thrown<br> +by callableObj when invoked with arguments args and keyword<br> +arguments kwargs. If a different type of exception is<br> +thrown, it will not be caught, and the test case will be<br> +deemed to have suffered an error, exactly as for an<br> +unexpected exception.<br> + <br> +If called with callableObj omitted or None, will return a<br> +context object used like this::<br> + <br> + with <a href="#TabTestCase-assertRaises">assertRaises</a>(SomeException):<br> + do_something()<br> + <br> +The context manager keeps a reference to the exception as<br> +the 'exception' attribute. This allows you to inspect the<br> +exception after the assertion::<br> + <br> + with <a href="#TabTestCase-assertRaises">assertRaises</a>(SomeException) as cm:<br> + do_something()<br> + the_exception = cm.exception<br> + <a href="#TabTestCase-assertEqual">assertEqual</a>(the_exception.error_code, 3)</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertRaisesRegexp"><strong>assertRaisesRegexp</strong></a>(self, expected_exception, expected_regexp, callable_obj<font color="#909090">=None</font>, *args, **kwargs)</dt><dd><tt>Asserts that the message in a raised exception matches a regexp.<br> + <br> +Args:<br> + expected_exception: Exception class expected to be raised.<br> + expected_regexp: Regexp (re pattern object or string) expected<br> + to be found in error message.<br> + callable_obj: Function to be called.<br> + args: Extra args.<br> + kwargs: Extra kwargs.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertRegexpMatches"><strong>assertRegexpMatches</strong></a>(self, text, expected_regexp, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test unless the text matches the regular expression.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertSequenceEqual"><strong>assertSequenceEqual</strong></a>(self, seq1, seq2, msg<font color="#909090">=None</font>, seq_type<font color="#909090">=None</font>)</dt><dd><tt>An equality assertion for ordered sequences (like lists and tuples).<br> + <br> +For the purposes of this function, a valid ordered sequence type is one<br> +which can be indexed, has a length, and has an equality operator.<br> + <br> +Args:<br> + seq1: The first sequence to compare.<br> + seq2: The second sequence to compare.<br> + seq_type: The expected datatype of the sequences, or None if no<br> + datatype should be enforced.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertSetEqual"><strong>assertSetEqual</strong></a>(self, set1, set2, msg<font color="#909090">=None</font>)</dt><dd><tt>A set-specific equality assertion.<br> + <br> +Args:<br> + set1: The first set to compare.<br> + set2: The second set to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.<br> + <br> +assertSetEqual uses ducktyping to support different types of sets, and<br> +is optimized for sets specifically (parameters must support a<br> +difference method).</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertTrue"><strong>assertTrue</strong></a>(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Check that the expression is true.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assertTupleEqual"><strong>assertTupleEqual</strong></a>(self, tuple1, tuple2, msg<font color="#909090">=None</font>)</dt><dd><tt>A tuple-specific equality assertion.<br> + <br> +Args:<br> + tuple1: The first tuple to compare.<br> + tuple2: The second tuple to compare.<br> + msg: Optional message to use on failure instead of a list of<br> + differences.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-assert_"><strong>assert_</strong></a> = assertTrue(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Check that the expression is true.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-countTestCases"><strong>countTestCases</strong></a>(self)</dt></dl> + +<dl><dt><a name="TabTestCase-debug"><strong>debug</strong></a>(self)</dt><dd><tt>Run the test without collecting errors in a TestResult</tt></dd></dl> + +<dl><dt><a name="TabTestCase-defaultTestResult"><strong>defaultTestResult</strong></a>(self)</dt></dl> + +<dl><dt><a name="TabTestCase-doCleanups"><strong>doCleanups</strong></a>(self)</dt><dd><tt>Execute all cleanup functions. Normally called for you after<br> +tearDown.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-fail"><strong>fail</strong></a>(self, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail immediately, with the given message.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-failIf"><strong>failIf</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="TabTestCase-failIfAlmostEqual"><strong>failIfAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="TabTestCase-failIfEqual"><strong>failIfEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="TabTestCase-failUnless"><strong>failUnless</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="TabTestCase-failUnlessAlmostEqual"><strong>failUnlessAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="TabTestCase-failUnlessEqual"><strong>failUnlessEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="TabTestCase-failUnlessRaises"><strong>failUnlessRaises</strong></a> = deprecated_func(*args, **kwargs)</dt></dl> + +<dl><dt><a name="TabTestCase-id"><strong>id</strong></a>(self)</dt></dl> + +<dl><dt><a name="TabTestCase-run"><strong>run</strong></a>(self, result<font color="#909090">=None</font>)</dt></dl> + +<dl><dt><a name="TabTestCase-shortDescription"><strong>shortDescription</strong></a>(self)</dt><dd><tt>Returns a one-line description of the test, or None if no<br> +description has been provided.<br> + <br> +The default implementation of this method returns the first line of<br> +the specified test method's docstring.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-skipTest"><strong>skipTest</strong></a>(self, reason)</dt><dd><tt>Skip this test.</tt></dd></dl> + +<hr> +Class methods inherited from <a href="unittest.case.html#TestCase">unittest.case.TestCase</a>:<br> +<dl><dt><a name="TabTestCase-setUpClass"><strong>setUpClass</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Hook method for setting up class fixture before running tests in the class.</tt></dd></dl> + +<dl><dt><a name="TabTestCase-tearDownClass"><strong>tearDownClass</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Hook method for deconstructing the class fixture after running all tests in the class.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="unittest.case.html#TestCase">unittest.case.TestCase</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +<hr> +Data and other attributes inherited from <a href="unittest.case.html#TestCase">unittest.case.TestCase</a>:<br> +<dl><dt><strong>failureException</strong> = <type 'exceptions.AssertionError'><dd><tt>Assertion failed.</tt></dl> + +<dl><dt><strong>longMessage</strong> = False</dl> + +<dl><dt><strong>maxDiff</strong> = 640</dl> + +</td></tr></table></td></tr></table> +</body></html>
\ No newline at end of file diff --git a/tools/telemetry/telemetry/__init__.py b/tools/telemetry/telemetry/__init__.py index 19e6dbf..f3c162f 100644 --- a/tools/telemetry/telemetry/__init__.py +++ b/tools/telemetry/telemetry/__init__.py @@ -1,4 +1,29 @@ -# Copyright (c) 2012 The Chromium Authors. All rights reserved. +# Copyright (c) 2013 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. -"""A library for cross-platform browser tests.""" +""" +A library for cross-platform browser tests. +""" +import inspect +import sys + +from telemetry.core.browser import Browser +from telemetry.core.browser_options import BrowserOptions +from telemetry.core.tab import Tab + +from telemetry.page.page_measurement import PageMeasurement +from telemetry.page.page_runner import Run as RunPage + +__all__ = [] + +# Find all local vars that are classes or functions and make sure they're in the +# __all__ array so they're included in docs. +for x in dir(): + if x.startswith('_'): + continue + if x in (inspect, sys): + continue + m = sys.modules[__name__] + if (inspect.isclass(getattr(m, x)) or + inspect.isfunction(getattr(m, x))): + __all__.append(x) diff --git a/tools/telemetry/update_docs b/tools/telemetry/update_docs new file mode 100755 index 0000000..f2f92ac --- /dev/null +++ b/tools/telemetry/update_docs @@ -0,0 +1,11 @@ +#!/usr/bin/env python +# Copyright 2013 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. +import os +import sys + +from build import update_docs + +if __name__ == '__main__': + sys.exit(update_docs.Main(sys.argv[1:])) |