<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>User Documentation — rfc3986 1.0.0 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Parsing a URI" href="user/parsing.html" />
<link rel="prev" title="rfc3986" href="index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> rfc3986
</a>
<div class="version">
1.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">User Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user/parsing.html">Parsing a URI</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/validating.html">Validating URIs</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/building.html">Building URIs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api-ref/index.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="release-notes/index.html">Release Notes and History</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">rfc3986</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>User Documentation</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/narrative.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="user-documentation">
<span id="narrative"></span><h1>User Documentation<a class="headerlink" href="#user-documentation" title="Permalink to this headline">¶</a></h1>
<p><code class="xref py py-mod docutils literal notranslate"><span class="pre">rfc3986</span></code> has several API features and convenience methods. The core of
<code class="xref py py-mod docutils literal notranslate"><span class="pre">rfc3986</span></code>’s API revolves around parsing, validating, and building URIs.</p>
<p>There is an API to provide compatibility with <code class="xref py py-mod docutils literal notranslate"><span class="pre">urllib.parse</span></code>, there is an
API to parse a URI as a URI Reference, there’s an API to provide validation of
URIs, and finally there’s an API to build URIs.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">There’s presently no support for IRIs as defined in <span class="target" id="index-0"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc3987.html"><strong>RFC 3987</strong></a>.</p>
</div>
<p><code class="xref py py-mod docutils literal notranslate"><span class="pre">rfc3986</span></code> parses URIs much differently from <code class="xref py py-mod docutils literal notranslate"><span class="pre">urllib.parse</span></code> so users may
see some subtle differences with very specific URLs that contain rough
edgecases. Regardless, we do our best to implement the same API so you should
be able to seemlessly swap <code class="xref py py-mod docutils literal notranslate"><span class="pre">rfc3986</span></code> for <code class="docutils literal notranslate"><span class="pre">urlparse</span></code>.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="user/parsing.html">Parsing a URI</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user/parsing.html#some-examples">Some Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/parsing.html#and-now-for-something-slightly-unusual">And Now For Something Slightly Unusual</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user/validating.html">Validating URIs</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user/validating.html#example-usage">Example Usage</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user/building.html">Building URIs</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user/building.html#example-usage">Example Usage</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="user/parsing.html" class="btn btn-neutral float-right" title="Parsing a URI" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral float-left" title="rfc3986" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017, Ian Stapleton Cordasco
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
1f68f38d33a8652088bdaaba73fcb34b
>
files
>
165
