Home | History | Annotate | Download | only in docs
      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>&nbsp;<br>
      9 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="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="../telemetry/page/record_wpr.py">telemetry/page/record_wpr.py</a></font></td></tr></table>
     12     <p><tt>#&nbsp;Copyright&nbsp;(c)&nbsp;2012&nbsp;The&nbsp;Chromium&nbsp;Authors.&nbsp;All&nbsp;rights&nbsp;reserved.<br>
     13 #&nbsp;Use&nbsp;of&nbsp;this&nbsp;source&nbsp;code&nbsp;is&nbsp;governed&nbsp;by&nbsp;a&nbsp;BSD-style&nbsp;license&nbsp;that&nbsp;can&nbsp;be<br>
     14 #&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;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>&nbsp;<br>
     19 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
     20     
     21 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
     22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.core.browser_options.html">telemetry.core.browser_options</a><br>
     23 <a href="telemetry.core.discover.html">telemetry.core.discover</a><br>
     24 <a href="logging.html">logging</a><br>
     25 <a href="os.html">os</a><br>
     26 </td><td width="25%" valign=top><a href="telemetry.page.page_measurement.html">telemetry.page.page_measurement</a><br>
     27 <a href="telemetry.page.page_runner.html">telemetry.page.page_runner</a><br>
     28 <a href="telemetry.page.page_set.html">telemetry.page.page_set</a><br>
     29 <a href="telemetry.page.page_test.html">telemetry.page.page_test</a><br>
     30 </td><td width="25%" valign=top><a href="sys.html">sys</a><br>
     31 <a href="tempfile.html">tempfile</a><br>
     32 <a href="telemetry.test.html">telemetry.test</a><br>
     33 <a href="time.html">time</a><br>
     34 </td><td width="25%" valign=top><a href="telemetry.core.wpr_modes.html">telemetry.core.wpr_modes</a><br>
     35 </td></tr></table></td></tr></table><p>
     36 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
     37 <tr bgcolor="#ee77aa">
     38 <td colspan=3 valign=bottom>&nbsp;<br>
     39 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
     40     
     41 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
     42 <td width="100%"><dl>
     43 <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>)
     44 </font></dt><dd>
     45 <dl>
     46 <dt><font face="helvetica, arial"><a href="telemetry.page.record_wpr.html#RecordPage">RecordPage</a>
     47 </font></dt></dl>
     48 </dd>
     49 </dl>
     50  <p>
     51 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
     52 <tr bgcolor="#ffc8d8">
     53 <td colspan=3 valign=bottom>&nbsp;<br>
     54 <font color="#000000" face="helvetica, arial"><a name="RecordPage">class <strong>RecordPage</strong></a>(<a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>)</font></td></tr>
     55     
     56 <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
     57 <td width="100%"><dl><dt>Method resolution order:</dt>
     58 <dd><a href="telemetry.page.record_wpr.html#RecordPage">RecordPage</a></dd>
     59 <dd><a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a></dd>
     60 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
     61 </dl>
     62 <hr>
     63 Methods defined here:<br>
     64 <dl><dt><a name="RecordPage-CanRunForPage"><strong>CanRunForPage</strong></a>(self, page)</dt></dl>
     65 
     66 <dl><dt><a name="RecordPage-CustomizeBrowserOptionsForPage"><strong>CustomizeBrowserOptionsForPage</strong></a>(self, page, options)</dt></dl>
     67 
     68 <dl><dt><a name="RecordPage-Run"><strong>Run</strong></a>(self, options, page, tab, results)</dt></dl>
     69 
     70 <dl><dt><a name="RecordPage-__init__"><strong>__init__</strong></a>(self, measurements)</dt></dl>
     71 
     72 <hr>
     73 Methods inherited from <a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>:<br>
     74 <dl><dt><a name="RecordPage-AddCommandLineOptions"><strong>AddCommandLineOptions</strong></a>(self, parser)</dt><dd><tt>Override&nbsp;to&nbsp;expose&nbsp;command-line&nbsp;options&nbsp;for&nbsp;this&nbsp;test.<br>
     75 &nbsp;<br>
     76 The&nbsp;provided&nbsp;parser&nbsp;is&nbsp;an&nbsp;optparse.OptionParser&nbsp;instance&nbsp;and&nbsp;accepts&nbsp;all<br>
     77 normal&nbsp;results.&nbsp;The&nbsp;parsed&nbsp;options&nbsp;are&nbsp;available&nbsp;in&nbsp;Run&nbsp;as<br>
     78 self.<strong>options</strong>.</tt></dd></dl>
     79 
     80 <dl><dt><a name="RecordPage-AddOutputOptions"><strong>AddOutputOptions</strong></a>(self, parser)</dt></dl>
     81 
     82 <dl><dt><a name="RecordPage-CreatePageSet"><strong>CreatePageSet</strong></a>(self, args, options)</dt><dd><tt>Override&nbsp;to&nbsp;make&nbsp;this&nbsp;test&nbsp;generate&nbsp;its&nbsp;own&nbsp;page&nbsp;set&nbsp;instead&nbsp;of<br>
     83 allowing&nbsp;arbitrary&nbsp;page&nbsp;sets&nbsp;entered&nbsp;from&nbsp;the&nbsp;command-line.</tt></dd></dl>
     84 
     85 <dl><dt><a name="RecordPage-CustomizeBrowserOptions"><strong>CustomizeBrowserOptions</strong></a>(self, options)</dt><dd><tt>Override&nbsp;to&nbsp;add&nbsp;test-specific&nbsp;options&nbsp;to&nbsp;the&nbsp;BrowserOptions&nbsp;object</tt></dd></dl>
     86 
     87 <dl><dt><a name="RecordPage-DidNavigateToPage"><strong>DidNavigateToPage</strong></a>(self, page, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;right&nbsp;after&nbsp;the&nbsp;page&nbsp;is&nbsp;navigated,&nbsp;but&nbsp;before<br>
     88 any&nbsp;waiting&nbsp;for&nbsp;completion&nbsp;has&nbsp;occurred.</tt></dd></dl>
     89 
     90 <dl><dt><a name="RecordPage-DidRunAction"><strong>DidRunAction</strong></a>(self, page, tab, action)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;after&nbsp;running&nbsp;the&nbsp;action&nbsp;on&nbsp;the&nbsp;page.</tt></dd></dl>
     91 
     92 <dl><dt><a name="RecordPage-DidRunPageSet"><strong>DidRunPageSet</strong></a>(self, tab, results)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;after&nbsp;page&nbsp;set&nbsp;is&nbsp;completed,&nbsp;but&nbsp;before&nbsp;browser<br>
     93 is&nbsp;torn&nbsp;down.</tt></dd></dl>
     94 
     95 <dl><dt><a name="RecordPage-DidStartHTTPServer"><strong>DidStartHTTPServer</strong></a>(self, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;after&nbsp;the&nbsp;HTTP&nbsp;server&nbsp;is&nbsp;started.</tt></dd></dl>
     96 
     97 <dl><dt><a name="RecordPage-NeedsBrowserRestartAfterEachRun"><strong>NeedsBrowserRestartAfterEachRun</strong></a>(self, tab)</dt><dd><tt>Override&nbsp;to&nbsp;specify&nbsp;browser&nbsp;restart&nbsp;after&nbsp;each&nbsp;run.</tt></dd></dl>
     98 
     99 <dl><dt><a name="RecordPage-PrepareResults"><strong>PrepareResults</strong></a>(self, options)</dt></dl>
    100 
    101 <dl><dt><a name="RecordPage-SetUpBrowser"><strong>SetUpBrowser</strong></a>(self, browser)</dt><dd><tt>Override&nbsp;to&nbsp;customize&nbsp;the&nbsp;browser&nbsp;right&nbsp;after&nbsp;it&nbsp;has&nbsp;launched.</tt></dd></dl>
    102 
    103 <dl><dt><a name="RecordPage-WillNavigateToPage"><strong>WillNavigateToPage</strong></a>(self, page, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;before&nbsp;the&nbsp;page&nbsp;is&nbsp;navigated.</tt></dd></dl>
    104 
    105 <dl><dt><a name="RecordPage-WillRunAction"><strong>WillRunAction</strong></a>(self, page, tab, action)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;before&nbsp;running&nbsp;the&nbsp;action&nbsp;on&nbsp;the&nbsp;page.</tt></dd></dl>
    106 
    107 <dl><dt><a name="RecordPage-WillRunPageSet"><strong>WillRunPageSet</strong></a>(self, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;operations&nbsp;before&nbsp;the&nbsp;page&nbsp;set&nbsp;is&nbsp;navigated.</tt></dd></dl>
    108 
    109 <hr>
    110 Data descriptors inherited from <a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>:<br>
    111 <dl><dt><strong>__dict__</strong></dt>
    112 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
    113 </dl>
    114 <dl><dt><strong>__weakref__</strong></dt>
    115 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
    116 </dl>
    117 <dl><dt><strong>action_name_to_run</strong></dt>
    118 </dl>
    119 <dl><dt><strong>clear_cache_before_each_run</strong></dt>
    120 <dd><tt>When&nbsp;set&nbsp;to&nbsp;True,&nbsp;the&nbsp;browser's&nbsp;disk&nbsp;and&nbsp;memory&nbsp;cache&nbsp;will&nbsp;be&nbsp;cleared<br>
    121 before&nbsp;each&nbsp;run.</tt></dd>
    122 </dl>
    123 <dl><dt><strong>discard_first_result</strong></dt>
    124 <dd><tt>When&nbsp;set&nbsp;to&nbsp;True,&nbsp;the&nbsp;first&nbsp;run&nbsp;of&nbsp;the&nbsp;test&nbsp;is&nbsp;discarded.&nbsp;&nbsp;This&nbsp;is<br>
    125 useful&nbsp;for&nbsp;cases&nbsp;where&nbsp;it's&nbsp;desirable&nbsp;to&nbsp;have&nbsp;some&nbsp;test&nbsp;resource&nbsp;cached&nbsp;so<br>
    126 the&nbsp;first&nbsp;run&nbsp;of&nbsp;the&nbsp;test&nbsp;can&nbsp;warm&nbsp;things&nbsp;up.</tt></dd>
    127 </dl>
    128 <dl><dt><strong>output_format_choices</strong></dt>
    129 <dd><tt>Allowed&nbsp;output&nbsp;formats.&nbsp;The&nbsp;default&nbsp;is&nbsp;the&nbsp;first&nbsp;item&nbsp;in&nbsp;the&nbsp;list.</tt></dd>
    130 </dl>
    131 </td></tr></table></td></tr></table><p>
    132 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    133 <tr bgcolor="#eeaa77">
    134 <td colspan=3 valign=bottom>&nbsp;<br>
    135 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
    136     
    137 <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    138 <td width="100%"><dl><dt><a name="-Main"><strong>Main</strong></a>(base_dir)</dt></dl>
    139 </td></tr></table>
    140 </body></html>