| |
| <!DOCTYPE html> |
| |
| <html> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>proton._url — Qpid Proton Python API 0.32.0 documentation</title> |
| <link rel="stylesheet" href="../../_static/sphinxdoc.css" type="text/css" /> |
| <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> |
| <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> |
| <script src="../../_static/jquery.js"></script> |
| <script src="../../_static/underscore.js"></script> |
| <script src="../../_static/doctools.js"></script> |
| <script src="../../_static/language_data.js"></script> |
| <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script> |
| <link rel="index" title="Index" href="../../genindex.html" /> |
| <link rel="search" title="Search" href="../../search.html" /> |
| </head><body> |
| <div class="related" role="navigation" aria-label="related navigation"> |
| <h3>Navigation</h3> |
| <ul> |
| <li class="right" style="margin-right: 10px"> |
| <a href="../../genindex.html" title="General Index" |
| accesskey="I">index</a></li> |
| <li class="nav-item nav-item-0"><a href="../../index.html">Qpid Proton Python API 0.32.0 documentation</a> »</li> |
| <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li> |
| <li class="nav-item nav-item-this"><a href="">proton._url</a></li> |
| </ul> |
| </div> |
| |
| <div class="document"> |
| <div class="documentwrapper"> |
| <div class="bodywrapper"> |
| <div class="body" role="main"> |
| |
| <h1>Source code for proton._url</h1><div class="highlight"><pre> |
| <span></span><span class="c1">#</span> |
| <span class="c1"># Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="c1"># or more contributor license agreements. See the NOTICE file</span> |
| <span class="c1"># distributed with this work for additional information</span> |
| <span class="c1"># regarding copyright ownership. The ASF licenses this file</span> |
| <span class="c1"># to you under the Apache License, Version 2.0 (the</span> |
| <span class="c1"># "License"); you may not use this file except in compliance</span> |
| <span class="c1"># with the License. You may obtain a copy of the License at</span> |
| <span class="c1">#</span> |
| <span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="c1">#</span> |
| <span class="c1"># Unless required by applicable law or agreed to in writing,</span> |
| <span class="c1"># software distributed under the License is distributed on an</span> |
| <span class="c1"># "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span> |
| <span class="c1"># KIND, either express or implied. See the License for the</span> |
| <span class="c1"># specific language governing permissions and limitations</span> |
| <span class="c1"># under the License.</span> |
| <span class="c1">#</span> |
| |
| <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">absolute_import</span> |
| |
| <span class="kn">import</span> <span class="nn">socket</span> |
| |
| <span class="kn">from</span> <span class="nn">._compat</span> <span class="kn">import</span> <span class="n">urlparse</span><span class="p">,</span> <span class="n">urlunparse</span><span class="p">,</span> <span class="n">quote</span><span class="p">,</span> <span class="n">unquote</span> |
| |
| |
| <div class="viewcode-block" id="Url"><a class="viewcode-back" href="../../proton.html#proton.Url">[docs]</a><span class="k">class</span> <span class="nc">Url</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> **DEPRECATED** Simple URL parser/constructor.</span> |
| |
| <span class="sd"> .. deprecated:: 0.27</span> |
| <span class="sd"> Use a ``str`` containing the URL instead.</span> |
| |
| <span class="sd"> Handles URLs of the form:</span> |
| |
| <span class="sd"> ``<scheme>://<user>:<password>@<host>:<port>/<path>``</span> |
| |
| <span class="sd"> All components can be ``None`` if not specified in the URL string.</span> |
| |
| <span class="sd"> The port can be specified as a service name, e.g. 'amqp' in the</span> |
| <span class="sd"> URL string but :class:`Url.Port` always gives the integer value.</span> |
| |
| <span class="sd"> .. warning:: The placement of user and password in URLs is not</span> |
| <span class="sd"> recommended. It can result in credentials leaking out in program</span> |
| <span class="sd"> logs. Use connection configuration attributes instead.</span> |
| |
| <span class="sd"> :ivar scheme: Url scheme e.g. 'amqp' or 'amqps'</span> |
| <span class="sd"> :ivar username: Username</span> |
| <span class="sd"> :ivar ~.password: Password</span> |
| <span class="sd"> :ivar ~.host: Host name, ipv6 literal or ipv4 dotted quad.</span> |
| <span class="sd"> :ivar ~.port: Integer port.</span> |
| <span class="sd"> :ivar host_port: Returns host:port</span> |
| <span class="sd"> </span> |
| <span class="sd"> :param url: URL string to parse.</span> |
| <span class="sd"> :type url: ``str``</span> |
| <span class="sd"> :param defaults: If ``True``, fill in missing default values in the URL.</span> |
| <span class="sd"> If ``False``, you can fill them in later by calling self.defaults()</span> |
| <span class="sd"> :type defaults: ``bool``</span> |
| <span class="sd"> :param kwargs: scheme, user, password, host, port, path.</span> |
| <span class="sd"> If specified, replaces corresponding part in url string.</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">AMQPS</span> <span class="o">=</span> <span class="s2">"amqps"</span> |
| <span class="sd">"""URL scheme for the AMQP protocol secured with SSL."""</span> |
| |
| <span class="n">AMQP</span> <span class="o">=</span> <span class="s2">"amqp"</span> |
| <span class="sd">"""URL scheme for the AMQP protocol."""</span> |
| |
| |
| <div class="viewcode-block" id="Url.Port"><a class="viewcode-back" href="../../proton.html#proton.Url.Port">[docs]</a> <span class="k">class</span> <span class="nc">Port</span><span class="p">(</span><span class="nb">int</span><span class="p">):</span> |
| <span class="sd">"""An integer port number that can be constructed from a service name string"""</span> |
| |
| <span class="k">def</span> <span class="fm">__new__</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> :param value: integer port number or string service name.</span> |
| <span class="sd"> """</span> |
| <span class="n">port</span> <span class="o">=</span> <span class="nb">super</span><span class="p">(</span><span class="n">Url</span><span class="o">.</span><span class="n">Port</span><span class="p">,</span> <span class="bp">cls</span><span class="p">)</span><span class="o">.</span><span class="fm">__new__</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_port_int</span><span class="p">(</span><span class="n">value</span><span class="p">))</span> |
| <span class="nb">setattr</span><span class="p">(</span><span class="n">port</span><span class="p">,</span> <span class="s1">'name'</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">))</span> |
| <span class="k">return</span> <span class="n">port</span> |
| |
| <span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> |
| <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="n">x</span> <span class="ow">or</span> <span class="nb">int</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="n">x</span> |
| |
| <span class="k">def</span> <span class="fm">__ne__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> |
| <span class="k">return</span> <span class="ow">not</span> <span class="bp">self</span> <span class="o">==</span> <span class="n">x</span> |
| |
| <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span> |
| |
| <span class="nd">@staticmethod</span> |
| <span class="k">def</span> <span class="nf">_port_int</span><span class="p">(</span><span class="n">value</span><span class="p">):</span> |
| <span class="sd">"""Convert service, an integer or a service name, into an integer port number."""</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">socket</span><span class="o">.</span><span class="n">getservbyname</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| <span class="k">except</span> <span class="n">socket</span><span class="o">.</span><span class="n">error</span><span class="p">:</span> |
| <span class="c1"># Not every system has amqp/amqps defined as a service</span> |
| <span class="k">if</span> <span class="n">value</span> <span class="o">==</span> <span class="n">Url</span><span class="o">.</span><span class="n">AMQPS</span><span class="p">:</span> |
| <span class="k">return</span> <span class="mi">5671</span> |
| <span class="k">elif</span> <span class="n">value</span> <span class="o">==</span> <span class="n">Url</span><span class="o">.</span><span class="n">AMQP</span><span class="p">:</span> |
| <span class="k">return</span> <span class="mi">5672</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Not a valid port number or service name: '</span><span class="si">%s</span><span class="s2">'"</span> <span class="o">%</span> <span class="n">value</span><span class="p">)</span></div> |
| |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">url</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">defaults</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">Url</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">scheme</span> <span class="o">=</span> <span class="n">url</span><span class="o">.</span><span class="n">scheme</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">username</span> <span class="o">=</span> <span class="n">url</span><span class="o">.</span><span class="n">username</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">password</span> <span class="o">=</span> <span class="n">url</span><span class="o">.</span><span class="n">password</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_host</span> <span class="o">=</span> <span class="n">url</span><span class="o">.</span><span class="n">_host</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_port</span> <span class="o">=</span> <span class="n">url</span><span class="o">.</span><span class="n">_port</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_path</span> <span class="o">=</span> <span class="n">url</span><span class="o">.</span><span class="n">_path</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_params</span> <span class="o">=</span> <span class="n">url</span><span class="o">.</span><span class="n">_params</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_query</span> <span class="o">=</span> <span class="n">url</span><span class="o">.</span><span class="n">_query</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_fragment</span> <span class="o">=</span> <span class="n">url</span><span class="o">.</span><span class="n">_fragment</span> |
| <span class="k">elif</span> <span class="n">url</span><span class="p">:</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">url</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'//'</span><span class="p">):</span> |
| <span class="n">p</span> <span class="o">=</span> <span class="n">url</span><span class="o">.</span><span class="n">partition</span><span class="p">(</span><span class="s1">':'</span><span class="p">)</span> |
| <span class="k">if</span> <span class="s1">'/'</span> <span class="ow">in</span> <span class="n">p</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">p</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'//'</span><span class="p">):</span> |
| <span class="n">url</span> <span class="o">=</span> <span class="s1">'//'</span> <span class="o">+</span> <span class="n">url</span> |
| <span class="n">u</span> <span class="o">=</span> <span class="n">urlparse</span><span class="p">(</span><span class="n">url</span><span class="p">)</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">u</span><span class="p">:</span> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Invalid URL '</span><span class="si">%s</span><span class="s2">'"</span> <span class="o">%</span> <span class="n">url</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">scheme</span> <span class="o">=</span> <span class="kc">None</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">u</span><span class="o">.</span><span class="n">scheme</span> <span class="k">else</span> <span class="n">u</span><span class="o">.</span><span class="n">scheme</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">username</span> <span class="o">=</span> <span class="n">u</span><span class="o">.</span><span class="n">username</span> <span class="ow">and</span> <span class="n">unquote</span><span class="p">(</span><span class="n">u</span><span class="o">.</span><span class="n">username</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">password</span> <span class="o">=</span> <span class="n">u</span><span class="o">.</span><span class="n">password</span> <span class="ow">and</span> <span class="n">unquote</span><span class="p">(</span><span class="n">u</span><span class="o">.</span><span class="n">password</span><span class="p">)</span> |
| <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_host</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_port</span><span class="p">)</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_parse_host_port</span><span class="p">(</span><span class="n">u</span><span class="o">.</span><span class="n">netloc</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_path</span> <span class="o">=</span> <span class="kc">None</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">u</span><span class="o">.</span><span class="n">path</span> <span class="k">else</span> <span class="n">u</span><span class="o">.</span><span class="n">path</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_params</span> <span class="o">=</span> <span class="n">u</span><span class="o">.</span><span class="n">params</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_query</span> <span class="o">=</span> <span class="n">u</span><span class="o">.</span><span class="n">query</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_fragment</span> <span class="o">=</span> <span class="n">u</span><span class="o">.</span><span class="n">fragment</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">scheme</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">username</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">password</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_host</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_port</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_path</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_params</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_query</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_fragment</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="p">:</span> <span class="c1"># Let kwargs override values parsed from url</span> |
| <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">k</span><span class="p">)</span> <span class="c1"># Check for invalid kwargs</span> |
| <span class="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">k</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="n">k</span><span class="p">])</span> |
| <span class="k">if</span> <span class="n">defaults</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">defaults</span><span class="p">()</span> |
| |
| <span class="nd">@staticmethod</span> |
| <span class="k">def</span> <span class="nf">_parse_host_port</span><span class="p">(</span><span class="n">nl</span><span class="p">):</span> |
| <span class="n">hostport</span> <span class="o">=</span> <span class="n">nl</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'@'</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> |
| <span class="n">hostportsplit</span> <span class="o">=</span> <span class="n">hostport</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">']'</span><span class="p">)</span> |
| <span class="n">beforebrace</span> <span class="o">=</span> <span class="n">hostportsplit</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> |
| <span class="n">afterbrace</span> <span class="o">=</span> <span class="n">hostportsplit</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> |
| |
| <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">hostportsplit</span><span class="p">)</span><span class="o">==</span><span class="mi">1</span><span class="p">:</span> |
| <span class="n">beforebrace</span> <span class="o">=</span> <span class="s1">''</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">beforebrace</span> <span class="o">+=</span> <span class="s1">']'</span> |
| <span class="k">if</span> <span class="s1">':'</span> <span class="ow">in</span> <span class="n">afterbrace</span><span class="p">:</span> |
| <span class="n">afterbracesplit</span> <span class="o">=</span> <span class="n">afterbrace</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">':'</span><span class="p">)</span> |
| <span class="n">port</span> <span class="o">=</span> <span class="n">afterbracesplit</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> |
| <span class="n">host</span> <span class="o">=</span> <span class="p">(</span><span class="n">beforebrace</span><span class="o">+</span><span class="n">afterbracesplit</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">port</span><span class="p">:</span> |
| <span class="n">port</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">host</span> <span class="o">=</span> <span class="p">(</span><span class="n">beforebrace</span><span class="o">+</span><span class="n">afterbrace</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> |
| <span class="n">port</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">host</span><span class="p">:</span> |
| <span class="n">host</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="k">return</span> <span class="p">(</span><span class="n">host</span><span class="p">,</span> <span class="n">port</span><span class="p">)</span> |
| |
| <span class="nd">@property</span> |
| <span class="k">def</span> <span class="nf">path</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> The path segment of a URL</span> |
| |
| <span class="sd"> :type: ``str``</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_path</span> <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_path</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">_path</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">'/'</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">_path</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> |
| |
| <span class="nd">@path</span><span class="o">.</span><span class="n">setter</span> |
| <span class="k">def</span> <span class="nf">path</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">p</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_path</span> <span class="o">=</span> <span class="n">p</span> <span class="k">if</span> <span class="n">p</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s1">'/'</span> <span class="k">else</span> <span class="s1">'/'</span> <span class="o">+</span> <span class="n">p</span> |
| |
| <span class="nd">@staticmethod</span> |
| <span class="k">def</span> <span class="nf">_ipv6literal</span><span class="p">(</span><span class="n">s</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">s</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'['</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">']'</span><span class="p">)</span> |
| |
| <span class="nd">@property</span> |
| <span class="k">def</span> <span class="nf">host</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> The host segment of a URL</span> |
| |
| <span class="sd"> :type: ``str``</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_host</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ipv6literal</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_host</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_host</span><span class="p">[</span><span class="mi">1</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_host</span> |
| |
| <span class="nd">@host</span><span class="o">.</span><span class="n">setter</span> |
| <span class="k">def</span> <span class="nf">host</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">h</span><span class="p">):</span> |
| <span class="k">if</span> <span class="s1">':'</span> <span class="ow">in</span> <span class="n">h</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ipv6literal</span><span class="p">(</span><span class="n">h</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_host</span> <span class="o">=</span> <span class="s1">'['</span> <span class="o">+</span> <span class="n">h</span> <span class="o">+</span> <span class="s1">']'</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_host</span> <span class="o">=</span> <span class="n">h</span> |
| |
| <span class="nd">@property</span> |
| <span class="k">def</span> <span class="nf">port</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> The port number segment of a URL.</span> |
| |
| <span class="sd"> :type: :class:`Url.Port`</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_port</span> <span class="ow">and</span> <span class="n">Url</span><span class="o">.</span><span class="n">Port</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_port</span><span class="p">)</span> |
| |
| <span class="nd">@port</span><span class="o">.</span><span class="n">setter</span> |
| <span class="k">def</span> <span class="nf">port</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">p</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_port</span> <span class="o">=</span> <span class="n">p</span> |
| |
| <span class="nd">@property</span> |
| <span class="k">def</span> <span class="nf">_netloc</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="n">hostport</span> <span class="o">=</span> <span class="s1">''</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_host</span><span class="p">:</span> |
| <span class="n">hostport</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_host</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_port</span><span class="p">:</span> |
| <span class="n">hostport</span> <span class="o">+=</span> <span class="s1">':'</span> |
| <span class="n">hostport</span> <span class="o">+=</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_port</span><span class="p">)</span> |
| <span class="n">userpart</span> <span class="o">=</span> <span class="s1">''</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">username</span><span class="p">:</span> |
| <span class="n">userpart</span> <span class="o">+=</span> <span class="n">quote</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">username</span><span class="p">)</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">password</span><span class="p">:</span> |
| <span class="n">userpart</span> <span class="o">+=</span> <span class="s1">':'</span> |
| <span class="n">userpart</span> <span class="o">+=</span> <span class="n">quote</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">password</span><span class="p">)</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">username</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">password</span><span class="p">:</span> |
| <span class="n">userpart</span> <span class="o">+=</span> <span class="s1">'@'</span> |
| <span class="k">return</span> <span class="n">userpart</span> <span class="o">+</span> <span class="n">hostport</span> |
| |
| <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">scheme</span> \ |
| <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_netloc</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_path</span> \ |
| <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_params</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_query</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fragment</span><span class="p">:</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">scheme</span> <span class="o">+</span> <span class="s1">'://'</span> |
| <span class="k">return</span> <span class="n">urlunparse</span><span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">scheme</span> <span class="ow">or</span> <span class="s1">''</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_netloc</span> <span class="ow">or</span> <span class="s1">''</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_path</span> <span class="ow">or</span> <span class="s1">''</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_params</span> <span class="ow">or</span> <span class="s1">''</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_query</span> <span class="ow">or</span> <span class="s1">''</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fragment</span> <span class="ow">or</span> <span class="s1">''</span><span class="p">))</span> |
| |
| <span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="s2">"Url('</span><span class="si">%s</span><span class="s2">')"</span> <span class="o">%</span> <span class="bp">self</span> |
| |
| <span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> |
| <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">str</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="fm">__ne__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span> |
| <span class="k">return</span> <span class="ow">not</span> <span class="bp">self</span> <span class="o">==</span> <span class="n">x</span> |
| |
| <div class="viewcode-block" id="Url.defaults"><a class="viewcode-back" href="../../proton.html#proton.Url.defaults">[docs]</a> <span class="k">def</span> <span class="nf">defaults</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Fill in missing values (scheme, host or port) with defaults</span> |
| <span class="sd"> :return: self</span> |
| <span class="sd"> """</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">scheme</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">scheme</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">AMQP</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_host</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_host</span> <span class="ow">or</span> <span class="s1">'0.0.0.0'</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_port</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_port</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">Port</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">scheme</span><span class="p">)</span> |
| <span class="k">return</span> <span class="bp">self</span></div></div> |
| </pre></div> |
| |
| <div class="clearer"></div> |
| </div> |
| </div> |
| </div> |
| <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
| <div class="sphinxsidebarwrapper"> |
| <div id="searchbox" style="display: none" role="search"> |
| <h3 id="searchlabel">Quick search</h3> |
| <div class="searchformwrapper"> |
| <form class="search" action="../../search.html" method="get"> |
| <input type="text" name="q" aria-labelledby="searchlabel" /> |
| <input type="submit" value="Go" /> |
| </form> |
| </div> |
| </div> |
| <script>$('#searchbox').show(0);</script> |
| </div> |
| </div> |
| <div class="clearer"></div> |
| </div> |
| <div class="related" role="navigation" aria-label="related navigation"> |
| <h3>Navigation</h3> |
| <ul> |
| <li class="right" style="margin-right: 10px"> |
| <a href="../../genindex.html" title="General Index" |
| >index</a></li> |
| <li class="nav-item nav-item-0"><a href="../../index.html">Qpid Proton Python API 0.32.0 documentation</a> »</li> |
| <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li> |
| <li class="nav-item nav-item-this"><a href="">proton._url</a></li> |
| </ul> |
| </div> |
| <div class="footer" role="contentinfo"> |
| © Copyright 2019, Apache Qpid Contributors. |
| Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1. |
| </div> |
| </body> |
| </html> |