telemetry.internal.browser.browser.html 10.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
  2. <html><head><title>Python: module telemetry.internal.browser.browser</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.browser.html"><font color="#ffffff">browser</font></a>.browser</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/browser/browser.py">telemetry/internal/browser/browser.py</a></font></td></tr></table>
  11. <p><tt>#&nbsp;Copyright&nbsp;2012&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.app.html">telemetry.internal.app</a><br>
  21. <a href="telemetry.internal.backends.browser_backend.html">telemetry.internal.backends.browser_backend</a><br>
  22. <a href="telemetry.internal.browser.browser_credentials.html">telemetry.internal.browser.browser_credentials</a><br>
  23. <a href="catapult_base.cloud_storage.html">catapult_base.cloud_storage</a><br>
  24. </td><td width="25%" valign=top><a href="telemetry.decorators.html">telemetry.decorators</a><br>
  25. <a href="telemetry.internal.util.exception_formatter.html">telemetry.internal.util.exception_formatter</a><br>
  26. <a href="telemetry.core.exceptions.html">telemetry.core.exceptions</a><br>
  27. <a href="telemetry.internal.browser.extension_dict.html">telemetry.internal.browser.extension_dict</a><br>
  28. </td><td width="25%" valign=top><a href="logging.html">logging</a><br>
  29. <a href="telemetry.core.profiling_controller.html">telemetry.core.profiling_controller</a><br>
  30. <a href="sys.html">sys</a><br>
  31. <a href="telemetry.internal.browser.tab_list.html">telemetry.internal.browser.tab_list</a><br>
  32. </td><td width="25%" valign=top><a href="telemetry.internal.browser.web_contents.html">telemetry.internal.browser.web_contents</a><br>
  33. </td></tr></table></td></tr></table><p>
  34. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  35. <tr bgcolor="#ee77aa">
  36. <td colspan=3 valign=bottom>&nbsp;<br>
  37. <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
  38. <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  39. <td width="100%"><dl>
  40. <dt><font face="helvetica, arial"><a href="telemetry.internal.app.html#App">telemetry.internal.app.App</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
  41. </font></dt><dd>
  42. <dl>
  43. <dt><font face="helvetica, arial"><a href="telemetry.internal.browser.browser.html#Browser">Browser</a>
  44. </font></dt></dl>
  45. </dd>
  46. </dl>
  47. <p>
  48. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  49. <tr bgcolor="#ffc8d8">
  50. <td colspan=3 valign=bottom>&nbsp;<br>
  51. <font color="#000000" face="helvetica, arial"><a name="Browser">class <strong>Browser</strong></a>(<a href="telemetry.internal.app.html#App">telemetry.internal.app.App</a>)</font></td></tr>
  52. <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
  53. <td colspan=2><tt>A&nbsp;running&nbsp;browser&nbsp;instance&nbsp;that&nbsp;can&nbsp;be&nbsp;controlled&nbsp;in&nbsp;a&nbsp;limited&nbsp;way.<br>
  54. &nbsp;<br>
  55. To&nbsp;create&nbsp;a&nbsp;browser&nbsp;instance,&nbsp;use&nbsp;browser_finder.FindBrowser.<br>
  56. &nbsp;<br>
  57. Be&nbsp;sure&nbsp;to&nbsp;clean&nbsp;up&nbsp;after&nbsp;yourself&nbsp;by&nbsp;calling&nbsp;<a href="#Browser-Close">Close</a>()&nbsp;when&nbsp;you&nbsp;are&nbsp;done&nbsp;with<br>
  58. the&nbsp;browser.&nbsp;Or&nbsp;better&nbsp;yet:<br>
  59. &nbsp;&nbsp;browser_to_create&nbsp;=&nbsp;FindBrowser(options)<br>
  60. &nbsp;&nbsp;with&nbsp;browser_to_create.Create(options)&nbsp;as&nbsp;browser:<br>
  61. &nbsp;&nbsp;&nbsp;&nbsp;...&nbsp;do&nbsp;all&nbsp;your&nbsp;operations&nbsp;on&nbsp;browser&nbsp;here<br>&nbsp;</tt></td></tr>
  62. <tr><td>&nbsp;</td>
  63. <td width="100%"><dl><dt>Method resolution order:</dt>
  64. <dd><a href="telemetry.internal.browser.browser.html#Browser">Browser</a></dd>
  65. <dd><a href="telemetry.internal.app.html#App">telemetry.internal.app.App</a></dd>
  66. <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
  67. </dl>
  68. <hr>
  69. Methods defined here:<br>
  70. <dl><dt><a name="Browser-Close"><strong>Close</strong></a>(self)</dt><dd><tt>Closes&nbsp;this&nbsp;browser.</tt></dd></dl>
  71. <dl><dt><a name="Browser-DumpMemory"><strong>DumpMemory</strong></a>(self, timeout<font color="#909090">=90</font>)</dt></dl>
  72. <dl><dt><a name="Browser-GetStackTrace"><strong>GetStackTrace</strong></a>(self)</dt></dl>
  73. <dl><dt><a name="Browser-GetStandardOutput"><strong>GetStandardOutput</strong></a>(self)</dt></dl>
  74. <dl><dt><a name="Browser-GetSystemInfo"><strong>GetSystemInfo</strong></a>(self)</dt><dd><tt>Returns&nbsp;low-level&nbsp;information&nbsp;about&nbsp;the&nbsp;system,&nbsp;if&nbsp;available.<br>
  75. &nbsp;<br>
  76. See&nbsp;the&nbsp;documentation&nbsp;of&nbsp;the&nbsp;SystemInfo&nbsp;class&nbsp;for&nbsp;more&nbsp;details.</tt></dd></dl>
  77. <dl><dt><a name="Browser-SetMemoryPressureNotificationsSuppressed"><strong>SetMemoryPressureNotificationsSuppressed</strong></a>(self, suppressed, timeout<font color="#909090">=90</font>)</dt></dl>
  78. <dl><dt><a name="Browser-SimulateMemoryPressureNotification"><strong>SimulateMemoryPressureNotification</strong></a>(self, pressure_level, timeout<font color="#909090">=90</font>)</dt></dl>
  79. <dl><dt><a name="Browser-__init__"><strong>__init__</strong></a>(self, backend, platform_backend, credentials_path)</dt></dl>
  80. <hr>
  81. Data descriptors defined here:<br>
  82. <dl><dt><strong>browser_type</strong></dt>
  83. </dl>
  84. <dl><dt><strong>cpu_stats</strong></dt>
  85. <dd><tt>Returns&nbsp;a&nbsp;dict&nbsp;of&nbsp;cpu&nbsp;statistics&nbsp;for&nbsp;the&nbsp;system.<br>
  86. {&nbsp;'Browser':&nbsp;{<br>
  87. &nbsp;&nbsp;&nbsp;&nbsp;'CpuProcessTime':&nbsp;S,<br>
  88. &nbsp;&nbsp;&nbsp;&nbsp;'TotalTime':&nbsp;T<br>
  89. &nbsp;&nbsp;},<br>
  90. &nbsp;&nbsp;'Gpu':&nbsp;{<br>
  91. &nbsp;&nbsp;&nbsp;&nbsp;'CpuProcessTime':&nbsp;S,<br>
  92. &nbsp;&nbsp;&nbsp;&nbsp;'TotalTime':&nbsp;T<br>
  93. &nbsp;&nbsp;},<br>
  94. &nbsp;&nbsp;'Renderer':&nbsp;{<br>
  95. &nbsp;&nbsp;&nbsp;&nbsp;'CpuProcessTime':&nbsp;S,<br>
  96. &nbsp;&nbsp;&nbsp;&nbsp;'TotalTime':&nbsp;T<br>
  97. &nbsp;&nbsp;}<br>
  98. }<br>
  99. Any&nbsp;of&nbsp;the&nbsp;above&nbsp;keys&nbsp;may&nbsp;be&nbsp;missing&nbsp;on&nbsp;a&nbsp;per-platform&nbsp;basis.</tt></dd>
  100. </dl>
  101. <dl><dt><strong>extensions</strong></dt>
  102. </dl>
  103. <dl><dt><strong>foreground_tab</strong></dt>
  104. </dl>
  105. <dl><dt><strong>memory_stats</strong></dt>
  106. <dd><tt>Returns&nbsp;a&nbsp;dict&nbsp;of&nbsp;memory&nbsp;statistics&nbsp;for&nbsp;the&nbsp;browser:<br>
  107. {&nbsp;'Browser':&nbsp;{<br>
  108. &nbsp;&nbsp;&nbsp;&nbsp;'VM':&nbsp;R,<br>
  109. &nbsp;&nbsp;&nbsp;&nbsp;'VMPeak':&nbsp;S,<br>
  110. &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSize':&nbsp;T,<br>
  111. &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSizePeak':&nbsp;U,<br>
  112. &nbsp;&nbsp;&nbsp;&nbsp;'ProportionalSetSize':&nbsp;V,<br>
  113. &nbsp;&nbsp;&nbsp;&nbsp;'PrivateDirty':&nbsp;W<br>
  114. &nbsp;&nbsp;},<br>
  115. &nbsp;&nbsp;'Gpu':&nbsp;{<br>
  116. &nbsp;&nbsp;&nbsp;&nbsp;'VM':&nbsp;R,<br>
  117. &nbsp;&nbsp;&nbsp;&nbsp;'VMPeak':&nbsp;S,<br>
  118. &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSize':&nbsp;T,<br>
  119. &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSizePeak':&nbsp;U,<br>
  120. &nbsp;&nbsp;&nbsp;&nbsp;'ProportionalSetSize':&nbsp;V,<br>
  121. &nbsp;&nbsp;&nbsp;&nbsp;'PrivateDirty':&nbsp;W<br>
  122. &nbsp;&nbsp;},<br>
  123. &nbsp;&nbsp;'Renderer':&nbsp;{<br>
  124. &nbsp;&nbsp;&nbsp;&nbsp;'VM':&nbsp;R,<br>
  125. &nbsp;&nbsp;&nbsp;&nbsp;'VMPeak':&nbsp;S,<br>
  126. &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSize':&nbsp;T,<br>
  127. &nbsp;&nbsp;&nbsp;&nbsp;'WorkingSetSizePeak':&nbsp;U,<br>
  128. &nbsp;&nbsp;&nbsp;&nbsp;'ProportionalSetSize':&nbsp;V,<br>
  129. &nbsp;&nbsp;&nbsp;&nbsp;'PrivateDirty':&nbsp;W<br>
  130. &nbsp;&nbsp;},<br>
  131. &nbsp;&nbsp;'SystemCommitCharge':&nbsp;X,<br>
  132. &nbsp;&nbsp;'SystemTotalPhysicalMemory':&nbsp;Y,<br>
  133. &nbsp;&nbsp;'ProcessCount':&nbsp;Z,<br>
  134. }<br>
  135. Any&nbsp;of&nbsp;the&nbsp;above&nbsp;keys&nbsp;may&nbsp;be&nbsp;missing&nbsp;on&nbsp;a&nbsp;per-platform&nbsp;basis.</tt></dd>
  136. </dl>
  137. <dl><dt><strong>profiling_controller</strong></dt>
  138. </dl>
  139. <dl><dt><strong>supports_cpu_metrics</strong></dt>
  140. </dl>
  141. <dl><dt><strong>supports_extensions</strong></dt>
  142. </dl>
  143. <dl><dt><strong>supports_memory_dumping</strong></dt>
  144. </dl>
  145. <dl><dt><strong>supports_memory_metrics</strong></dt>
  146. </dl>
  147. <dl><dt><strong>supports_overriding_memory_pressure_notifications</strong></dt>
  148. </dl>
  149. <dl><dt><strong>supports_power_metrics</strong></dt>
  150. </dl>
  151. <dl><dt><strong>supports_system_info</strong></dt>
  152. </dl>
  153. <dl><dt><strong>supports_tab_control</strong></dt>
  154. </dl>
  155. <dl><dt><strong>tabs</strong></dt>
  156. </dl>
  157. <hr>
  158. Methods inherited from <a href="telemetry.internal.app.html#App">telemetry.internal.app.App</a>:<br>
  159. <dl><dt><a name="Browser-__enter__"><strong>__enter__</strong></a>(self)</dt></dl>
  160. <dl><dt><a name="Browser-__exit__"><strong>__exit__</strong></a>(self, *args)</dt></dl>
  161. <hr>
  162. Data descriptors inherited from <a href="telemetry.internal.app.html#App">telemetry.internal.app.App</a>:<br>
  163. <dl><dt><strong>__dict__</strong></dt>
  164. <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
  165. </dl>
  166. <dl><dt><strong>__weakref__</strong></dt>
  167. <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  168. </dl>
  169. <dl><dt><strong>app_type</strong></dt>
  170. </dl>
  171. <dl><dt><strong>platform</strong></dt>
  172. </dl>
  173. </td></tr></table></td></tr></table>
  174. </body></html>