tools/telemetry/docs/telemetry.html - Issue 196383034: Update telemetry docs by running the update_docs script.

Unified Diff: tools/telemetry/docs/telemetry.html

Issue 196383034: Update telemetry docs by running the update_docs script. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 6 years, 9 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

Index: tools/telemetry/docs/telemetry.html

diff --git a/tools/telemetry/docs/telemetry.html b/tools/telemetry/docs/telemetry.html

index 5b75b23a945949ea92e62138464739fd47be6e05..42cc1119f6f45e8dc9e082b443a331d068d30457 100644

--- a/tools/telemetry/docs/telemetry.html

+++ b/tools/telemetry/docs/telemetry.html

@@ -18,11 +18,16 @@

<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.core.html">core (package)</a>

-<a href="telemetry.page.html">page (package)</a>

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

+<a href="telemetry.decorators.html">decorators</a>

+<a href="telemetry.exception_formatter.html">exception_formatter</a>

+</td><td width="25%" valign=top><a href="telemetry.page.html">page (package)</a>

+<a href="telemetry.test.html">test</a>

<a href="telemetry.test_runner.html">test_runner</a>

</td><td width="25%" valign=top><a href="telemetry.unittest.html">unittest (package)</a>

-</td><td width="25%" valign=top></td></tr></table></td></tr></table>

+<a href="telemetry.util.html">util (package)</a>

+<a href="telemetry.value.html">value (package)</a>

+</td><td width="25%" valign=top><a href="telemetry.web_components.html">web_components (package)</a>

+</td></tr></table></td></tr></table>

@@ -39,7 +44,7 @@

<dt><a href="optparse.html#Values">optparse.Values</a>

</dt><dd>

<dl>

-<dt><a href="telemetry.core.browser_options.html#BrowserOptions">telemetry.core.browser_options.BrowserOptions</a>

+<dt><a href="telemetry.core.browser_options.html#BrowserFinderOptions">telemetry.core.browser_options.BrowserFinderOptions</a>

</dt></dl>

</dd>

<dt><a href="telemetry.core.web_contents.html#WebContents">telemetry.core.web_contents.WebContents</a>(<a href="__builtin__.html#object">__builtin__.object</a>)

@@ -48,7 +53,7 @@

<dt><a href="telemetry.core.tab.html#Tab">telemetry.core.tab.Tab</a>

</dt></dl>

</dd>

-<dt><a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>(<a href="__builtin__.html#object">__builtin__.object</a>)

+<dt><a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>(<a href="telemetry.core.command_line.html#ArgumentHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a>)

</dt><dd>

<dl>

<dt><a href="telemetry.page.page_measurement.html#PageMeasurement">telemetry.page.page_measurement.PageMeasurement</a>

@@ -79,20 +84,31 @@ the browser. Or better yet:

<dl><dt><a name="Browser-GetStandardOutput">GetStandardOutput</a>(self)</dt></dl>

-<dl><dt><a name="Browser-GetTraceResultAndReset">GetTraceResultAndReset</a>(self)</dt><dd><tt>Returns the result of the trace, as TraceResult <a href="__builtin__.html#object">object</a>.</tt></dd></dl>

+<dl><dt><a name="Browser-GetSystemInfo">GetSystemInfo</a>(self)</dt><dd><tt>Returns low-level information about the system, if available.

+

+See the documentation of the SystemInfo class for more details.</tt></dd></dl>

<dl><dt><a name="Browser-SetHTTPServerDirectories">SetHTTPServerDirectories</a>(self, paths)</dt><dd><tt>Returns True if the HTTP server was started, False otherwise.</tt></dd></dl>

<dl><dt><a name="Browser-SetReplayArchivePath">SetReplayArchivePath</a>(self, archive_path, append_to_existing_wpr=False, make_javascript_deterministic=True)</dt></dl>

-<dl><dt><a name="Browser-StartProfiling">StartProfiling</a>(self, options, base_output_file)</dt><dd><tt>Starts profiling using |options|.profiler_tool. Results are saved to

+<dl><dt><a name="Browser-Start">Start</a>(self)</dt></dl>

+<dl><dt><a name="Browser-StartLocalServer">StartLocalServer</a>(self, server)</dt><dd><tt>Starts a LocalServer and associates it with this browser.

+

+It will be closed when the browser closes.</tt></dd></dl>

+<dl><dt><a name="Browser-StartProfiling">StartProfiling</a>(self, profiler_name, base_output_file)</dt><dd><tt>Starts profiling using |profiler_name|. Results are saved to

|base_output_file|.<process_name>.</tt></dd></dl>

<dl><dt><a name="Browser-StartTracing">StartTracing</a>(self, custom_categories=None, timeout=10)</dt></dl>

-<dl><dt><a name="Browser-StopProfiling">StopProfiling</a>(self)</dt><dd><tt>Stops all active profilers and saves their results.</tt></dd></dl>

+<dl><dt><a name="Browser-StopProfiling">StopProfiling</a>(self)</dt><dd><tt>Stops all active profilers and saves their results.

+

+Returns:

+  A list of filenames produced by the profiler.</tt></dd></dl>

-<dl><dt><a name="Browser-StopTracing">StopTracing</a>(self)</dt></dl>

+<dl><dt><a name="Browser-StopTracing">StopTracing</a>(self)</dt><dd><tt>Stops tracing and returns the result as TimelineData <a href="__builtin__.html#object">object</a>.</tt></dd></dl>

<dl><dt><a name="Browser-__enter__">__enter__</a>(self)</dt></dl>

@@ -112,8 +128,26 @@ Data descriptors defined here:

</dl>

<dl><dt>browser_type</dt>

</dl>

+<dl><dt>cpu_stats</dt>

+<dd><tt>Returns a dict of cpu statistics for the system.

+{ 'Browser': {

+    'CpuProcessTime': S,

+    'TotalTime': T

+  },

+  'Gpu': {

+    'CpuProcessTime': S,

+    'TotalTime': T

+  },

+  'Renderer': {

+    'CpuProcessTime': S,

+    'TotalTime': T

+  }

+}

+Any of the above keys may be missing on a per-platform basis.</tt></dd>

+</dl>

<dl><dt>extensions</dt>

-<dd><tt>Returns the extension dictionary if it exists.</tt></dd>

+</dl>

+<dl><dt>foreground_tab</dt>

</dl>

<dl><dt>http_server</dt>

</dl>

@@ -142,33 +176,39 @@ Data descriptors defined here:

<dl><dt>is_content_shell</dt>

<dd><tt>Returns whether this browser is a content shell, only.</tt></dd>

</dl>

+<dl><dt>is_tracing_running</dt>

+</dl>

+<dl><dt>local_servers</dt>

+<dd><tt>Returns the currently running local servers.</tt></dd>

+</dl>

<dl><dt>memory_stats</dt>

<dd><tt>Returns a dict of memory statistics for the browser:

{ 'Browser': {

-    'VM': S,

-    'VMPeak': T,

-    'WorkingSetSize': U,

-    'WorkingSetSizePeak': V,

-    'ProportionalSetSize': W,

-    'PrivateDirty': X

+    'VM': R,

+    'VMPeak': S,

+    'WorkingSetSize': T,

+    'WorkingSetSizePeak': U,

+    'ProportionalSetSize': V,

+    'PrivateDirty': W

},

'Gpu': {

-    'VM': S,

-    'VMPeak': T,

-    'WorkingSetSize': U,

-    'WorkingSetSizePeak': V,

-    'ProportionalSetSize': W,

-    'PrivateDirty': X

+    'VM': R,

+    'VMPeak': S,

+    'WorkingSetSize': T,

+    'WorkingSetSizePeak': U,

+    'ProportionalSetSize': V,

+    'PrivateDirty': W

},

'Renderer': {

-    'VM': S,

-    'VMPeak': T,

-    'WorkingSetSize': U,

-    'WorkingSetSizePeak': V,

-    'ProportionalSetSize': W,

-    'PrivateDirty': X

+    'VM': R,

+    'VMPeak': S,

+    'WorkingSetSize': T,

+    'WorkingSetSizePeak': U,

+    'ProportionalSetSize': V,

+    'PrivateDirty': W

},

-  'SystemCommitCharge': Y,

+  'SystemCommitCharge': X,

+  'SystemTotalPhysicalMemory': Y,

'ProcessCount': Z,

}

Any of the above keys may be missing on a per-platform basis.</tt></dd>

@@ -177,43 +217,49 @@ Any of the above keys may be missing on&

</dl>

<dl><dt>supports_extensions</dt>

</dl>

+<dl><dt>supports_system_info</dt>

+</dl>

<dl><dt>supports_tab_control</dt>

</dl>

<dl><dt>supports_tracing</dt>

</dl>

+<dl><dt>synthetic_gesture_source_type</dt>

+</dl>

</dl>

</td></tr></table>

-<a name="BrowserOptions">class BrowserOptions</a>(<a href="optparse.html#Values">optparse.Values</a>)</td></tr>

+<a name="BrowserFinderOptions">class BrowserFinderOptions</a>(<a href="optparse.html#Values">optparse.Values</a>)</td></tr>

-<td colspan=2><tt>Options to be used for discovering and launching a browser.  </tt></td></tr>

+<td colspan=2><tt>Options to be used for discovering a browser.  </tt></td></tr>

<td width="100%">Methods defined here:

-<dl><dt><a name="BrowserOptions-AppendExtraBrowserArg">AppendExtraBrowserArg</a>(self, arg)</dt></dl>

+<dl><dt><a name="BrowserFinderOptions-AppendExtraBrowserArgs">AppendExtraBrowserArgs</a>(self, args)</dt></dl>

+<dl><dt><a name="BrowserFinderOptions-Copy">Copy</a>(self)</dt></dl>

-<dl><dt><a name="BrowserOptions-Copy">Copy</a>(self)</dt></dl>

+<dl><dt><a name="BrowserFinderOptions-CreateParser">CreateParser</a>(self, *args, **kwargs)</dt></dl>

-<dl><dt><a name="BrowserOptions-CreateParser">CreateParser</a>(self, *args, **kwargs)</dt></dl>

+<dl><dt><a name="BrowserFinderOptions-MergeDefaultValues">MergeDefaultValues</a>(self, defaults)</dt></dl>

-<dl><dt><a name="BrowserOptions-__init__">__init__</a>(self, browser_type=None)</dt></dl>

+<dl><dt><a name="BrowserFinderOptions-__init__">__init__</a>(self, browser_type=None)</dt></dl>

<hr>

Methods inherited from <a href="optparse.html#Values">optparse.Values</a>:

-<dl><dt><a name="BrowserOptions-__cmp__">__cmp__</a>(self, other)</dt></dl>

+<dl><dt><a name="BrowserFinderOptions-__cmp__">__cmp__</a>(self, other)</dt></dl>

-<dl><dt><a name="BrowserOptions-__repr__">__repr__</a> = _repr(self)</dt></dl>

+<dl><dt><a name="BrowserFinderOptions-__repr__">__repr__</a> = _repr(self)</dt></dl>

-<dl><dt><a name="BrowserOptions-__str__">__str__</a>(self)</dt></dl>

+<dl><dt><a name="BrowserFinderOptions-__str__">__str__</a>(self)</dt></dl>

-<dl><dt><a name="BrowserOptions-ensure_value">ensure_value</a>(self, attr, value)</dt></dl>

+<dl><dt><a name="BrowserFinderOptions-ensure_value">ensure_value</a>(self, attr, value)</dt></dl>

-<dl><dt><a name="BrowserOptions-read_file">read_file</a>(self, filename, mode='careful')</dt></dl>

+<dl><dt><a name="BrowserFinderOptions-read_file">read_file</a>(self, filename, mode='careful')</dt></dl>

-<dl><dt><a name="BrowserOptions-read_module">read_module</a>(self, modname, mode='careful')</dt></dl>

+<dl><dt><a name="BrowserFinderOptions-read_module">read_module</a>(self, modname, mode='careful')</dt></dl>

</td></tr></table>

@@ -239,7 +285,7 @@ example:

To add test-specific options:

class BodyChildElementMeasurement(<a href="#PageMeasurement">PageMeasurement</a>):

-      def <a href="#PageMeasurement-AddCommandLineOptions">AddCommandLineOptions</a>(parser):

+      def <a href="#PageMeasurement-AddCommandLineArgs">AddCommandLineArgs</a>(parser):

parser.add_option('--element', action='store', default='body')

def <a href="#PageMeasurement-MeasurePage">MeasurePage</a>(self, page, tab, results):

@@ -250,12 +296,11 @@ To add test-specific options:

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

<dd><a href="telemetry.page.page_measurement.html#PageMeasurement">PageMeasurement</a></dd>

<dd><a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a></dd>

+<dd><a href="telemetry.core.command_line.html#ArgumentHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a></dd>

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

</dl>

<hr>

Methods defined here:

-<dl><dt><a name="PageMeasurement-AddOutputOptions">AddOutputOptions</a>(self, parser)</dt></dl>

<dl><dt><a name="PageMeasurement-MeasurePage">MeasurePage</a>(self, page, tab, results)</dt><dd><tt>Override to actually measure the page's performance.

page is a page_set.Page

@@ -276,14 +321,10 @@ Put together:

raise Exception('Oh, wow.')

results.Add('two_plus_two', 'count', res)</tt></dd></dl>

-<dl><dt><a name="PageMeasurement-PrepareResults">PrepareResults</a>(self, options)</dt></dl>

-<dl><dt><a name="PageMeasurement-__init__">__init__</a>(self, action_name_to_run='', needs_browser_restart_after_each_run=False, discard_first_result=False, clear_cache_before_each_run=False)</dt></dl>

+<dl><dt><a name="PageMeasurement-__init__">__init__</a>(self, action_name_to_run='', needs_browser_restart_after_each_page=False, discard_first_result=False, clear_cache_before_each_run=False)</dt></dl>

<hr>

Data descriptors defined here:

-<dl><dt>output_format_choices</dt>

-</dl>

<dl><dt>results_are_the_same_on_every_page</dt>

<dd><tt>By default, measurements are assumed to output the same values for every

page. This allows incremental output, for example in CSV. If, however, the

@@ -294,62 +335,136 @@ run.</tt></dd>

</dl>

<hr>

Methods inherited from <a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>:

-<dl><dt><a name="PageMeasurement-AddCommandLineOptions">AddCommandLineOptions</a>(self, parser)</dt><dd><tt>Override to expose command-line options for this test.

-

-The provided parser is an optparse.OptionParser instance and accepts all

-normal results. The parsed options are available in Run as

-self.options.</tt></dd></dl>

<dl><dt><a name="PageMeasurement-CanRunForPage">CanRunForPage</a>(self, page)</dt><dd><tt>Override to customize if the test can be ran for the given page.</tt></dd></dl>

+<dl><dt><a name="PageMeasurement-CleanUpAfterPage">CleanUpAfterPage</a>(self, page, tab)</dt><dd><tt>Called after the test run method was run, even if it failed.</tt></dd></dl>

+<dl><dt><a name="PageMeasurement-CreateExpectations">CreateExpectations</a>(self, page_set)</dt><dd><tt>Override to make this test generate its own expectations instead of

+any that may have been defined in the page set.</tt></dd></dl>

<dl><dt><a name="PageMeasurement-CreatePageSet">CreatePageSet</a>(self, args, options)</dt><dd><tt>Override to make this test generate its own page set instead of

allowing arbitrary page sets entered from the command-line.</tt></dd></dl>

-<dl><dt><a name="PageMeasurement-CustomizeBrowserOptions">CustomizeBrowserOptions</a>(self, options)</dt><dd><tt>Override to add test-specific options to the <a href="#BrowserOptions">BrowserOptions</a> <a href="__builtin__.html#object">object</a></tt></dd></dl>

+<dl><dt><a name="PageMeasurement-CustomizeBrowserOptions">CustomizeBrowserOptions</a>(self, options)</dt><dd><tt>Override to add test-specific options to the BrowserOptions <a href="__builtin__.html#object">object</a></tt></dd></dl>

-<dl><dt><a name="PageMeasurement-CustomizeBrowserOptionsForPage">CustomizeBrowserOptionsForPage</a>(self, page, options)</dt><dd><tt>Add options specific to the test and the given page.</tt></dd></dl>

+<dl><dt><a name="PageMeasurement-CustomizeBrowserOptionsForPageSet">CustomizeBrowserOptionsForPageSet</a>(self, page_set, options)</dt><dd><tt>Set options required for this page set.

+

+These options will be used every time the browser is started while running

+this page set. They may, however, be further modified by

+CustomizeBrowserOptionsForSinglePage or by the profiler.</tt></dd></dl>

-<dl><dt><a name="PageMeasurement-DidNavigateToPage">DidNavigateToPage</a>(self, page, tab)</dt><dd><tt>Override to do operations right after the page is navigated, but before

-any waiting for completion has occurred.</tt></dd></dl>

+<dl><dt><a name="PageMeasurement-CustomizeBrowserOptionsForSinglePage">CustomizeBrowserOptionsForSinglePage</a>(self, page, options)</dt><dd><tt>Set options specific to the test and the given page.

+

+This will be called with the current page when the browser is (re)started.

+Changing options at this point only makes sense if the browser is being

+restarted for each page. Note that if page has a startup_url, the browser

+will always be restarted for each run.</tt></dd></dl>

+<dl><dt><a name="PageMeasurement-DidNavigateToPage">DidNavigateToPage</a>(self, page, tab)</dt><dd><tt>Override to do operations right after the page is navigated and after

+all waiting for completion has occurred.</tt></dd></dl>

<dl><dt><a name="PageMeasurement-DidRunAction">DidRunAction</a>(self, page, tab, action)</dt><dd><tt>Override to do operations after running the action on the page.</tt></dd></dl>

-<dl><dt><a name="PageMeasurement-DidRunPageSet">DidRunPageSet</a>(self, tab, results)</dt><dd><tt>Override to do operations after page set is completed, but before browser

-is torn down.</tt></dd></dl>

+<dl><dt><a name="PageMeasurement-DidRunActions">DidRunActions</a>(self, page, tab)</dt><dd><tt>Override to do operations after running the actions on the page.</tt></dd></dl>

+<dl><dt><a name="PageMeasurement-DidRunPageRepeats">DidRunPageRepeats</a>(self, page)</dt><dd><tt>Override to do operations after each page is iterated over.</tt></dd></dl>

+<dl><dt><a name="PageMeasurement-DidRunTest">DidRunTest</a>(self, browser, results)</dt><dd><tt>Override to do operations after all page set(s) are completed.

+

+This will occur before the browser is torn down.</tt></dd></dl>

+<dl><dt><a name="PageMeasurement-DidStartBrowser">DidStartBrowser</a>(self, browser)</dt><dd><tt>Override to customize the browser right after it has launched.</tt></dd></dl>

<dl><dt><a name="PageMeasurement-DidStartHTTPServer">DidStartHTTPServer</a>(self, tab)</dt><dd><tt>Override to do operations after the HTTP server is started.</tt></dd></dl>

-<dl><dt><a name="PageMeasurement-NeedsBrowserRestartAfterEachRun">NeedsBrowserRestartAfterEachRun</a>(self, tab)</dt><dd><tt>Override to specify browser restart after each run.</tt></dd></dl>

+<dl><dt><a name="PageMeasurement-IsExiting">IsExiting</a>(self)</dt></dl>

+<dl><dt><a name="PageMeasurement-RequestExit">RequestExit</a>(self)</dt></dl>

-<dl><dt><a name="PageMeasurement-Run">Run</a>(self, options, page, tab, results)</dt></dl>

+<dl><dt><a name="PageMeasurement-RestartBrowserBeforeEachPage">RestartBrowserBeforeEachPage</a>(self)</dt><dd><tt>Should the browser be restarted for the page?

+

+This returns true if the test needs to unconditionally restart the

+browser for each page. It may be called before the browser is started.</tt></dd></dl>

-<dl><dt><a name="PageMeasurement-SetUpBrowser">SetUpBrowser</a>(self, browser)</dt><dd><tt>Override to customize the browser right after it has launched.</tt></dd></dl>

+<dl><dt><a name="PageMeasurement-Run">Run</a>(self, page, tab, results)</dt></dl>

-<dl><dt><a name="PageMeasurement-WillNavigateToPage">WillNavigateToPage</a>(self, page, tab)</dt><dd><tt>Override to do operations before the page is navigated.</tt></dd></dl>

+<dl><dt><a name="PageMeasurement-RunNavigateSteps">RunNavigateSteps</a>(self, page, tab)</dt><dd><tt>Navigates the tab to the page URL attribute.

+

+Runs the 'navigate_steps' page attribute as a compound action.</tt></dd></dl>

+<dl><dt><a name="PageMeasurement-StopBrowserAfterPage">StopBrowserAfterPage</a>(self, browser, page)</dt><dd><tt>Should the browser be stopped after the page is run?

+

+This is called after a page is run to decide whether the browser needs to

+be stopped to clean up its state. If it is stopped, then it will be

+restarted to run the next page.

+

+A test that overrides this can look at both the page and the browser to

+decide whether it needs to stop the browser.</tt></dd></dl>

+<dl><dt><a name="PageMeasurement-TabForPage">TabForPage</a>(self, page, browser)</dt><dd><tt>Override to select a different tab for the page.  For instance, to

+create a new tab for every page, return browser.tabs.New().</tt></dd></dl>

+<dl><dt><a name="PageMeasurement-ValidatePageSet">ValidatePageSet</a>(self, page_set)</dt><dd><tt>Override to examine the page set before the test run.  Useful for

+example to validate that the pageset can be used with the test.</tt></dd></dl>

+<dl><dt><a name="PageMeasurement-WillNavigateToPage">WillNavigateToPage</a>(self, page, tab)</dt><dd><tt>Override to do operations before the page is navigated, notably Telemetry

+will already have performed the following operations on the browser before

+calling this function:

+* Ensure only one tab is open.

+* Call WaitForDocumentReadyStateToComplete on the tab.</tt></dd></dl>

<dl><dt><a name="PageMeasurement-WillRunAction">WillRunAction</a>(self, page, tab, action)</dt><dd><tt>Override to do operations before running the action on the page.</tt></dd></dl>

-<dl><dt><a name="PageMeasurement-WillRunPageSet">WillRunPageSet</a>(self, tab)</dt><dd><tt>Override to do operations before the page set is navigated.</tt></dd></dl>

+<dl><dt><a name="PageMeasurement-WillRunActions">WillRunActions</a>(self, page, tab)</dt><dd><tt>Override to do operations before running the actions on the page.</tt></dd></dl>

+<dl><dt><a name="PageMeasurement-WillRunPageRepeats">WillRunPageRepeats</a>(self, page)</dt><dd><tt>Override to do operations before each page is iterated over.</tt></dd></dl>

+<dl><dt><a name="PageMeasurement-WillRunTest">WillRunTest</a>(self, options)</dt><dd><tt>Override to do operations before the page set(s) are navigated.</tt></dd></dl>

+<dl><dt><a name="PageMeasurement-WillStartBrowser">WillStartBrowser</a>(self, browser)</dt><dd><tt>Override to manipulate the browser environment before it launches.</tt></dd></dl>

<hr>

Data descriptors inherited from <a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</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>action_name_to_run</dt>

</dl>

+<dl><dt>attempts</dt>

+<dd><tt>Maximum number of times test will be attempted.</tt></dd>

+</dl>

<dl><dt>clear_cache_before_each_run</dt>

<dd><tt>When set to True, the browser's disk and memory cache will be cleared

before each run.</tt></dd>

</dl>

+<dl><dt>close_tabs_before_run</dt>

+<dd><tt>When set to True, all tabs are closed before running the test for the

+first time.</tt></dd>

+</dl>

<dl><dt>discard_first_result</dt>

<dd><tt>When set to True, the first run of the test is discarded.  This is

useful for cases where it's desirable to have some test resource cached so

the first run of the test can warm things up.</tt></dd>

</dl>

+<dl><dt>max_errors</dt>

+<dd><tt>Maximum number of errors allowed for the page set.</tt></dd>

+</dl>

+<dl><dt>max_failures</dt>

+<dd><tt>Maximum number of failures allowed for the page set.</tt></dd>

+</dl>

+<hr>

+Class methods inherited from <a href="telemetry.core.command_line.html#ArgumentHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</a>:

+<dl><dt><a name="PageMeasurement-AddCommandLineArgs">AddCommandLineArgs</a>(cls, parser) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Override to accept custom command-line arguments.</tt></dd></dl>

+<dl><dt><a name="PageMeasurement-ProcessCommandLineArgs">ProcessCommandLineArgs</a>(cls, parser, args) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Override to process command-line arguments.

+

+We pass in parser so we can call parser.error().</tt></dd></dl>

+<hr>

+Data descriptors inherited from <a href="telemetry.core.command_line.html#ArgumentHandlerMixIn">telemetry.core.command_line.ArgumentHandlerMixIn</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>

</td></tr></table>

@@ -384,12 +499,24 @@ and the page's documentVisibilityState becoming 'visibl

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

are included in this call.</tt></dd></dl>

-<dl><dt><a name="Tab-ClearCache">ClearCache</a>(self)</dt><dd><tt>Clears the browser's HTTP disk cache and the tab's HTTP memory cache.</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.</tt></dd></dl>

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

<dl><dt><a name="Tab-CollectGarbage">CollectGarbage</a>(self)</dt></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|.</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.</tt></dd></dl>

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

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

@@ -402,9 +529,32 @@ action_function must be a Python function that&nbs

This function returns when the navigation is complete or when

the timeout has been exceeded.</tt></dd></dl>

-<dl><dt><a name="Tab-Screenshot">Screenshot</a>(self, timeout=60)</dt><dd><tt>Capture a screenshot of the window for rendering validation</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.</tt></dd></dl>

-<dl><dt><a name="Tab-__del__">__del__</a>(self)</dt></dl>

+<dl><dt><a name="Tab-StartVideoCapture">StartVideoCapture</a>(self, min_bitrate_mbps)</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.</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.

+

+Yields:

+  (time_ms, bitmap) tuples representing each video keyframe. Only the first

+  frame in a run of sequential duplicate bitmaps is typically included.

+    time_ms is milliseconds since navigationStart.

+    bitmap is a telemetry.core.Bitmap.</tt></dd></dl>

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

@@ -423,11 +573,16 @@ Currently this dictionary contains:

'event_listener_count': integer

}</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>

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

</dl>

</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.core.web_contents.html#WebContents">telemetry.core.web_contents.WebContents</a>:

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

@@ -435,9 +590,7 @@ Methods inherited from <a href="telemetry.core.web_contents.html#WebContents">te

Not all browsers or browser versions support this method.

Be sure to check browser.supports_tab_control.</tt></dd></dl>

-<dl><dt><a name="Tab-Disconnect">Disconnect</a>(self)</dt></dl>

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

+<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.

@@ -448,17 +601,35 @@ be raised.

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

EvaluationException will be raised.</tt></dd></dl>

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

+<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.</tt></dd></dl>

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

If the expression failed to evaluate, EvaluateException will be raised.</tt></dd></dl>

-<dl><dt><a name="Tab-StartTimelineRecording">StartTimelineRecording</a>(self)</dt></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.</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.</tt></dd></dl>

+<dl><dt><a name="Tab-StartTimelineRecording">StartTimelineRecording</a>(self, options=None)</dt></dl>

<dl><dt><a name="Tab-StopTimelineRecording">StopTimelineRecording</a>(self)</dt></dl>

-<dl><dt><a name="Tab-WaitForDocumentReadyStateToBeComplete">WaitForDocumentReadyStateToBeComplete</a>(self, timeout=60)</dt></dl>

+<dl><dt><a name="Tab-TakeJSHeapSnapshot">TakeJSHeapSnapshot</a>(self, timeout=120)</dt></dl>

+<dl><dt><a name="Tab-WaitForDocumentReadyStateToBeComplete">WaitForDocumentReadyStateToBeComplete</a>(self, timeout=90)</dt></dl>

-<dl><dt><a name="Tab-WaitForDocumentReadyStateToBeInteractiveOrBetter">WaitForDocumentReadyStateToBeInteractiveOrBetter</a>(self, timeout=60)</dt></dl>

+<dl><dt><a name="Tab-WaitForDocumentReadyStateToBeInteractiveOrBetter">WaitForDocumentReadyStateToBeInteractiveOrBetter</a>(self, timeout=90)</dt></dl>

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

+

+This method is robust against any given Evaluation timing out.</tt></dd></dl>

<hr>

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

@@ -468,6 +639,8 @@ Data descriptors inherited from <a href="telemetry.core.web_contents.html#WebCon

<dl><dt>__weakref__</dt>

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

</dl>

+<dl><dt>is_timeline_recording_running</dt>

+</dl>

<dl><dt>message_output_stream</dt>

</dl>

<dl><dt>timeline_model</dt>

@@ -479,7 +652,7 @@ Data descriptors inherited from <a href="telemetry.core.web_contents.html#WebCon

<big>Functions</big></td></tr>

-<td width="100%"><dl><dt><a name="-RunPage">RunPage</a> = Run(test, page_set, options)</dt><dd><tt>Runs a given test against a given page_set with the given options.</tt></dd></dl>

+<td width="100%"><dl><dt><a name="-RunPage">RunPage</a> = Run(test, page_set, expectations, finder_options)</dt><dd><tt>Runs a given test against a given page_set with the given options.</tt></dd></dl>

</td></tr></table>

@@ -487,5 +660,5 @@ Data descriptors inherited from <a href="telemetry.core.web_contents.html#WebCon

-<td width="100%">__all__ = ['Browser', 'BrowserOptions', 'PageMeasurement', 'RunPage', 'Tab']</td></tr></table>

+<td width="100%">__all__ = ['Browser', 'BrowserFinderOptions', 'PageMeasurement', 'RunPage', 'Tab']</td></tr></table>

</body></html>

« no previous file with comments | « no previous file | tools/telemetry/docs/telemetry.core.html » ('j') | no next file with comments »