tools/telemetry/docs/telemetry.core.util.html - Issue 196383034: Update telemetry docs by running the update_docs script.

Side by Side Diff: tools/telemetry/docs/telemetry.core.util.html

Issue 196383034: Update telemetry docs by running the update_docs script. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 6 years, 9 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch | Annotate | Revision Log

« no previous file with comments | « tools/telemetry/docs/telemetry.core.timeline.trace_event_importer.html ('k') | tools/telemetry/docs/telemetry.core.web_contents.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

OLD	NEW
1	1

2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">	2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

3 <html><head><title>Python: module telemetry.core.util</title>	3 <html><head><title>Python: module telemetry.core.util</title>

4 </head><body bgcolor="#f0f0f8">	4 </head><body bgcolor="#f0f0f8">

5	5

6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">	6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">

7 <tr bgcolor="#7799ee">	7 <tr bgcolor="#7799ee">

8 <td valign=bottom> <br>	8 <td valign=bottom> <br>

9 <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a hre f="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry .core.html"><font color="#ffffff">core</font></a>.util</strong></big></big></fon t></td	9 <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a hre f="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry .core.html"><font color="#ffffff">core</font></a>.util</strong></big></big></fon t></td

10 ><td align=right valign=bottom	10 ><td align=right valign=bottom

11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href= "../telemetry/core/util.py">telemetry/core/util.py</a></font></td></tr></table>	11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href= "../telemetry/core/util.py">telemetry/core/util.py</a></font></td></tr></table>

12 <p><tt># Copyright (c) 2012 The Chromium Autho rs. All rights reserved.<br>	12 <p><tt># Copyright (c) 2012 The Chromium Autho rs. All rights reserved.<br>

13 # Use of this source code is governed by  a BSD-style license that can be<br>	13 # Use of this source code is governed by  a BSD-style license that can be<br>

14 # found in the LICENSE file.</tt></p>	14 # found in the LICENSE file.</tt></p>

15 <p>	15 <p>

16 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">	16 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

17 <tr bgcolor="#aa55cc">	17 <tr bgcolor="#aa55cc">

18 <td colspan=3 valign=bottom> <br>	18 <td colspan=3 valign=bottom> <br>

19 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big ></font></td></tr>	19 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big ></font></td></tr>

20	20

21 <tr><td bgcolor="#aa55cc"><tt>      </tt></td><td>  </td>	21 <tr><td bgcolor="#aa55cc"><tt>      </tt></td><td>  </td>

22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t op><a href="inspect.html">inspect</a><br>	22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t op><a href="inspect.html">inspect</a><br>

	23 <a href="logging.html">logging</a><br>

23 </td><td width="25%" valign=top><a href="os.html">os</a><br>	24 </td><td width="25%" valign=top><a href="os.html">os</a><br>

24 </td><td width="25%" valign=top><a href="socket.html">socket</a><br>	25 <a href="socket.html">socket</a><br>

25 </td><td width="25%" valign=top><a href="time.html">time</a><br>	26 </td><td width="25%" valign=top><a href="sys.html">sys</a><br>

26 </td></tr></table></td></tr></table><p>	27 <a href="time.html">time</a><br>

	28 </td><td width="25%" valign=top></td></tr></table></td></tr></table><p>

27 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">	29 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

28 <tr bgcolor="#ee77aa">	30 <tr bgcolor="#ee77aa">

29 <td colspan=3 valign=bottom> <br>	31 <td colspan=3 valign=bottom> <br>

30 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big ></font></td></tr>	32 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big ></font></td></tr>

31	33

32 <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td>  </td>	34 <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td>  </td>

33 <td width="100%"><dl>	35 <td width="100%"><dl>

34 <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__. object</a>

35 </font></dt><dd>

36 <dl>

37 <dt><font face="helvetica, arial"><a href="telemetry.core.util.html#PortPair">Po rtPair</a>

38 </font></dt></dl>

39 </dd>

40 <dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions .Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException< /a>)	36 <dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions .Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException< /a>)

41 </font></dt><dd>	37 </font></dt><dd>

42 <dl>	38 <dl>

43 <dt><font face="helvetica, arial"><a href="telemetry.core.util.html#TimeoutExcep tion">TimeoutException</a>	39 <dt><font face="helvetica, arial"><a href="telemetry.core.util.html#TimeoutExcep tion">TimeoutException</a>

44 </font></dt></dl>	40 </font></dt></dl>

45 </dd>	41 </dd>

46 </dl>	42 </dl>

47 <p>	43 <p>

48 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">	44 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

49 <tr bgcolor="#ffc8d8">	45 <tr bgcolor="#ffc8d8">

50 <td colspan=3 valign=bottom> <br>	46 <td colspan=3 valign=bottom> <br>

51 <font color="#000000" face="helvetica, arial"><a name="PortPair">class <strong>P ortPair</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</ font></td></tr>

52

53 <tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>

54 <td width="100%">Methods defined here:<br>

55 <dl><dt><a name="PortPair-__init__"><strong>__init__</strong></a>(self, local_po rt, remote_port)</dt></dl>

56

57 <hr>

58 Data descriptors defined here:<br>

59 <dl><dt><strong>__dict__</strong></dt>

60 <dd><tt>dictionary for instance variables (if defined)< /tt></dd>

61 </dl>

62 <dl><dt><strong>__weakref__</strong></dt>

63 <dd><tt>list of weak references to the object&nbsp ;(if defined)</tt></dd>

64 </dl>

65 </td></tr></table> <p>

66 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

67 <tr bgcolor="#ffc8d8">

68 <td colspan=3 valign=bottom> <br>

69 <font color="#000000" face="helvetica, arial"><a name="TimeoutException">class < strong>TimeoutException</strong></a>(<a href="exceptions.html#Exception">excepti ons.Exception</a>)</font></td></tr>	47 <font color="#000000" face="helvetica, arial"><a name="TimeoutException">class < strong>TimeoutException</strong></a>(<a href="exceptions.html#Exception">excepti ons.Exception</a>)</font></td></tr>

70	48

71 <tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>	49 <tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>

72 <td width="100%"><dl><dt>Method resolution order:</dt>	50 <td width="100%"><dl><dt>Method resolution order:</dt>

73 <dd><a href="telemetry.core.util.html#TimeoutException">TimeoutException</a></dd >	51 <dd><a href="telemetry.core.util.html#TimeoutException">TimeoutException</a></dd >

74 <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>	52 <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

75 <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>	53 <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

76 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>	54 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

77 </dl>	55 </dl>

78 <hr>	56 <hr>

79 Data descriptors defined here:<br>	57 Data descriptors defined here:<br>

80 <dl><dt><strong>__weakref__</strong></dt>	58 <dl><dt><strong>__weakref__</strong></dt>

81 <dd><tt>list of weak references to the object&nbsp ;(if defined)</tt></dd>	59 <dd><tt>list of weak references to the object&nbsp ;(if defined)</tt></dd>

82 </dl>	60 </dl>

83 <hr>	61 <hr>

84 Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception< /a>:<br>	62 Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception< /a>:<br>

85 <dl><dt><a name="TimeoutException-__init__"><strong>__init__</strong></a>(...)</ dt><dd><tt>x.<a href="#TimeoutException-__init__">__init__</a>(...) initial izes x; see help(type(x)) for signature</tt></dd></dl>	63 <dl><dt><a name="TimeoutException-__init__"><strong>__init__</strong></a>(...)</ dt><dd><tt>x.<a href="#TimeoutException-__init__">__init__</a>(...) initial izes x; see help(type(x)) for signature</tt></dd></dl>

86	64

87 <hr>	65 <hr>

88 Data and other attributes inherited from <a href="exceptions.html#Exception">exc eptions.Exception</a>:<br>	66 Data and other attributes inherited from <a href="exceptions.html#Exception">exc eptions.Exception</a>:<br>

89 <dl><dt><strong>__new__</strong> = <built-in method __new__ of type object&gt ;<dd><tt>T.<a href="#TimeoutException-__new__">__new__</a>(S, ...) -&g t; a new <a href="__builtin__.html#object">object</a> with&n bsp;type S, a subtype of T</tt></dl>	67 <dl><dt><strong>__new__</strong> = <built-in method __new__ of type object&gt ;<dd><tt>T.<a href="#TimeoutException-__new__">__new__</a>(S, ...) -&g t; a new object with type S, a subtype&n bsp;of T</tt></dl>

90	68

91 <hr>	69 <hr>

92 Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseEx ception</a>:<br>	70 Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseEx ception</a>:<br>

93 <dl><dt><a name="TimeoutException-__delattr__"><strong>__delattr__</strong></a>( ...)</dt><dd><tt>x.<a href="#TimeoutException-__delattr__">__delattr__</a>('name ') <==> del x.name</tt></dd></dl>	71 <dl><dt><a name="TimeoutException-__delattr__"><strong>__delattr__</strong></a>( ...)</dt><dd><tt>x.<a href="#TimeoutException-__delattr__">__delattr__</a>('name ') <==> del x.name</tt></dd></dl>

94	72

95 <dl><dt><a name="TimeoutException-__getattribute__"><strong>__getattribute__</st rong></a>(...)</dt><dd><tt>x.<a href="#TimeoutException-__getattribute__">__geta ttribute__</a>('name') <==> x.name</tt></dd></dl>	73 <dl><dt><a name="TimeoutException-__getattribute__"><strong>__getattribute__</st rong></a>(...)</dt><dd><tt>x.<a href="#TimeoutException-__getattribute__">__geta ttribute__</a>('name') <==> x.name</tt></dd></dl>

96	74

97 <dl><dt><a name="TimeoutException-__getitem__"><strong>__getitem__</strong></a>( ...)</dt><dd><tt>x.<a href="#TimeoutException-__getitem__">__getitem__</a>(y)&nb sp;<==> x[y]</tt></dd></dl>	75 <dl><dt><a name="TimeoutException-__getitem__"><strong>__getitem__</strong></a>( ...)</dt><dd><tt>x.<a href="#TimeoutException-__getitem__">__getitem__</a>(y)&nb sp;<==> x[y]</tt></dd></dl>

98	76

99 <dl><dt><a name="TimeoutException-__getslice__"><strong>__getslice__</strong></a >(...)</dt><dd><tt>x.<a href="#TimeoutException-__getslice__">__getslice__</a>(i , j) <==> x[i:j]<br>	77 <dl><dt><a name="TimeoutException-__getslice__"><strong>__getslice__</strong></a >(...)</dt><dd><tt>x.<a href="#TimeoutException-__getslice__">__getslice__</a>(i , j) <==> x[i:j]<br>

(...skipping 20 matching lines...) Expand all Loading...
120 </dl>	98 </dl>

121 <dl><dt><strong>message</strong></dt>	99 <dl><dt><strong>message</strong></dt>

122 </dl>	100 </dl>

123 </td></tr></table></td></tr></table><p>	101 </td></tr></table></td></tr></table><p>

124 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">	102 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

125 <tr bgcolor="#eeaa77">	103 <tr bgcolor="#eeaa77">

126 <td colspan=3 valign=bottom> <br>	104 <td colspan=3 valign=bottom> <br>

127 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></b ig></font></td></tr>	105 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></b ig></font></td></tr>

128	106

129 <tr><td bgcolor="#eeaa77"><tt>      </tt></td><td>  </td>	107 <tr><td bgcolor="#eeaa77"><tt>      </tt></td><td>  </td>

130 <td width="100%"><dl><dt><a name="-CloseConnections"><strong>CloseConnections</s trong></a>(tab)</dt><dd><tt>Closes all TCP sockets held&nbsp ;open by the browser.</tt></dd></dl>	108 <td width="100%"><dl><dt><a name="-AddDirToPythonPath"><strong>AddDirToPythonPat h</strong></a>(*path_parts)</dt></dl>

	109 <dl><dt><a name="-CloseConnections"><strong>CloseConnections</strong></a>(tab)< /dt><dd><tt>Closes all TCP sockets held open by&nb sp;the browser.</tt></dd></dl>

131 <dl><dt><a name="-FindElementAndPerformAction"><strong>FindElementAndPerformAct ion</strong></a>(tab, text, callback_code)</dt><dd><tt>JavaScript snippet&n bsp;for finding an element with a given text& nbsp;on a page.</tt></dd></dl>	110 <dl><dt><a name="-FindElementAndPerformAction"><strong>FindElementAndPerformAct ion</strong></a>(tab, text, callback_code)</dt><dd><tt>JavaScript snippet&n bsp;for finding an element with a given text& nbsp;on a page.</tt></dd></dl>

132 <dl><dt><a name="-GetAvailableLocalPort"><strong>GetAvailableLocalPort</strong> </a>()</dt></dl>	111 <dl><dt><a name="-FindSupportBinary"><strong>FindSupportBinary</strong></a>(bin ary_name, executable<font color="#909090">=True</font>)</dt><dd><tt>Returns&nbsp ;the path to the given binary name.</tt></dd></dl>

	112 <dl><dt><a name="-GetBaseDir"><strong>GetBaseDir</strong></a>()</dt></dl>

	113 <dl><dt><a name="-GetBuildDirectories"><strong>GetBuildDirectories</strong></a> ()</dt><dd><tt>Yields all combination of Chromium build  output directories.</tt></dd></dl>

133 <dl><dt><a name="-GetChromiumSrcDir"><strong>GetChromiumSrcDir</strong></a>()</ dt></dl>	114 <dl><dt><a name="-GetChromiumSrcDir"><strong>GetChromiumSrcDir</strong></a>()</ dt></dl>

134 <dl><dt><a name="-GetTelemetryDir"><strong>GetTelemetryDir</strong></a>()</dt>< /dl>	115 <dl><dt><a name="-GetTelemetryDir"><strong>GetTelemetryDir</strong></a>()</dt>< /dl>

135 <dl><dt><a name="-GetUnittestDataDir"><strong>GetUnittestDataDir</strong></a>() </dt></dl>	116 <dl><dt><a name="-GetUnittestDataDir"><strong>GetUnittestDataDir</strong></a>() </dt></dl>

136 <dl><dt><a name="-WaitFor"><strong>WaitFor</strong></a>(condition, timeout, pol l_interval<font color="#909090">=0.1</font>, pass_time_left_to_func<font color=" #909090">=False</font>)</dt></dl>	117 <dl><dt><a name="-GetUnreservedAvailableLocalPort"><strong>GetUnreservedAvailab leLocalPort</strong></a>()</dt><dd><tt>Returns an available port& nbsp;on the system.<br>

	118  <br>

	119 WARNING: This method does not reserve the por t it returns, so it may be used<br>

	120 by something else before you get to use  it. This can lead to flake.</tt></dd></dl>

	121 <dl><dt><a name="-WaitFor"><strong>WaitFor</strong></a>(condition, timeout)</dt ><dd><tt>Waits for up to \|timeout\| secs for t he function \|condition\| to return True.<br>

	122  <br>

	123 Polling frequency is (elapsed_time / 10), with&nbs p;a min of .1s and max of 5s.<br>

	124  <br>

	125 Returns:<br>

	126   Result of \|condition\| function (if present) .</tt></dd></dl>

137 </td></tr></table>	127 </td></tr></table>

138 </body></html>	128 </body></html>

OLD	NEW