1 2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 3<html><head><title>Python: module telemetry.internal.backends.chrome_inspector.devtools_http</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.backends.html"><font color="#ffffff">backends</font></a>.<a href="telemetry.internal.backends.chrome_inspector.html"><font color="#ffffff">chrome_inspector</font></a>.devtools_http</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/backends/chrome_inspector/devtools_http.py">telemetry/internal/backends/chrome_inspector/devtools_http.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="errno.html">errno</a><br> 24<a href="telemetry.core.exceptions.html">telemetry.core.exceptions</a><br> 25</td><td width="25%" valign=top><a href="httplib.html">httplib</a><br> 26<a href="json.html">json</a><br> 27</td><td width="25%" valign=top><a href="socket.html">socket</a><br> 28<a href="sys.html">sys</a><br> 29</td><td width="25%" valign=top></td></tr></table></td></tr></table><p> 30<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 31<tr bgcolor="#ee77aa"> 32<td colspan=3 valign=bottom> <br> 33<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> 34 35<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> 36<td width="100%"><dl> 37<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> 38</font></dt><dd> 39<dl> 40<dt><font face="helvetica, arial"><a href="telemetry.internal.backends.chrome_inspector.devtools_http.html#DevToolsHttp">DevToolsHttp</a> 41</font></dt></dl> 42</dd> 43<dt><font face="helvetica, arial"><a href="telemetry.core.exceptions.html#Error">telemetry.core.exceptions.Error</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>) 44</font></dt><dd> 45<dl> 46<dt><font face="helvetica, arial"><a href="telemetry.internal.backends.chrome_inspector.devtools_http.html#DevToolsClientConnectionError">DevToolsClientConnectionError</a> 47</font></dt><dd> 48<dl> 49<dt><font face="helvetica, arial"><a href="telemetry.internal.backends.chrome_inspector.devtools_http.html#DevToolsClientUrlError">DevToolsClientUrlError</a> 50</font></dt></dl> 51</dd> 52</dl> 53</dd> 54</dl> 55 <p> 56<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 57<tr bgcolor="#ffc8d8"> 58<td colspan=3 valign=bottom> <br> 59<font color="#000000" face="helvetica, arial"><a name="DevToolsClientConnectionError">class <strong>DevToolsClientConnectionError</strong></a>(<a href="telemetry.core.exceptions.html#Error">telemetry.core.exceptions.Error</a>)</font></td></tr> 60 61<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> 62<td width="100%"><dl><dt>Method resolution order:</dt> 63<dd><a href="telemetry.internal.backends.chrome_inspector.devtools_http.html#DevToolsClientConnectionError">DevToolsClientConnectionError</a></dd> 64<dd><a href="telemetry.core.exceptions.html#Error">telemetry.core.exceptions.Error</a></dd> 65<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> 66<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> 67<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> 68</dl> 69<hr> 70Methods inherited from <a href="telemetry.core.exceptions.html#Error">telemetry.core.exceptions.Error</a>:<br> 71<dl><dt><a name="DevToolsClientConnectionError-AddDebuggingMessage"><strong>AddDebuggingMessage</strong></a>(self, msg)</dt><dd><tt>Adds a message to the description of the exception.<br> 72 <br> 73Many Telemetry exceptions arise from failures in another application. These<br> 74failures are difficult to pinpoint. This method allows Telemetry classes to<br> 75append useful debugging information to the exception. This method also logs<br> 76information about the location from where it was called.</tt></dd></dl> 77 78<dl><dt><a name="DevToolsClientConnectionError-__init__"><strong>__init__</strong></a>(self, msg<font color="#909090">=''</font>)</dt></dl> 79 80<dl><dt><a name="DevToolsClientConnectionError-__str__"><strong>__str__</strong></a>(self)</dt></dl> 81 82<hr> 83Data descriptors inherited from <a href="telemetry.core.exceptions.html#Error">telemetry.core.exceptions.Error</a>:<br> 84<dl><dt><strong>__weakref__</strong></dt> 85<dd><tt>list of weak references to the object (if defined)</tt></dd> 86</dl> 87<hr> 88Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> 89<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#DevToolsClientConnectionError-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> 90 91<hr> 92Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> 93<dl><dt><a name="DevToolsClientConnectionError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#DevToolsClientConnectionError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> 94 95<dl><dt><a name="DevToolsClientConnectionError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#DevToolsClientConnectionError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> 96 97<dl><dt><a name="DevToolsClientConnectionError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#DevToolsClientConnectionError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> 98 99<dl><dt><a name="DevToolsClientConnectionError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#DevToolsClientConnectionError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> 100 <br> 101Use of negative indices is not supported.</tt></dd></dl> 102 103<dl><dt><a name="DevToolsClientConnectionError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> 104 105<dl><dt><a name="DevToolsClientConnectionError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#DevToolsClientConnectionError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> 106 107<dl><dt><a name="DevToolsClientConnectionError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#DevToolsClientConnectionError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> 108 109<dl><dt><a name="DevToolsClientConnectionError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> 110 111<dl><dt><a name="DevToolsClientConnectionError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> 112 113<hr> 114Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> 115<dl><dt><strong>__dict__</strong></dt> 116</dl> 117<dl><dt><strong>args</strong></dt> 118</dl> 119<dl><dt><strong>message</strong></dt> 120</dl> 121</td></tr></table> <p> 122<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 123<tr bgcolor="#ffc8d8"> 124<td colspan=3 valign=bottom> <br> 125<font color="#000000" face="helvetica, arial"><a name="DevToolsClientUrlError">class <strong>DevToolsClientUrlError</strong></a>(<a href="telemetry.internal.backends.chrome_inspector.devtools_http.html#DevToolsClientConnectionError">DevToolsClientConnectionError</a>)</font></td></tr> 126 127<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> 128<td width="100%"><dl><dt>Method resolution order:</dt> 129<dd><a href="telemetry.internal.backends.chrome_inspector.devtools_http.html#DevToolsClientUrlError">DevToolsClientUrlError</a></dd> 130<dd><a href="telemetry.internal.backends.chrome_inspector.devtools_http.html#DevToolsClientConnectionError">DevToolsClientConnectionError</a></dd> 131<dd><a href="telemetry.core.exceptions.html#Error">telemetry.core.exceptions.Error</a></dd> 132<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> 133<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> 134<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> 135</dl> 136<hr> 137Methods inherited from <a href="telemetry.core.exceptions.html#Error">telemetry.core.exceptions.Error</a>:<br> 138<dl><dt><a name="DevToolsClientUrlError-AddDebuggingMessage"><strong>AddDebuggingMessage</strong></a>(self, msg)</dt><dd><tt>Adds a message to the description of the exception.<br> 139 <br> 140Many Telemetry exceptions arise from failures in another application. These<br> 141failures are difficult to pinpoint. This method allows Telemetry classes to<br> 142append useful debugging information to the exception. This method also logs<br> 143information about the location from where it was called.</tt></dd></dl> 144 145<dl><dt><a name="DevToolsClientUrlError-__init__"><strong>__init__</strong></a>(self, msg<font color="#909090">=''</font>)</dt></dl> 146 147<dl><dt><a name="DevToolsClientUrlError-__str__"><strong>__str__</strong></a>(self)</dt></dl> 148 149<hr> 150Data descriptors inherited from <a href="telemetry.core.exceptions.html#Error">telemetry.core.exceptions.Error</a>:<br> 151<dl><dt><strong>__weakref__</strong></dt> 152<dd><tt>list of weak references to the object (if defined)</tt></dd> 153</dl> 154<hr> 155Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> 156<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#DevToolsClientUrlError-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> 157 158<hr> 159Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> 160<dl><dt><a name="DevToolsClientUrlError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#DevToolsClientUrlError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> 161 162<dl><dt><a name="DevToolsClientUrlError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#DevToolsClientUrlError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> 163 164<dl><dt><a name="DevToolsClientUrlError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#DevToolsClientUrlError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> 165 166<dl><dt><a name="DevToolsClientUrlError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#DevToolsClientUrlError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> 167 <br> 168Use of negative indices is not supported.</tt></dd></dl> 169 170<dl><dt><a name="DevToolsClientUrlError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> 171 172<dl><dt><a name="DevToolsClientUrlError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#DevToolsClientUrlError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> 173 174<dl><dt><a name="DevToolsClientUrlError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#DevToolsClientUrlError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> 175 176<dl><dt><a name="DevToolsClientUrlError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> 177 178<dl><dt><a name="DevToolsClientUrlError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> 179 180<hr> 181Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> 182<dl><dt><strong>__dict__</strong></dt> 183</dl> 184<dl><dt><strong>args</strong></dt> 185</dl> 186<dl><dt><strong>message</strong></dt> 187</dl> 188</td></tr></table> <p> 189<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 190<tr bgcolor="#ffc8d8"> 191<td colspan=3 valign=bottom> <br> 192<font color="#000000" face="helvetica, arial"><a name="DevToolsHttp">class <strong>DevToolsHttp</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> 193 194<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> 195<td colspan=2><tt>A helper class to send and parse DevTools HTTP requests.<br> 196 <br> 197This class maintains a persistent http connection to Chrome devtools.<br> 198Ideally, owners of instances of this class should call <a href="#DevToolsHttp-Disconnect">Disconnect</a>() before<br> 199disposing of the instance. Otherwise, the connection will not be closed until<br> 200the instance is garbage collected.<br> </tt></td></tr> 201<tr><td> </td> 202<td width="100%">Methods defined here:<br> 203<dl><dt><a name="DevToolsHttp-Disconnect"><strong>Disconnect</strong></a>(self)</dt><dd><tt>Closes the HTTP connection.</tt></dd></dl> 204 205<dl><dt><a name="DevToolsHttp-Request"><strong>Request</strong></a>(self, path, timeout<font color="#909090">=30</font>)</dt><dd><tt>Sends a request to Chrome devtools.<br> 206 <br> 207This method lazily creates an HTTP connection, if one does not already<br> 208exist.<br> 209 <br> 210Args:<br> 211 path: The DevTools URL path, without the /json/ prefix.<br> 212 timeout: Timeout defaults to 30 seconds.<br> 213 <br> 214Raises:<br> 215 <a href="#DevToolsClientConnectionError">DevToolsClientConnectionError</a>: If the connection fails.</tt></dd></dl> 216 217<dl><dt><a name="DevToolsHttp-RequestJson"><strong>RequestJson</strong></a>(self, path, timeout<font color="#909090">=30</font>)</dt><dd><tt>Sends a request and parse the response as JSON.<br> 218 <br> 219Args:<br> 220 path: The DevTools URL path, without the /json/ prefix.<br> 221 timeout: Timeout defaults to 30 seconds.<br> 222 <br> 223Raises:<br> 224 <a href="#DevToolsClientConnectionError">DevToolsClientConnectionError</a>: If the connection fails.<br> 225 ValueError: If the response is not a valid JSON.</tt></dd></dl> 226 227<dl><dt><a name="DevToolsHttp-__del__"><strong>__del__</strong></a>(self)</dt></dl> 228 229<dl><dt><a name="DevToolsHttp-__init__"><strong>__init__</strong></a>(self, devtools_port)</dt></dl> 230 231<hr> 232Data descriptors defined here:<br> 233<dl><dt><strong>__dict__</strong></dt> 234<dd><tt>dictionary for instance variables (if defined)</tt></dd> 235</dl> 236<dl><dt><strong>__weakref__</strong></dt> 237<dd><tt>list of weak references to the object (if defined)</tt></dd> 238</dl> 239</td></tr></table></td></tr></table> 240</body></html>