tools/telemetry/docs/telemetry.page.page_test.html - Issue 17150002: [telemetry] Initial (autogenerated) documentation plus support scripts

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

Issue 17150002: [telemetry] Initial (autogenerated) documentation plus support scripts (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: update with nits Created 7 years, 6 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_set_archive_info.html ('k') | tools/telemetry/docs/telemetry.page.page_test_results.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

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

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

new file mode 100644

index 0000000000000000000000000000000000000000..5d78d3ec9cc87c5c34a36e440a38f55c09a9dcf6

--- /dev/null

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

@@ -0,0 +1,190 @@

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

+<html><head><title>Python: module telemetry.page.page_test</title>

+</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.page.html">page</a>.page_test</big></big></td

+><td align=right valign=bottom

+><a href=".">index</a> <a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_test.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_test.py</a></td></tr></table>

+ <tt># Copyright (c) 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.page.actions.all_page_actions.html">telemetry.page.actions.all_page_actions</a>

+<a href="telemetry.page.gtest_test_results.html">telemetry.page.gtest_test_results</a>

+</td><td width="25%" valign=top><a href="logging.html">logging</a>

+<a href="telemetry.page.actions.page_action.html">telemetry.page.actions.page_action</a>

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

+<a href="telemetry.core.util.html">telemetry.core.util</a>

+</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="__builtin__.html#object">__builtin__.object</a>

+</dt><dd>

+<dl>

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

+</dt></dl>

+</dd>

+<dt><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)

+</dt><dd>

+<dl>

+<dt><a href="telemetry.page.page_test.html#Failure">Failure</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="Failure">class Failure</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</td></tr>

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

+<td colspan=2><tt><a href="exceptions.html#Exception">Exception</a> that can be thrown from PageMeasurement to indicate an

+undesired but designed-for problem.  </tt></td></tr>

+<tr><td> </td>

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

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

+<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

+<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

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

+</dl>

+<hr>

+Data descriptors defined here:

+<dl><dt>__weakref__</dt>

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

+</dl>

+<hr>

+Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

+<dl><dt><a name="Failure-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#Failure-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>

+<hr>

+Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

+<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#Failure-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>

+<hr>

+Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

+<dl><dt><a name="Failure-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#Failure-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

+<dl><dt><a name="Failure-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#Failure-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

+<dl><dt><a name="Failure-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#Failure-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

+<dl><dt><a name="Failure-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#Failure-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

+

+Use of negative indices is not supported.</tt></dd></dl>

+<dl><dt><a name="Failure-__reduce__">__reduce__</a>(...)</dt></dl>

+<dl><dt><a name="Failure-__repr__">__repr__</a>(...)</dt><dd><tt>x.<a href="#Failure-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>

+<dl><dt><a name="Failure-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#Failure-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

+<dl><dt><a name="Failure-__setstate__">__setstate__</a>(...)</dt></dl>

+<dl><dt><a name="Failure-__str__">__str__</a>(...)</dt><dd><tt>x.<a href="#Failure-__str__">__str__</a>() <==> str(x)</tt></dd></dl>

+<dl><dt><a name="Failure-__unicode__">__unicode__</a>(...)</dt></dl>

+<hr>

+Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

+<dl><dt>__dict__</dt>

+</dl>

+<dl><dt>args</dt>

+</dl>

+<dl><dt>message</dt>

+</dl>

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

+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

+<tr bgcolor="#ffc8d8">

+<td colspan=3 valign=bottom>

+<a name="PageTest">class PageTest</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</td></tr>

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

+<td colspan=2><tt>A class styled on unittest.TestCase for creating page-specific tests.  </tt></td></tr>

+<tr><td> </td>

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

+<dl><dt><a name="PageTest-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="PageTest-AddOutputOptions">AddOutputOptions</a>(self, parser)</dt></dl>

+<dl><dt><a name="PageTest-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="PageTest-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="PageTest-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="PageTest-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="PageTest-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="PageTest-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="PageTest-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="PageTest-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="PageTest-NeedsBrowserRestartAfterEachRun">NeedsBrowserRestartAfterEachRun</a>(self, tab)</dt><dd><tt>Override to specify browser restart after each run.</tt></dd></dl>

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

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

+<dl><dt><a name="PageTest-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="PageTest-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="PageTest-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="PageTest-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="PageTest-__init__">__init__</a>(self, test_method_name, action_name_to_run='', needs_browser_restart_after_each_run=False, discard_first_result=False)</dt></dl>

+<hr>

+Data descriptors defined here:

+<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>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>output_format_choices</dt>

+<dd><tt>Allowed output formats. The default is the first item in the list.</tt></dd>

+</dl>

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

+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

+<tr bgcolor="#eeaa77">

+<td colspan=3 valign=bottom>

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

+<tr><td bgcolor="#eeaa77"><tt>      </tt></td><td> </td>

+<td width="100%"><dl><dt><a name="-GetCompoundActionFromPage">GetCompoundActionFromPage</a>(page, action_name)</dt></dl>

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

+</body></html>