1 2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 3<html><head><title>Python: module telemetry.record_wpr</title> 4<meta charset="utf-8"> 5</head><body bgcolor="#f0f0f8"> 6 7<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> 8<tr bgcolor="#7799ee"> 9<td valign=bottom> <br> 10<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.record_wpr</strong></big></big></font></td 11><td align=right valign=bottom 12><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/record_wpr.py">telemetry/record_wpr.py</a></font></td></tr></table> 13 <p><tt># Copyright 2012 The Chromium Authors. All rights reserved.<br> 14# Use of this source code is governed by a BSD-style license that can be<br> 15# found in the LICENSE file.</tt></p> 16<p> 17<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 18<tr bgcolor="#aa55cc"> 19<td colspan=3 valign=bottom> <br> 20<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> 21 22<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> 23<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="argparse.html">argparse</a><br> 24<a href="telemetry.benchmark.html">telemetry.benchmark</a><br> 25<a href="telemetry.internal.util.binary_manager.html">telemetry.internal.util.binary_manager</a><br> 26<a href="telemetry.internal.browser.browser_options.html">telemetry.internal.browser.browser_options</a><br> 27</td><td width="25%" valign=top><a href="telemetry.internal.util.command_line.html">telemetry.internal.util.command_line</a><br> 28<a href="telemetry.core.discover.html">telemetry.core.discover</a><br> 29<a href="logging.html">logging</a><br> 30<a href="telemetry.page.page_test.html">telemetry.page.page_test</a><br> 31</td><td width="25%" valign=top><a href="telemetry.internal.results.results_options.html">telemetry.internal.results.results_options</a><br> 32<a href="telemetry.story.html">telemetry.story</a><br> 33<a href="telemetry.internal.story_runner.html">telemetry.internal.story_runner</a><br> 34<a href="sys.html">sys</a><br> 35</td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.core.util</a><br> 36<a href="telemetry.util.wpr_modes.html">telemetry.util.wpr_modes</a><br> 37</td></tr></table></td></tr></table><p> 38<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 39<tr bgcolor="#ee77aa"> 40<td colspan=3 valign=bottom> <br> 41<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> 42 43<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> 44<td width="100%"><dl> 45<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> 46</font></dt><dd> 47<dl> 48<dt><font face="helvetica, arial"><a href="telemetry.record_wpr.html#WprRecorder">WprRecorder</a> 49</font></dt></dl> 50</dd> 51<dt><font face="helvetica, arial"><a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>(<a href="__builtin__.html#object">__builtin__.object</a>) 52</font></dt><dd> 53<dl> 54<dt><font face="helvetica, arial"><a href="telemetry.record_wpr.html#RecorderPageTest">RecorderPageTest</a> 55</font></dt></dl> 56</dd> 57</dl> 58 <p> 59<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 60<tr bgcolor="#ffc8d8"> 61<td colspan=3 valign=bottom> <br> 62<font color="#000000" face="helvetica, arial"><a name="RecorderPageTest">class <strong>RecorderPageTest</strong></a>(<a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>)</font></td></tr> 63 64<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> 65<td width="100%"><dl><dt>Method resolution order:</dt> 66<dd><a href="telemetry.record_wpr.html#RecorderPageTest">RecorderPageTest</a></dd> 67<dd><a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a></dd> 68<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> 69</dl> 70<hr> 71Methods defined here:<br> 72<dl><dt><a name="RecorderPageTest-CleanUpAfterPage"><strong>CleanUpAfterPage</strong></a>(self, page, tab)</dt></dl> 73 74<dl><dt><a name="RecorderPageTest-CustomizeBrowserOptions"><strong>CustomizeBrowserOptions</strong></a>(self, options)</dt></dl> 75 76<dl><dt><a name="RecorderPageTest-DidNavigateToPage"><strong>DidNavigateToPage</strong></a>(self, page, tab)</dt></dl> 77 78<dl><dt><a name="RecorderPageTest-DidStartBrowser"><strong>DidStartBrowser</strong></a>(self, browser)</dt></dl> 79 80<dl><dt><a name="RecorderPageTest-RunNavigateSteps"><strong>RunNavigateSteps</strong></a>(self, page, tab)</dt></dl> 81 82<dl><dt><a name="RecorderPageTest-ValidateAndMeasurePage"><strong>ValidateAndMeasurePage</strong></a>(self, page, tab, results)</dt></dl> 83 84<dl><dt><a name="RecorderPageTest-WillNavigateToPage"><strong>WillNavigateToPage</strong></a>(self, page, tab)</dt><dd><tt>Override to ensure all resources are fetched from network.</tt></dd></dl> 85 86<dl><dt><a name="RecorderPageTest-WillStartBrowser"><strong>WillStartBrowser</strong></a>(self, browser)</dt></dl> 87 88<dl><dt><a name="RecorderPageTest-__init__"><strong>__init__</strong></a>(self)</dt></dl> 89 90<hr> 91Methods inherited from <a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>:<br> 92<dl><dt><a name="RecorderPageTest-DidRunPage"><strong>DidRunPage</strong></a>(self, platform)</dt><dd><tt>Called after the test run method was run, even if it failed.</tt></dd></dl> 93 94<dl><dt><a name="RecorderPageTest-RestartBrowserBeforeEachPage"><strong>RestartBrowserBeforeEachPage</strong></a>(self)</dt><dd><tt>Should the browser be restarted for the page?<br> 95 <br> 96This returns true if the test needs to unconditionally restart the<br> 97browser for each page. It may be called before the browser is started.</tt></dd></dl> 98 99<dl><dt><a name="RecorderPageTest-SetOptions"><strong>SetOptions</strong></a>(self, options)</dt><dd><tt>Sets the BrowserFinderOptions instance to use.</tt></dd></dl> 100 101<dl><dt><a name="RecorderPageTest-StopBrowserAfterPage"><strong>StopBrowserAfterPage</strong></a>(self, browser, page)</dt><dd><tt>Should the browser be stopped after the page is run?<br> 102 <br> 103This is called after a page is run to decide whether the browser needs to<br> 104be stopped to clean up its state. If it is stopped, then it will be<br> 105restarted to run the next page.<br> 106 <br> 107A test that overrides this can look at both the page and the browser to<br> 108decide whether it needs to stop the browser.</tt></dd></dl> 109 110<dl><dt><a name="RecorderPageTest-TabForPage"><strong>TabForPage</strong></a>(self, page, browser)</dt><dd><tt>Override to select a different tab for the page. For instance, to<br> 111create a new tab for every page, return browser.tabs.New().</tt></dd></dl> 112 113<hr> 114Data descriptors inherited from <a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>:<br> 115<dl><dt><strong>__dict__</strong></dt> 116<dd><tt>dictionary for instance variables (if defined)</tt></dd> 117</dl> 118<dl><dt><strong>__weakref__</strong></dt> 119<dd><tt>list of weak references to the object (if defined)</tt></dd> 120</dl> 121<dl><dt><strong>clear_cache_before_each_run</strong></dt> 122<dd><tt>When set to True, the browser's disk and memory cache will be cleared<br> 123before each run.</tt></dd> 124</dl> 125<dl><dt><strong>close_tabs_before_run</strong></dt> 126<dd><tt>When set to True, all tabs are closed before running the test for the<br> 127first time.</tt></dd> 128</dl> 129<dl><dt><strong>is_multi_tab_test</strong></dt> 130<dd><tt>Returns True if the test opens multiple tabs.<br> 131 <br> 132If the test overrides TabForPage, it is deemed a multi-tab test.<br> 133Multi-tab tests do not retry after tab or browser crashes, whereas,<br> 134single-tab tests too. That is because the state of multi-tab tests<br> 135(e.g., how many tabs are open, etc.) is unknown after crashes.</tt></dd> 136</dl> 137</td></tr></table> <p> 138<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 139<tr bgcolor="#ffc8d8"> 140<td colspan=3 valign=bottom> <br> 141<font color="#000000" face="helvetica, arial"><a name="WprRecorder">class <strong>WprRecorder</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> 142 143<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> 144<td width="100%">Methods defined here:<br> 145<dl><dt><a name="WprRecorder-CreateResults"><strong>CreateResults</strong></a>(self)</dt></dl> 146 147<dl><dt><a name="WprRecorder-HandleResults"><strong>HandleResults</strong></a>(self, results, upload_to_cloud_storage)</dt></dl> 148 149<dl><dt><a name="WprRecorder-Record"><strong>Record</strong></a>(self, results)</dt></dl> 150 151<dl><dt><a name="WprRecorder-__init__"><strong>__init__</strong></a>(self, base_dir, target, args<font color="#909090">=None</font>)</dt></dl> 152 153<hr> 154Data descriptors defined here:<br> 155<dl><dt><strong>__dict__</strong></dt> 156<dd><tt>dictionary for instance variables (if defined)</tt></dd> 157</dl> 158<dl><dt><strong>__weakref__</strong></dt> 159<dd><tt>list of weak references to the object (if defined)</tt></dd> 160</dl> 161<dl><dt><strong>options</strong></dt> 162</dl> 163</td></tr></table></td></tr></table><p> 164<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 165<tr bgcolor="#eeaa77"> 166<td colspan=3 valign=bottom> <br> 167<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> 168 169<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> 170<td width="100%"><dl><dt><a name="-Main"><strong>Main</strong></a>(base_dir)</dt><dd><tt># TODO(nednguyen): use benchmark.Environment instead of base_dir for discovering<br> 171# benchmark & story classes.</tt></dd></dl> 172</td></tr></table> 173</body></html>