GIF89a;
Mini Shell
Mini Shell
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>20.16. urlparse — Parse URLs into components — Python 2.7.5 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.7.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/sidebar.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Python 2.7.5 documentation"
href="../_static/opensearch.xml"/>
<link rel="author" title="About these documents" href="../about.html" />
<link rel="copyright" title="Copyright" href="../copyright.html" />
<link rel="top" title="Python 2.7.5 documentation" href="../index.html" />
<link rel="up" title="20. Internet Protocols and Support" href="internet.html" />
<link rel="next" title="20.17. SocketServer — A framework for network servers" href="socketserver.html" />
<link rel="prev" title="20.15. uuid — UUID objects according to RFC 4122" href="uuid.html" />
<link rel="shortcut icon" type="image/png" href="../_static/py.png" />
<script type="text/javascript" src="../_static/copybutton.js"></script>
</head>
<body>
<div class="related">
<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="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="socketserver.html" title="20.17. SocketServer — A framework for network servers"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="uuid.html" title="20.15. uuid — UUID objects according to RFC 4122"
accesskey="P">previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="http://www.python.org/">Python</a> »</li>
<li>
<a href="../index.html">Python 2.7.5 documentation</a> »
</li>
<li><a href="index.html" >The Python Standard Library</a> »</li>
<li><a href="internet.html" accesskey="U">20. Internet Protocols and Support</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-urlparse">
<span id="urlparse-parse-urls-into-components"></span><h1>20.16. <a class="reference internal" href="#module-urlparse" title="urlparse: Parse URLs into or assemble them from components."><tt class="xref py py-mod docutils literal"><span class="pre">urlparse</span></tt></a> — Parse URLs into components<a class="headerlink" href="#module-urlparse" title="Permalink to this headline">¶</a></h1>
<div class="admonition note" id="index-0">
<p class="first admonition-title">Note</p>
<p class="last">The <a class="reference internal" href="#module-urlparse" title="urlparse: Parse URLs into or assemble them from components."><tt class="xref py py-mod docutils literal"><span class="pre">urlparse</span></tt></a> module is renamed to <tt class="xref py py-mod docutils literal"><span class="pre">urllib.parse</span></tt> in Python 3.
The <a class="reference internal" href="../glossary.html#term-to3"><em class="xref std std-term">2to3</em></a> tool will automatically adapt imports when converting
your sources to Python 3.</p>
</div>
<p><strong>Source code:</strong> <a class="reference external" href="http://hg.python.org/cpython/file/2.7/Lib/urlparse.py">Lib/urlparse.py</a></p>
<hr class="docutils" />
<p>This module defines a standard interface to break Uniform Resource Locator (URL)
strings up in components (addressing scheme, network location, path etc.), to
combine the components back into a URL string, and to convert a “relative URL”
to an absolute URL given a “base URL.”</p>
<p>The module has been designed to match the Internet RFC on Relative Uniform
Resource Locators. It supports the following URL schemes: <tt class="docutils literal"><span class="pre">file</span></tt>, <tt class="docutils literal"><span class="pre">ftp</span></tt>,
<tt class="docutils literal"><span class="pre">gopher</span></tt>, <tt class="docutils literal"><span class="pre">hdl</span></tt>, <tt class="docutils literal"><span class="pre">http</span></tt>, <tt class="docutils literal"><span class="pre">https</span></tt>, <tt class="docutils literal"><span class="pre">imap</span></tt>, <tt class="docutils literal"><span class="pre">mailto</span></tt>, <tt class="docutils literal"><span class="pre">mms</span></tt>,
<tt class="docutils literal"><span class="pre">news</span></tt>, <tt class="docutils literal"><span class="pre">nntp</span></tt>, <tt class="docutils literal"><span class="pre">prospero</span></tt>, <tt class="docutils literal"><span class="pre">rsync</span></tt>, <tt class="docutils literal"><span class="pre">rtsp</span></tt>, <tt class="docutils literal"><span class="pre">rtspu</span></tt>, <tt class="docutils literal"><span class="pre">sftp</span></tt>,
<tt class="docutils literal"><span class="pre">shttp</span></tt>, <tt class="docutils literal"><span class="pre">sip</span></tt>, <tt class="docutils literal"><span class="pre">sips</span></tt>, <tt class="docutils literal"><span class="pre">snews</span></tt>, <tt class="docutils literal"><span class="pre">svn</span></tt>, <tt class="docutils literal"><span class="pre">svn+ssh</span></tt>, <tt class="docutils literal"><span class="pre">telnet</span></tt>,
<tt class="docutils literal"><span class="pre">wais</span></tt>.</p>
<p class="versionadded">
<span class="versionmodified">New in version 2.5: </span>Support for the <tt class="docutils literal"><span class="pre">sftp</span></tt> and <tt class="docutils literal"><span class="pre">sips</span></tt> schemes.</p>
<p>The <a class="reference internal" href="#module-urlparse" title="urlparse: Parse URLs into or assemble them from components."><tt class="xref py py-mod docutils literal"><span class="pre">urlparse</span></tt></a> module defines the following functions:</p>
<dl class="function">
<dt id="urlparse.urlparse">
<tt class="descclassname">urlparse.</tt><tt class="descname">urlparse</tt><big>(</big><em>urlstring</em><span class="optional">[</span>, <em>scheme</em><span class="optional">[</span>, <em>allow_fragments</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#urlparse.urlparse" title="Permalink to this definition">¶</a></dt>
<dd><p>Parse a URL into six components, returning a 6-tuple. This corresponds to the
general structure of a URL: <tt class="docutils literal"><span class="pre">scheme://netloc/path;parameters?query#fragment</span></tt>.
Each tuple item is a string, possibly empty. The components are not broken up in
smaller parts (for example, the network location is a single string), and %
escapes are not expanded. The delimiters as shown above are not part of the
result, except for a leading slash in the <em>path</em> component, which is retained if
present. For example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">urlparse</span> <span class="kn">import</span> <span class="n">urlparse</span>
<span class="gp">>>> </span><span class="n">o</span> <span class="o">=</span> <span class="n">urlparse</span><span class="p">(</span><span class="s">'http://www.cwi.nl:80/</span><span class="si">%7E</span><span class="s">guido/Python.html'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">o</span>
<span class="go">ParseResult(scheme='http', netloc='www.cwi.nl:80', path='/%7Eguido/Python.html',</span>
<span class="go"> params='', query='', fragment='')</span>
<span class="gp">>>> </span><span class="n">o</span><span class="o">.</span><span class="n">scheme</span>
<span class="go">'http'</span>
<span class="gp">>>> </span><span class="n">o</span><span class="o">.</span><span class="n">port</span>
<span class="go">80</span>
<span class="gp">>>> </span><span class="n">o</span><span class="o">.</span><span class="n">geturl</span><span class="p">()</span>
<span class="go">'http://www.cwi.nl:80/%7Eguido/Python.html'</span>
</pre></div>
</div>
<p>Following the syntax specifications in <span class="target" id="index-1"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc1808.html"><strong>RFC 1808</strong></a>, urlparse recognizes
a netloc only if it is properly introduced by ‘//’. Otherwise the
input is presumed to be a relative URL and thus to start with
a path component.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">urlparse</span> <span class="kn">import</span> <span class="n">urlparse</span>
<span class="gp">>>> </span><span class="n">urlparse</span><span class="p">(</span><span class="s">'//www.cwi.nl:80/</span><span class="si">%7E</span><span class="s">guido/Python.html'</span><span class="p">)</span>
<span class="go">ParseResult(scheme='', netloc='www.cwi.nl:80', path='/%7Eguido/Python.html',</span>
<span class="go"> params='', query='', fragment='')</span>
<span class="gp">>>> </span><span class="n">urlparse</span><span class="p">(</span><span class="s">'www.cwi.nl/</span><span class="si">%7E</span><span class="s">guido/Python.html'</span><span class="p">)</span>
<span class="go">ParseResult(scheme='', netloc='', path='www.cwi.nl:80/%7Eguido/Python.html',</span>
<span class="go"> params='', query='', fragment='')</span>
<span class="gp">>>> </span><span class="n">urlparse</span><span class="p">(</span><span class="s">'help/Python.html'</span><span class="p">)</span>
<span class="go">ParseResult(scheme='', netloc='', path='help/Python.html', params='',</span>
<span class="go"> query='', fragment='')</span>
</pre></div>
</div>
<p>If the <em>scheme</em> argument is specified, it gives the default addressing
scheme, to be used only if the URL does not specify one. The default value for
this argument is the empty string.</p>
<p>If the <em>allow_fragments</em> argument is false, fragment identifiers are not
allowed, even if the URL’s addressing scheme normally does support them. The
default value for this argument is <a class="reference internal" href="constants.html#True" title="True"><tt class="xref py py-const docutils literal"><span class="pre">True</span></tt></a>.</p>
<p>The return value is actually an instance of a subclass of <a class="reference internal" href="functions.html#tuple" title="tuple"><tt class="xref py py-class docutils literal"><span class="pre">tuple</span></tt></a>. This
class has the following additional read-only convenience attributes:</p>
<table border="1" class="docutils">
<colgroup>
<col width="25%" />
<col width="10%" />
<col width="36%" />
<col width="30%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Attribute</th>
<th class="head">Index</th>
<th class="head">Value</th>
<th class="head">Value if not present</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">scheme</span></tt></td>
<td>0</td>
<td>URL scheme specifier</td>
<td>empty string</td>
</tr>
<tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">netloc</span></tt></td>
<td>1</td>
<td>Network location part</td>
<td>empty string</td>
</tr>
<tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">path</span></tt></td>
<td>2</td>
<td>Hierarchical path</td>
<td>empty string</td>
</tr>
<tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">params</span></tt></td>
<td>3</td>
<td>Parameters for last path
element</td>
<td>empty string</td>
</tr>
<tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">query</span></tt></td>
<td>4</td>
<td>Query component</td>
<td>empty string</td>
</tr>
<tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">fragment</span></tt></td>
<td>5</td>
<td>Fragment identifier</td>
<td>empty string</td>
</tr>
<tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">username</span></tt></td>
<td> </td>
<td>User name</td>
<td><a class="reference internal" href="constants.html#None" title="None"><tt class="xref py py-const docutils literal"><span class="pre">None</span></tt></a></td>
</tr>
<tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">password</span></tt></td>
<td> </td>
<td>Password</td>
<td><a class="reference internal" href="constants.html#None" title="None"><tt class="xref py py-const docutils literal"><span class="pre">None</span></tt></a></td>
</tr>
<tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">hostname</span></tt></td>
<td> </td>
<td>Host name (lower case)</td>
<td><a class="reference internal" href="constants.html#None" title="None"><tt class="xref py py-const docutils literal"><span class="pre">None</span></tt></a></td>
</tr>
<tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">port</span></tt></td>
<td> </td>
<td>Port number as integer,
if present</td>
<td><a class="reference internal" href="constants.html#None" title="None"><tt class="xref py py-const docutils literal"><span class="pre">None</span></tt></a></td>
</tr>
</tbody>
</table>
<p>See section <a class="reference internal" href="#urlparse-result-object"><em>Results of urlparse() and urlsplit()</em></a> for more information on the result
object.</p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 2.5: </span>Added attributes to return value.</p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 2.7: </span>Added IPv6 URL parsing capabilities.</p>
</dd></dl>
<dl class="function">
<dt id="urlparse.parse_qs">
<tt class="descclassname">urlparse.</tt><tt class="descname">parse_qs</tt><big>(</big><em>qs</em><span class="optional">[</span>, <em>keep_blank_values</em><span class="optional">[</span>, <em>strict_parsing</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#urlparse.parse_qs" title="Permalink to this definition">¶</a></dt>
<dd><p>Parse a query string given as a string argument (data of type
<em class="mimetype">application/x-www-form-urlencoded</em>). Data are returned as a
dictionary. The dictionary keys are the unique query variable names and the
values are lists of values for each name.</p>
<p>The optional argument <em>keep_blank_values</em> is a flag indicating whether blank
values in percent-encoded queries should be treated as blank strings. A true value
indicates that blanks should be retained as blank strings. The default false
value indicates that blank values are to be ignored and treated as if they were
not included.</p>
<p>The optional argument <em>strict_parsing</em> is a flag indicating what to do with
parsing errors. If false (the default), errors are silently ignored. If true,
errors raise a <a class="reference internal" href="exceptions.html#exceptions.ValueError" title="exceptions.ValueError"><tt class="xref py py-exc docutils literal"><span class="pre">ValueError</span></tt></a> exception.</p>
<p>Use the <a class="reference internal" href="urllib.html#urllib.urlencode" title="urllib.urlencode"><tt class="xref py py-func docutils literal"><span class="pre">urllib.urlencode()</span></tt></a> function to convert such dictionaries into
query strings.</p>
<p class="versionadded">
<span class="versionmodified">New in version 2.6: </span>Copied from the <a class="reference internal" href="cgi.html#module-cgi" title="cgi: Helpers for running Python scripts via the Common Gateway Interface."><tt class="xref py py-mod docutils literal"><span class="pre">cgi</span></tt></a> module.</p>
</dd></dl>
<dl class="function">
<dt id="urlparse.parse_qsl">
<tt class="descclassname">urlparse.</tt><tt class="descname">parse_qsl</tt><big>(</big><em>qs</em><span class="optional">[</span>, <em>keep_blank_values</em><span class="optional">[</span>, <em>strict_parsing</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#urlparse.parse_qsl" title="Permalink to this definition">¶</a></dt>
<dd><p>Parse a query string given as a string argument (data of type
<em class="mimetype">application/x-www-form-urlencoded</em>). Data are returned as a list of
name, value pairs.</p>
<p>The optional argument <em>keep_blank_values</em> is a flag indicating whether blank
values in percent-encoded queries should be treated as blank strings. A true value
indicates that blanks should be retained as blank strings. The default false
value indicates that blank values are to be ignored and treated as if they were
not included.</p>
<p>The optional argument <em>strict_parsing</em> is a flag indicating what to do with
parsing errors. If false (the default), errors are silently ignored. If true,
errors raise a <a class="reference internal" href="exceptions.html#exceptions.ValueError" title="exceptions.ValueError"><tt class="xref py py-exc docutils literal"><span class="pre">ValueError</span></tt></a> exception.</p>
<p>Use the <a class="reference internal" href="urllib.html#urllib.urlencode" title="urllib.urlencode"><tt class="xref py py-func docutils literal"><span class="pre">urllib.urlencode()</span></tt></a> function to convert such lists of pairs into
query strings.</p>
<p class="versionadded">
<span class="versionmodified">New in version 2.6: </span>Copied from the <a class="reference internal" href="cgi.html#module-cgi" title="cgi: Helpers for running Python scripts via the Common Gateway Interface."><tt class="xref py py-mod docutils literal"><span class="pre">cgi</span></tt></a> module.</p>
</dd></dl>
<dl class="function">
<dt id="urlparse.urlunparse">
<tt class="descclassname">urlparse.</tt><tt class="descname">urlunparse</tt><big>(</big><em>parts</em><big>)</big><a class="headerlink" href="#urlparse.urlunparse" title="Permalink to this definition">¶</a></dt>
<dd><p>Construct a URL from a tuple as returned by <tt class="docutils literal"><span class="pre">urlparse()</span></tt>. The <em>parts</em> argument
can be any six-item iterable. This may result in a slightly different, but
equivalent URL, if the URL that was parsed originally had unnecessary delimiters
(for example, a ? with an empty query; the RFC states that these are
equivalent).</p>
</dd></dl>
<dl class="function">
<dt id="urlparse.urlsplit">
<tt class="descclassname">urlparse.</tt><tt class="descname">urlsplit</tt><big>(</big><em>urlstring</em><span class="optional">[</span>, <em>scheme</em><span class="optional">[</span>, <em>allow_fragments</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#urlparse.urlsplit" title="Permalink to this definition">¶</a></dt>
<dd><p>This is similar to <a class="reference internal" href="#module-urlparse" title="urlparse: Parse URLs into or assemble them from components."><tt class="xref py py-func docutils literal"><span class="pre">urlparse()</span></tt></a>, but does not split the params from the URL.
This should generally be used instead of <a class="reference internal" href="#module-urlparse" title="urlparse: Parse URLs into or assemble them from components."><tt class="xref py py-func docutils literal"><span class="pre">urlparse()</span></tt></a> if the more recent URL
syntax allowing parameters to be applied to each segment of the <em>path</em> portion
of the URL (see <span class="target" id="index-2"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2396.html"><strong>RFC 2396</strong></a>) is wanted. A separate function is needed to
separate the path segments and parameters. This function returns a 5-tuple:
(addressing scheme, network location, path, query, fragment identifier).</p>
<p>The return value is actually an instance of a subclass of <a class="reference internal" href="functions.html#tuple" title="tuple"><tt class="xref py py-class docutils literal"><span class="pre">tuple</span></tt></a>. This
class has the following additional read-only convenience attributes:</p>
<table border="1" class="docutils">
<colgroup>
<col width="25%" />
<col width="10%" />
<col width="35%" />
<col width="31%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Attribute</th>
<th class="head">Index</th>
<th class="head">Value</th>
<th class="head">Value if not present</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">scheme</span></tt></td>
<td>0</td>
<td>URL scheme specifier</td>
<td>empty string</td>
</tr>
<tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">netloc</span></tt></td>
<td>1</td>
<td>Network location part</td>
<td>empty string</td>
</tr>
<tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">path</span></tt></td>
<td>2</td>
<td>Hierarchical path</td>
<td>empty string</td>
</tr>
<tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">query</span></tt></td>
<td>3</td>
<td>Query component</td>
<td>empty string</td>
</tr>
<tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">fragment</span></tt></td>
<td>4</td>
<td>Fragment identifier</td>
<td>empty string</td>
</tr>
<tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">username</span></tt></td>
<td> </td>
<td>User name</td>
<td><a class="reference internal" href="constants.html#None" title="None"><tt class="xref py py-const docutils literal"><span class="pre">None</span></tt></a></td>
</tr>
<tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">password</span></tt></td>
<td> </td>
<td>Password</td>
<td><a class="reference internal" href="constants.html#None" title="None"><tt class="xref py py-const docutils literal"><span class="pre">None</span></tt></a></td>
</tr>
<tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">hostname</span></tt></td>
<td> </td>
<td>Host name (lower case)</td>
<td><a class="reference internal" href="constants.html#None" title="None"><tt class="xref py py-const docutils literal"><span class="pre">None</span></tt></a></td>
</tr>
<tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">port</span></tt></td>
<td> </td>
<td>Port number as integer,
if present</td>
<td><a class="reference internal" href="constants.html#None" title="None"><tt class="xref py py-const docutils literal"><span class="pre">None</span></tt></a></td>
</tr>
</tbody>
</table>
<p>See section <a class="reference internal" href="#urlparse-result-object"><em>Results of urlparse() and urlsplit()</em></a> for more information on the result
object.</p>
<p class="versionadded">
<span class="versionmodified">New in version 2.2.</span></p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 2.5: </span>Added attributes to return value.</p>
</dd></dl>
<dl class="function">
<dt id="urlparse.urlunsplit">
<tt class="descclassname">urlparse.</tt><tt class="descname">urlunsplit</tt><big>(</big><em>parts</em><big>)</big><a class="headerlink" href="#urlparse.urlunsplit" title="Permalink to this definition">¶</a></dt>
<dd><p>Combine the elements of a tuple as returned by <a class="reference internal" href="#urlparse.urlsplit" title="urlparse.urlsplit"><tt class="xref py py-func docutils literal"><span class="pre">urlsplit()</span></tt></a> into a complete
URL as a string. The <em>parts</em> argument can be any five-item iterable. This may
result in a slightly different, but equivalent URL, if the URL that was parsed
originally had unnecessary delimiters (for example, a ? with an empty query; the
RFC states that these are equivalent).</p>
<p class="versionadded">
<span class="versionmodified">New in version 2.2.</span></p>
</dd></dl>
<dl class="function">
<dt id="urlparse.urljoin">
<tt class="descclassname">urlparse.</tt><tt class="descname">urljoin</tt><big>(</big><em>base</em>, <em>url</em><span class="optional">[</span>, <em>allow_fragments</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#urlparse.urljoin" title="Permalink to this definition">¶</a></dt>
<dd><p>Construct a full (“absolute”) URL by combining a “base URL” (<em>base</em>) with
another URL (<em>url</em>). Informally, this uses components of the base URL, in
particular the addressing scheme, the network location and (part of) the path,
to provide missing components in the relative URL. For example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">urlparse</span> <span class="kn">import</span> <span class="n">urljoin</span>
<span class="gp">>>> </span><span class="n">urljoin</span><span class="p">(</span><span class="s">'http://www.cwi.nl/</span><span class="si">%7E</span><span class="s">guido/Python.html'</span><span class="p">,</span> <span class="s">'FAQ.html'</span><span class="p">)</span>
<span class="go">'http://www.cwi.nl/%7Eguido/FAQ.html'</span>
</pre></div>
</div>
<p>The <em>allow_fragments</em> argument has the same meaning and default as for
<a class="reference internal" href="#module-urlparse" title="urlparse: Parse URLs into or assemble them from components."><tt class="xref py py-func docutils literal"><span class="pre">urlparse()</span></tt></a>.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">If <em>url</em> is an absolute URL (that is, starting with <tt class="docutils literal"><span class="pre">//</span></tt> or <tt class="docutils literal"><span class="pre">scheme://</span></tt>),
the <em>url</em>‘s host name and/or scheme will be present in the result. For example:</p>
</div>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">urljoin</span><span class="p">(</span><span class="s">'http://www.cwi.nl/</span><span class="si">%7E</span><span class="s">guido/Python.html'</span><span class="p">,</span>
<span class="gp">... </span> <span class="s">'//www.python.org/</span><span class="si">%7E</span><span class="s">guido'</span><span class="p">)</span>
<span class="go">'http://www.python.org/%7Eguido'</span>
</pre></div>
</div>
<p>If you do not want that behavior, preprocess the <em>url</em> with <a class="reference internal" href="#urlparse.urlsplit" title="urlparse.urlsplit"><tt class="xref py py-func docutils literal"><span class="pre">urlsplit()</span></tt></a> and
<a class="reference internal" href="#urlparse.urlunsplit" title="urlparse.urlunsplit"><tt class="xref py py-func docutils literal"><span class="pre">urlunsplit()</span></tt></a>, removing possible <em>scheme</em> and <em>netloc</em> parts.</p>
</dd></dl>
<dl class="function">
<dt id="urlparse.urldefrag">
<tt class="descclassname">urlparse.</tt><tt class="descname">urldefrag</tt><big>(</big><em>url</em><big>)</big><a class="headerlink" href="#urlparse.urldefrag" title="Permalink to this definition">¶</a></dt>
<dd><p>If <em>url</em> contains a fragment identifier, returns a modified version of <em>url</em>
with no fragment identifier, and the fragment identifier as a separate string.
If there is no fragment identifier in <em>url</em>, returns <em>url</em> unmodified and an
empty string.</p>
</dd></dl>
<div class="admonition-see-also admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><span class="target" id="index-3"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc3986.html"><strong>RFC 3986</strong></a> - Uniform Resource Identifiers</dt>
<dd>This is the current standard (STD66). Any changes to urlparse module
should conform to this. Certain deviations could be observed, which are
mostly due backward compatiblity purposes and for certain de-facto
parsing requirements as commonly observed in major browsers.</dd>
<dt><span class="target" id="index-4"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2732.html"><strong>RFC 2732</strong></a> - Format for Literal IPv6 Addresses in URL’s.</dt>
<dd>This specifies the parsing requirements of IPv6 URLs.</dd>
<dt><span class="target" id="index-5"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2396.html"><strong>RFC 2396</strong></a> - Uniform Resource Identifiers (URI): Generic Syntax</dt>
<dd>Document describing the generic syntactic requirements for both Uniform Resource
Names (URNs) and Uniform Resource Locators (URLs).</dd>
<dt><span class="target" id="index-6"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2368.html"><strong>RFC 2368</strong></a> - The mailto URL scheme.</dt>
<dd>Parsing requirements for mailto url schemes.</dd>
<dt><span class="target" id="index-7"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc1808.html"><strong>RFC 1808</strong></a> - Relative Uniform Resource Locators</dt>
<dd>This Request For Comments includes the rules for joining an absolute and a
relative URL, including a fair number of “Abnormal Examples” which govern the
treatment of border cases.</dd>
<dt><span class="target" id="index-8"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc1738.html"><strong>RFC 1738</strong></a> - Uniform Resource Locators (URL)</dt>
<dd>This specifies the formal syntax and semantics of absolute URLs.</dd>
</dl>
</div>
<div class="section" id="results-of-urlparse-and-urlsplit">
<span id="urlparse-result-object"></span><h2>20.16.1. Results of <a class="reference internal" href="#module-urlparse" title="urlparse: Parse URLs into or assemble them from components."><tt class="xref py py-func docutils literal"><span class="pre">urlparse()</span></tt></a> and <a class="reference internal" href="#urlparse.urlsplit" title="urlparse.urlsplit"><tt class="xref py py-func docutils literal"><span class="pre">urlsplit()</span></tt></a><a class="headerlink" href="#results-of-urlparse-and-urlsplit" title="Permalink to this headline">¶</a></h2>
<p>The result objects from the <a class="reference internal" href="#module-urlparse" title="urlparse: Parse URLs into or assemble them from components."><tt class="xref py py-func docutils literal"><span class="pre">urlparse()</span></tt></a> and <a class="reference internal" href="#urlparse.urlsplit" title="urlparse.urlsplit"><tt class="xref py py-func docutils literal"><span class="pre">urlsplit()</span></tt></a> functions are
subclasses of the <a class="reference internal" href="functions.html#tuple" title="tuple"><tt class="xref py py-class docutils literal"><span class="pre">tuple</span></tt></a> type. These subclasses add the attributes
described in those functions, as well as provide an additional method:</p>
<dl class="method">
<dt id="urlparse.ParseResult.geturl">
<tt class="descclassname">ParseResult.</tt><tt class="descname">geturl</tt><big>(</big><big>)</big><a class="headerlink" href="#urlparse.ParseResult.geturl" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the re-combined version of the original URL as a string. This may differ
from the original URL in that the scheme will always be normalized to lower case
and empty components may be dropped. Specifically, empty parameters, queries,
and fragment identifiers will be removed.</p>
<p>The result of this method is a fixpoint if passed back through the original
parsing function:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">urlparse</span>
<span class="gp">>>> </span><span class="n">url</span> <span class="o">=</span> <span class="s">'HTTP://www.Python.org/doc/#'</span>
</pre></div>
</div>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">r1</span> <span class="o">=</span> <span class="n">urlparse</span><span class="o">.</span><span class="n">urlsplit</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">r1</span><span class="o">.</span><span class="n">geturl</span><span class="p">()</span>
<span class="go">'http://www.Python.org/doc/'</span>
</pre></div>
</div>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">r2</span> <span class="o">=</span> <span class="n">urlparse</span><span class="o">.</span><span class="n">urlsplit</span><span class="p">(</span><span class="n">r1</span><span class="o">.</span><span class="n">geturl</span><span class="p">())</span>
<span class="gp">>>> </span><span class="n">r2</span><span class="o">.</span><span class="n">geturl</span><span class="p">()</span>
<span class="go">'http://www.Python.org/doc/'</span>
</pre></div>
</div>
<p class="versionadded">
<span class="versionmodified">New in version 2.5.</span></p>
</dd></dl>
<p>The following classes provide the implementations of the parse results:</p>
<dl class="class">
<dt id="urlparse.BaseResult">
<em class="property">class </em><tt class="descclassname">urlparse.</tt><tt class="descname">BaseResult</tt><a class="headerlink" href="#urlparse.BaseResult" title="Permalink to this definition">¶</a></dt>
<dd><p>Base class for the concrete result classes. This provides most of the attribute
definitions. It does not provide a <tt class="xref py py-meth docutils literal"><span class="pre">geturl()</span></tt> method. It is derived from
<a class="reference internal" href="functions.html#tuple" title="tuple"><tt class="xref py py-class docutils literal"><span class="pre">tuple</span></tt></a>, but does not override the <a class="reference internal" href="../reference/datamodel.html#object.__init__" title="object.__init__"><tt class="xref py py-meth docutils literal"><span class="pre">__init__()</span></tt></a> or <a class="reference internal" href="../reference/datamodel.html#object.__new__" title="object.__new__"><tt class="xref py py-meth docutils literal"><span class="pre">__new__()</span></tt></a>
methods.</p>
</dd></dl>
<dl class="class">
<dt id="urlparse.ParseResult">
<em class="property">class </em><tt class="descclassname">urlparse.</tt><tt class="descname">ParseResult</tt><big>(</big><em>scheme</em>, <em>netloc</em>, <em>path</em>, <em>params</em>, <em>query</em>, <em>fragment</em><big>)</big><a class="headerlink" href="#urlparse.ParseResult" title="Permalink to this definition">¶</a></dt>
<dd><p>Concrete class for <a class="reference internal" href="#module-urlparse" title="urlparse: Parse URLs into or assemble them from components."><tt class="xref py py-func docutils literal"><span class="pre">urlparse()</span></tt></a> results. The <a class="reference internal" href="../reference/datamodel.html#object.__new__" title="object.__new__"><tt class="xref py py-meth docutils literal"><span class="pre">__new__()</span></tt></a> method is
overridden to support checking that the right number of arguments are passed.</p>
</dd></dl>
<dl class="class">
<dt id="urlparse.SplitResult">
<em class="property">class </em><tt class="descclassname">urlparse.</tt><tt class="descname">SplitResult</tt><big>(</big><em>scheme</em>, <em>netloc</em>, <em>path</em>, <em>query</em>, <em>fragment</em><big>)</big><a class="headerlink" href="#urlparse.SplitResult" title="Permalink to this definition">¶</a></dt>
<dd><p>Concrete class for <a class="reference internal" href="#urlparse.urlsplit" title="urlparse.urlsplit"><tt class="xref py py-func docutils literal"><span class="pre">urlsplit()</span></tt></a> results. The <a class="reference internal" href="../reference/datamodel.html#object.__new__" title="object.__new__"><tt class="xref py py-meth docutils literal"><span class="pre">__new__()</span></tt></a> method is
overridden to support checking that the right number of arguments are passed.</p>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">20.16. <tt class="docutils literal"><span class="pre">urlparse</span></tt> — Parse URLs into components</a><ul>
<li><a class="reference internal" href="#results-of-urlparse-and-urlsplit">20.16.1. Results of <tt class="docutils literal"><span class="pre">urlparse()</span></tt> and <tt class="docutils literal"><span class="pre">urlsplit()</span></tt></a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="uuid.html"
title="previous chapter">20.15. <tt class="docutils literal"><span class="pre">uuid</span></tt> — UUID objects according to RFC 4122</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="socketserver.html"
title="next chapter">20.17. <tt class="docutils literal"><span class="pre">SocketServer</span></tt> — A framework for network servers</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../bugs.html">Report a Bug</a></li>
<li><a href="../_sources/library/urlparse.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="socketserver.html" title="20.17. SocketServer — A framework for network servers"
>next</a> |</li>
<li class="right" >
<a href="uuid.html" title="20.15. uuid — UUID objects according to RFC 4122"
>previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="http://www.python.org/">Python</a> »</li>
<li>
<a href="../index.html">Python 2.7.5 documentation</a> »
</li>
<li><a href="index.html" >The Python Standard Library</a> »</li>
<li><a href="internet.html" >20. Internet Protocols and Support</a> »</li>
</ul>
</div>
<div class="footer">
© <a href="../copyright.html">Copyright</a> 1990-2019, Python Software Foundation.
<br />
The Python Software Foundation is a non-profit corporation.
<a href="http://www.python.org/psf/donations/">Please donate.</a>
<br />
Last updated on Jul 03, 2019.
<a href="../bugs.html">Found a bug</a>?
<br />
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
./BlackJoker Mini Shell 1.0