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

Unified Diff: tools/telemetry/docs/telemetry.page.page_measurement.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

« no previous file with comments | « tools/telemetry/docs/telemetry.page.page_filter.html ('k') | tools/telemetry/docs/telemetry.page.page_measurement_results.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: tools/telemetry/docs/telemetry.page.page_measurement.html

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

index 8ca291a85bfd9316e5d744e30ac7fcfe96ff93ea..2260808e78aa62965e48dd885e047c31a141964e 100644

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

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

@@ -19,14 +19,8 @@

<big>Modules</big></td></tr>

-<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.page.block_page_measurement_results.html">telemetry.page.block_page_measurement_results</a>

-<a href="telemetry.page.buildbot_page_measurement_results.html">telemetry.page.buildbot_page_measurement_results</a>

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

-<a href="os.html">os</a>

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

-<a href="telemetry.page.page_test.html">telemetry.page.page_test</a>

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

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

+<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.page.page_test.html">telemetry.page.page_test</a>

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

@@ -40,7 +34,7 @@

<dt><a href="telemetry.page.page_measurement.html#MeasurementFailure">MeasurementFailure</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">PageMeasurement</a>

@@ -133,7 +127,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):

@@ -144,12 +138,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

@@ -170,14 +163,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

@@ -188,61 +177,135 @@ 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 BrowserOptions object</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-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, but before

-any waiting for completion has occurred.</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-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-Run">Run</a>(self, page, tab, results)</dt></dl>

-<dl><dt><a name="PageMeasurement-Run">Run</a>(self, options, page, tab, results)</dt></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-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-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.</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></td></tr></table>

</body></html>