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

Side by Side Diff: tools/telemetry/docs/telemetry.page.record_wpr.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 unified diff | Download patch | Annotate | Revision Log

OLD	NEW
(Empty)
	1

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

	3 <html><head><title>Python: module telemetry.page.record_wpr</title>

	4 </head><body bgcolor="#f0f0f8">

	5

	6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">

	7 <tr bgcolor="#7799ee">

	8 <td valign=bottom> <br>

	9 <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a hre f="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry .page.html"><font color="#ffffff">page</font></a>.record_wpr</strong></big></big ></font></td

	10 ><td align=right valign=bottom

	11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href= "file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/record_wpr.py ">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/record_wpr.py</a> </font></td></tr></table>

	12 <p><tt># Copyright (c) 2012 The Chromium Autho rs. All rights reserved.<br>

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

	14 # found in the LICENSE file.</tt></p>

	15 <p>

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

	17 <tr bgcolor="#aa55cc">

	18 <td colspan=3 valign=bottom> <br>

	19 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big ></font></td></tr>

	20

	21 <tr><td bgcolor="#aa55cc"><tt>      </tt></td><td>  </td>

	22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t op><a href="telemetry.core.browser_finder.html">telemetry.core.browser_finder</a ><br>

	23 <a href="telemetry.core.browser_options.html">telemetry.core.browser_options</a> <br>

	24 <a href="telemetry.core.discover.html">telemetry.core.discover</a><br>

	25 <a href="logging.html">logging</a><br>

	26 </td><td width="25%" valign=top><a href="os.html">os</a><br>

	27 <a href="telemetry.page.page_measurement.html">telemetry.page.page_measurement</ a><br>

	28 <a href="telemetry.page.page_runner.html">telemetry.page.page_runner</a><br>

	29 <a href="telemetry.page.page_set.html">telemetry.page.page_set</a><br>

	30 </td><td width="25%" valign=top><a href="telemetry.page.page_test.html">telemetr y.page.page_test</a><br>

	31 <a href="telemetry.page.page_test_results.html">telemetry.page.page_test_results </a><br>

	32 <a href="sys.html">sys</a><br>

	33 <a href="tempfile.html">tempfile</a><br>

	34 </td><td width="25%" valign=top><a href="time.html">time</a><br>

	35 <a href="telemetry.core.wpr_modes.html">telemetry.core.wpr_modes</a><br>

	36 </td></tr></table></td></tr></table><p>

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

	38 <tr bgcolor="#ee77aa">

	39 <td colspan=3 valign=bottom> <br>

	40 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big ></font></td></tr>

	41

	42 <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td>  </td>

	43 <td width="100%"><dl>

	44 <dt><font face="helvetica, arial"><a href="telemetry.page.page_test.html#PageTes t">telemetry.page.page_test.PageTest</a>(<a href="__builtin__.html#object">__bui ltin__.object</a>)

	45 </font></dt><dd>

	46 <dl>

	47 <dt><font face="helvetica, arial"><a href="telemetry.page.record_wpr.html#Record Page">RecordPage</a>

	48 </font></dt></dl>

	49 </dd>

	50 </dl>

	51 <p>

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

	53 <tr bgcolor="#ffc8d8">

	54 <td colspan=3 valign=bottom> <br>

	55 <font color="#000000" face="helvetica, arial"><a name="RecordPage">class <strong >RecordPage</strong></a>(<a href="telemetry.page.page_test.html#PageTest">teleme try.page.page_test.PageTest</a>)</font></td></tr>

	56

	57 <tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>

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

	59 <dd><a href="telemetry.page.record_wpr.html#RecordPage">RecordPage</a></dd>

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

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

	62 </dl>

	63 <hr>

	64 Methods defined here:<br>

	65 <dl><dt><a name="RecordPage-CanRunForPage"><strong>CanRunForPage</strong></a>(se lf, page)</dt></dl>

	66

	67 <dl><dt><a name="RecordPage-CustomizeBrowserOptionsForPage"><strong>CustomizeBro wserOptionsForPage</strong></a>(self, page, options)</dt></dl>

	68

	69 <dl><dt><a name="RecordPage-Run"><strong>Run</strong></a>(self, options, page, t ab, results)</dt></dl>

	70

	71 <dl><dt><a name="RecordPage-__init__"><strong>__init__</strong></a>(self, measur ements)</dt></dl>

	72

	73 <hr>

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

	75 <dl><dt><a name="RecordPage-AddCommandLineOptions"><strong>AddCommandLineOptions </strong></a>(self, parser)</dt><dd><tt>Override to expose comman d-line options for this test.<br>

	76  <br>

	77 The provided parser is an optparse.OptionParser in stance and accepts all<br>

	78 normal results. The parsed options are available&n bsp;in Run as<br>

	79 self.<strong>options</strong>.</tt></dd></dl>

	80

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

	82

	83 <dl><dt><a name="RecordPage-CreatePageSet"><strong>CreatePageSet</strong></a>(se lf, args, options)</dt><dd><tt>Override to make this test&nb sp;generate its own page set instead of<br>

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

	85

	86 <dl><dt><a name="RecordPage-CustomizeBrowserOptions"><strong>CustomizeBrowserOpt ions</strong></a>(self, options)</dt><dd><tt>Override to add test -specific options to the BrowserOptions object</tt></dd ></dl>

	87

	88 <dl><dt><a name="RecordPage-DidNavigateToPage"><strong>DidNavigateToPage</strong ></a>(self, page, tab)</dt><dd><tt>Override to do operations&nbsp ;right after the page is navigated, but befor e<br>

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

	90

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

	92

	93 <dl><dt><a name="RecordPage-DidRunPageSet"><strong>DidRunPageSet</strong></a>(se lf, tab, results)</dt><dd><tt>Override to do operations afte r page set is completed, but before browser<b r>

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

	95

	96 <dl><dt><a name="RecordPage-DidStartHTTPServer"><strong>DidStartHTTPServer</stro ng></a>(self, tab)</dt><dd><tt>Override to do operations aft er the HTTP server is started.</tt></dd></dl>

	97

	98 <dl><dt><a name="RecordPage-NeedsBrowserRestartAfterEachRun"><strong>NeedsBrowse rRestartAfterEachRun</strong></a>(self, tab)</dt><dd><tt>Override to s pecify browser restart after each run.</tt></dd></dl>

	99

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

	101

	102 <dl><dt><a name="RecordPage-SetUpBrowser"><strong>SetUpBrowser</strong></a>(self , browser)</dt><dd><tt>Override to customize the browser&nbs p;right after it has launched.</tt></dd></dl>

	103

	104 <dl><dt><a name="RecordPage-WillNavigateToPage"><strong>WillNavigateToPage</stro ng></a>(self, page, tab)</dt><dd><tt>Override to do operations&nb sp;before the page is navigated.</tt></dd></dl>

	105

	106 <dl><dt><a name="RecordPage-WillRunAction"><strong>WillRunAction</strong></a>(se lf, page, tab, action)</dt><dd><tt>Override to do operations&nbsp ;before running the action on the page.</tt></dd>< /dl>

	107

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

	109

	110 <hr>

	111 Data descriptors inherited from <a href="telemetry.page.page_test.html#PageTest" >telemetry.page.page_test.PageTest</a>:<br>

	112 <dl><dt><strong>__dict__</strong></dt>

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

	114 </dl>

	115 <dl><dt><strong>__weakref__</strong></dt>

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

	117 </dl>

	118 <dl><dt><strong>action_name_to_run</strong></dt>

	119 </dl>

	120 <dl><dt><strong>discard_first_result</strong></dt>

	121 <dd><tt>When set to True, the first run of&nb sp;the test is discarded.  This is<br>

	122 useful for cases where it's desirable to have  some test resource cached so<br>

	123 the first run of the test can warm thing s up.</tt></dd>

	124 </dl>

	125 <dl><dt><strong>output_format_choices</strong></dt>

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

	127 </dl>

	128 </td></tr></table></td></tr></table><p>

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

	130 <tr bgcolor="#eeaa77">

	131 <td colspan=3 valign=bottom> <br>

	132 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></b ig></font></td></tr>

	133

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

	135 <td width="100%"><dl><dt><a name="-Main"><strong>Main</strong></a>(measurement_d ir)</dt></dl>

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

	137 </body></html>

OLD	NEW

« no previous file with comments | « tools/telemetry/docs/telemetry.page.perf_tests_helper.html ('k') | tools/telemetry/docs/telemetry.unittest.html » ('j') | no next file with comments »