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

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   3 <html><head><title>Python: module telemetry.core.browser_finder</title>
   4 </head><body bgcolor="#f0f0f8">
   5
   6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
   7 <tr bgcolor="#7799ee">
   8 <td valign=bottom>&nbsp;<br>
   9 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.core.html"><font color="#ffffff">core</font></a>.browser_finder</strong></big></big></font></td
  10 ><td align=right valign=bottom
  11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/core/browser_finder.py">telemetry/core/browser_finder.py</a></font></td></tr></table>
  12     <p><tt>Finds&nbsp;browsers&nbsp;that&nbsp;can&nbsp;be&nbsp;controlled&nbsp;by&nbsp;telemetry.</tt></p>
  13 <p>
  14 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  15 <tr bgcolor="#aa55cc">
  16 <td colspan=3 valign=bottom>&nbsp;<br>
  17 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
  18
  19 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  20 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.core.backends.chrome.android_browser_finder.html">telemetry.core.backends.chrome.android_browser_finder</a><br>
  21 <a href="telemetry.core.backends.webdriver.webdriver_desktop_browser_finder.html">telemetry.core.backends.webdriver.webdriver_desktop_browser_finder</a><br>
  22 </td><td width="25%" valign=top><a href="telemetry.core.backends.chrome.cros_browser_finder.html">telemetry.core.backends.chrome.cros_browser_finder</a><br>
  23 <a href="telemetry.core.backends.chrome.desktop_browser_finder.html">telemetry.core.backends.chrome.desktop_browser_finder</a><br>
  24 </td><td width="25%" valign=top><a href="logging.html">logging</a><br>
  25 <a href="operator.html">operator</a><br>
  26 </td><td width="25%" valign=top><a href="telemetry.core.backends.webdriver.webdriver_desktop_browser_finder.html">telemetry.core.backends.webdriver.webdriver_desktop_browser_finder</a><br>
  27 </td></tr></table></td></tr></table><p>
  28 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  29 <tr bgcolor="#ee77aa">
  30 <td colspan=3 valign=bottom>&nbsp;<br>
  31 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
  32
  33 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  34 <td width="100%"><dl>
  35 <dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)
  36 </font></dt><dd>
  37 <dl>
  38 <dt><font face="helvetica, arial"><a href="telemetry.core.browser_finder.html#BrowserFinderException">BrowserFinderException</a>
  39 </font></dt><dt><font face="helvetica, arial"><a href="telemetry.core.browser_finder.html#BrowserTypeRequiredException">BrowserTypeRequiredException</a>
  40 </font></dt></dl>
  41 </dd>
  42 </dl>
  43  <p>
  44 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  45 <tr bgcolor="#ffc8d8">
  46 <td colspan=3 valign=bottom>&nbsp;<br>
  47 <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>
  48
  49 <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  50 <td width="100%"><dl><dt>Method resolution order:</dt>
  51 <dd><a href="telemetry.core.browser_finder.html#BrowserFinderException">BrowserFinderException</a></dd>
  52 <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
  53 <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
  54 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
  55 </dl>
  56 <hr>
  57 Data descriptors defined here:<br>
  58 <dl><dt><strong>__weakref__</strong></dt>
  59 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  60 </dl>
  61 <hr>
  62 Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
  63 <dl><dt><a name="BrowserFinderException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserFinderException-__init__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;help(type(x))&nbsp;for&nbsp;signature</tt></dd></dl>
  64
  65 <hr>
  66 Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
  67 <dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#BrowserFinderException-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;object&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
  68
  69 <hr>
  70 Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
  71 <dl><dt><a name="BrowserFinderException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserFinderException-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>
  72
  73 <dl><dt><a name="BrowserFinderException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserFinderException-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>
  74
  75 <dl><dt><a name="BrowserFinderException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserFinderException-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
  76
  77 <dl><dt><a name="BrowserFinderException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserFinderException-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
  78 &nbsp;<br>
  79 Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>
  80
  81 <dl><dt><a name="BrowserFinderException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
  82
  83 <dl><dt><a name="BrowserFinderException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserFinderException-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>
  84
  85 <dl><dt><a name="BrowserFinderException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserFinderException-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>
  86
  87 <dl><dt><a name="BrowserFinderException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
  88
  89 <dl><dt><a name="BrowserFinderException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserFinderException-__str__">__str__</a>()&nbsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>
  90
  91 <dl><dt><a name="BrowserFinderException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
  92
  93 <hr>
  94 Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
  95 <dl><dt><strong>__dict__</strong></dt>
  96 </dl>
  97 <dl><dt><strong>args</strong></dt>
  98 </dl>
  99 <dl><dt><strong>message</strong></dt>
 100 </dl>
 101 </td></tr></table> <p>
 102 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 103 <tr bgcolor="#ffc8d8">
 104 <td colspan=3 valign=bottom>&nbsp;<br>
 105 <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>
 106
 107 <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 108 <td width="100%"><dl><dt>Method resolution order:</dt>
 109 <dd><a href="telemetry.core.browser_finder.html#BrowserTypeRequiredException">BrowserTypeRequiredException</a></dd>
 110 <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
 111 <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
 112 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
 113 </dl>
 114 <hr>
 115 Data descriptors defined here:<br>
 116 <dl><dt><strong>__weakref__</strong></dt>
 117 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
 118 </dl>
 119 <hr>
 120 Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
 121 <dl><dt><a name="BrowserTypeRequiredException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserTypeRequiredException-__init__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;help(type(x))&nbsp;for&nbsp;signature</tt></dd></dl>
 122
 123 <hr>
 124 Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
 125 <dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#BrowserTypeRequiredException-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;object&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
 126
 127 <hr>
 128 Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
 129 <dl><dt><a name="BrowserTypeRequiredException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserTypeRequiredException-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>
 130
 131 <dl><dt><a name="BrowserTypeRequiredException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserTypeRequiredException-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>
 132
 133 <dl><dt><a name="BrowserTypeRequiredException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserTypeRequiredException-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
 134
 135 <dl><dt><a name="BrowserTypeRequiredException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserTypeRequiredException-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
 136 &nbsp;<br>
 137 Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>
 138
 139 <dl><dt><a name="BrowserTypeRequiredException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
 140
 141 <dl><dt><a name="BrowserTypeRequiredException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserTypeRequiredException-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>
 142
 143 <dl><dt><a name="BrowserTypeRequiredException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserTypeRequiredException-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>
 144
 145 <dl><dt><a name="BrowserTypeRequiredException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
 146
 147 <dl><dt><a name="BrowserTypeRequiredException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#BrowserTypeRequiredException-__str__">__str__</a>()&nbsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>
 148
 149 <dl><dt><a name="BrowserTypeRequiredException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
 150
 151 <hr>
 152 Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
 153 <dl><dt><strong>__dict__</strong></dt>
 154 </dl>
 155 <dl><dt><strong>args</strong></dt>
 156 </dl>
 157 <dl><dt><strong>message</strong></dt>
 158 </dl>
 159 </td></tr></table></td></tr></table><p>
 160 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 161 <tr bgcolor="#eeaa77">
 162 <td colspan=3 valign=bottom>&nbsp;<br>
 163 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
 164
 165 <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 166 <td width="100%"><dl><dt><a name="-FindBrowser"><strong>FindBrowser</strong></a>(options)</dt><dd><tt>Finds&nbsp;the&nbsp;best&nbsp;PossibleBrowser&nbsp;object&nbsp;given&nbsp;a&nbsp;BrowserOptions&nbsp;object.<br>
 167 &nbsp;<br>
 168 Args:<br>
 169 &nbsp;&nbsp;A&nbsp;BrowserOptions&nbsp;object.<br>
 170 &nbsp;<br>
 171 Returns:<br>
 172 &nbsp;&nbsp;A&nbsp;PossibleBrowser&nbsp;object.<br>
 173 &nbsp;<br>
 174 Raises:<br>
 175 &nbsp;&nbsp;<a href="#BrowserFinderException">BrowserFinderException</a>:&nbsp;Options&nbsp;improperly&nbsp;set,&nbsp;or&nbsp;an&nbsp;error&nbsp;occurred.</tt></dd></dl>
 176  <dl><dt><a name="-GetAllAvailableBrowserTypes"><strong>GetAllAvailableBrowserTypes</strong></a>(options)</dt><dd><tt>Returns&nbsp;a&nbsp;list&nbsp;of&nbsp;available&nbsp;browser&nbsp;types.<br>
 177 &nbsp;<br>
 178 Args:<br>
 179 &nbsp;&nbsp;options:&nbsp;A&nbsp;BrowserOptions&nbsp;object.<br>
 180 &nbsp;<br>
 181 Returns:<br>
 182 &nbsp;&nbsp;A&nbsp;list&nbsp;of&nbsp;browser&nbsp;type&nbsp;strings.<br>
 183 &nbsp;<br>
 184 Raises:<br>
 185 &nbsp;&nbsp;<a href="#BrowserFinderException">BrowserFinderException</a>:&nbsp;Options&nbsp;are&nbsp;improperly&nbsp;set,&nbsp;or&nbsp;an&nbsp;error&nbsp;occurred.</tt></dd></dl>
 186 </td></tr></table><p>
 187 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 188 <tr bgcolor="#55aa55">
 189 <td colspan=3 valign=bottom>&nbsp;<br>
 190 <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
 191
 192 <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 193 <td width="100%"><strong>ALL_BROWSER_TYPES</strong> = ['exact', 'release', 'release_x64', 'debug', 'debug_x64', 'canary', 'content-shell-debug', 'content-shell-debug_x64', 'content-shell-release', 'content-shell-release_x64', 'system', 'android-chrome-beta', 'android-chrome-dev', 'android-chromium-testshell', 'android-jb-system-chrome', 'android-chrome-canary', 'android-chrome', 'android-webview', 'android-content-shell', 'cros-chrome', ...]<br>
 194 <strong>BROWSER_FINDERS</strong> = [&lt;module 'telemetry.core.backends.chrome.desktop_...core/backends/chrome/desktop_browser_finder.pyc'&gt;, &lt;module 'telemetry.core.backends.chrome.android_...core/backends/chrome/android_browser_finder.pyc'&gt;, &lt;module 'telemetry.core.backends.chrome.cros_bro...ry/core/backends/chrome/cros_browser_finder.pyc'&gt;, &lt;module 'telemetry.core.backends.webdriver.webdr.../webdriver/webdriver_desktop_browser_finder.pyc'&gt;]</td></tr></table>
 195 </body></html>