1 2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 3 <html><head><title>Python: module telemetry.internal.testing.page_sets.example_domain</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>.<a href="telemetry.internal.html"><font color="#ffffff">internal</font></a>.<a href="telemetry.internal.testing.html"><font color="#ffffff">testing</font></a>.<a href="telemetry.internal.testing.page_sets.html"><font color="#ffffff">page_sets</font></a>.example_domain</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/internal/testing/page_sets/example_domain.py">telemetry/internal/testing/page_sets/example_domain.py</a></font></td></tr></table> 13 <p><tt># Copyright 2014 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="telemetry.page.page.html">telemetry.page.page</a><br> 24 </td><td width="25%" valign=top><a href="telemetry.story.html">telemetry.story</a><br> 25 </td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p> 26 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 27 <tr bgcolor="#ee77aa"> 28 <td colspan=3 valign=bottom> <br> 29 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> 30 31 <tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> 32 <td width="100%"><dl> 33 <dt><font face="helvetica, arial"><a href="telemetry.story.story_set.html#StorySet">telemetry.story.story_set.StorySet</a>(<a href="__builtin__.html#object">__builtin__.object</a>) 34 </font></dt><dd> 35 <dl> 36 <dt><font face="helvetica, arial"><a href="telemetry.internal.testing.page_sets.example_domain.html#ExampleDomainPageSet">ExampleDomainPageSet</a> 37 </font></dt></dl> 38 </dd> 39 </dl> 40 <p> 41 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 42 <tr bgcolor="#ffc8d8"> 43 <td colspan=3 valign=bottom> <br> 44 <font color="#000000" face="helvetica, arial"><a name="ExampleDomainPageSet">class <strong>ExampleDomainPageSet</strong></a>(<a href="telemetry.story.story_set.html#StorySet">telemetry.story.story_set.StorySet</a>)</font></td></tr> 45 46 <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> 47 <td width="100%"><dl><dt>Method resolution order:</dt> 48 <dd><a href="telemetry.internal.testing.page_sets.example_domain.html#ExampleDomainPageSet">ExampleDomainPageSet</a></dd> 49 <dd><a href="telemetry.story.story_set.html#StorySet">telemetry.story.story_set.StorySet</a></dd> 50 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> 51 </dl> 52 <hr> 53 Methods defined here:<br> 54 <dl><dt><a name="ExampleDomainPageSet-__init__"><strong>__init__</strong></a>(self)</dt></dl> 55 56 <hr> 57 Methods inherited from <a href="telemetry.story.story_set.html#StorySet">telemetry.story.story_set.StorySet</a>:<br> 58 <dl><dt><a name="ExampleDomainPageSet-AddStory"><strong>AddStory</strong></a>(self, story)</dt></dl> 59 60 <dl><dt><a name="ExampleDomainPageSet-RemoveStory"><strong>RemoveStory</strong></a>(self, story)</dt><dd><tt>Removes a Story.<br> 61 <br> 62 Allows the stories to be filtered.</tt></dd></dl> 63 64 <dl><dt><a name="ExampleDomainPageSet-WprFilePathForStory"><strong>WprFilePathForStory</strong></a>(self, story)</dt><dd><tt>Convenient function to retrieve WPR archive file path.<br> 65 <br> 66 Args:<br> 67 story: The Story to look up.<br> 68 <br> 69 Returns:<br> 70 The WPR archive file path for the given Story, if found.<br> 71 Otherwise, None.</tt></dd></dl> 72 73 <dl><dt><a name="ExampleDomainPageSet-__getitem__"><strong>__getitem__</strong></a>(self, key)</dt></dl> 74 75 <dl><dt><a name="ExampleDomainPageSet-__iter__"><strong>__iter__</strong></a>(self)</dt></dl> 76 77 <dl><dt><a name="ExampleDomainPageSet-__len__"><strong>__len__</strong></a>(self)</dt></dl> 78 79 <dl><dt><a name="ExampleDomainPageSet-__setitem__"><strong>__setitem__</strong></a>(self, key, value)</dt></dl> 80 81 <hr> 82 Class methods inherited from <a href="telemetry.story.story_set.html#StorySet">telemetry.story.story_set.StorySet</a>:<br> 83 <dl><dt><a name="ExampleDomainPageSet-Description"><strong>Description</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Return a string explaining in human-understandable terms what this<br> 84 story represents.<br> 85 Note that this should be a classmethod so the benchmark_runner script can<br> 86 display stories' names along with their descriptions in the list command.</tt></dd></dl> 87 88 <dl><dt><a name="ExampleDomainPageSet-Name"><strong>Name</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Returns the string name of this <a href="telemetry.story.story_set.html#StorySet">StorySet</a>.<br> 89 Note that this should be a classmethod so the benchmark_runner script can<br> 90 match the story class with its name specified in the run command:<br> 91 'Run <User story test name> <User story class name>'</tt></dd></dl> 92 93 <hr> 94 Data descriptors inherited from <a href="telemetry.story.story_set.html#StorySet">telemetry.story.story_set.StorySet</a>:<br> 95 <dl><dt><strong>__dict__</strong></dt> 96 <dd><tt>dictionary for instance variables (if defined)</tt></dd> 97 </dl> 98 <dl><dt><strong>__weakref__</strong></dt> 99 <dd><tt>list of weak references to the object (if defined)</tt></dd> 100 </dl> 101 <dl><dt><strong>allow_mixed_story_states</strong></dt> 102 <dd><tt>True iff Stories are allowed to have different StoryState classes.<br> 103 <br> 104 There are no checks in place for determining if SharedStates are<br> 105 being assigned correctly to all Stories in a given StorySet. The<br> 106 majority of test cases should not need the ability to have multiple<br> 107 SharedStates, which usually implies you should be writing multiple<br> 108 benchmarks instead. We provide errors to avoid accidentally assigning<br> 109 or defaulting to the wrong SharedState.<br> 110 Override at your own risk. Here be dragons.</tt></dd> 111 </dl> 112 <dl><dt><strong>archive_data_file</strong></dt> 113 </dl> 114 <dl><dt><strong>base_dir</strong></dt> 115 <dd><tt>The base directory to resolve archive_data_file.<br> 116 <br> 117 This defaults to the directory containing the StorySet instance's class.</tt></dd> 118 </dl> 119 <dl><dt><strong>bucket</strong></dt> 120 </dl> 121 <dl><dt><strong>file_path</strong></dt> 122 </dl> 123 <dl><dt><strong>serving_dirs</strong></dt> 124 </dl> 125 <dl><dt><strong>wpr_archive_info</strong></dt> 126 <dd><tt>Lazily constructs wpr_archive_info if it's not set and returns it.</tt></dd> 127 </dl> 128 </td></tr></table></td></tr></table> 129 </body></html>
