1 2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 3 <html><head><title>Python: module telemetry.web_perf.story_test</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.web_perf.html"><font color="#ffffff">web_perf</font></a>.story_test</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/web_perf/story_test.py">telemetry/web_perf/story_test.py</a></font></td></tr></table> 13 <p><tt># Copyright 2015 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="#ee77aa"> 19 <td colspan=3 valign=bottom> <br> 20 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> 21 22 <tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> 23 <td width="100%"><dl> 24 <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> 25 </font></dt><dd> 26 <dl> 27 <dt><font face="helvetica, arial"><a href="telemetry.web_perf.story_test.html#StoryTest">StoryTest</a> 28 </font></dt></dl> 29 </dd> 30 <dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>) 31 </font></dt><dd> 32 <dl> 33 <dt><font face="helvetica, arial"><a href="telemetry.web_perf.story_test.html#Failure">Failure</a> 34 </font></dt></dl> 35 </dd> 36 </dl> 37 <p> 38 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 39 <tr bgcolor="#ffc8d8"> 40 <td colspan=3 valign=bottom> <br> 41 <font color="#000000" face="helvetica, arial"><a name="Failure">class <strong>Failure</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> 42 43 <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> 44 <td colspan=2><tt><a href="#StoryTest">StoryTest</a> <a href="exceptions.html#Exception">Exception</a> raised when an undesired but designed-for problem.<br> </tt></td></tr> 45 <tr><td> </td> 46 <td width="100%"><dl><dt>Method resolution order:</dt> 47 <dd><a href="telemetry.web_perf.story_test.html#Failure">Failure</a></dd> 48 <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> 49 <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> 50 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> 51 </dl> 52 <hr> 53 Data descriptors defined here:<br> 54 <dl><dt><strong>__weakref__</strong></dt> 55 <dd><tt>list of weak references to the object (if defined)</tt></dd> 56 </dl> 57 <hr> 58 Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> 59 <dl><dt><a name="Failure-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> 60 61 <hr> 62 Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> 63 <dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#Failure-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> 64 65 <hr> 66 Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> 67 <dl><dt><a name="Failure-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> 68 69 <dl><dt><a name="Failure-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> 70 71 <dl><dt><a name="Failure-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> 72 73 <dl><dt><a name="Failure-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> 74 <br> 75 Use of negative indices is not supported.</tt></dd></dl> 76 77 <dl><dt><a name="Failure-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> 78 79 <dl><dt><a name="Failure-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> 80 81 <dl><dt><a name="Failure-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> 82 83 <dl><dt><a name="Failure-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> 84 85 <dl><dt><a name="Failure-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Failure-__str__">__str__</a>() <==> str(x)</tt></dd></dl> 86 87 <dl><dt><a name="Failure-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> 88 89 <hr> 90 Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> 91 <dl><dt><strong>__dict__</strong></dt> 92 </dl> 93 <dl><dt><strong>args</strong></dt> 94 </dl> 95 <dl><dt><strong>message</strong></dt> 96 </dl> 97 </td></tr></table> <p> 98 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 99 <tr bgcolor="#ffc8d8"> 100 <td colspan=3 valign=bottom> <br> 101 <font color="#000000" face="helvetica, arial"><a name="StoryTest">class <strong>StoryTest</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> 102 103 <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> 104 <td colspan=2><tt>A class for creating story tests.<br> 105 <br> 106 The overall test run control flow follows this order:<br> 107 test.WillRunStory<br> 108 state.WillRunStory<br> 109 state.RunStory<br> 110 test.Measure<br> 111 state.DidRunStory<br> 112 test.DidRunStory<br> </tt></td></tr> 113 <tr><td> </td> 114 <td width="100%">Methods defined here:<br> 115 <dl><dt><a name="StoryTest-DidRunStory"><strong>DidRunStory</strong></a>(self, platform)</dt><dd><tt>Override to do any action after running the story, e.g., clean up.<br> 116 <br> 117 This is run after state.DidRunStory. And this is always called even if the<br> 118 test run failed.<br> 119 Args:<br> 120 platform: The platform that the story will run on.</tt></dd></dl> 121 122 <dl><dt><a name="StoryTest-Measure"><strong>Measure</strong></a>(self, platform, results)</dt><dd><tt>Override to take the measurement.<br> 123 <br> 124 This is run only if state.RunStory is successful.<br> 125 Args:<br> 126 platform: The platform that the story will run on.<br> 127 results: The results of running the story.</tt></dd></dl> 128 129 <dl><dt><a name="StoryTest-WillRunStory"><strong>WillRunStory</strong></a>(self, platform)</dt><dd><tt>Override to do any action before running the story.<br> 130 <br> 131 This is run before state.WillRunStory.<br> 132 Args:<br> 133 platform: The platform that the story will run on.</tt></dd></dl> 134 135 <hr> 136 Data descriptors defined here:<br> 137 <dl><dt><strong>__dict__</strong></dt> 138 <dd><tt>dictionary for instance variables (if defined)</tt></dd> 139 </dl> 140 <dl><dt><strong>__weakref__</strong></dt> 141 <dd><tt>list of weak references to the object (if defined)</tt></dd> 142 </dl> 143 </td></tr></table></td></tr></table> 144 </body></html>
