tools/telemetry/docs/pydoc/telemetry.internal.browser.tab.html - Issue 1647513002: Delete tools/telemetry.

Unified Diff: tools/telemetry/docs/pydoc/telemetry.internal.browser.tab.html

Issue 1647513002: Delete tools/telemetry. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master

Patch Set: Created 4 years, 11 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/pydoc/telemetry.internal.browser.profile_types.html ('k') | tools/telemetry/docs/pydoc/telemetry.internal.browser.tab_list.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: tools/telemetry/docs/pydoc/telemetry.internal.browser.tab.html

diff --git a/tools/telemetry/docs/pydoc/telemetry.internal.browser.tab.html b/tools/telemetry/docs/pydoc/telemetry.internal.browser.tab.html

deleted file mode 100644

index 2133051f16ada4d7a78590060b776689efea97db..0000000000000000000000000000000000000000

--- a/tools/telemetry/docs/pydoc/telemetry.internal.browser.tab.html

+++ /dev/null

@@ -1,395 +0,0 @@

-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

-<html><head><title>Python: module telemetry.internal.browser.tab</title>

-<meta charset="utf-8">

-</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.internal.html">internal</a>.<a href="telemetry.internal.browser.html">browser</a>.tab</big></big></td

-><td align=right valign=bottom

-><a href=".">index</a> <a href="../telemetry/internal/browser/tab.py">telemetry/internal/browser/tab.py</a></td></tr></table>

- <tt># Copyright 2012 The Chromium Authors. All rights reserved.

-# Use of this source code is governed by a BSD-style license that can be

-# found in the LICENSE file.</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.internal.image_processing.video.html">telemetry.internal.image_processing.video</a>

-</td><td width="25%" valign=top><a href="telemetry.internal.browser.web_contents.html">telemetry.internal.browser.web_contents</a>

-</td><td width="25%" valign=top></td><td width="25%" valign=top></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="telemetry.internal.browser.web_contents.html#WebContents">telemetry.internal.browser.web_contents.WebContents</a>(<a href="__builtin__.html#object">__builtin__.object</a>)

-</dt><dd>

-<dl>

-<dt><a href="telemetry.internal.browser.tab.html#Tab">Tab</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="Tab">class Tab</a>(<a href="telemetry.internal.browser.web_contents.html#WebContents">telemetry.internal.browser.web_contents.WebContents</a>)</td></tr>

-<tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>

-<td colspan=2><tt>Represents a tab in the browser

-

-The important parts of the <a href="#Tab">Tab</a> object are in the runtime and page objects.

-E.g.:

-    # Navigates the tab to a given url.

-    tab.<a href="#Tab-Navigate">Navigate</a>('<a href="http://www.google.com/">http://www.google.com/</a>')

-

-    # Evaluates 1+1 in the tab's JavaScript context.

-    tab.Evaluate('1+1')  </tt></td></tr>

-<tr><td> </td>

-<td width="100%"><dl><dt>Method resolution order:</dt>

-<dd><a href="telemetry.internal.browser.tab.html#Tab">Tab</a></dd>

-<dd><a href="telemetry.internal.browser.web_contents.html#WebContents">telemetry.internal.browser.web_contents.WebContents</a></dd>

-<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

-</dl>

-<hr>

-Methods defined here:

-<dl><dt><a name="Tab-Activate">Activate</a>(self)</dt><dd><tt>Brings this tab to the foreground asynchronously.

-

-Not all browsers or browser versions support this method.

-Be sure to check browser.supports_tab_control.

-

-Please note: this is asynchronous. There is a delay between this call

-and the page's documentVisibilityState becoming 'visible', and yet more

-delay until the actual tab is visible to the user. None of these delays

-are included in this call.

-

-Raises:

-  devtools_http.DevToolsClientConnectionError

-  devtools_client_backend.TabNotFoundError

-  tab_list_backend.TabUnexpectedResponseException</tt></dd></dl>

-<dl><dt><a name="Tab-ClearCache">ClearCache</a>(self, force)</dt><dd><tt>Clears the browser's networking related disk, memory and other caches.

-

-Args:

-  force: Iff true, navigates to about:blank which destroys the previous

-      renderer, ensuring that even "live" resources in the memory cache are

-      cleared.

-

-Raises:

-  exceptions.EvaluateException

-  exceptions.WebSocketDisconnected

-  exceptions.TimeoutException

-  exceptions.DevtoolsTargetCrashException

-  errors.DeviceUnresponsiveError</tt></dd></dl>

-<dl><dt><a name="Tab-ClearHighlight">ClearHighlight</a>(self, color)</dt><dd><tt>Clears a highlight of the given bitmap.RgbaColor.

-

-Raises:

-  exceptions.EvaluateException

-  exceptions.WebSocketDisconnected

-  exceptions.TimeoutException

-  exceptions.DevtoolsTargetCrashException</tt></dd></dl>

-<dl><dt><a name="Tab-Close">Close</a>(self)</dt><dd><tt>Closes this tab.

-

-Not all browsers or browser versions support this method.

-Be sure to check browser.supports_tab_control.

-

-Raises:

-  devtools_http.DevToolsClientConnectionError

-  devtools_client_backend.TabNotFoundError

-  tab_list_backend.TabUnexpectedResponseException

-  exceptions.TimeoutException</tt></dd></dl>

-<dl><dt><a name="Tab-CollectGarbage">CollectGarbage</a>(self)</dt><dd><tt>Forces a garbage collection.

-

-Raises:

-  exceptions.WebSocketDisconnected

-  exceptions.TimeoutException

-  exceptions.DevtoolsTargetCrashException</tt></dd></dl>

-<dl><dt><a name="Tab-GetCookieByName">GetCookieByName</a>(self, name, timeout=60)</dt><dd><tt>Returns the value of the cookie by the given |name|.

-

-Raises:

-  exceptions.WebSocketDisconnected

-  exceptions.TimeoutException

-  exceptions.DevtoolsTargetCrashException</tt></dd></dl>

-<dl><dt><a name="Tab-Highlight">Highlight</a>(self, color)</dt><dd><tt>Synchronously highlights entire tab contents with the given RgbaColor.

-

-TODO(tonyg): It is possible that the z-index hack here might not work for

-all pages. If this happens, DevTools also provides a method for this.

-

-Raises:

-  exceptions.EvaluateException

-  exceptions.WebSocketDisconnected

-  exceptions.TimeoutException

-  exceptions.DevtoolsTargetCrashException</tt></dd></dl>

-<dl><dt><a name="Tab-Screenshot">Screenshot</a>(self, timeout=60)</dt><dd><tt>Capture a screenshot of the tab's contents.

-

-Returns:

-  A telemetry.core.Bitmap.

-Raises:

-  exceptions.WebSocketDisconnected

-  exceptions.TimeoutException

-  exceptions.DevtoolsTargetCrashException</tt></dd></dl>

-<dl><dt><a name="Tab-StartVideoCapture">StartVideoCapture</a>(self, min_bitrate_mbps, highlight_bitmap=RgbaColor(r=222, g=100, b=13, a=255))</dt><dd><tt>Starts capturing video of the tab's contents.

-

-This works by flashing the entire tab contents to a arbitrary color and then

-starting video recording. When the frames are processed, we can look for

-that flash as the content bounds.

-

-Args:

-  min_bitrate_mbps: The minimum caputre bitrate in MegaBits Per Second.

-      The platform is free to deliver a higher bitrate if it can do so

-      without increasing overhead.

-

-Raises:

-  exceptions.EvaluateException

-  exceptions.WebSocketDisconnected

-  exceptions.TimeoutException

-  exceptions.DevtoolsTargetCrashException

-  ValueError: If the required |min_bitrate_mbps| can't be achieved.</tt></dd></dl>

-<dl><dt><a name="Tab-StopVideoCapture">StopVideoCapture</a>(self)</dt><dd><tt>Stops recording video of the tab's contents.

-

-This looks for the initial color flash in the first frame to establish the

-tab content boundaries and then omits all frames displaying the flash.

-

-Returns:

-  video: A video object which is a telemetry.core.Video</tt></dd></dl>

-<dl><dt><a name="Tab-__init__">__init__</a>(self, inspector_backend, tab_list_backend, browser)</dt></dl>

-<hr>

-Data descriptors defined here:

-<dl><dt>browser</dt>

-<dd><tt>The browser in which this tab resides.</tt></dd>

-</dl>

-<dl><dt>dom_stats</dt>

-<dd><tt>A dictionary populated with measured DOM statistics.

-

-Currently this dictionary contains:

-{

-  'document_count': integer,

-  'node_count': integer,

-  'event_listener_count': integer

-}

-

-Raises:

-  inspector_memory.InspectorMemoryException

-  exceptions.TimeoutException

-  exceptions.DevtoolsTargetCrashException</tt></dd>

-</dl>

-<dl><dt>is_video_capture_running</dt>

-</dl>

-<dl><dt>screenshot_supported</dt>

-<dd><tt>True if the browser instance is capable of capturing screenshots.</tt></dd>

-</dl>

-<dl><dt>url</dt>

-<dd><tt>Returns the URL of the tab, as reported by devtools.

-

-Raises:

-  devtools_http.DevToolsClientConnectionError</tt></dd>

-</dl>

-<dl><dt>video_capture_supported</dt>

-<dd><tt>True if the browser instance is capable of capturing video.</tt></dd>

-</dl>

-<hr>

-Methods inherited from <a href="telemetry.internal.browser.web_contents.html#WebContents">telemetry.internal.browser.web_contents.WebContents</a>:

-<dl><dt><a name="Tab-CloseConnections">CloseConnections</a>(self)</dt><dd><tt>Closes all TCP sockets held open by the browser.

-

-Raises:

-  exceptions.DevtoolsTargetCrashException if the tab is not alive.</tt></dd></dl>

-<dl><dt><a name="Tab-EnableAllContexts">EnableAllContexts</a>(self)</dt><dd><tt>Enable all contexts in a page. Returns the number of available contexts.

-

-Raises:

-  exceptions.WebSocketDisconnected

-  exceptions.TimeoutException

-  exceptions.DevtoolsTargetCrashException</tt></dd></dl>

-<dl><dt><a name="Tab-EvaluateJavaScript">EvaluateJavaScript</a>(self, expr, timeout=90)</dt><dd><tt>Evalutes expr in JavaScript and returns the JSONized result.

-

-Consider using ExecuteJavaScript for cases where the result of the

-expression is not needed.

-

-If evaluation throws in JavaScript, a Python EvaluateException will

-be raised.

-

-If the result of the evaluation cannot be JSONized, then an

-EvaluationException will be raised.

-

-Raises:

-  exceptions.Error: See <a href="#Tab-EvaluateJavaScriptInContext">EvaluateJavaScriptInContext</a>() for a detailed list

-  of possible exceptions.</tt></dd></dl>

-<dl><dt><a name="Tab-EvaluateJavaScriptInContext">EvaluateJavaScriptInContext</a>(self, expr, context_id, timeout=90)</dt><dd><tt>Similar to ExecuteJavaScript, except context_id can refer to an iframe.

-The main page has context_id=1, the first iframe context_id=2, etc.

-

-Raises:

-  exceptions.EvaluateException

-  exceptions.WebSocketDisconnected

-  exceptions.TimeoutException

-  exceptions.DevtoolsTargetCrashException</tt></dd></dl>

-<dl><dt><a name="Tab-ExecuteJavaScript">ExecuteJavaScript</a>(self, statement, timeout=90)</dt><dd><tt>Executes statement in JavaScript. Does not return the result.

-

-If the statement failed to evaluate, EvaluateException will be raised.

-

-Raises:

-  exceptions.Error: See <a href="#Tab-ExecuteJavaScriptInContext">ExecuteJavaScriptInContext</a>() for a detailed list of

-  possible exceptions.</tt></dd></dl>

-<dl><dt><a name="Tab-ExecuteJavaScriptInContext">ExecuteJavaScriptInContext</a>(self, expr, context_id, timeout=90)</dt><dd><tt>Similar to ExecuteJavaScript, except context_id can refer to an iframe.

-The main page has context_id=1, the first iframe context_id=2, etc.

-

-Raises:

-  exceptions.EvaluateException

-  exceptions.WebSocketDisconnected

-  exceptions.TimeoutException

-  exceptions.DevtoolsTargetCrashException</tt></dd></dl>

-<dl><dt><a name="Tab-GetUrl">GetUrl</a>(self)</dt><dd><tt>Returns the URL to which the <a href="telemetry.internal.browser.web_contents.html#WebContents">WebContents</a> is connected.

-

-Raises:

-  exceptions.Error: If there is an error in inspector backend connection.</tt></dd></dl>

-<dl><dt><a name="Tab-GetWebviewContexts">GetWebviewContexts</a>(self)</dt><dd><tt>Returns a list of webview contexts within the current inspector backend.

-

-Returns:

-  A list of <a href="telemetry.internal.browser.web_contents.html#WebContents">WebContents</a> objects representing the webview contexts.

-

-Raises:

-  exceptions.Error: If there is an error in inspector backend connection.</tt></dd></dl>

-<dl><dt><a name="Tab-HasReachedQuiescence">HasReachedQuiescence</a>(self)</dt><dd><tt>Determine whether the page has reached quiescence after loading.

-

-Returns:

-  True if 2 seconds have passed since last resource received, false

-  otherwise.

-Raises:

-  exceptions.Error: See <a href="#Tab-EvaluateJavaScript">EvaluateJavaScript</a>() for a detailed list of

-  possible exceptions.</tt></dd></dl>

-<dl><dt><a name="Tab-IsAlive">IsAlive</a>(self)</dt><dd><tt>Whether the <a href="telemetry.internal.browser.web_contents.html#WebContents">WebContents</a> is still operating normally.

-

-Since <a href="telemetry.internal.browser.web_contents.html#WebContents">WebContents</a> function asynchronously, this method does not guarantee

-that the <a href="telemetry.internal.browser.web_contents.html#WebContents">WebContents</a> will still be alive at any point in the future.

-

-Returns:

-  A boolean indicating whether the <a href="telemetry.internal.browser.web_contents.html#WebContents">WebContents</a> is opearting normally.</tt></dd></dl>

-<dl><dt><a name="Tab-Navigate">Navigate</a>(self, url, script_to_evaluate_on_commit=None, timeout=90)</dt><dd><tt>Navigates to url.

-

-If |script_to_evaluate_on_commit| is given, the script source string will be

-evaluated when the navigation is committed. This is after the context of

-the page exists, but before any script on the page itself has executed.

-

-Raises:

-  exceptions.TimeoutException

-  exceptions.DevtoolsTargetCrashException</tt></dd></dl>

-<dl><dt><a name="Tab-StartTimelineRecording">StartTimelineRecording</a>(self)</dt><dd><tt>Starts timeline recording.

-

-Raises:

-  exceptions.TimeoutException

-  exceptions.DevtoolsTargetCrashException</tt></dd></dl>

-<dl><dt><a name="Tab-StopTimelineRecording">StopTimelineRecording</a>(self)</dt><dd><tt>Stops timeline recording.

-

-Raises:

-  exceptions.TimeoutException

-  exceptions.DevtoolsTargetCrashException</tt></dd></dl>

-<dl><dt><a name="Tab-SynthesizeScrollGesture">SynthesizeScrollGesture</a>(self, x=100, y=800, xDistance=0, yDistance=-500, xOverscroll=None, yOverscroll=None, preventFling=True, speed=None, gestureSourceType=None, repeatCount=None, repeatDelayMs=None, interactionMarkerName=None)</dt><dd><tt>Runs an inspector command that causes a repeatable browser driven scroll.

-

-Args:

-  x: X coordinate of the start of the gesture in CSS pixels.

-  y: Y coordinate of the start of the gesture in CSS pixels.

-  xDistance: Distance to scroll along the X axis (positive to scroll left).

-  yDistance: Ddistance to scroll along the Y axis (positive to scroll up).

-  xOverscroll: Number of additional pixels to scroll back along the X axis.

-  xOverscroll: Number of additional pixels to scroll back along the Y axis.

-  preventFling: Prevents a fling gesture.

-  speed: Swipe speed in pixels per second.

-  gestureSourceType: Which type of input events to be generated.

-  repeatCount: Number of additional repeats beyond the first scroll.

-  repeatDelayMs: Number of milliseconds delay between each repeat.

-  interactionMarkerName: The name of the interaction markers to generate.

-

-Raises:

-  exceptions.TimeoutException

-  exceptions.DevtoolsTargetCrashException</tt></dd></dl>

-<dl><dt><a name="Tab-WaitForDocumentReadyStateToBeComplete">WaitForDocumentReadyStateToBeComplete</a>(self, timeout=90)</dt><dd><tt>Waits for the document to finish loading.

-

-Raises:

-  exceptions.Error: See <a href="#Tab-WaitForJavaScriptExpression">WaitForJavaScriptExpression</a>() for a detailed list

-  of possible exceptions.</tt></dd></dl>

-<dl><dt><a name="Tab-WaitForDocumentReadyStateToBeInteractiveOrBetter">WaitForDocumentReadyStateToBeInteractiveOrBetter</a>(self, timeout=90)</dt><dd><tt>Waits for the document to be interactive.

-

-Raises:

-  exceptions.Error: See <a href="#Tab-WaitForJavaScriptExpression">WaitForJavaScriptExpression</a>() for a detailed list

-  of possible exceptions.</tt></dd></dl>

-<dl><dt><a name="Tab-WaitForJavaScriptExpression">WaitForJavaScriptExpression</a>(self, expr, timeout, dump_page_state_on_timeout=True)</dt><dd><tt>Waits for the given JavaScript expression to be True.

-

-This method is robust against any given Evaluation timing out.

-

-Args:

-  expr: The expression to evaluate.

-  timeout: The number of seconds to wait for the expression to be True.

-  dump_page_state_on_timeout: Whether to provide additional information on

-      the page state if a TimeoutException is thrown.

-

-Raises:

-  exceptions.TimeoutException: On a timeout.

-  exceptions.Error: See <a href="#Tab-EvaluateJavaScript">EvaluateJavaScript</a>() for a detailed list of

-  possible exceptions.</tt></dd></dl>

-<dl><dt><a name="Tab-WaitForNavigate">WaitForNavigate</a>(self, timeout=90)</dt><dd><tt>Waits for the navigation to complete.

-

-The current page is expect to be in a navigation.

-This function returns when the navigation is complete or when

-the timeout has been exceeded.

-

-Raises:

-  exceptions.TimeoutException

-  exceptions.DevtoolsTargetCrashException</tt></dd></dl>

-<hr>

-Data descriptors inherited from <a href="telemetry.internal.browser.web_contents.html#WebContents">telemetry.internal.browser.web_contents.WebContents</a>:

-<dl><dt>__dict__</dt>

-<dd><tt>dictionary for instance variables (if defined)</tt></dd>

-</dl>

-<dl><dt>__weakref__</dt>

-<dd><tt>list of weak references to the object (if defined)</tt></dd>

-</dl>

-<dl><dt>id</dt>

-<dd><tt>Return the unique id string for this tab object.</tt></dd>

-</dl>

-<dl><dt>message_output_stream</dt>

-</dl>

-<dl><dt>timeline_model</dt>

-</dl>

-</td></tr></table></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%">DEFAULT_TAB_TIMEOUT = 60</td></tr></table>

-</body></html>