| <?xml version="1.0" encoding="ascii"?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| "DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <title>proton.Url</title> |
| <link rel="stylesheet" href="epydoc.css" type="text/css" /> |
| <script type="text/javascript" src="epydoc.js"></script> |
| </head> |
| |
| <body bgcolor="white" text="black" link="blue" vlink="#204080" |
| alink="#204080"> |
| <!-- ==================== NAVIGATION BAR ==================== --> |
| <table class="navbar" border="0" width="100%" cellpadding="0" |
| bgcolor="#a0c0ff" cellspacing="0"> |
| <tr valign="middle"> |
| <!-- Home link --> |
| <th> <a |
| href="proton-module.html">Home</a> </th> |
| |
| <!-- Tree link --> |
| <th> <a |
| href="module-tree.html">Trees</a> </th> |
| |
| <!-- Index link --> |
| <th> <a |
| href="identifier-index.html">Indices</a> </th> |
| |
| <!-- Help link --> |
| <th> <a |
| href="help.html">Help</a> </th> |
| |
| <!-- Project homepage --> |
| <th class="navbar" align="right" width="100%"> |
| <table border="0" cellpadding="0" cellspacing="0"> |
| <tr><th class="navbar" align="center" |
| ><a class="navbar" target="_top" href="http://qpid.apache.org/index.html">Qpid Proton Python API</a></th> |
| </tr></table></th> |
| </tr> |
| </table> |
| <table width="100%" cellpadding="0" cellspacing="0"> |
| <tr valign="top"> |
| <td width="100%"> |
| <span class="breadcrumbs"> |
| <a href="proton-module.html">Package proton</a> :: |
| Class Url |
| </span> |
| </td> |
| <td> |
| <table cellpadding="0" cellspacing="0"> |
| <!-- hide/show private --> |
| <tr><td align="right"><span class="options" |
| >[<a href="frames.html" target="_top">frames</a |
| >] | <a href="proton.Url-class.html" |
| target="_top">no frames</a>]</span></td></tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== CLASS DESCRIPTION ==================== --> |
| <h1 class="epydoc">Class Url</h1><p class="nomargin-top"><span class="codelink"><a href="proton-pysrc.html#Url">source code</a></span></p> |
| <center> |
| |
| </center> |
| <hr /> |
| <p>Simple URL parser/constructor, handles URLs of the form:</p> |
| |
| <p><scheme>://<user>:<password>@<host>:<port>/<path></p> |
| <p>All components can be None if not specified in the URL string.</p> |
| <p>The port can be specified as a service name, e.g. 'amqp' in the URL |
| string but Url.port always gives the integer value.</p> |
| <p>Warning: The placement of user and password in URLs is not |
| recommended. It can result in credentials leaking out in program logs. |
| Use connection configuration attributes instead.</p> |
| |
| <!-- ==================== NESTED CLASSES ==================== --> |
| <a name="section-NestedClasses"></a> |
| <table class="summary" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr bgcolor="#70b0f0" class="table-header"> |
| <td align="left" colspan="2" class="table-header"> |
| <span class="table-header">Nested Classes</span></td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton.Url.Port-class.html" class="summary-name">Port</a><br /> |
| An integer port number that can be constructed from a service name |
| string |
| </td> |
| </tr> |
| <tr> |
| <td class="summary" colspan="2"> |
| <a href="proton.Url.PartDescriptor-class.html" class="summary-name">PartDescriptor</a> |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== INSTANCE METHODS ==================== --> |
| <a name="section-InstanceMethods"></a> |
| <table class="summary" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr bgcolor="#70b0f0" class="table-header"> |
| <td align="left" colspan="2" class="table-header"> |
| <span class="table-header">Instance Methods</span></td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a href="proton.Url-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">url</span>=<span class="summary-sig-default">None</span>, |
| <span class="summary-sig-arg">defaults</span>=<span class="summary-sig-default">True</span>, |
| <span class="summary-sig-arg">**kwargs</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Url.__init__">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a href="proton.Url-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Url.__str__">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a href="proton.Url-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Url.__repr__">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a name="__eq__"></a><span class="summary-sig-name">__eq__</span>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">x</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Url.__eq__">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a name="__ne__"></a><span class="summary-sig-name">__ne__</span>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">x</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Url.__ne__">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a name="__del__"></a><span class="summary-sig-name">__del__</span>(<span class="summary-sig-arg">self</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Url.__del__">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a href="proton.Url-class.html#defaults" class="summary-sig-name">defaults</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
| Fill in missing values (scheme, host or port) with defaults</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton-pysrc.html#Url.defaults">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== CLASS VARIABLES ==================== --> |
| <a name="section-ClassVariables"></a> |
| <table class="summary" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr bgcolor="#70b0f0" class="table-header"> |
| <td align="left" colspan="2" class="table-header"> |
| <span class="table-header">Class Variables</span></td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a name="AMQPS"></a><span class="summary-name">AMQPS</span> = <code title=""amqps"">"amqps"</code> |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a name="AMQP"></a><span class="summary-name">AMQP</span> = <code title=""amqp"">"amqp"</code> |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a name="username"></a><span class="summary-name">username</span> = <code title="PartDescriptor('username')">PartDescriptor('username')</code> |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a name="path"></a><span class="summary-name">path</span> = <code title="PartDescriptor('path')">PartDescriptor('path')</code> |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== INSTANCE VARIABLES ==================== --> |
| <a name="section-InstanceVariables"></a> |
| <table class="summary" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr bgcolor="#70b0f0" class="table-header"> |
| <td align="left" colspan="2" class="table-header"> |
| <span class="table-header">Instance Variables</span></td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="proton.Url-class.html#scheme" class="summary-name">scheme</a> = <code title="PartDescriptor('scheme')">PartDescriptor('scheme')</code><br /> |
| Url scheme e.g. |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a name="password"></a><span class="summary-name">password</span> = <code title="PartDescriptor('password')">PartDescriptor('password')</code><br /> |
| Password |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a name="host"></a><span class="summary-name">host</span> = <code title="PartDescriptor('host')">PartDescriptor('host')</code><br /> |
| Host name, ipv6 literal or ipv4 dotted quad. |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a name="port"></a><span class="summary-name">port</span> = <code title="property(_get_port, _set_port)">property(_get_port, _set_port)</code><br /> |
| Integer port. |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a name="host_port"></a><span class="summary-name">host_port</span><br /> |
| Returns host:port |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a name="user"></a><span class="summary-name">user</span><br /> |
| Username |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== METHOD DETAILS ==================== --> |
| <a name="section-MethodDetails"></a> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr bgcolor="#70b0f0" class="table-header"> |
| <td align="left" colspan="2" class="table-header"> |
| <span class="table-header">Method Details</span></td> |
| </tr> |
| </table> |
| <a name="__init__"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr valign="top"><td> |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, |
| <span class="sig-arg">url</span>=<span class="sig-default">None</span>, |
| <span class="sig-arg">defaults</span>=<span class="sig-default">True</span>, |
| <span class="sig-arg">**kwargs</span>)</span> |
| <br /><em class="fname">(Constructor)</em> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="proton-pysrc.html#Url.__init__">source code</a></span> |
| </td> |
| </tr></table> |
| |
| |
| <dl class="fields"> |
| <dt>Parameters:</dt> |
| <dd><ul class="nomargin-top"> |
| <li><strong class="pname"><code>url</code></strong> - URL string to parse.</li> |
| <li><strong class="pname"><code>defaults</code></strong> - If true, fill in missing default values in the URL. If false, you |
| can fill them in later by calling self.defaults()</li> |
| <li><strong class="pname"><code>kwargs</code></strong> - scheme, user, password, host, port, path. If specified, replaces |
| corresponding part in url string.</li> |
| </ul></dd> |
| <dt>Overrides: |
| object.__init__ |
| </dt> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="__str__"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr valign="top"><td> |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span> |
| <br /><em class="fname">(Informal representation operator)</em> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="proton-pysrc.html#Url.__str__">source code</a></span> |
| </td> |
| </tr></table> |
| |
| |
| <dl class="fields"> |
| <dt>Overrides: |
| object.__str__ |
| <dd><em class="note">(inherited documentation)</em></dd> |
| </dt> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="__repr__"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr valign="top"><td> |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span> |
| <br /><em class="fname">(Representation operator)</em> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="proton-pysrc.html#Url.__repr__">source code</a></span> |
| </td> |
| </tr></table> |
| |
| |
| <dl class="fields"> |
| <dt>Overrides: |
| object.__repr__ |
| <dd><em class="note">(inherited documentation)</em></dd> |
| </dt> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="defaults"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr valign="top"><td> |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">defaults</span>(<span class="sig-arg">self</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="proton-pysrc.html#Url.defaults">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <p>Fill in missing values (scheme, host or port) with defaults</p> |
| <dl class="fields"> |
| <dt>Returns:</dt> |
| <dd>self</dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <br /> |
| <!-- ==================== INSTANCE VARIABLE DETAILS ==================== --> |
| <a name="section-InstanceVariableDetails"></a> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr bgcolor="#70b0f0" class="table-header"> |
| <td align="left" colspan="2" class="table-header"> |
| <span class="table-header">Instance Variable Details</span></td> |
| </tr> |
| </table> |
| <a name="scheme"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">scheme</h3> |
| Url scheme e.g. 'amqp' or 'amqps' |
| <dl class="fields"> |
| </dl> |
| <dl class="fields"> |
| <dt>Value:</dt> |
| <dd><table><tr><td><pre class="variable"> |
| PartDescriptor('scheme') |
| </pre></td></tr></table> |
| </dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <br /> |
| <!-- ==================== NAVIGATION BAR ==================== --> |
| <table class="navbar" border="0" width="100%" cellpadding="0" |
| bgcolor="#a0c0ff" cellspacing="0"> |
| <tr valign="middle"> |
| <!-- Home link --> |
| <th> <a |
| href="proton-module.html">Home</a> </th> |
| |
| <!-- Tree link --> |
| <th> <a |
| href="module-tree.html">Trees</a> </th> |
| |
| <!-- Index link --> |
| <th> <a |
| href="identifier-index.html">Indices</a> </th> |
| |
| <!-- Help link --> |
| <th> <a |
| href="help.html">Help</a> </th> |
| |
| <!-- Project homepage --> |
| <th class="navbar" align="right" width="100%"> |
| <table border="0" cellpadding="0" cellspacing="0"> |
| <tr><th class="navbar" align="center" |
| ><a class="navbar" target="_top" href="http://qpid.apache.org/index.html">Qpid Proton Python API</a></th> |
| </tr></table></th> |
| </tr> |
| </table> |
| <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
| <tr> |
| <td align="left" class="footer"> |
| Generated by Epydoc 3.0.1 |
| </td> |
| <td align="right" class="footer"> |
| <a target="mainFrame" href="http://epydoc.sourceforge.net" |
| >http://epydoc.sourceforge.net</a> |
| </td> |
| </tr> |
| </table> |
| |
| <script type="text/javascript"> |
| <!-- |
| // Private objects are initially displayed (because if |
| // javascript is turned off then we want them to be |
| // visible); but by default, we want to hide them. So hide |
| // them unless we have a cookie that says to show them. |
| checkCookie(); |
| // --> |
| </script> |
| </body> |
| </html> |