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.chrome.android_browser_finder.html">telemetry.core.chrome.android_browser_finder</a><br>
  21 </td><td width="25%" valign=top><a href="telemetry.core.chrome.cros_browser_finder.html">telemetry.core.chrome.cros_browser_finder</a><br>
  22 </td><td width="25%" valign=top><a href="telemetry.core.chrome.desktop_browser_finder.html">telemetry.core.chrome.desktop_browser_finder</a><br>
  23 </td><td width="25%" valign=top><a href="logging.html">logging</a><br>
  24 </td></tr></table></td></tr></table><p>
  25 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  26 <tr bgcolor="#ee77aa">
  27 <td colspan=3 valign=bottom>&nbsp;<br>
  28 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
  29
  30 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  31 <td width="100%"><dl>
  32 <dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)
  33 </font></dt><dd>
  34 <dl>
  35 <dt><font face="helvetica, arial"><a href="telemetry.core.browser_finder.html#BrowserFinderException">BrowserFinderException</a>
  36 </font></dt><dt><font face="helvetica, arial"><a href="telemetry.core.browser_finder.html#BrowserTypeRequiredException">BrowserTypeRequiredException</a>
  37 </font></dt></dl>
  38 </dd>
  39 </dl>
  40  <p>
  41 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  42 <tr bgcolor="#ffc8d8">
  43 <td colspan=3 valign=bottom>&nbsp;<br>
  44 <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>
  45
  46 <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  47 <td width="100%"><dl><dt>Method resolution order:</dt>
  48 <dd><a href="telemetry.core.browser_finder.html#BrowserFinderException">BrowserFinderException</a></dd>
  49 <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
  50 <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
  51 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
  52 </dl>
  53 <hr>
  54 Data descriptors defined here:<br>
  55 <dl><dt><strong>__weakref__</strong></dt>
  56 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  57 </dl>
  58 <hr>
  59 Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
  60 <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>
  61
  62 <hr>
  63 Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
  64 <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>
  65
  66 <hr>
  67 Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
  68 <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>
  69
  70 <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>
  71
  72 <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>
  73
  74 <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>
  75 &nbsp;<br>
  76 Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>
  77
  78 <dl><dt><a name="BrowserFinderException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
  79
  80 <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>
  81
  82 <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>
  83
  84 <dl><dt><a name="BrowserFinderException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
  85
  86 <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>
  87
  88 <dl><dt><a name="BrowserFinderException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
  89
  90 <hr>
  91 Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
  92 <dl><dt><strong>__dict__</strong></dt>
  93 </dl>
  94 <dl><dt><strong>args</strong></dt>
  95 </dl>
  96 <dl><dt><strong>message</strong></dt>
  97 </dl>
  98 </td></tr></table> <p>
  99 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 100 <tr bgcolor="#ffc8d8">
 101 <td colspan=3 valign=bottom>&nbsp;<br>
 102 <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>
 103
 104 <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 105 <td width="100%"><dl><dt>Method resolution order:</dt>
 106 <dd><a href="telemetry.core.browser_finder.html#BrowserTypeRequiredException">BrowserTypeRequiredException</a></dd>
 107 <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
 108 <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
 109 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
 110 </dl>
 111 <hr>
 112 Data descriptors defined here:<br>
 113 <dl><dt><strong>__weakref__</strong></dt>
 114 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
 115 </dl>
 116 <hr>
 117 Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
 118 <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>
 119
 120 <hr>
 121 Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
 122 <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>
 123
 124 <hr>
 125 Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
 126 <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>
 127
 128 <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>
 129
 130 <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>
 131
 132 <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>
 133 &nbsp;<br>
 134 Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>
 135
 136 <dl><dt><a name="BrowserTypeRequiredException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
 137
 138 <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>
 139
 140 <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>
 141
 142 <dl><dt><a name="BrowserTypeRequiredException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
 143
 144 <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>
 145
 146 <dl><dt><a name="BrowserTypeRequiredException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
 147
 148 <hr>
 149 Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
 150 <dl><dt><strong>__dict__</strong></dt>
 151 </dl>
 152 <dl><dt><strong>args</strong></dt>
 153 </dl>
 154 <dl><dt><strong>message</strong></dt>
 155 </dl>
 156 </td></tr></table></td></tr></table><p>
 157 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 158 <tr bgcolor="#eeaa77">
 159 <td colspan=3 valign=bottom>&nbsp;<br>
 160 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
 161
 162 <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 163 <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;to&nbsp;run&nbsp;given&nbsp;the&nbsp;provided<br>
 164 BrowserOptions&nbsp;object.&nbsp;The&nbsp;returned&nbsp;possiblity&nbsp;object&nbsp;can&nbsp;then&nbsp;be&nbsp;used&nbsp;to<br>
 165 connect&nbsp;to&nbsp;and&nbsp;control&nbsp;the&nbsp;located&nbsp;browser.&nbsp;A&nbsp;<a href="#BrowserFinderException">BrowserFinderException</a>&nbsp;will<br>
 166 be&nbsp;raised&nbsp;if&nbsp;the&nbsp;BrowserOptions&nbsp;argument&nbsp;is&nbsp;improperly&nbsp;set&nbsp;or&nbsp;if&nbsp;an&nbsp;error<br>
 167 occurs&nbsp;when&nbsp;finding&nbsp;a&nbsp;browser.</tt></dd></dl>
 168  <dl><dt><a name="-GetAllAvailableBrowserTypes"><strong>GetAllAvailableBrowserTypes</strong></a>(options)</dt><dd><tt>Returns&nbsp;an&nbsp;array&nbsp;of&nbsp;browser&nbsp;types&nbsp;supported&nbsp;on&nbsp;this&nbsp;system.<br>
 169 A&nbsp;<a href="#BrowserFinderException">BrowserFinderException</a>&nbsp;will&nbsp;be&nbsp;raised&nbsp;if&nbsp;the&nbsp;BrowserOptions&nbsp;argument&nbsp;is<br>
 170 improperly&nbsp;set&nbsp;or&nbsp;if&nbsp;an&nbsp;error&nbsp;occurs&nbsp;when&nbsp;finding&nbsp;a&nbsp;browser.</tt></dd></dl>
 171 </td></tr></table><p>
 172 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 173 <tr bgcolor="#55aa55">
 174 <td colspan=3 valign=bottom>&nbsp;<br>
 175 <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
 176
 177 <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 178 <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>
 179 </body></html>