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

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

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

Patch Set: update with nits Created 7 years, 6 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Download patch

« no previous file with comments | « tools/telemetry/docs/telemetry.core.browser_credentials.html ('k') | tools/telemetry/docs/telemetry.core.browser_options.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

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

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 0000000000000000000000000000000000000000..5e60c3506f1736074eee703fde78c4ee13b32fb8

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

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

+><td align=right valign=bottom

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

+ <tt>Finds browsers that can be controlled by telemetry.</tt>

+

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

+<tr bgcolor="#aa55cc">

+<td colspan=3 valign=bottom>

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

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

+<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.core.chrome.android_browser_finder.html">telemetry.core.chrome.android_browser_finder</a>

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

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

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

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

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

+<tr bgcolor="#ee77aa">

+<td colspan=3 valign=bottom>

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

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

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

+<dt><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)

+</dt><dd>

+<dl>

+<dt><a href="telemetry.core.browser_finder.html#BrowserFinderException">BrowserFinderException</a>

+</dt><dt><a href="telemetry.core.browser_finder.html#BrowserTypeRequiredException">BrowserTypeRequiredException</a>

+</dt></dl>

+</dd>

+</dl>

+

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

+<tr bgcolor="#ffc8d8">

+<td colspan=3 valign=bottom>

+<a name="BrowserFinderException">class BrowserFinderException</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</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:

+<dl><dt>__weakref__</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>:

+<dl><dt><a name="BrowserFinderException-__init__">__init__</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>:

+<dl><dt>__new__ = <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>:

+<dl><dt><a name="BrowserFinderException-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#BrowserFinderException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

+<dl><dt><a name="BrowserFinderException-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#BrowserFinderException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

+<dl><dt><a name="BrowserFinderException-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#BrowserFinderException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

+<dl><dt><a name="BrowserFinderException-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#BrowserFinderException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

+

+Use of negative indices is not supported.</tt></dd></dl>

+<dl><dt><a name="BrowserFinderException-__reduce__">__reduce__</a>(...)</dt></dl>

+<dl><dt><a name="BrowserFinderException-__repr__">__repr__</a>(...)</dt><dd><tt>x.<a href="#BrowserFinderException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>

+<dl><dt><a name="BrowserFinderException-__setattr__">__setattr__</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__">__setstate__</a>(...)</dt></dl>

+<dl><dt><a name="BrowserFinderException-__str__">__str__</a>(...)</dt><dd><tt>x.<a href="#BrowserFinderException-__str__">__str__</a>() <==> str(x)</tt></dd></dl>

+<dl><dt><a name="BrowserFinderException-__unicode__">__unicode__</a>(...)</dt></dl>

+<hr>

+Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

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

+</dl>

+<dl><dt>args</dt>

+</dl>

+<dl><dt>message</dt>

+</dl>

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

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

+<tr bgcolor="#ffc8d8">

+<td colspan=3 valign=bottom>

+<a name="BrowserTypeRequiredException">class BrowserTypeRequiredException</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</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:

+<dl><dt>__weakref__</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>:

+<dl><dt><a name="BrowserTypeRequiredException-__init__">__init__</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>:

+<dl><dt>__new__ = <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>:

+<dl><dt><a name="BrowserTypeRequiredException-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#BrowserTypeRequiredException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

+<dl><dt><a name="BrowserTypeRequiredException-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#BrowserTypeRequiredException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

+<dl><dt><a name="BrowserTypeRequiredException-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#BrowserTypeRequiredException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

+<dl><dt><a name="BrowserTypeRequiredException-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#BrowserTypeRequiredException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

+

+Use of negative indices is not supported.</tt></dd></dl>

+<dl><dt><a name="BrowserTypeRequiredException-__reduce__">__reduce__</a>(...)</dt></dl>

+<dl><dt><a name="BrowserTypeRequiredException-__repr__">__repr__</a>(...)</dt><dd><tt>x.<a href="#BrowserTypeRequiredException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>

+<dl><dt><a name="BrowserTypeRequiredException-__setattr__">__setattr__</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__">__setstate__</a>(...)</dt></dl>

+<dl><dt><a name="BrowserTypeRequiredException-__str__">__str__</a>(...)</dt><dd><tt>x.<a href="#BrowserTypeRequiredException-__str__">__str__</a>() <==> str(x)</tt></dd></dl>

+<dl><dt><a name="BrowserTypeRequiredException-__unicode__">__unicode__</a>(...)</dt></dl>

+<hr>

+Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

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

+</dl>

+<dl><dt>args</dt>

+</dl>

+<dl><dt>message</dt>

+</dl>

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

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

+<tr bgcolor="#eeaa77">

+<td colspan=3 valign=bottom>

+<big>Functions</big></td></tr>

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

+<td width="100%"><dl><dt><a name="-FindBrowser">FindBrowser</a>(options)</dt><dd><tt>Finds the best PossibleBrowser object to run given the provided

+BrowserOptions object. The returned possiblity object can then be used to

+connect to and control the located browser. A <a href="#BrowserFinderException">BrowserFinderException</a> will

+be raised if the BrowserOptions argument is improperly set or if an error

+occurs when finding a browser.</tt></dd></dl>

+ <dl><dt><a name="-GetAllAvailableBrowserTypes">GetAllAvailableBrowserTypes</a>(options)</dt><dd><tt>Returns an array of browser types supported on this system.

+A <a href="#BrowserFinderException">BrowserFinderException</a> will be raised if the BrowserOptions argument is

+improperly set or if an error occurs when finding a browser.</tt></dd></dl>

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

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

+<tr bgcolor="#55aa55">

+<td colspan=3 valign=bottom>

+<big>Data</big></td></tr>

+<tr><td bgcolor="#55aa55"><tt>      </tt></td><td> </td>

+<td width="100%">ALL_BROWSER_TYPES = 'exact,release,debug,canary,content-shell-debug,c...chrome,cros-chrome,cros-chrome-guest,system-guest'</td></tr></table>

+</body></html>