1 2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 3<html><head><title>Python: package telemetry.page</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>.page</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/page/__init__.py">telemetry/page/__init__.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>Package Contents</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="telemetry.page.action_runner.html">action_runner</a><br> 24<a href="telemetry.page.page.html">page</a><br> 25</td><td width="25%" valign=top><a href="telemetry.page.page_run_end_to_end_unittest.html">page_run_end_to_end_unittest</a><br> 26<a href="telemetry.page.page_test.html">page_test</a><br> 27</td><td width="25%" valign=top><a href="telemetry.page.page_test_unittest.html">page_test_unittest</a><br> 28<a href="telemetry.page.page_unittest.html">page_unittest</a><br> 29</td><td width="25%" valign=top><a href="telemetry.page.shared_page_state.html">shared_page_state</a><br> 30<a href="telemetry.page.shared_page_state_unittest.html">shared_page_state_unittest</a><br> 31</td></tr></table></td></tr></table><p> 32<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 33<tr bgcolor="#ee77aa"> 34<td colspan=3 valign=bottom> <br> 35<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> 36 37<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> 38<td width="100%"><dl> 39<dt><font face="helvetica, arial"><a href="telemetry.story.story.html#Story">telemetry.story.story.Story</a>(<a href="__builtin__.html#object">__builtin__.object</a>) 40</font></dt><dd> 41<dl> 42<dt><font face="helvetica, arial"><a href="telemetry.page.html#Page">Page</a> 43</font></dt></dl> 44</dd> 45</dl> 46 <p> 47<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 48<tr bgcolor="#ffc8d8"> 49<td colspan=3 valign=bottom> <br> 50<font color="#000000" face="helvetica, arial"><a name="Page">class <strong>Page</strong></a>(<a href="telemetry.story.story.html#Story">telemetry.story.story.Story</a>)</font></td></tr> 51 52<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> 53<td width="100%"><dl><dt>Method resolution order:</dt> 54<dd><a href="telemetry.page.html#Page">Page</a></dd> 55<dd><a href="telemetry.story.story.html#Story">telemetry.story.story.Story</a></dd> 56<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> 57</dl> 58<hr> 59Methods defined here:<br> 60<dl><dt><a name="Page-AddCustomizeBrowserOptions"><strong>AddCustomizeBrowserOptions</strong></a>(self, options)</dt><dd><tt>Inherit page overrides this to add customized browser options.</tt></dd></dl> 61 62<dl><dt><a name="Page-AsDict"><strong>AsDict</strong></a>(self)</dt><dd><tt>Converts a page object to a dict suitable for JSON output.</tt></dd></dl> 63 64<dl><dt><a name="Page-GetSyntheticDelayCategories"><strong>GetSyntheticDelayCategories</strong></a>(self)</dt></dl> 65 66<dl><dt><a name="Page-Run"><strong>Run</strong></a>(self, shared_state)</dt></dl> 67 68<dl><dt><a name="Page-RunNavigateSteps"><strong>RunNavigateSteps</strong></a>(self, action_runner)</dt></dl> 69 70<dl><dt><a name="Page-RunPageInteractions"><strong>RunPageInteractions</strong></a>(self, action_runner)</dt><dd><tt>Override this to define custom interactions with the page.<br> 71e.g:<br> 72 def <a href="#Page-RunPageInteractions">RunPageInteractions</a>(self, action_runner):<br> 73 action_runner.ScrollPage()<br> 74 action_runner.TapElement(text='Next')</tt></dd></dl> 75 76<dl><dt><a name="Page-__cmp__"><strong>__cmp__</strong></a>(self, other)</dt></dl> 77 78<dl><dt><a name="Page-__init__"><strong>__init__</strong></a>(self, url, page_set<font color="#909090">=None</font>, base_dir<font color="#909090">=None</font>, name<font color="#909090">=''</font>, credentials_path<font color="#909090">=None</font>, credentials_bucket<font color="#909090">='chromium-telemetry'</font>, labels<font color="#909090">=None</font>, startup_url<font color="#909090">=''</font>, make_javascript_deterministic<font color="#909090">=True</font>, shared_page_state_class<font color="#909090">=<class 'telemetry.page.shared_page_state.SharedPageState'></font>)</dt></dl> 79 80<dl><dt><a name="Page-__lt__"><strong>__lt__</strong></a>(self, other)</dt></dl> 81 82<dl><dt><a name="Page-__str__"><strong>__str__</strong></a>(self)</dt></dl> 83 84<hr> 85Data descriptors defined here:<br> 86<dl><dt><strong>base_dir</strong></dt> 87</dl> 88<dl><dt><strong>credentials_path</strong></dt> 89</dl> 90<dl><dt><strong>display_name</strong></dt> 91</dl> 92<dl><dt><strong>file_path</strong></dt> 93<dd><tt>Returns the path of the file, stripping the scheme and query string.</tt></dd> 94</dl> 95<dl><dt><strong>file_path_url</strong></dt> 96<dd><tt>Returns the file path, including the params, query, and fragment.</tt></dd> 97</dl> 98<dl><dt><strong>file_path_url_with_scheme</strong></dt> 99</dl> 100<dl><dt><strong>is_file</strong></dt> 101<dd><tt>Returns True iff this URL points to a file.</tt></dd> 102</dl> 103<dl><dt><strong>page_set</strong></dt> 104</dl> 105<dl><dt><strong>serving_dir</strong></dt> 106</dl> 107<dl><dt><strong>startup_url</strong></dt> 108</dl> 109<dl><dt><strong>story_set</strong></dt> 110</dl> 111<dl><dt><strong>url</strong></dt> 112</dl> 113<hr> 114Data descriptors inherited from <a href="telemetry.story.story.html#Story">telemetry.story.story.Story</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>file_safe_name</strong></dt> 122<dd><tt>A version of display_name that's safe to use as a filename.<br> 123 <br> 124The default implementation sanitizes special characters with underscores,<br> 125but it's okay to override it with a more specific implementation in<br> 126subclasses.</tt></dd> 127</dl> 128<dl><dt><strong>id</strong></dt> 129</dl> 130<dl><dt><strong>is_local</strong></dt> 131<dd><tt>Returns True iff this story does not require network.</tt></dd> 132</dl> 133<dl><dt><strong>labels</strong></dt> 134</dl> 135<dl><dt><strong>make_javascript_deterministic</strong></dt> 136</dl> 137<dl><dt><strong>name</strong></dt> 138</dl> 139<dl><dt><strong>shared_state_class</strong></dt> 140</dl> 141</td></tr></table></td></tr></table> 142</body></html>