telemetry.internal.backends.browser_backend.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
  2. <html><head><title>Python: module telemetry.internal.backends.browser_backend</title>
  3. <meta charset="utf-8">
  4. </head><body bgcolor="#f0f0f8">
  5. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
  6. <tr bgcolor="#7799ee">
  7. <td valign=bottom>&nbsp;<br>
  8. <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.internal.html"><font color="#ffffff">internal</font></a>.<a href="telemetry.internal.backends.html"><font color="#ffffff">backends</font></a>.browser_backend</strong></big></big></font></td
  9. ><td align=right valign=bottom
  10. ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/internal/backends/browser_backend.py">telemetry/internal/backends/browser_backend.py</a></font></td></tr></table>
  11. <p><tt>#&nbsp;Copyright&nbsp;2013&nbsp;The&nbsp;Chromium&nbsp;Authors.&nbsp;All&nbsp;rights&nbsp;reserved.<br>
  12. #&nbsp;Use&nbsp;of&nbsp;this&nbsp;source&nbsp;code&nbsp;is&nbsp;governed&nbsp;by&nbsp;a&nbsp;BSD-style&nbsp;license&nbsp;that&nbsp;can&nbsp;be<br>
  13. #&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;file.</tt></p>
  14. <p>
  15. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  16. <tr bgcolor="#aa55cc">
  17. <td colspan=3 valign=bottom>&nbsp;<br>
  18. <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
  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.internal.backends.app_backend.html">telemetry.internal.backends.app_backend</a><br>
  21. <a href="catapult_base.cloud_storage.html">catapult_base.cloud_storage</a><br>
  22. </td><td width="25%" valign=top><a href="telemetry.decorators.html">telemetry.decorators</a><br>
  23. <a href="telemetry.core.platform.html">telemetry.core.platform</a><br>
  24. </td><td width="25%" valign=top><a href="telemetry.internal.platform.profiling_controller_backend.html">telemetry.internal.platform.profiling_controller_backend</a><br>
  25. <a href="sys.html">sys</a><br>
  26. </td><td width="25%" valign=top><a href="uuid.html">uuid</a><br>
  27. <a href="telemetry.internal.browser.web_contents.html">telemetry.internal.browser.web_contents</a><br>
  28. </td></tr></table></td></tr></table><p>
  29. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  30. <tr bgcolor="#ee77aa">
  31. <td colspan=3 valign=bottom>&nbsp;<br>
  32. <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
  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.internal.backends.browser_backend.html#ExtensionsNotSupportedException">ExtensionsNotSupportedException</a>
  39. </font></dt></dl>
  40. </dd>
  41. <dt><font face="helvetica, arial"><a href="telemetry.internal.backends.app_backend.html#AppBackend">telemetry.internal.backends.app_backend.AppBackend</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
  42. </font></dt><dd>
  43. <dl>
  44. <dt><font face="helvetica, arial"><a href="telemetry.internal.backends.browser_backend.html#BrowserBackend">BrowserBackend</a>
  45. </font></dt></dl>
  46. </dd>
  47. </dl>
  48. <p>
  49. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  50. <tr bgcolor="#ffc8d8">
  51. <td colspan=3 valign=bottom>&nbsp;<br>
  52. <font color="#000000" face="helvetica, arial"><a name="BrowserBackend">class <strong>BrowserBackend</strong></a>(<a href="telemetry.internal.backends.app_backend.html#AppBackend">telemetry.internal.backends.app_backend.AppBackend</a>)</font></td></tr>
  53. <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
  54. <td colspan=2><tt>A&nbsp;base&nbsp;class&nbsp;for&nbsp;browser&nbsp;backends.<br>&nbsp;</tt></td></tr>
  55. <tr><td>&nbsp;</td>
  56. <td width="100%"><dl><dt>Method resolution order:</dt>
  57. <dd><a href="telemetry.internal.backends.browser_backend.html#BrowserBackend">BrowserBackend</a></dd>
  58. <dd><a href="telemetry.internal.backends.app_backend.html#AppBackend">telemetry.internal.backends.app_backend.AppBackend</a></dd>
  59. <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
  60. </dl>
  61. <hr>
  62. Methods defined here:<br>
  63. <dl><dt><a name="BrowserBackend-DumpMemory"><strong>DumpMemory</strong></a>(self, timeout<font color="#909090">=90</font>)</dt></dl>
  64. <dl><dt><a name="BrowserBackend-GetStackTrace"><strong>GetStackTrace</strong></a>(self)</dt></dl>
  65. <dl><dt><a name="BrowserBackend-GetStandardOutput"><strong>GetStandardOutput</strong></a>(self)</dt></dl>
  66. <dl><dt><a name="BrowserBackend-GetSystemInfo"><strong>GetSystemInfo</strong></a>(self)</dt></dl>
  67. <dl><dt><a name="BrowserBackend-IsAppRunning"><strong>IsAppRunning</strong></a>(self)</dt></dl>
  68. <dl><dt><a name="BrowserBackend-IsBrowserRunning"><strong>IsBrowserRunning</strong></a>(self)</dt></dl>
  69. <dl><dt><a name="BrowserBackend-SetBrowser"><strong>SetBrowser</strong></a>(self, browser)</dt></dl>
  70. <dl><dt><a name="BrowserBackend-SetMemoryPressureNotificationsSuppressed"><strong>SetMemoryPressureNotificationsSuppressed</strong></a>(self, suppressed, timeout<font color="#909090">=90</font>)</dt></dl>
  71. <dl><dt><a name="BrowserBackend-SimulateMemoryPressureNotification"><strong>SimulateMemoryPressureNotification</strong></a>(self, pressure_level, timeout<font color="#909090">=90</font>)</dt></dl>
  72. <dl><dt><a name="BrowserBackend-Start"><strong>Start</strong></a>(self)</dt></dl>
  73. <dl><dt><a name="BrowserBackend-StartTracing"><strong>StartTracing</strong></a>(self, trace_options, custom_categories<font color="#909090">=None</font>, timeout<font color="#909090">=90</font>)</dt></dl>
  74. <dl><dt><a name="BrowserBackend-StopTracing"><strong>StopTracing</strong></a>(self, trace_data_builder)</dt></dl>
  75. <dl><dt><a name="BrowserBackend-UploadLogsToCloudStorage"><strong>UploadLogsToCloudStorage</strong></a>(self)</dt><dd><tt>Uploading&nbsp;log&nbsp;files&nbsp;produce&nbsp;by&nbsp;this&nbsp;browser&nbsp;instance&nbsp;to&nbsp;cloud&nbsp;storage.<br>
  76. &nbsp;<br>
  77. Check&nbsp;supports_uploading_logs&nbsp;before&nbsp;calling&nbsp;this&nbsp;method.</tt></dd></dl>
  78. <dl><dt><a name="BrowserBackend-__init__"><strong>__init__</strong></a>(self, platform_backend, supports_extensions, browser_options, tab_list_backend)</dt></dl>
  79. <hr>
  80. Data descriptors defined here:<br>
  81. <dl><dt><strong>browser</strong></dt>
  82. </dl>
  83. <dl><dt><strong>browser_type</strong></dt>
  84. </dl>
  85. <dl><dt><strong>log_file_path</strong></dt>
  86. </dl>
  87. <dl><dt><strong>profiling_controller_backend</strong></dt>
  88. </dl>
  89. <dl><dt><strong>should_ignore_certificate_errors</strong></dt>
  90. </dl>
  91. <dl><dt><strong>supports_cpu_metrics</strong></dt>
  92. </dl>
  93. <dl><dt><strong>supports_extensions</strong></dt>
  94. <dd><tt>True&nbsp;if&nbsp;this&nbsp;browser&nbsp;backend&nbsp;supports&nbsp;extensions.</tt></dd>
  95. </dl>
  96. <dl><dt><strong>supports_memory_dumping</strong></dt>
  97. </dl>
  98. <dl><dt><strong>supports_memory_metrics</strong></dt>
  99. </dl>
  100. <dl><dt><strong>supports_overriding_memory_pressure_notifications</strong></dt>
  101. </dl>
  102. <dl><dt><strong>supports_power_metrics</strong></dt>
  103. </dl>
  104. <dl><dt><strong>supports_system_info</strong></dt>
  105. </dl>
  106. <dl><dt><strong>supports_tab_control</strong></dt>
  107. </dl>
  108. <dl><dt><strong>supports_tracing</strong></dt>
  109. </dl>
  110. <dl><dt><strong>supports_uploading_logs</strong></dt>
  111. </dl>
  112. <dl><dt><strong>tab_list_backend</strong></dt>
  113. </dl>
  114. <dl><dt><strong>wpr_mode</strong></dt>
  115. </dl>
  116. <hr>
  117. Methods inherited from <a href="telemetry.internal.backends.app_backend.html#AppBackend">telemetry.internal.backends.app_backend.AppBackend</a>:<br>
  118. <dl><dt><a name="BrowserBackend-Close"><strong>Close</strong></a>(self)</dt></dl>
  119. <dl><dt><a name="BrowserBackend-SetApp"><strong>SetApp</strong></a>(self, app)</dt></dl>
  120. <dl><dt><a name="BrowserBackend-__del__"><strong>__del__</strong></a>(self)</dt></dl>
  121. <hr>
  122. Data descriptors inherited from <a href="telemetry.internal.backends.app_backend.html#AppBackend">telemetry.internal.backends.app_backend.AppBackend</a>:<br>
  123. <dl><dt><strong>__dict__</strong></dt>
  124. <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
  125. </dl>
  126. <dl><dt><strong>__weakref__</strong></dt>
  127. <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  128. </dl>
  129. <dl><dt><strong>app</strong></dt>
  130. </dl>
  131. <dl><dt><strong>app_type</strong></dt>
  132. </dl>
  133. <dl><dt><strong>pid</strong></dt>
  134. </dl>
  135. <dl><dt><strong>platform_backend</strong></dt>
  136. </dl>
  137. </td></tr></table> <p>
  138. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  139. <tr bgcolor="#ffc8d8">
  140. <td colspan=3 valign=bottom>&nbsp;<br>
  141. <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>
  142. <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  143. <td width="100%"><dl><dt>Method resolution order:</dt>
  144. <dd><a href="telemetry.internal.backends.browser_backend.html#ExtensionsNotSupportedException">ExtensionsNotSupportedException</a></dd>
  145. <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
  146. <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
  147. <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
  148. </dl>
  149. <hr>
  150. Data descriptors defined here:<br>
  151. <dl><dt><strong>__weakref__</strong></dt>
  152. <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  153. </dl>
  154. <hr>
  155. Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
  156. <dl><dt><a name="ExtensionsNotSupportedException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionsNotSupportedException-__init__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;help(type(x))&nbsp;for&nbsp;signature</tt></dd></dl>
  157. <hr>
  158. Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
  159. <dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#ExtensionsNotSupportedException-__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>
  160. <hr>
  161. Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
  162. <dl><dt><a name="ExtensionsNotSupportedException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionsNotSupportedException-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>
  163. <dl><dt><a name="ExtensionsNotSupportedException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionsNotSupportedException-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>
  164. <dl><dt><a name="ExtensionsNotSupportedException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionsNotSupportedException-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
  165. <dl><dt><a name="ExtensionsNotSupportedException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionsNotSupportedException-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
  166. &nbsp;<br>
  167. Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>
  168. <dl><dt><a name="ExtensionsNotSupportedException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
  169. <dl><dt><a name="ExtensionsNotSupportedException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionsNotSupportedException-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>
  170. <dl><dt><a name="ExtensionsNotSupportedException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionsNotSupportedException-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>
  171. <dl><dt><a name="ExtensionsNotSupportedException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
  172. <dl><dt><a name="ExtensionsNotSupportedException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#ExtensionsNotSupportedException-__str__">__str__</a>()&nbsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>
  173. <dl><dt><a name="ExtensionsNotSupportedException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
  174. <hr>
  175. Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
  176. <dl><dt><strong>__dict__</strong></dt>
  177. </dl>
  178. <dl><dt><strong>args</strong></dt>
  179. </dl>
  180. <dl><dt><strong>message</strong></dt>
  181. </dl>
  182. </td></tr></table></td></tr></table>
  183. </body></html>