Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
關註 1
收藏 0
Wiki 捐赠
gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
目錄樹: 0f75e31513
分支列表 標籤列表
${ item.name }
Create branch ${ searchTerm }
from '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/urllib.parse.html

1115 line
108KB
原始文件 Blame 文件歷史 

  1. <!DOCTYPE html>

  2. 

  3. <html lang="en" data-content_root="../">

  4.   <head>

  5.     <meta charset="utf-8" />

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  7. <meta property="og:title" content="urllib.parse — Parse URLs into components" />

  8. <meta property="og:type" content="website" />

  9. <meta property="og:url" content="https://docs.python.org/3/library/urllib.parse.html" />

  10. <meta property="og:site_name" content="Python documentation" />

  11. <meta property="og:description" content="Source code: Lib/urllib/parse.py This module defines a standard interface to break Uniform Resource Locator (URL) strings up in components (addressing scheme, network location, path etc.), to combi..." />

  12. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />

  13. <meta property="og:image:alt" content="Python documentation" />

  14. <meta name="description" content="Source code: Lib/urllib/parse.py This module defines a standard interface to break Uniform Resource Locator (URL) strings up in components (addressing scheme, network location, path etc.), to combi..." />

  15. <meta property="og:image:width" content="200" />

  16. <meta property="og:image:height" content="200" />

  17. <meta name="theme-color" content="#3776ab" />

  18. 

  19.     <title>urllib.parse — Parse URLs into components &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

  20.     

  21.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />

  22.     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />

  23.     <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />

  24.     

  25.     <script src="../_static/documentation_options.js?v=2c828074"></script>

  26.     <script src="../_static/doctools.js?v=888ff710"></script>

  27.     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

  28.     

  29.     <script src="../_static/sidebar.js"></script>

  30.     

  31.     <link rel="search" type="application/opensearchdescription+xml"

  32.           title="Search within Python 3.12.3 documentation"

  33.           href="../_static/opensearch.xml"/>

  34.     <link rel="author" title="About these documents" href="../about.html" />

  35.     <link rel="index" title="Index" href="../genindex.html" />

  36.     <link rel="search" title="Search" href="../search.html" />

  37.     <link rel="copyright" title="Copyright" href="../copyright.html" />

  38.     <link rel="next" title="urllib.error — Exception classes raised by urllib.request" href="urllib.error.html" />

  39.     <link rel="prev" title="urllib.request — Extensible library for opening URLs" href="urllib.request.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/urllib.parse.html" />

  41.     

  42.       

  43.     

  44. 

  45.     

  46.     <style>

  47.       @media only screen {

  48.         table.full-width-table {

  49.             width: 100%;

  50.         }

  51.       }

  52.     </style>

  53. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">

  54.     <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />

  55.             <script type="text/javascript" src="../_static/copybutton.js"></script>

  56.             <script type="text/javascript" src="../_static/menu.js"></script>

  57.             <script type="text/javascript" src="../_static/search-focus.js"></script>

  58.             <script type="text/javascript" src="../_static/themetoggle.js"></script> 

  59. 

  60.   </head>

  61. <body>

  62. <div class="mobile-nav">

  63.     <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

  64.            aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />

  65.     <nav class="nav-content" role="navigation">

  66.         <label for="menuToggler" class="toggler__label">

  67.             <span></span>

  68.         </label>

  69.         <span class="nav-items-wrapper">

  70.             <a href="https://www.python.org/" class="nav-logo">

  71.                 <img src="../_static/py.svg" alt="Python logo"/>

  72.             </a>

  73.             <span class="version_switcher_placeholder"></span>

  74.             <form role="search" class="search" action="../search.html" method="get">

  75.                 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">

  76.                     <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>

  77.                 </svg>

  78.                 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />

  79.                 <input type="submit" value="Go"/>

  80.             </form>

  81.         </span>

  82.     </nav>

  83.     <div class="menu-wrapper">

  84.         <nav class="menu" role="navigation" aria-label="main navigation">

  85.             <div class="language_switcher_placeholder"></div>

  86.             

  87. <label class="theme-selector-label">

  88.     Theme

  89.     <select class="theme-selector" oninput="activateTheme(this.value)">

  90.         <option value="auto" selected>Auto</option>

  91.         <option value="light">Light</option>

  92.         <option value="dark">Dark</option>

  93.     </select>

  94. </label>

  95.   <div>

  96.     <h3><a href="../contents.html">Table of Contents</a></h3>

  97.     <ul>

  98. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">urllib.parse</span></code> — Parse URLs into components</a><ul>

  99. <li><a class="reference internal" href="#url-parsing">URL Parsing</a></li>

  100. <li><a class="reference internal" href="#url-parsing-security">URL parsing security</a></li>

  101. <li><a class="reference internal" href="#parsing-ascii-encoded-bytes">Parsing ASCII Encoded Bytes</a></li>

  102. <li><a class="reference internal" href="#structured-parse-results">Structured Parse Results</a></li>

  103. <li><a class="reference internal" href="#url-quoting">URL Quoting</a></li>

  104. </ul>

  105. </li>

  106. </ul>

  107. 

  108.   </div>

  109.   <div>

  110.     <h4>Previous topic</h4>

  111.     <p class="topless"><a href="urllib.request.html"

  112.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">urllib.request</span></code> — Extensible library for opening URLs</a></p>

  113.   </div>

  114.   <div>

  115.     <h4>Next topic</h4>

  116.     <p class="topless"><a href="urllib.error.html"

  117.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">urllib.error</span></code> — Exception classes raised by urllib.request</a></p>

  118.   </div>

  119.   <div role="note" aria-label="source link">

  120.     <h3>This Page</h3>

  121.     <ul class="this-page-menu">

  122.       <li><a href="../bugs.html">Report a Bug</a></li>

  123.       <li>

  124.         <a href="https://github.com/python/cpython/blob/main/Doc/library/urllib.parse.rst"

  125.             rel="nofollow">Show Source

  126.         </a>

  127.       </li>

  128.     </ul>

  129.   </div>

  130.         </nav>

  131.     </div>

  132. </div>

  133. 

  134.   

  135.     <div class="related" role="navigation" aria-label="related navigation">

  136.       <h3>Navigation</h3>

  137.       <ul>

  138.         <li class="right" style="margin-right: 10px">

  139.           <a href="../genindex.html" title="General Index"

  140.              accesskey="I">index</a></li>

  141.         <li class="right" >

  142.           <a href="../py-modindex.html" title="Python Module Index"

  143.              >modules</a> |</li>

  144.         <li class="right" >

  145.           <a href="urllib.error.html" title="urllib.error — Exception classes raised by urllib.request"

  146.              accesskey="N">next</a> |</li>

  147.         <li class="right" >

  148.           <a href="urllib.request.html" title="urllib.request — Extensible library for opening URLs"

  149.              accesskey="P">previous</a> |</li>

  150. 

  151.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  152.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  153.           <li class="switchers">

  154.             <div class="language_switcher_placeholder"></div>

  155.             <div class="version_switcher_placeholder"></div>

  156.           </li>

  157.           <li>

  158.               

  159.           </li>

  160.     <li id="cpython-language-and-version">

  161.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  162.     </li>

  163. 

  164.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  165.           <li class="nav-item nav-item-2"><a href="internet.html" accesskey="U">Internet Protocols and Support</a> &#187;</li>

  166.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">urllib.parse</span></code> — Parse URLs into components</a></li>

  167.                 <li class="right">

  168.                     

  169. 

  170.     <div class="inline-search" role="search">

  171.         <form class="inline-search" action="../search.html" method="get">

  172.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  173.           <input type="submit" value="Go" />

  174.         </form>

  175.     </div>

  176.                      |

  177.                 </li>

  178.             <li class="right">

  179. <label class="theme-selector-label">

  180.     Theme

  181.     <select class="theme-selector" oninput="activateTheme(this.value)">

  182.         <option value="auto" selected>Auto</option>

  183.         <option value="light">Light</option>

  184.         <option value="dark">Dark</option>

  185.     </select>

  186. </label> |</li>

  187.             

  188.       </ul>

  189.     </div>    

  190. 

  191.     <div class="document">

  192.       <div class="documentwrapper">

  193.         <div class="bodywrapper">

  194.           <div class="body" role="main">

  195.             

  196.   <section id="module-urllib.parse">

  197. <span id="urllib-parse-parse-urls-into-components"></span><h1><a class="reference internal" href="#module-urllib.parse" title="urllib.parse: Parse URLs into or assemble them from components."><code class="xref py py-mod docutils literal notranslate"><span class="pre">urllib.parse</span></code></a> — Parse URLs into components<a class="headerlink" href="#module-urllib.parse" title="Link to this heading">¶</a></h1>

  198. <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/urllib/parse.py">Lib/urllib/parse.py</a></p>

  199. <hr class="docutils" id="index-0" />

  200. <p>This module defines a standard interface to break Uniform Resource Locator (URL)

  201. strings up in components (addressing scheme, network location, path etc.), to

  202. combine the components back into a URL string, and to convert a “relative URL”

  203. to an absolute URL given a “base URL.”</p>

  204. <p>The module has been designed to match the internet RFC on Relative Uniform

  205. Resource Locators. It supports the following URL schemes: <code class="docutils literal notranslate"><span class="pre">file</span></code>, <code class="docutils literal notranslate"><span class="pre">ftp</span></code>,

  206. <code class="docutils literal notranslate"><span class="pre">gopher</span></code>, <code class="docutils literal notranslate"><span class="pre">hdl</span></code>, <code class="docutils literal notranslate"><span class="pre">http</span></code>, <code class="docutils literal notranslate"><span class="pre">https</span></code>, <code class="docutils literal notranslate"><span class="pre">imap</span></code>, <code class="docutils literal notranslate"><span class="pre">mailto</span></code>, <code class="docutils literal notranslate"><span class="pre">mms</span></code>,

  207. <code class="docutils literal notranslate"><span class="pre">news</span></code>, <code class="docutils literal notranslate"><span class="pre">nntp</span></code>, <code class="docutils literal notranslate"><span class="pre">prospero</span></code>, <code class="docutils literal notranslate"><span class="pre">rsync</span></code>, <code class="docutils literal notranslate"><span class="pre">rtsp</span></code>, <code class="docutils literal notranslate"><span class="pre">rtsps</span></code>, <code class="docutils literal notranslate"><span class="pre">rtspu</span></code>,

  208. <code class="docutils literal notranslate"><span class="pre">sftp</span></code>, <code class="docutils literal notranslate"><span class="pre">shttp</span></code>, <code class="docutils literal notranslate"><span class="pre">sip</span></code>, <code class="docutils literal notranslate"><span class="pre">sips</span></code>, <code class="docutils literal notranslate"><span class="pre">snews</span></code>, <code class="docutils literal notranslate"><span class="pre">svn</span></code>, <code class="docutils literal notranslate"><span class="pre">svn+ssh</span></code>,

  209. <code class="docutils literal notranslate"><span class="pre">telnet</span></code>, <code class="docutils literal notranslate"><span class="pre">wais</span></code>, <code class="docutils literal notranslate"><span class="pre">ws</span></code>, <code class="docutils literal notranslate"><span class="pre">wss</span></code>.</p>

  210. <p>The <a class="reference internal" href="#module-urllib.parse" title="urllib.parse: Parse URLs into or assemble them from components."><code class="xref py py-mod docutils literal notranslate"><span class="pre">urllib.parse</span></code></a> module defines functions that fall into two broad

  211. categories: URL parsing and URL quoting. These are covered in detail in

  212. the following sections.</p>

  213. <section id="url-parsing">

  214. <h2>URL Parsing<a class="headerlink" href="#url-parsing" title="Link to this heading">¶</a></h2>

  215. <p>The URL parsing functions focus on splitting a URL string into its components,

  216. or on combining URL components into a URL string.</p>

  217. <dl class="py function">

  218. <dt class="sig sig-object py" id="urllib.parse.urlparse">

  219. <span class="sig-prename descclassname"><span class="pre">urllib.parse.</span></span><span class="sig-name descname"><span class="pre">urlparse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urlstring</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scheme</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_fragments</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#urllib.parse.urlparse" title="Link to this definition">¶</a></dt>

  220. <dd><p>Parse a URL into six components, returning a 6-item <a class="reference internal" href="../glossary.html#term-named-tuple"><span class="xref std std-term">named tuple</span></a>.  This

  221. corresponds to the general structure of a URL:

  222. <code class="docutils literal notranslate"><span class="pre">scheme://netloc/path;parameters?query#fragment</span></code>.

  223. Each tuple item is a string, possibly empty. The components are not broken up

  224. into smaller parts (for example, the network location is a single string), and %

  225. escapes are not expanded. The delimiters as shown above are not part of the

  226. result, except for a leading slash in the <em>path</em> component, which is retained if

  227. present.  For example:</p>

  228. <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">urllib.parse</span> <span class="kn">import</span> <span class="n">urlparse</span>

  229. <span class="gp">&gt;&gt;&gt; </span><span class="n">urlparse</span><span class="p">(</span><span class="s2">&quot;scheme://netloc/path;parameters?query#fragment&quot;</span><span class="p">)</span>

  230. <span class="go">ParseResult(scheme=&#39;scheme&#39;, netloc=&#39;netloc&#39;, path=&#39;/path;parameters&#39;, params=&#39;&#39;,</span>

  231. <span class="go">            query=&#39;query&#39;, fragment=&#39;fragment&#39;)</span>

  232. <span class="gp">&gt;&gt;&gt; </span><span class="n">o</span> <span class="o">=</span> <span class="n">urlparse</span><span class="p">(</span><span class="s2">&quot;http://docs.python.org:80/3/library/urllib.parse.html?&quot;</span>

  233. <span class="gp">... </span>             <span class="s2">&quot;highlight=params#url-parsing&quot;</span><span class="p">)</span>

  234. <span class="gp">&gt;&gt;&gt; </span><span class="n">o</span>

  235. <span class="go">ParseResult(scheme=&#39;http&#39;, netloc=&#39;docs.python.org:80&#39;,</span>

  236. <span class="go">            path=&#39;/3/library/urllib.parse.html&#39;, params=&#39;&#39;,</span>

  237. <span class="go">            query=&#39;highlight=params&#39;, fragment=&#39;url-parsing&#39;)</span>

  238. <span class="gp">&gt;&gt;&gt; </span><span class="n">o</span><span class="o">.</span><span class="n">scheme</span>

  239. <span class="go">&#39;http&#39;</span>

  240. <span class="gp">&gt;&gt;&gt; </span><span class="n">o</span><span class="o">.</span><span class="n">netloc</span>

  241. <span class="go">&#39;docs.python.org:80&#39;</span>

  242. <span class="gp">&gt;&gt;&gt; </span><span class="n">o</span><span class="o">.</span><span class="n">hostname</span>

  243. <span class="go">&#39;docs.python.org&#39;</span>

  244. <span class="gp">&gt;&gt;&gt; </span><span class="n">o</span><span class="o">.</span><span class="n">port</span>

  245. <span class="go">80</span>

  246. <span class="gp">&gt;&gt;&gt; </span><span class="n">o</span><span class="o">.</span><span class="n">_replace</span><span class="p">(</span><span class="n">fragment</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">geturl</span><span class="p">()</span>

  247. <span class="go">&#39;http://docs.python.org:80/3/library/urllib.parse.html?highlight=params&#39;</span>

  248. </pre></div>

  249. </div>

  250. <p>Following the syntax specifications in <span class="target" id="index-1"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc1808.html"><strong>RFC 1808</strong></a>, urlparse recognizes

  251. a netloc only if it is properly introduced by ‘//’.  Otherwise the

  252. input is presumed to be a relative URL and thus to start with

  253. a path component.</p>

  254. <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">urllib.parse</span> <span class="kn">import</span> <span class="n">urlparse</span>

  255. <span class="gp">&gt;&gt;&gt; </span><span class="n">urlparse</span><span class="p">(</span><span class="s1">&#39;//www.cwi.nl:80/</span><span class="si">%7E</span><span class="s1">guido/Python.html&#39;</span><span class="p">)</span>

  256. <span class="go">ParseResult(scheme=&#39;&#39;, netloc=&#39;www.cwi.nl:80&#39;, path=&#39;/%7Eguido/Python.html&#39;,</span>

  257. <span class="go">            params=&#39;&#39;, query=&#39;&#39;, fragment=&#39;&#39;)</span>

  258. <span class="gp">&gt;&gt;&gt; </span><span class="n">urlparse</span><span class="p">(</span><span class="s1">&#39;www.cwi.nl/</span><span class="si">%7E</span><span class="s1">guido/Python.html&#39;</span><span class="p">)</span>

  259. <span class="go">ParseResult(scheme=&#39;&#39;, netloc=&#39;&#39;, path=&#39;www.cwi.nl/%7Eguido/Python.html&#39;,</span>

  260. <span class="go">            params=&#39;&#39;, query=&#39;&#39;, fragment=&#39;&#39;)</span>

  261. <span class="gp">&gt;&gt;&gt; </span><span class="n">urlparse</span><span class="p">(</span><span class="s1">&#39;help/Python.html&#39;</span><span class="p">)</span>

  262. <span class="go">ParseResult(scheme=&#39;&#39;, netloc=&#39;&#39;, path=&#39;help/Python.html&#39;, params=&#39;&#39;,</span>

  263. <span class="go">            query=&#39;&#39;, fragment=&#39;&#39;)</span>

  264. </pre></div>

  265. </div>

  266. <p>The <em>scheme</em> argument gives the default addressing scheme, to be

  267. used only if the URL does not specify one.  It should be the same type

  268. (text or bytes) as <em>urlstring</em>, except that the default value <code class="docutils literal notranslate"><span class="pre">''</span></code> is

  269. always allowed, and is automatically converted to <code class="docutils literal notranslate"><span class="pre">b''</span></code> if appropriate.</p>

  270. <p>If the <em>allow_fragments</em> argument is false, fragment identifiers are not

  271. recognized.  Instead, they are parsed as part of the path, parameters

  272. or query component, and <code class="xref py py-attr docutils literal notranslate"><span class="pre">fragment</span></code> is set to the empty string in

  273. the return value.</p>

  274. <p>The return value is a <a class="reference internal" href="../glossary.html#term-named-tuple"><span class="xref std std-term">named tuple</span></a>, which means that its items can

  275. be accessed by index or as named attributes, which are:</p>

  276. <table class="docutils align-default">

  277. <thead>

  278. <tr class="row-odd"><th class="head"><p>Attribute</p></th>

  279. <th class="head"><p>Index</p></th>

  280. <th class="head"><p>Value</p></th>

  281. <th class="head"><p>Value if not present</p></th>

  282. </tr>

  283. </thead>

  284. <tbody>

  285. <tr class="row-even"><td><p><code class="xref py py-attr docutils literal notranslate"><span class="pre">scheme</span></code></p></td>

  286. <td><p>0</p></td>

  287. <td><p>URL scheme specifier</p></td>

  288. <td><p><em>scheme</em> parameter</p></td>

  289. </tr>

  290. <tr class="row-odd"><td><p><code class="xref py py-attr docutils literal notranslate"><span class="pre">netloc</span></code></p></td>

  291. <td><p>1</p></td>

  292. <td><p>Network location part</p></td>

  293. <td><p>empty string</p></td>

  294. </tr>

  295. <tr class="row-even"><td><p><code class="xref py py-attr docutils literal notranslate"><span class="pre">path</span></code></p></td>

  296. <td><p>2</p></td>

  297. <td><p>Hierarchical path</p></td>

  298. <td><p>empty string</p></td>

  299. </tr>

  300. <tr class="row-odd"><td><p><code class="xref py py-attr docutils literal notranslate"><span class="pre">params</span></code></p></td>

  301. <td><p>3</p></td>

  302. <td><p>Parameters for last

  303. path element</p></td>

  304. <td><p>empty string</p></td>

  305. </tr>

  306. <tr class="row-even"><td><p><code class="xref py py-attr docutils literal notranslate"><span class="pre">query</span></code></p></td>

  307. <td><p>4</p></td>

  308. <td><p>Query component</p></td>

  309. <td><p>empty string</p></td>

  310. </tr>

  311. <tr class="row-odd"><td><p><code class="xref py py-attr docutils literal notranslate"><span class="pre">fragment</span></code></p></td>

  312. <td><p>5</p></td>

  313. <td><p>Fragment identifier</p></td>

  314. <td><p>empty string</p></td>

  315. </tr>

  316. <tr class="row-even"><td><p><code class="xref py py-attr docutils literal notranslate"><span class="pre">username</span></code></p></td>

  317. <td></td>

  318. <td><p>User name</p></td>

  319. <td><p><a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate"><span class="pre">None</span></code></a></p></td>

  320. </tr>

  321. <tr class="row-odd"><td><p><code class="xref py py-attr docutils literal notranslate"><span class="pre">password</span></code></p></td>

  322. <td></td>

  323. <td><p>Password</p></td>

  324. <td><p><a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate"><span class="pre">None</span></code></a></p></td>

  325. </tr>

  326. <tr class="row-even"><td><p><code class="xref py py-attr docutils literal notranslate"><span class="pre">hostname</span></code></p></td>

  327. <td></td>

  328. <td><p>Host name (lower case)</p></td>

  329. <td><p><a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate"><span class="pre">None</span></code></a></p></td>

  330. </tr>

  331. <tr class="row-odd"><td><p><code class="xref py py-attr docutils literal notranslate"><span class="pre">port</span></code></p></td>

  332. <td></td>

  333. <td><p>Port number as integer,

  334. if present</p></td>

  335. <td><p><a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate"><span class="pre">None</span></code></a></p></td>

  336. </tr>

  337. </tbody>

  338. </table>

  339. <p>Reading the <code class="xref py py-attr docutils literal notranslate"><span class="pre">port</span></code> attribute will raise a <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> if

  340. an invalid port is specified in the URL.  See section

  341. <a class="reference internal" href="#urlparse-result-object"><span class="std std-ref">Structured Parse Results</span></a> for more information on the result object.</p>

  342. <p>Unmatched square brackets in the <code class="xref py py-attr docutils literal notranslate"><span class="pre">netloc</span></code> attribute will raise a

  343. <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a>.</p>

  344. <p>Characters in the <code class="xref py py-attr docutils literal notranslate"><span class="pre">netloc</span></code> attribute that decompose under NFKC

  345. normalization (as used by the IDNA encoding) into any of <code class="docutils literal notranslate"><span class="pre">/</span></code>, <code class="docutils literal notranslate"><span class="pre">?</span></code>,

  346. <code class="docutils literal notranslate"><span class="pre">#</span></code>, <code class="docutils literal notranslate"><span class="pre">&#64;</span></code>, or <code class="docutils literal notranslate"><span class="pre">:</span></code> will raise a <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a>. If the URL is

  347. decomposed before parsing, no error will be raised.</p>

  348. <p>As is the case with all named tuples, the subclass has a few additional methods

  349. and attributes that are particularly useful. One such method is <code class="xref py py-meth docutils literal notranslate"><span class="pre">_replace()</span></code>.

  350. The <code class="xref py py-meth docutils literal notranslate"><span class="pre">_replace()</span></code> method will return a new ParseResult object replacing specified

  351. fields with new values.</p>

  352. <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">urllib.parse</span> <span class="kn">import</span> <span class="n">urlparse</span>

  353. <span class="gp">&gt;&gt;&gt; </span><span class="n">u</span> <span class="o">=</span> <span class="n">urlparse</span><span class="p">(</span><span class="s1">&#39;//www.cwi.nl:80/</span><span class="si">%7E</span><span class="s1">guido/Python.html&#39;</span><span class="p">)</span>

  354. <span class="gp">&gt;&gt;&gt; </span><span class="n">u</span>

  355. <span class="go">ParseResult(scheme=&#39;&#39;, netloc=&#39;www.cwi.nl:80&#39;, path=&#39;/%7Eguido/Python.html&#39;,</span>

  356. <span class="go">            params=&#39;&#39;, query=&#39;&#39;, fragment=&#39;&#39;)</span>

  357. <span class="gp">&gt;&gt;&gt; </span><span class="n">u</span><span class="o">.</span><span class="n">_replace</span><span class="p">(</span><span class="n">scheme</span><span class="o">=</span><span class="s1">&#39;http&#39;</span><span class="p">)</span>

  358. <span class="go">ParseResult(scheme=&#39;http&#39;, netloc=&#39;www.cwi.nl:80&#39;, path=&#39;/%7Eguido/Python.html&#39;,</span>

  359. <span class="go">            params=&#39;&#39;, query=&#39;&#39;, fragment=&#39;&#39;)</span>

  360. </pre></div>

  361. </div>

  362. <div class="admonition warning">

  363. <p class="admonition-title">Warning</p>

  364. <p><a class="reference internal" href="#urllib.parse.urlparse" title="urllib.parse.urlparse"><code class="xref py py-func docutils literal notranslate"><span class="pre">urlparse()</span></code></a> does not perform validation.  See <a class="reference internal" href="#url-parsing-security"><span class="std std-ref">URL parsing

  365. security</span></a> for details.</p>

  366. </div>

  367. <div class="versionchanged">

  368. <p><span class="versionmodified changed">Changed in version 3.2: </span>Added IPv6 URL parsing capabilities.</p>

  369. </div>

  370. <div class="versionchanged">

  371. <p><span class="versionmodified changed">Changed in version 3.3: </span>The fragment is now parsed for all URL schemes (unless <em>allow_fragment</em> is

  372. false), in accordance with <span class="target" id="index-2"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3986.html"><strong>RFC 3986</strong></a>.  Previously, an allowlist of

  373. schemes that support fragments existed.</p>

  374. </div>

  375. <div class="versionchanged">

  376. <p><span class="versionmodified changed">Changed in version 3.6: </span>Out-of-range port numbers now raise <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a>, instead of

  377. returning <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate"><span class="pre">None</span></code></a>.</p>

  378. </div>

  379. <div class="versionchanged">

  380. <p><span class="versionmodified changed">Changed in version 3.8: </span>Characters that affect netloc parsing under NFKC normalization will

  381. now raise <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a>.</p>

  382. </div>

  383. </dd></dl>

  384. 

  385. <dl class="py function">

  386. <dt class="sig sig-object py" id="urllib.parse.parse_qs">

  387. <span class="sig-prename descclassname"><span class="pre">urllib.parse.</span></span><span class="sig-name descname"><span class="pre">parse_qs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">qs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keep_blank_values</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict_parsing</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'utf-8'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'replace'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_num_fields</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separator</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'&amp;'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#urllib.parse.parse_qs" title="Link to this definition">¶</a></dt>

  388. <dd><p>Parse a query string given as a string argument (data of type

  389. <em class="mimetype">application/x-www-form-urlencoded</em>).  Data are returned as a

  390. dictionary.  The dictionary keys are the unique query variable names and the

  391. values are lists of values for each name.</p>

  392. <p>The optional argument <em>keep_blank_values</em> is a flag indicating whether blank

  393. values in percent-encoded queries should be treated as blank strings. A true value

  394. indicates that blanks should be retained as  blank strings.  The default false

  395. value indicates that blank values are to be ignored and treated as if they were

  396. not included.</p>

  397. <p>The optional argument <em>strict_parsing</em> is a flag indicating what to do with

  398. parsing errors.  If false (the default), errors are silently ignored.  If true,

  399. errors raise a <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> exception.</p>

  400. <p>The optional <em>encoding</em> and <em>errors</em> parameters specify how to decode

  401. percent-encoded sequences into Unicode characters, as accepted by the

  402. <a class="reference internal" href="stdtypes.html#bytes.decode" title="bytes.decode"><code class="xref py py-meth docutils literal notranslate"><span class="pre">bytes.decode()</span></code></a> method.</p>

  403. <p>The optional argument <em>max_num_fields</em> is the maximum number of fields to

  404. read. If set, then throws a <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> if there are more than

  405. <em>max_num_fields</em> fields read.</p>

  406. <p>The optional argument <em>separator</em> is the symbol to use for separating the

  407. query arguments. It defaults to <code class="docutils literal notranslate"><span class="pre">&amp;</span></code>.</p>

  408. <p>Use the <a class="reference internal" href="#urllib.parse.urlencode" title="urllib.parse.urlencode"><code class="xref py py-func docutils literal notranslate"><span class="pre">urllib.parse.urlencode()</span></code></a> function (with the <code class="docutils literal notranslate"><span class="pre">doseq</span></code>

  409. parameter set to <code class="docutils literal notranslate"><span class="pre">True</span></code>) to convert such dictionaries into query

  410. strings.</p>

  411. <div class="versionchanged">

  412. <p><span class="versionmodified changed">Changed in version 3.2: </span>Add <em>encoding</em> and <em>errors</em> parameters.</p>

  413. </div>

  414. <div class="versionchanged">

  415. <p><span class="versionmodified changed">Changed in version 3.8: </span>Added <em>max_num_fields</em> parameter.</p>

  416. </div>

  417. <div class="versionchanged">

  418. <p><span class="versionmodified changed">Changed in version 3.10: </span>Added <em>separator</em> parameter with the default value of <code class="docutils literal notranslate"><span class="pre">&amp;</span></code>. Python

  419. versions earlier than Python 3.10 allowed using both <code class="docutils literal notranslate"><span class="pre">;</span></code> and <code class="docutils literal notranslate"><span class="pre">&amp;</span></code> as

  420. query parameter separator. This has been changed to allow only a single

  421. separator key, with <code class="docutils literal notranslate"><span class="pre">&amp;</span></code> as the default separator.</p>

  422. </div>

  423. </dd></dl>

  424. 

  425. <dl class="py function">

  426. <dt class="sig sig-object py" id="urllib.parse.parse_qsl">

  427. <span class="sig-prename descclassname"><span class="pre">urllib.parse.</span></span><span class="sig-name descname"><span class="pre">parse_qsl</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">qs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keep_blank_values</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict_parsing</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'utf-8'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'replace'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_num_fields</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separator</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'&amp;'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#urllib.parse.parse_qsl" title="Link to this definition">¶</a></dt>

  428. <dd><p>Parse a query string given as a string argument (data of type

  429. <em class="mimetype">application/x-www-form-urlencoded</em>).  Data are returned as a list of

  430. name, value pairs.</p>

  431. <p>The optional argument <em>keep_blank_values</em> is a flag indicating whether blank

  432. values in percent-encoded queries should be treated as blank strings. A true value

  433. indicates that blanks should be retained as  blank strings.  The default false

  434. value indicates that blank values are to be ignored and treated as if they were

  435. not included.</p>

  436. <p>The optional argument <em>strict_parsing</em> is a flag indicating what to do with

  437. parsing errors.  If false (the default), errors are silently ignored.  If true,

  438. errors raise a <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> exception.</p>

  439. <p>The optional <em>encoding</em> and <em>errors</em> parameters specify how to decode

  440. percent-encoded sequences into Unicode characters, as accepted by the

  441. <a class="reference internal" href="stdtypes.html#bytes.decode" title="bytes.decode"><code class="xref py py-meth docutils literal notranslate"><span class="pre">bytes.decode()</span></code></a> method.</p>

  442. <p>The optional argument <em>max_num_fields</em> is the maximum number of fields to

  443. read. If set, then throws a <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> if there are more than

  444. <em>max_num_fields</em> fields read.</p>

  445. <p>The optional argument <em>separator</em> is the symbol to use for separating the

  446. query arguments. It defaults to <code class="docutils literal notranslate"><span class="pre">&amp;</span></code>.</p>

  447. <p>Use the <a class="reference internal" href="#urllib.parse.urlencode" title="urllib.parse.urlencode"><code class="xref py py-func docutils literal notranslate"><span class="pre">urllib.parse.urlencode()</span></code></a> function to convert such lists of pairs into

  448. query strings.</p>

  449. <div class="versionchanged">

  450. <p><span class="versionmodified changed">Changed in version 3.2: </span>Add <em>encoding</em> and <em>errors</em> parameters.</p>

  451. </div>

  452. <div class="versionchanged">

  453. <p><span class="versionmodified changed">Changed in version 3.8: </span>Added <em>max_num_fields</em> parameter.</p>

  454. </div>

  455. <div class="versionchanged">

  456. <p><span class="versionmodified changed">Changed in version 3.10: </span>Added <em>separator</em> parameter with the default value of <code class="docutils literal notranslate"><span class="pre">&amp;</span></code>. Python

  457. versions earlier than Python 3.10 allowed using both <code class="docutils literal notranslate"><span class="pre">;</span></code> and <code class="docutils literal notranslate"><span class="pre">&amp;</span></code> as

  458. query parameter separator. This has been changed to allow only a single

  459. separator key, with <code class="docutils literal notranslate"><span class="pre">&amp;</span></code> as the default separator.</p>

  460. </div>

  461. </dd></dl>

  462. 

  463. <dl class="py function">

  464. <dt class="sig sig-object py" id="urllib.parse.urlunparse">

  465. <span class="sig-prename descclassname"><span class="pre">urllib.parse.</span></span><span class="sig-name descname"><span class="pre">urlunparse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parts</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#urllib.parse.urlunparse" title="Link to this definition">¶</a></dt>

  466. <dd><p>Construct a URL from a tuple as returned by <code class="docutils literal notranslate"><span class="pre">urlparse()</span></code>. The <em>parts</em>

  467. argument can be any six-item iterable. This may result in a slightly

  468. different, but equivalent URL, if the URL that was parsed originally had

  469. unnecessary delimiters (for example, a <code class="docutils literal notranslate"><span class="pre">?</span></code> with an empty query; the RFC

  470. states that these are equivalent).</p>

  471. </dd></dl>

  472. 

  473. <dl class="py function">

  474. <dt class="sig sig-object py" id="urllib.parse.urlsplit">

  475. <span class="sig-prename descclassname"><span class="pre">urllib.parse.</span></span><span class="sig-name descname"><span class="pre">urlsplit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urlstring</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scheme</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_fragments</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#urllib.parse.urlsplit" title="Link to this definition">¶</a></dt>

  476. <dd><p>This is similar to <a class="reference internal" href="#urllib.parse.urlparse" title="urllib.parse.urlparse"><code class="xref py py-func docutils literal notranslate"><span class="pre">urlparse()</span></code></a>, but does not split the params from the URL.

  477. This should generally be used instead of <a class="reference internal" href="#urllib.parse.urlparse" title="urllib.parse.urlparse"><code class="xref py py-func docutils literal notranslate"><span class="pre">urlparse()</span></code></a> if the more recent URL

  478. syntax allowing parameters to be applied to each segment of the <em>path</em> portion

  479. of the URL (see <span class="target" id="index-3"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2396.html"><strong>RFC 2396</strong></a>) is wanted.  A separate function is needed to

  480. separate the path segments and parameters.  This function returns a 5-item

  481. <a class="reference internal" href="../glossary.html#term-named-tuple"><span class="xref std std-term">named tuple</span></a>:</p>

  482. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">addressing</span> <span class="n">scheme</span><span class="p">,</span> <span class="n">network</span> <span class="n">location</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">query</span><span class="p">,</span> <span class="n">fragment</span> <span class="n">identifier</span><span class="p">)</span><span class="o">.</span>

  483. </pre></div>

  484. </div>

  485. <p>The return value is a <a class="reference internal" href="../glossary.html#term-named-tuple"><span class="xref std std-term">named tuple</span></a>, its items can be accessed by index

  486. or as named attributes:</p>

  487. <table class="docutils align-default">

  488. <thead>

  489. <tr class="row-odd"><th class="head"><p>Attribute</p></th>

  490. <th class="head"><p>Index</p></th>

  491. <th class="head"><p>Value</p></th>

  492. <th class="head"><p>Value if not present</p></th>

  493. </tr>

  494. </thead>

  495. <tbody>

  496. <tr class="row-even"><td><p><code class="xref py py-attr docutils literal notranslate"><span class="pre">scheme</span></code></p></td>

  497. <td><p>0</p></td>

  498. <td><p>URL scheme specifier</p></td>

  499. <td><p><em>scheme</em> parameter</p></td>

  500. </tr>

  501. <tr class="row-odd"><td><p><code class="xref py py-attr docutils literal notranslate"><span class="pre">netloc</span></code></p></td>

  502. <td><p>1</p></td>

  503. <td><p>Network location part</p></td>

  504. <td><p>empty string</p></td>

  505. </tr>

  506. <tr class="row-even"><td><p><code class="xref py py-attr docutils literal notranslate"><span class="pre">path</span></code></p></td>

  507. <td><p>2</p></td>

  508. <td><p>Hierarchical path</p></td>

  509. <td><p>empty string</p></td>

  510. </tr>

  511. <tr class="row-odd"><td><p><code class="xref py py-attr docutils literal notranslate"><span class="pre">query</span></code></p></td>

  512. <td><p>3</p></td>

  513. <td><p>Query component</p></td>

  514. <td><p>empty string</p></td>

  515. </tr>

  516. <tr class="row-even"><td><p><code class="xref py py-attr docutils literal notranslate"><span class="pre">fragment</span></code></p></td>

  517. <td><p>4</p></td>

  518. <td><p>Fragment identifier</p></td>

  519. <td><p>empty string</p></td>

  520. </tr>

  521. <tr class="row-odd"><td><p><code class="xref py py-attr docutils literal notranslate"><span class="pre">username</span></code></p></td>

  522. <td></td>

  523. <td><p>User name</p></td>

  524. <td><p><a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate"><span class="pre">None</span></code></a></p></td>

  525. </tr>

  526. <tr class="row-even"><td><p><code class="xref py py-attr docutils literal notranslate"><span class="pre">password</span></code></p></td>

  527. <td></td>

  528. <td><p>Password</p></td>

  529. <td><p><a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate"><span class="pre">None</span></code></a></p></td>

  530. </tr>

  531. <tr class="row-odd"><td><p><code class="xref py py-attr docutils literal notranslate"><span class="pre">hostname</span></code></p></td>

  532. <td></td>

  533. <td><p>Host name (lower case)</p></td>

  534. <td><p><a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate"><span class="pre">None</span></code></a></p></td>

  535. </tr>

  536. <tr class="row-even"><td><p><code class="xref py py-attr docutils literal notranslate"><span class="pre">port</span></code></p></td>

  537. <td></td>

  538. <td><p>Port number as integer,

  539. if present</p></td>

  540. <td><p><a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate"><span class="pre">None</span></code></a></p></td>

  541. </tr>

  542. </tbody>

  543. </table>

  544. <p>Reading the <code class="xref py py-attr docutils literal notranslate"><span class="pre">port</span></code> attribute will raise a <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> if

  545. an invalid port is specified in the URL.  See section

  546. <a class="reference internal" href="#urlparse-result-object"><span class="std std-ref">Structured Parse Results</span></a> for more information on the result object.</p>

  547. <p>Unmatched square brackets in the <code class="xref py py-attr docutils literal notranslate"><span class="pre">netloc</span></code> attribute will raise a

  548. <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a>.</p>

  549. <p>Characters in the <code class="xref py py-attr docutils literal notranslate"><span class="pre">netloc</span></code> attribute that decompose under NFKC

  550. normalization (as used by the IDNA encoding) into any of <code class="docutils literal notranslate"><span class="pre">/</span></code>, <code class="docutils literal notranslate"><span class="pre">?</span></code>,

  551. <code class="docutils literal notranslate"><span class="pre">#</span></code>, <code class="docutils literal notranslate"><span class="pre">&#64;</span></code>, or <code class="docutils literal notranslate"><span class="pre">:</span></code> will raise a <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a>. If the URL is

  552. decomposed before parsing, no error will be raised.</p>

  553. <p>Following some of the <a class="reference external" href="https://url.spec.whatwg.org/#concept-basic-url-parser">WHATWG spec</a> that updates RFC 3986, leading C0

  554. control and space characters are stripped from the URL. <code class="docutils literal notranslate"><span class="pre">\n</span></code>,

  555. <code class="docutils literal notranslate"><span class="pre">\r</span></code> and tab <code class="docutils literal notranslate"><span class="pre">\t</span></code> characters are removed from the URL at any position.</p>

  556. <div class="admonition warning">

  557. <p class="admonition-title">Warning</p>

  558. <p><a class="reference internal" href="#urllib.parse.urlsplit" title="urllib.parse.urlsplit"><code class="xref py py-func docutils literal notranslate"><span class="pre">urlsplit()</span></code></a> does not perform validation.  See <a class="reference internal" href="#url-parsing-security"><span class="std std-ref">URL parsing

  559. security</span></a> for details.</p>

  560. </div>

  561. <div class="versionchanged">

  562. <p><span class="versionmodified changed">Changed in version 3.6: </span>Out-of-range port numbers now raise <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a>, instead of

  563. returning <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate"><span class="pre">None</span></code></a>.</p>

  564. </div>

  565. <div class="versionchanged">

  566. <p><span class="versionmodified changed">Changed in version 3.8: </span>Characters that affect netloc parsing under NFKC normalization will

  567. now raise <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a>.</p>

  568. </div>

  569. <div class="versionchanged">

  570. <p><span class="versionmodified changed">Changed in version 3.10: </span>ASCII newline and tab characters are stripped from the URL.</p>

  571. </div>

  572. <div class="versionchanged">

  573. <p><span class="versionmodified changed">Changed in version 3.12: </span>Leading WHATWG C0 control and space characters are stripped from the URL.</p>

  574. </div>

  575. </dd></dl>

  576. 

  577. <dl class="py function">

  578. <dt class="sig sig-object py" id="urllib.parse.urlunsplit">

  579. <span class="sig-prename descclassname"><span class="pre">urllib.parse.</span></span><span class="sig-name descname"><span class="pre">urlunsplit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parts</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#urllib.parse.urlunsplit" title="Link to this definition">¶</a></dt>

  580. <dd><p>Combine the elements of a tuple as returned by <a class="reference internal" href="#urllib.parse.urlsplit" title="urllib.parse.urlsplit"><code class="xref py py-func docutils literal notranslate"><span class="pre">urlsplit()</span></code></a> into a

  581. complete URL as a string. The <em>parts</em> argument can be any five-item

  582. iterable. This may result in a slightly different, but equivalent URL, if the

  583. URL that was parsed originally had unnecessary delimiters (for example, a ?

  584. with an empty query; the RFC states that these are equivalent).</p>

  585. </dd></dl>

  586. 

  587. <dl class="py function">

  588. <dt class="sig sig-object py" id="urllib.parse.urljoin">

  589. <span class="sig-prename descclassname"><span class="pre">urllib.parse.</span></span><span class="sig-name descname"><span class="pre">urljoin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_fragments</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#urllib.parse.urljoin" title="Link to this definition">¶</a></dt>

  590. <dd><p>Construct a full (“absolute”) URL by combining a “base URL” (<em>base</em>) with

  591. another URL (<em>url</em>).  Informally, this uses components of the base URL, in

  592. particular the addressing scheme, the network location and (part of) the

  593. path, to provide missing components in the relative URL.  For example:</p>

  594. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">urllib.parse</span> <span class="kn">import</span> <span class="n">urljoin</span>

  595. <span class="gp">&gt;&gt;&gt; </span><span class="n">urljoin</span><span class="p">(</span><span class="s1">&#39;http://www.cwi.nl/</span><span class="si">%7E</span><span class="s1">guido/Python.html&#39;</span><span class="p">,</span> <span class="s1">&#39;FAQ.html&#39;</span><span class="p">)</span>

  596. <span class="go">&#39;http://www.cwi.nl/%7Eguido/FAQ.html&#39;</span>

  597. </pre></div>

  598. </div>

  599. <p>The <em>allow_fragments</em> argument has the same meaning and default as for

  600. <a class="reference internal" href="#urllib.parse.urlparse" title="urllib.parse.urlparse"><code class="xref py py-func docutils literal notranslate"><span class="pre">urlparse()</span></code></a>.</p>

  601. <div class="admonition note">

  602. <p class="admonition-title">Note</p>

  603. <p>If <em>url</em> is an absolute URL (that is, it starts with <code class="docutils literal notranslate"><span class="pre">//</span></code> or <code class="docutils literal notranslate"><span class="pre">scheme://</span></code>),

  604. the <em>url</em>’s hostname and/or scheme will be present in the result.  For example:</p>

  605. <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">urljoin</span><span class="p">(</span><span class="s1">&#39;http://www.cwi.nl/</span><span class="si">%7E</span><span class="s1">guido/Python.html&#39;</span><span class="p">,</span>

  606. <span class="gp">... </span>        <span class="s1">&#39;//www.python.org/</span><span class="si">%7E</span><span class="s1">guido&#39;</span><span class="p">)</span>

  607. <span class="go">&#39;http://www.python.org/%7Eguido&#39;</span>

  608. </pre></div>

  609. </div>

  610. <p>If you do not want that behavior, preprocess the <em>url</em> with <a class="reference internal" href="#urllib.parse.urlsplit" title="urllib.parse.urlsplit"><code class="xref py py-func docutils literal notranslate"><span class="pre">urlsplit()</span></code></a> and

  611. <a class="reference internal" href="#urllib.parse.urlunsplit" title="urllib.parse.urlunsplit"><code class="xref py py-func docutils literal notranslate"><span class="pre">urlunsplit()</span></code></a>, removing possible <em>scheme</em> and <em>netloc</em> parts.</p>

  612. </div>

  613. <div class="versionchanged">

  614. <p><span class="versionmodified changed">Changed in version 3.5: </span>Behavior updated to match the semantics defined in <span class="target" id="index-4"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3986.html"><strong>RFC 3986</strong></a>.</p>

  615. </div>

  616. </dd></dl>

  617. 

  618. <dl class="py function">

  619. <dt class="sig sig-object py" id="urllib.parse.urldefrag">

  620. <span class="sig-prename descclassname"><span class="pre">urllib.parse.</span></span><span class="sig-name descname"><span class="pre">urldefrag</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#urllib.parse.urldefrag" title="Link to this definition">¶</a></dt>

  621. <dd><p>If <em>url</em> contains a fragment identifier, return a modified version of <em>url</em>

  622. with no fragment identifier, and the fragment identifier as a separate

  623. string.  If there is no fragment identifier in <em>url</em>, return <em>url</em> unmodified

  624. and an empty string.</p>

  625. <p>The return value is a <a class="reference internal" href="../glossary.html#term-named-tuple"><span class="xref std std-term">named tuple</span></a>, its items can be accessed by index

  626. or as named attributes:</p>

  627. <table class="docutils align-default">

  628. <thead>

  629. <tr class="row-odd"><th class="head"><p>Attribute</p></th>

  630. <th class="head"><p>Index</p></th>

  631. <th class="head"><p>Value</p></th>

  632. <th class="head"><p>Value if not present</p></th>

  633. </tr>

  634. </thead>

  635. <tbody>

  636. <tr class="row-even"><td><p><code class="xref py py-attr docutils literal notranslate"><span class="pre">url</span></code></p></td>

  637. <td><p>0</p></td>

  638. <td><p>URL with no fragment</p></td>

  639. <td><p>empty string</p></td>

  640. </tr>

  641. <tr class="row-odd"><td><p><code class="xref py py-attr docutils literal notranslate"><span class="pre">fragment</span></code></p></td>

  642. <td><p>1</p></td>

  643. <td><p>Fragment identifier</p></td>

  644. <td><p>empty string</p></td>

  645. </tr>

  646. </tbody>

  647. </table>

  648. <p>See section <a class="reference internal" href="#urlparse-result-object"><span class="std std-ref">Structured Parse Results</span></a> for more information on the result

  649. object.</p>

  650. <div class="versionchanged">

  651. <p><span class="versionmodified changed">Changed in version 3.2: </span>Result is a structured object rather than a simple 2-tuple.</p>

  652. </div>

  653. </dd></dl>

  654. 

  655. <dl class="py function">

  656. <dt class="sig sig-object py" id="urllib.parse.unwrap">

  657. <span class="sig-prename descclassname"><span class="pre">urllib.parse.</span></span><span class="sig-name descname"><span class="pre">unwrap</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#urllib.parse.unwrap" title="Link to this definition">¶</a></dt>

  658. <dd><p>Extract the url from a wrapped URL (that is, a string formatted as

  659. <code class="docutils literal notranslate"><span class="pre">&lt;URL:scheme://host/path&gt;</span></code>, <code class="docutils literal notranslate"><span class="pre">&lt;scheme://host/path&gt;</span></code>, <code class="docutils literal notranslate"><span class="pre">URL:scheme://host/path</span></code>

  660. or <code class="docutils literal notranslate"><span class="pre">scheme://host/path</span></code>). If <em>url</em> is not a wrapped URL, it is returned

  661. without changes.</p>

  662. </dd></dl>

  663. 

  664. </section>

  665. <section id="url-parsing-security">

  666. <span id="id1"></span><h2>URL parsing security<a class="headerlink" href="#url-parsing-security" title="Link to this heading">¶</a></h2>

  667. <p>The <a class="reference internal" href="#urllib.parse.urlsplit" title="urllib.parse.urlsplit"><code class="xref py py-func docutils literal notranslate"><span class="pre">urlsplit()</span></code></a> and <a class="reference internal" href="#urllib.parse.urlparse" title="urllib.parse.urlparse"><code class="xref py py-func docutils literal notranslate"><span class="pre">urlparse()</span></code></a> APIs do not perform <strong>validation</strong> of

  668. inputs.  They may not raise errors on inputs that other applications consider

  669. invalid.  They may also succeed on some inputs that might not be considered

  670. URLs elsewhere.  Their purpose is for practical functionality rather than

  671. purity.</p>

  672. <p>Instead of raising an exception on unusual input, they may instead return some

  673. component parts as empty strings. Or components may contain more than perhaps

  674. they should.</p>

  675. <p>We recommend that users of these APIs where the values may be used anywhere

  676. with security implications code defensively. Do some verification within your

  677. code before trusting a returned component part.  Does that <code class="docutils literal notranslate"><span class="pre">scheme</span></code> make

  678. sense?  Is that a sensible <code class="docutils literal notranslate"><span class="pre">path</span></code>?  Is there anything strange about that

  679. <code class="docutils literal notranslate"><span class="pre">hostname</span></code>?  etc.</p>

  680. <p>What constitutes a URL is not universally well defined.  Different applications

  681. have different needs and desired constraints.  For instance the living <a class="reference external" href="https://url.spec.whatwg.org/#concept-basic-url-parser">WHATWG

  682. spec</a> describes what user facing web clients such as a web browser require.

  683. While <span class="target" id="index-5"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3986.html"><strong>RFC 3986</strong></a> is more general.  These functions incorporate some aspects of

  684. both, but cannot be claimed compliant with either.  The APIs and existing user

  685. code with expectations on specific behaviors predate both standards leading us

  686. to be very cautious about making API behavior changes.</p>

  687. </section>

  688. <section id="parsing-ascii-encoded-bytes">

  689. <span id="id2"></span><h2>Parsing ASCII Encoded Bytes<a class="headerlink" href="#parsing-ascii-encoded-bytes" title="Link to this heading">¶</a></h2>

  690. <p>The URL parsing functions were originally designed to operate on character

  691. strings only. In practice, it is useful to be able to manipulate properly

  692. quoted and encoded URLs as sequences of ASCII bytes. Accordingly, the

  693. URL parsing functions in this module all operate on <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> and

  694. <a class="reference internal" href="stdtypes.html#bytearray" title="bytearray"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytearray</span></code></a> objects in addition to <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> objects.</p>

  695. <p>If <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> data is passed in, the result will also contain only

  696. <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> data. If <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> or <a class="reference internal" href="stdtypes.html#bytearray" title="bytearray"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytearray</span></code></a> data is

  697. passed in, the result will contain only <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> data.</p>

  698. <p>Attempting to mix <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> data with <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> or

  699. <a class="reference internal" href="stdtypes.html#bytearray" title="bytearray"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytearray</span></code></a> in a single function call will result in a

  700. <a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">TypeError</span></code></a> being raised, while attempting to pass in non-ASCII

  701. byte values will trigger <a class="reference internal" href="exceptions.html#UnicodeDecodeError" title="UnicodeDecodeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">UnicodeDecodeError</span></code></a>.</p>

  702. <p>To support easier conversion of result objects between <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> and

  703. <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a>, all return values from URL parsing functions provide

  704. either an <code class="xref py py-meth docutils literal notranslate"><span class="pre">encode()</span></code> method (when the result contains <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>

  705. data) or a <code class="xref py py-meth docutils literal notranslate"><span class="pre">decode()</span></code> method (when the result contains <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a>

  706. data). The signatures of these methods match those of the corresponding

  707. <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> and <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> methods (except that the default encoding

  708. is <code class="docutils literal notranslate"><span class="pre">'ascii'</span></code> rather than <code class="docutils literal notranslate"><span class="pre">'utf-8'</span></code>). Each produces a value of a

  709. corresponding type that contains either <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> data (for

  710. <code class="xref py py-meth docutils literal notranslate"><span class="pre">encode()</span></code> methods) or <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> data (for

  711. <code class="xref py py-meth docutils literal notranslate"><span class="pre">decode()</span></code> methods).</p>

  712. <p>Applications that need to operate on potentially improperly quoted URLs

  713. that may contain non-ASCII data will need to do their own decoding from

  714. bytes to characters before invoking the URL parsing methods.</p>

  715. <p>The behaviour described in this section applies only to the URL parsing

  716. functions. The URL quoting functions use their own rules when producing

  717. or consuming byte sequences as detailed in the documentation of the

  718. individual URL quoting functions.</p>

  719. <div class="versionchanged">

  720. <p><span class="versionmodified changed">Changed in version 3.2: </span>URL parsing functions now accept ASCII encoded byte sequences</p>

  721. </div>

  722. </section>

  723. <section id="structured-parse-results">

  724. <span id="urlparse-result-object"></span><h2>Structured Parse Results<a class="headerlink" href="#structured-parse-results" title="Link to this heading">¶</a></h2>

  725. <p>The result objects from the <a class="reference internal" href="#urllib.parse.urlparse" title="urllib.parse.urlparse"><code class="xref py py-func docutils literal notranslate"><span class="pre">urlparse()</span></code></a>, <a class="reference internal" href="#urllib.parse.urlsplit" title="urllib.parse.urlsplit"><code class="xref py py-func docutils literal notranslate"><span class="pre">urlsplit()</span></code></a>  and

  726. <a class="reference internal" href="#urllib.parse.urldefrag" title="urllib.parse.urldefrag"><code class="xref py py-func docutils literal notranslate"><span class="pre">urldefrag()</span></code></a> functions are subclasses of the <a class="reference internal" href="stdtypes.html#tuple" title="tuple"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a> type.

  727. These subclasses add the attributes listed in the documentation for

  728. those functions, the encoding and decoding support described in the

  729. previous section, as well as an additional method:</p>

  730. <dl class="py method">

  731. <dt class="sig sig-object py" id="urllib.parse.urllib.parse.SplitResult.geturl">

  732. <span class="sig-prename descclassname"><span class="pre">urllib.parse.SplitResult.</span></span><span class="sig-name descname"><span class="pre">geturl</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#urllib.parse.urllib.parse.SplitResult.geturl" title="Link to this definition">¶</a></dt>

  733. <dd><p>Return the re-combined version of the original URL as a string. This may

  734. differ from the original URL in that the scheme may be normalized to lower

  735. case and empty components may be dropped. Specifically, empty parameters,

  736. queries, and fragment identifiers will be removed.</p>

  737. <p>For <a class="reference internal" href="#urllib.parse.urldefrag" title="urllib.parse.urldefrag"><code class="xref py py-func docutils literal notranslate"><span class="pre">urldefrag()</span></code></a> results, only empty fragment identifiers will be removed.

  738. For <a class="reference internal" href="#urllib.parse.urlsplit" title="urllib.parse.urlsplit"><code class="xref py py-func docutils literal notranslate"><span class="pre">urlsplit()</span></code></a> and <a class="reference internal" href="#urllib.parse.urlparse" title="urllib.parse.urlparse"><code class="xref py py-func docutils literal notranslate"><span class="pre">urlparse()</span></code></a> results, all noted changes will be

  739. made to the URL returned by this method.</p>

  740. <p>The result of this method remains unchanged if passed back through the original

  741. parsing function:</p>

  742. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">urllib.parse</span> <span class="kn">import</span> <span class="n">urlsplit</span>

  743. <span class="gp">&gt;&gt;&gt; </span><span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;HTTP://www.Python.org/doc/#&#39;</span>

  744. <span class="gp">&gt;&gt;&gt; </span><span class="n">r1</span> <span class="o">=</span> <span class="n">urlsplit</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>

  745. <span class="gp">&gt;&gt;&gt; </span><span class="n">r1</span><span class="o">.</span><span class="n">geturl</span><span class="p">()</span>

  746. <span class="go">&#39;http://www.Python.org/doc/&#39;</span>

  747. <span class="gp">&gt;&gt;&gt; </span><span class="n">r2</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>

  748. <span class="gp">&gt;&gt;&gt; </span><span class="n">r2</span><span class="o">.</span><span class="n">geturl</span><span class="p">()</span>

  749. <span class="go">&#39;http://www.Python.org/doc/&#39;</span>

  750. </pre></div>

  751. </div>

  752. </dd></dl>

  753. 

  754. <p>The following classes provide the implementations of the structured parse

  755. results when operating on <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> objects:</p>

  756. <dl class="py class">

  757. <dt class="sig sig-object py" id="urllib.parse.DefragResult">

  758. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">urllib.parse.</span></span><span class="sig-name descname"><span class="pre">DefragResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fragment</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#urllib.parse.DefragResult" title="Link to this definition">¶</a></dt>

  759. <dd><p>Concrete class for <a class="reference internal" href="#urllib.parse.urldefrag" title="urllib.parse.urldefrag"><code class="xref py py-func docutils literal notranslate"><span class="pre">urldefrag()</span></code></a> results containing <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>

  760. data. The <code class="xref py py-meth docutils literal notranslate"><span class="pre">encode()</span></code> method returns a <a class="reference internal" href="#urllib.parse.DefragResultBytes" title="urllib.parse.DefragResultBytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">DefragResultBytes</span></code></a>

  761. instance.</p>

  762. <div class="versionadded">

  763. <p><span class="versionmodified added">New in version 3.2.</span></p>

  764. </div>

  765. </dd></dl>

  766. 

  767. <dl class="py class">

  768. <dt class="sig sig-object py" id="urllib.parse.ParseResult">

  769. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">urllib.parse.</span></span><span class="sig-name descname"><span class="pre">ParseResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scheme</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">netloc</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fragment</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#urllib.parse.ParseResult" title="Link to this definition">¶</a></dt>

  770. <dd><p>Concrete class for <a class="reference internal" href="#urllib.parse.urlparse" title="urllib.parse.urlparse"><code class="xref py py-func docutils literal notranslate"><span class="pre">urlparse()</span></code></a> results containing <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>

  771. data. The <code class="xref py py-meth docutils literal notranslate"><span class="pre">encode()</span></code> method returns a <a class="reference internal" href="#urllib.parse.ParseResultBytes" title="urllib.parse.ParseResultBytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParseResultBytes</span></code></a>

  772. instance.</p>

  773. </dd></dl>

  774. 

  775. <dl class="py class">

  776. <dt class="sig sig-object py" id="urllib.parse.SplitResult">

  777. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">urllib.parse.</span></span><span class="sig-name descname"><span class="pre">SplitResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scheme</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">netloc</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fragment</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#urllib.parse.SplitResult" title="Link to this definition">¶</a></dt>

  778. <dd><p>Concrete class for <a class="reference internal" href="#urllib.parse.urlsplit" title="urllib.parse.urlsplit"><code class="xref py py-func docutils literal notranslate"><span class="pre">urlsplit()</span></code></a> results containing <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>

  779. data. The <code class="xref py py-meth docutils literal notranslate"><span class="pre">encode()</span></code> method returns a <a class="reference internal" href="#urllib.parse.SplitResultBytes" title="urllib.parse.SplitResultBytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">SplitResultBytes</span></code></a>

  780. instance.</p>

  781. </dd></dl>

  782. 

  783. <p>The following classes provide the implementations of the parse results when

  784. operating on <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> or <a class="reference internal" href="stdtypes.html#bytearray" title="bytearray"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytearray</span></code></a> objects:</p>

  785. <dl class="py class">

  786. <dt class="sig sig-object py" id="urllib.parse.DefragResultBytes">

  787. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">urllib.parse.</span></span><span class="sig-name descname"><span class="pre">DefragResultBytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fragment</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#urllib.parse.DefragResultBytes" title="Link to this definition">¶</a></dt>

  788. <dd><p>Concrete class for <a class="reference internal" href="#urllib.parse.urldefrag" title="urllib.parse.urldefrag"><code class="xref py py-func docutils literal notranslate"><span class="pre">urldefrag()</span></code></a> results containing <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a>

  789. data. The <code class="xref py py-meth docutils literal notranslate"><span class="pre">decode()</span></code> method returns a <a class="reference internal" href="#urllib.parse.DefragResult" title="urllib.parse.DefragResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">DefragResult</span></code></a>

  790. instance.</p>

  791. <div class="versionadded">

  792. <p><span class="versionmodified added">New in version 3.2.</span></p>

  793. </div>

  794. </dd></dl>

  795. 

  796. <dl class="py class">

  797. <dt class="sig sig-object py" id="urllib.parse.ParseResultBytes">

  798. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">urllib.parse.</span></span><span class="sig-name descname"><span class="pre">ParseResultBytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scheme</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">netloc</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fragment</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#urllib.parse.ParseResultBytes" title="Link to this definition">¶</a></dt>

  799. <dd><p>Concrete class for <a class="reference internal" href="#urllib.parse.urlparse" title="urllib.parse.urlparse"><code class="xref py py-func docutils literal notranslate"><span class="pre">urlparse()</span></code></a> results containing <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a>

  800. data. The <code class="xref py py-meth docutils literal notranslate"><span class="pre">decode()</span></code> method returns a <a class="reference internal" href="#urllib.parse.ParseResult" title="urllib.parse.ParseResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParseResult</span></code></a>

  801. instance.</p>

  802. <div class="versionadded">

  803. <p><span class="versionmodified added">New in version 3.2.</span></p>

  804. </div>

  805. </dd></dl>

  806. 

  807. <dl class="py class">

  808. <dt class="sig sig-object py" id="urllib.parse.SplitResultBytes">

  809. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">urllib.parse.</span></span><span class="sig-name descname"><span class="pre">SplitResultBytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scheme</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">netloc</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fragment</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#urllib.parse.SplitResultBytes" title="Link to this definition">¶</a></dt>

  810. <dd><p>Concrete class for <a class="reference internal" href="#urllib.parse.urlsplit" title="urllib.parse.urlsplit"><code class="xref py py-func docutils literal notranslate"><span class="pre">urlsplit()</span></code></a> results containing <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a>

  811. data. The <code class="xref py py-meth docutils literal notranslate"><span class="pre">decode()</span></code> method returns a <a class="reference internal" href="#urllib.parse.SplitResult" title="urllib.parse.SplitResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">SplitResult</span></code></a>

  812. instance.</p>

  813. <div class="versionadded">

  814. <p><span class="versionmodified added">New in version 3.2.</span></p>

  815. </div>

  816. </dd></dl>

  817. 

  818. </section>

  819. <section id="url-quoting">

  820. <h2>URL Quoting<a class="headerlink" href="#url-quoting" title="Link to this heading">¶</a></h2>

  821. <p>The URL quoting functions focus on taking program data and making it safe

  822. for use as URL components by quoting special characters and appropriately

  823. encoding non-ASCII text. They also support reversing these operations to

  824. recreate the original data from the contents of a URL component if that

  825. task isn’t already covered by the URL parsing functions above.</p>

  826. <dl class="py function">

  827. <dt class="sig sig-object py" id="urllib.parse.quote">

  828. <span class="sig-prename descclassname"><span class="pre">urllib.parse.</span></span><span class="sig-name descname"><span class="pre">quote</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">safe</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'/'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#urllib.parse.quote" title="Link to this definition">¶</a></dt>

  829. <dd><p>Replace special characters in <em>string</em> using the <code class="samp docutils literal notranslate"><span class="pre">%</span><em><span class="pre">xx</span></em></code> escape. Letters,

  830. digits, and the characters <code class="docutils literal notranslate"><span class="pre">'_.-~'</span></code> are never quoted. By default, this

  831. function is intended for quoting the path section of a URL. The optional

  832. <em>safe</em> parameter specifies additional ASCII characters that should not be

  833. quoted — its default value is <code class="docutils literal notranslate"><span class="pre">'/'</span></code>.</p>

  834. <p><em>string</em> may be either a <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> or a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> object.</p>

  835. <div class="versionchanged">

  836. <p><span class="versionmodified changed">Changed in version 3.7: </span>Moved from <span class="target" id="index-6"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2396.html"><strong>RFC 2396</strong></a> to <span class="target" id="index-7"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3986.html"><strong>RFC 3986</strong></a> for quoting URL strings. “~” is now

  837. included in the set of unreserved characters.</p>

  838. </div>

  839. <p>The optional <em>encoding</em> and <em>errors</em> parameters specify how to deal with

  840. non-ASCII characters, as accepted by the <a class="reference internal" href="stdtypes.html#str.encode" title="str.encode"><code class="xref py py-meth docutils literal notranslate"><span class="pre">str.encode()</span></code></a> method.

  841. <em>encoding</em> defaults to <code class="docutils literal notranslate"><span class="pre">'utf-8'</span></code>.

  842. <em>errors</em> defaults to <code class="docutils literal notranslate"><span class="pre">'strict'</span></code>, meaning unsupported characters raise a

  843. <a class="reference internal" href="exceptions.html#UnicodeEncodeError" title="UnicodeEncodeError"><code class="xref py py-class docutils literal notranslate"><span class="pre">UnicodeEncodeError</span></code></a>.

  844. <em>encoding</em> and <em>errors</em> must not be supplied if <em>string</em> is a

  845. <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a>, or a <a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeError</span></code></a> is raised.</p>

  846. <p>Note that <code class="docutils literal notranslate"><span class="pre">quote(string,</span> <span class="pre">safe,</span> <span class="pre">encoding,</span> <span class="pre">errors)</span></code> is equivalent to

  847. <code class="docutils literal notranslate"><span class="pre">quote_from_bytes(string.encode(encoding,</span> <span class="pre">errors),</span> <span class="pre">safe)</span></code>.</p>

  848. <p>Example: <code class="docutils literal notranslate"><span class="pre">quote('/El</span> <span class="pre">Niño/')</span></code> yields <code class="docutils literal notranslate"><span class="pre">'/El%20Ni%C3%B1o/'</span></code>.</p>

  849. </dd></dl>

  850. 

  851. <dl class="py function">

  852. <dt class="sig sig-object py" id="urllib.parse.quote_plus">

  853. <span class="sig-prename descclassname"><span class="pre">urllib.parse.</span></span><span class="sig-name descname"><span class="pre">quote_plus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">safe</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#urllib.parse.quote_plus" title="Link to this definition">¶</a></dt>

  854. <dd><p>Like <a class="reference internal" href="#urllib.parse.quote" title="urllib.parse.quote"><code class="xref py py-func docutils literal notranslate"><span class="pre">quote()</span></code></a>, but also replace spaces with plus signs, as required for

  855. quoting HTML form values when building up a query string to go into a URL.

  856. Plus signs in the original string are escaped unless they are included in

  857. <em>safe</em>.  It also does not have <em>safe</em> default to <code class="docutils literal notranslate"><span class="pre">'/'</span></code>.</p>

  858. <p>Example: <code class="docutils literal notranslate"><span class="pre">quote_plus('/El</span> <span class="pre">Niño/')</span></code> yields <code class="docutils literal notranslate"><span class="pre">'%2FEl+Ni%C3%B1o%2F'</span></code>.</p>

  859. </dd></dl>

  860. 

  861. <dl class="py function">

  862. <dt class="sig sig-object py" id="urllib.parse.quote_from_bytes">

  863. <span class="sig-prename descclassname"><span class="pre">urllib.parse.</span></span><span class="sig-name descname"><span class="pre">quote_from_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bytes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">safe</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'/'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#urllib.parse.quote_from_bytes" title="Link to this definition">¶</a></dt>

  864. <dd><p>Like <a class="reference internal" href="#urllib.parse.quote" title="urllib.parse.quote"><code class="xref py py-func docutils literal notranslate"><span class="pre">quote()</span></code></a>, but accepts a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> object rather than a

  865. <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, and does not perform string-to-bytes encoding.</p>

  866. <p>Example: <code class="docutils literal notranslate"><span class="pre">quote_from_bytes(b'a&amp;\xef')</span></code> yields

  867. <code class="docutils literal notranslate"><span class="pre">'a%26%EF'</span></code>.</p>

  868. </dd></dl>

  869. 

  870. <dl class="py function">

  871. <dt class="sig sig-object py" id="urllib.parse.unquote">

  872. <span class="sig-prename descclassname"><span class="pre">urllib.parse.</span></span><span class="sig-name descname"><span class="pre">unquote</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'utf-8'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'replace'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#urllib.parse.unquote" title="Link to this definition">¶</a></dt>

  873. <dd><p>Replace <code class="samp docutils literal notranslate"><span class="pre">%</span><em><span class="pre">xx</span></em></code> escapes with their single-character equivalent.

  874. The optional <em>encoding</em> and <em>errors</em> parameters specify how to decode

  875. percent-encoded sequences into Unicode characters, as accepted by the

  876. <a class="reference internal" href="stdtypes.html#bytes.decode" title="bytes.decode"><code class="xref py py-meth docutils literal notranslate"><span class="pre">bytes.decode()</span></code></a> method.</p>

  877. <p><em>string</em> may be either a <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> or a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> object.</p>

  878. <p><em>encoding</em> defaults to <code class="docutils literal notranslate"><span class="pre">'utf-8'</span></code>.

  879. <em>errors</em> defaults to <code class="docutils literal notranslate"><span class="pre">'replace'</span></code>, meaning invalid sequences are replaced

  880. by a placeholder character.</p>

  881. <p>Example: <code class="docutils literal notranslate"><span class="pre">unquote('/El%20Ni%C3%B1o/')</span></code> yields <code class="docutils literal notranslate"><span class="pre">'/El</span> <span class="pre">Niño/'</span></code>.</p>

  882. <div class="versionchanged">

  883. <p><span class="versionmodified changed">Changed in version 3.9: </span><em>string</em> parameter supports bytes and str objects (previously only str).</p>

  884. </div>

  885. </dd></dl>

  886. 

  887. <dl class="py function">

  888. <dt class="sig sig-object py" id="urllib.parse.unquote_plus">

  889. <span class="sig-prename descclassname"><span class="pre">urllib.parse.</span></span><span class="sig-name descname"><span class="pre">unquote_plus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'utf-8'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'replace'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#urllib.parse.unquote_plus" title="Link to this definition">¶</a></dt>

  890. <dd><p>Like <a class="reference internal" href="#urllib.parse.unquote" title="urllib.parse.unquote"><code class="xref py py-func docutils literal notranslate"><span class="pre">unquote()</span></code></a>, but also replace plus signs with spaces, as required

  891. for unquoting HTML form values.</p>

  892. <p><em>string</em> must be a <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>.</p>

  893. <p>Example: <code class="docutils literal notranslate"><span class="pre">unquote_plus('/El+Ni%C3%B1o/')</span></code> yields <code class="docutils literal notranslate"><span class="pre">'/El</span> <span class="pre">Niño/'</span></code>.</p>

  894. </dd></dl>

  895. 

  896. <dl class="py function">

  897. <dt class="sig sig-object py" id="urllib.parse.unquote_to_bytes">

  898. <span class="sig-prename descclassname"><span class="pre">urllib.parse.</span></span><span class="sig-name descname"><span class="pre">unquote_to_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#urllib.parse.unquote_to_bytes" title="Link to this definition">¶</a></dt>

  899. <dd><p>Replace <code class="samp docutils literal notranslate"><span class="pre">%</span><em><span class="pre">xx</span></em></code> escapes with their single-octet equivalent, and return a

  900. <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> object.</p>

  901. <p><em>string</em> may be either a <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> or a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> object.</p>

  902. <p>If it is a <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, unescaped non-ASCII characters in <em>string</em>

  903. are encoded into UTF-8 bytes.</p>

  904. <p>Example: <code class="docutils literal notranslate"><span class="pre">unquote_to_bytes('a%26%EF')</span></code> yields <code class="docutils literal notranslate"><span class="pre">b'a&amp;\xef'</span></code>.</p>

  905. </dd></dl>

  906. 

  907. <dl class="py function">

  908. <dt class="sig sig-object py" id="urllib.parse.urlencode">

  909. <span class="sig-prename descclassname"><span class="pre">urllib.parse.</span></span><span class="sig-name descname"><span class="pre">urlencode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doseq</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">safe</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quote_via</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">quote_plus</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#urllib.parse.urlencode" title="Link to this definition">¶</a></dt>

  910. <dd><p>Convert a mapping object or a sequence of two-element tuples, which may

  911. contain <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> or <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> objects, to a percent-encoded ASCII

  912. text string.  If the resultant string is to be used as a <em>data</em> for POST

  913. operation with the <a class="reference internal" href="urllib.request.html#urllib.request.urlopen" title="urllib.request.urlopen"><code class="xref py py-func docutils literal notranslate"><span class="pre">urlopen()</span></code></a> function, then

  914. it should be encoded to bytes, otherwise it would result in a

  915. <a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">TypeError</span></code></a>.</p>

  916. <p>The resulting string is a series of <code class="docutils literal notranslate"><span class="pre">key=value</span></code> pairs separated by <code class="docutils literal notranslate"><span class="pre">'&amp;'</span></code>

  917. characters, where both <em>key</em> and <em>value</em> are quoted using the <em>quote_via</em>

  918. function.  By default, <a class="reference internal" href="#urllib.parse.quote_plus" title="urllib.parse.quote_plus"><code class="xref py py-func docutils literal notranslate"><span class="pre">quote_plus()</span></code></a> is used to quote the values, which

  919. means spaces are quoted as a <code class="docutils literal notranslate"><span class="pre">'+'</span></code> character and ‘/’ characters are

  920. encoded as <code class="docutils literal notranslate"><span class="pre">%2F</span></code>, which follows the standard for GET requests

  921. (<code class="docutils literal notranslate"><span class="pre">application/x-www-form-urlencoded</span></code>).  An alternate function that can be

  922. passed as <em>quote_via</em> is <a class="reference internal" href="#urllib.parse.quote" title="urllib.parse.quote"><code class="xref py py-func docutils literal notranslate"><span class="pre">quote()</span></code></a>, which will encode spaces as <code class="docutils literal notranslate"><span class="pre">%20</span></code>

  923. and not encode ‘/’ characters.  For maximum control of what is quoted, use

  924. <code class="docutils literal notranslate"><span class="pre">quote</span></code> and specify a value for <em>safe</em>.</p>

  925. <p>When a sequence of two-element tuples is used as the <em>query</em>

  926. argument, the first element of each tuple is a key and the second is a

  927. value. The value element in itself can be a sequence and in that case, if

  928. the optional parameter <em>doseq</em> evaluates to <code class="docutils literal notranslate"><span class="pre">True</span></code>, individual

  929. <code class="docutils literal notranslate"><span class="pre">key=value</span></code> pairs separated by <code class="docutils literal notranslate"><span class="pre">'&amp;'</span></code> are generated for each element of

  930. the value sequence for the key.  The order of parameters in the encoded

  931. string will match the order of parameter tuples in the sequence.</p>

  932. <p>The <em>safe</em>, <em>encoding</em>, and <em>errors</em> parameters are passed down to

  933. <em>quote_via</em> (the <em>encoding</em> and <em>errors</em> parameters are only passed

  934. when a query element is a <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>).</p>

  935. <p>To reverse this encoding process, <a class="reference internal" href="#urllib.parse.parse_qs" title="urllib.parse.parse_qs"><code class="xref py py-func docutils literal notranslate"><span class="pre">parse_qs()</span></code></a> and <a class="reference internal" href="#urllib.parse.parse_qsl" title="urllib.parse.parse_qsl"><code class="xref py py-func docutils literal notranslate"><span class="pre">parse_qsl()</span></code></a> are

  936. provided in this module to parse query strings into Python data structures.</p>

  937. <p>Refer to <a class="reference internal" href="urllib.request.html#urllib-examples"><span class="std std-ref">urllib examples</span></a> to find out how the

  938. <a class="reference internal" href="#urllib.parse.urlencode" title="urllib.parse.urlencode"><code class="xref py py-func docutils literal notranslate"><span class="pre">urllib.parse.urlencode()</span></code></a> method can be used for generating the query

  939. string of a URL or data for a POST request.</p>

  940. <div class="versionchanged">

  941. <p><span class="versionmodified changed">Changed in version 3.2: </span><em>query</em> supports bytes and string objects.</p>

  942. </div>

  943. <div class="versionchanged">

  944. <p><span class="versionmodified changed">Changed in version 3.5: </span>Added the <em>quote_via</em> parameter.</p>

  945. </div>

  946. </dd></dl>

  947. 

  948. <div class="admonition seealso">

  949. <p class="admonition-title">See also</p>

  950. <dl class="simple">

  951. <dt><a class="reference external" href="https://url.spec.whatwg.org/">WHATWG</a> -  URL Living standard</dt><dd><p>Working Group for the URL Standard that defines URLs, domains, IP addresses, the

  952. application/x-www-form-urlencoded format, and their API.</p>

  953. </dd>

  954. <dt><span class="target" id="index-8"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3986.html"><strong>RFC 3986</strong></a> - Uniform Resource Identifiers</dt><dd><p>This is the current standard (STD66). Any changes to urllib.parse module

  955. should conform to this. Certain deviations could be observed, which are

  956. mostly for backward compatibility purposes and for certain de-facto

  957. parsing requirements as commonly observed in major browsers.</p>

  958. </dd>

  959. <dt><span class="target" id="index-9"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2732.html"><strong>RFC 2732</strong></a> - Format for Literal IPv6 Addresses in URL’s.</dt><dd><p>This specifies the parsing requirements of IPv6 URLs.</p>

  960. </dd>

  961. <dt><span class="target" id="index-10"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2396.html"><strong>RFC 2396</strong></a> - Uniform Resource Identifiers (URI): Generic Syntax</dt><dd><p>Document describing the generic syntactic requirements for both Uniform Resource

  962. Names (URNs) and Uniform Resource Locators (URLs).</p>

  963. </dd>

  964. <dt><span class="target" id="index-11"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2368.html"><strong>RFC 2368</strong></a> - The mailto URL scheme.</dt><dd><p>Parsing requirements for mailto URL schemes.</p>

  965. </dd>

  966. <dt><span class="target" id="index-12"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc1808.html"><strong>RFC 1808</strong></a> - Relative Uniform Resource Locators</dt><dd><p>This Request For Comments includes the rules for joining an absolute and a

  967. relative URL, including a fair number of “Abnormal Examples” which govern the

  968. treatment of border cases.</p>

  969. </dd>

  970. <dt><span class="target" id="index-13"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc1738.html"><strong>RFC 1738</strong></a> - Uniform Resource Locators (URL)</dt><dd><p>This specifies the formal syntax and semantics of absolute URLs.</p>

  971. </dd>

  972. </dl>

  973. </div>

  974. </section>

  975. </section>

  976. 

  977. 

  978.             <div class="clearer"></div>

  979.           </div>

  980.         </div>

  981.       </div>

  982.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  983.         <div class="sphinxsidebarwrapper">

  984.   <div>

  985.     <h3><a href="../contents.html">Table of Contents</a></h3>

  986.     <ul>

  987. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">urllib.parse</span></code> — Parse URLs into components</a><ul>

  988. <li><a class="reference internal" href="#url-parsing">URL Parsing</a></li>

  989. <li><a class="reference internal" href="#url-parsing-security">URL parsing security</a></li>

  990. <li><a class="reference internal" href="#parsing-ascii-encoded-bytes">Parsing ASCII Encoded Bytes</a></li>

  991. <li><a class="reference internal" href="#structured-parse-results">Structured Parse Results</a></li>

  992. <li><a class="reference internal" href="#url-quoting">URL Quoting</a></li>

  993. </ul>

  994. </li>

  995. </ul>

  996. 

  997.   </div>

  998.   <div>

  999.     <h4>Previous topic</h4>

  1000.     <p class="topless"><a href="urllib.request.html"

  1001.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">urllib.request</span></code> — Extensible library for opening URLs</a></p>

  1002.   </div>

  1003.   <div>

  1004.     <h4>Next topic</h4>

  1005.     <p class="topless"><a href="urllib.error.html"

  1006.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">urllib.error</span></code> — Exception classes raised by urllib.request</a></p>

  1007.   </div>

  1008.   <div role="note" aria-label="source link">

  1009.     <h3>This Page</h3>

  1010.     <ul class="this-page-menu">

  1011.       <li><a href="../bugs.html">Report a Bug</a></li>

  1012.       <li>

  1013.         <a href="https://github.com/python/cpython/blob/main/Doc/library/urllib.parse.rst"

  1014.             rel="nofollow">Show Source

  1015.         </a>

  1016.       </li>

  1017.     </ul>

  1018.   </div>

  1019.         </div>

  1020. <div id="sidebarbutton" title="Collapse sidebar">

  1021. <span>«</span>

  1022. </div>

  1023. 

  1024.       </div>

  1025.       <div class="clearer"></div>

  1026.     </div>  

  1027.     <div class="related" role="navigation" aria-label="related navigation">

  1028.       <h3>Navigation</h3>

  1029.       <ul>

  1030.         <li class="right" style="margin-right: 10px">

  1031.           <a href="../genindex.html" title="General Index"

  1032.              >index</a></li>

  1033.         <li class="right" >

  1034.           <a href="../py-modindex.html" title="Python Module Index"

  1035.              >modules</a> |</li>

  1036.         <li class="right" >

  1037.           <a href="urllib.error.html" title="urllib.error — Exception classes raised by urllib.request"

  1038.              >next</a> |</li>

  1039.         <li class="right" >

  1040.           <a href="urllib.request.html" title="urllib.request — Extensible library for opening URLs"

  1041.              >previous</a> |</li>

  1042. 

  1043.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  1044.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  1045.           <li class="switchers">

  1046.             <div class="language_switcher_placeholder"></div>

  1047.             <div class="version_switcher_placeholder"></div>

  1048.           </li>

  1049.           <li>

  1050.               

  1051.           </li>

  1052.     <li id="cpython-language-and-version">

  1053.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  1054.     </li>

  1055. 

  1056.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  1057.           <li class="nav-item nav-item-2"><a href="internet.html" >Internet Protocols and Support</a> &#187;</li>

  1058.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">urllib.parse</span></code> — Parse URLs into components</a></li>

  1059.                 <li class="right">

  1060.                     

  1061. 

  1062.     <div class="inline-search" role="search">

  1063.         <form class="inline-search" action="../search.html" method="get">

  1064.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  1065.           <input type="submit" value="Go" />

  1066.         </form>

  1067.     </div>

  1068.                      |

  1069.                 </li>

  1070.             <li class="right">

  1071. <label class="theme-selector-label">

  1072.     Theme

  1073.     <select class="theme-selector" oninput="activateTheme(this.value)">

  1074.         <option value="auto" selected>Auto</option>

  1075.         <option value="light">Light</option>

  1076.         <option value="dark">Dark</option>

  1077.     </select>

  1078. </label> |</li>

  1079.             

  1080.       </ul>

  1081.     </div>  

  1082.     <div class="footer">

  1083.     &copy; 

  1084.       <a href="../copyright.html">

  1085.     

  1086.     Copyright

  1087.     

  1088.       </a>

  1089.      2001-2024, Python Software Foundation.

  1090.     <br />

  1091.     This page is licensed under the Python Software Foundation License Version 2.

  1092.     <br />

  1093.     Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.

  1094.     <br />

  1095.     

  1096.       See <a href="/license.html">History and License</a> for more information.<br />

  1097.     

  1098.     

  1099.     <br />

  1100. 

  1101.     The Python Software Foundation is a non-profit corporation.

  1102. <a href="https://www.python.org/psf/donations/">Please donate.</a>

  1103. <br />

  1104.     <br />

  1105.       Last updated on Apr 09, 2024 (13:47 UTC).

  1106.     

  1107.       <a href="/bugs.html">Found a bug</a>?

  1108.     

  1109.     <br />

  1110. 

  1111.     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

  1112.     </div>

  1113. 

  1114.   </body>

  1115. </html>
上海开阖软件有限公司 沪ICP备12045867号-1