1
:mod:`urllib.parse` --- Parse URLs into components
2
==================================================
4
.. module:: urllib.parse
5
:synopsis: Parse URLs into or assemble them from components.
10
single: World Wide Web
15
This module defines a standard interface to break Uniform Resource Locator (URL)
16
strings up in components (addressing scheme, network location, path etc.), to
17
combine the components back into a URL string, and to convert a "relative URL"
18
to an absolute URL given a "base URL."
20
The module has been designed to match the Internet RFC on Relative Uniform
21
Resource Locators (and discovered a bug in an earlier draft!). It supports the
22
following URL schemes: ``file``, ``ftp``, ``gopher``, ``hdl``, ``http``,
23
``https``, ``imap``, ``mailto``, ``mms``, ``news``, ``nntp``, ``prospero``,
24
``rsync``, ``rtsp``, ``rtspu``, ``sftp``, ``shttp``, ``sip``, ``sips``,
25
``snews``, ``svn``, ``svn+ssh``, ``telnet``, ``wais``.
27
The :mod:`urllib.parse` module defines the following functions:
29
.. function:: urlparse(urlstring[, default_scheme[, allow_fragments]])
31
Parse a URL into six components, returning a 6-tuple. This corresponds to the
32
general structure of a URL: ``scheme://netloc/path;parameters?query#fragment``.
33
Each tuple item is a string, possibly empty. The components are not broken up in
34
smaller parts (for example, the network location is a single string), and %
35
escapes are not expanded. The delimiters as shown above are not part of the
36
result, except for a leading slash in the *path* component, which is retained if
39
>>> from urllib.parse import urlparse
40
>>> o = urlparse('http://www.cwi.nl:80/%7Eguido/Python.html')
41
>>> o # doctest: +NORMALIZE_WHITESPACE
42
ParseResult(scheme='http', netloc='www.cwi.nl:80', path='/%7Eguido/Python.html',
43
params='', query='', fragment='')
49
'http://www.cwi.nl:80/%7Eguido/Python.html'
51
If the *default_scheme* argument is specified, it gives the default addressing
52
scheme, to be used only if the URL does not specify one. The default value for
53
this argument is the empty string.
55
If the *allow_fragments* argument is false, fragment identifiers are not
56
allowed, even if the URL's addressing scheme normally does support them. The
57
default value for this argument is :const:`True`.
59
The return value is actually an instance of a subclass of :class:`tuple`. This
60
class has the following additional read-only convenience attributes:
62
+------------------+-------+--------------------------+----------------------+
63
| Attribute | Index | Value | Value if not present |
64
+==================+=======+==========================+======================+
65
| :attr:`scheme` | 0 | URL scheme specifier | empty string |
66
+------------------+-------+--------------------------+----------------------+
67
| :attr:`netloc` | 1 | Network location part | empty string |
68
+------------------+-------+--------------------------+----------------------+
69
| :attr:`path` | 2 | Hierarchical path | empty string |
70
+------------------+-------+--------------------------+----------------------+
71
| :attr:`params` | 3 | Parameters for last path | empty string |
73
+------------------+-------+--------------------------+----------------------+
74
| :attr:`query` | 4 | Query component | empty string |
75
+------------------+-------+--------------------------+----------------------+
76
| :attr:`fragment` | 5 | Fragment identifier | empty string |
77
+------------------+-------+--------------------------+----------------------+
78
| :attr:`username` | | User name | :const:`None` |
79
+------------------+-------+--------------------------+----------------------+
80
| :attr:`password` | | Password | :const:`None` |
81
+------------------+-------+--------------------------+----------------------+
82
| :attr:`hostname` | | Host name (lower case) | :const:`None` |
83
+------------------+-------+--------------------------+----------------------+
84
| :attr:`port` | | Port number as integer, | :const:`None` |
86
+------------------+-------+--------------------------+----------------------+
88
See section :ref:`urlparse-result-object` for more information on the result
92
.. function:: parse_qs(qs[, keep_blank_values[, strict_parsing]])
94
Parse a query string given as a string argument (data of type
95
:mimetype:`application/x-www-form-urlencoded`). Data are returned as a
96
dictionary. The dictionary keys are the unique query variable names and the
97
values are lists of values for each name.
99
The optional argument *keep_blank_values* is a flag indicating whether blank
100
values in URL encoded queries should be treated as blank strings. A true value
101
indicates that blanks should be retained as blank strings. The default false
102
value indicates that blank values are to be ignored and treated as if they were
105
The optional argument *strict_parsing* is a flag indicating what to do with
106
parsing errors. If false (the default), errors are silently ignored. If true,
107
errors raise a :exc:`ValueError` exception.
109
Use the :func:`urllib.parse.urlencode` function to convert such
110
dictionaries into query strings.
113
.. function:: parse_qsl(qs[, keep_blank_values[, strict_parsing]])
115
Parse a query string given as a string argument (data of type
116
:mimetype:`application/x-www-form-urlencoded`). Data are returned as a list of
119
The optional argument *keep_blank_values* is a flag indicating whether blank
120
values in URL encoded queries should be treated as blank strings. A true value
121
indicates that blanks should be retained as blank strings. The default false
122
value indicates that blank values are to be ignored and treated as if they were
125
The optional argument *strict_parsing* is a flag indicating what to do with
126
parsing errors. If false (the default), errors are silently ignored. If true,
127
errors raise a :exc:`ValueError` exception.
129
Use the :func:`urllib.parse.urlencode` function to convert such lists of pairs into
133
.. function:: urlunparse(parts)
135
Construct a URL from a tuple as returned by ``urlparse()``. The *parts*
136
argument can be any six-item iterable. This may result in a slightly
137
different, but equivalent URL, if the URL that was parsed originally had
138
unnecessary delimiters (for example, a ``?`` with an empty query; the RFC
139
states that these are equivalent).
142
.. function:: urlsplit(urlstring[, default_scheme[, allow_fragments]])
144
This is similar to :func:`urlparse`, but does not split the params from the URL.
145
This should generally be used instead of :func:`urlparse` if the more recent URL
146
syntax allowing parameters to be applied to each segment of the *path* portion
147
of the URL (see :rfc:`2396`) is wanted. A separate function is needed to
148
separate the path segments and parameters. This function returns a 5-tuple:
149
(addressing scheme, network location, path, query, fragment identifier).
151
The return value is actually an instance of a subclass of :class:`tuple`. This
152
class has the following additional read-only convenience attributes:
154
+------------------+-------+-------------------------+----------------------+
155
| Attribute | Index | Value | Value if not present |
156
+==================+=======+=========================+======================+
157
| :attr:`scheme` | 0 | URL scheme specifier | empty string |
158
+------------------+-------+-------------------------+----------------------+
159
| :attr:`netloc` | 1 | Network location part | empty string |
160
+------------------+-------+-------------------------+----------------------+
161
| :attr:`path` | 2 | Hierarchical path | empty string |
162
+------------------+-------+-------------------------+----------------------+
163
| :attr:`query` | 3 | Query component | empty string |
164
+------------------+-------+-------------------------+----------------------+
165
| :attr:`fragment` | 4 | Fragment identifier | empty string |
166
+------------------+-------+-------------------------+----------------------+
167
| :attr:`username` | | User name | :const:`None` |
168
+------------------+-------+-------------------------+----------------------+
169
| :attr:`password` | | Password | :const:`None` |
170
+------------------+-------+-------------------------+----------------------+
171
| :attr:`hostname` | | Host name (lower case) | :const:`None` |
172
+------------------+-------+-------------------------+----------------------+
173
| :attr:`port` | | Port number as integer, | :const:`None` |
175
+------------------+-------+-------------------------+----------------------+
177
See section :ref:`urlparse-result-object` for more information on the result
181
.. function:: urlunsplit(parts)
183
Combine the elements of a tuple as returned by :func:`urlsplit` into a
184
complete URL as a string. The *parts* argument can be any five-item
185
iterable. This may result in a slightly different, but equivalent URL, if the
186
URL that was parsed originally had unnecessary delimiters (for example, a ?
187
with an empty query; the RFC states that these are equivalent).
190
.. function:: urljoin(base, url[, allow_fragments])
192
Construct a full ("absolute") URL by combining a "base URL" (*base*) with
193
another URL (*url*). Informally, this uses components of the base URL, in
194
particular the addressing scheme, the network location and (part of) the
195
path, to provide missing components in the relative URL. For example:
197
>>> from urllib.parse import urljoin
198
>>> urljoin('http://www.cwi.nl/%7Eguido/Python.html', 'FAQ.html')
199
'http://www.cwi.nl/%7Eguido/FAQ.html'
201
The *allow_fragments* argument has the same meaning and default as for
206
If *url* is an absolute URL (that is, starting with ``//`` or ``scheme://``),
207
the *url*'s host name and/or scheme will be present in the result. For example:
211
>>> urljoin('http://www.cwi.nl/%7Eguido/Python.html',
212
... '//www.python.org/%7Eguido')
213
'http://www.python.org/%7Eguido'
215
If you do not want that behavior, preprocess the *url* with :func:`urlsplit` and
216
:func:`urlunsplit`, removing possible *scheme* and *netloc* parts.
219
.. function:: urldefrag(url)
221
If *url* contains a fragment identifier, return a modified version of *url*
222
with no fragment identifier, and the fragment identifier as a separate
223
string. If there is no fragment identifier in *url*, return *url* unmodified
226
.. function:: quote(string[, safe[, encoding[, errors]]])
228
Replace special characters in *string* using the ``%xx`` escape. Letters,
229
digits, and the characters ``'_.-'`` are never quoted. The optional *safe*
230
parameter specifies additional ASCII characters that should not be quoted
231
--- its default value is ``'/'``.
233
*string* may be either a :class:`str` or a :class:`bytes`.
235
The optional *encoding* and *errors* parameters specify how to deal with
236
non-ASCII characters, as accepted by the :meth:`str.encode` method.
237
*encoding* defaults to ``'utf-8'``.
238
*errors* defaults to ``'strict'``, meaning unsupported characters raise a
239
:class:`UnicodeEncodeError`.
240
*encoding* and *errors* must not be supplied if *string* is a
241
:class:`bytes`, or a :class:`TypeError` is raised.
243
Note that ``quote(string, safe, encoding, errors)`` is equivalent to
244
``quote_from_bytes(string.encode(encoding, errors), safe)``.
246
Example: ``quote('/El Niño/')`` yields ``'/El%20Ni%C3%B1o/'``.
249
.. function:: quote_plus(string[, safe[, encoding[, errors]]])
251
Like :func:`quote`, but also replace spaces by plus signs, as required for
252
quoting HTML form values. Plus signs in the original string are escaped
253
unless they are included in *safe*. It also does not have *safe* default to
256
Example: ``quote_plus('/El Niño/')`` yields ``'%2FEl+Ni%C3%B1o%2F'``.
258
.. function:: quote_from_bytes(bytes[, safe])
260
Like :func:`quote`, but accepts a :class:`bytes` object rather than a
261
:class:`str`, and does not perform string-to-bytes encoding.
263
Example: ``quote_from_bytes(b'a&\xef')`` yields
266
.. function:: unquote(string[, encoding[, errors]])
268
Replace ``%xx`` escapes by their single-character equivalent.
269
The optional *encoding* and *errors* parameters specify how to decode
270
percent-encoded sequences into Unicode characters, as accepted by the
271
:meth:`bytes.decode` method.
273
*string* must be a :class:`str`.
275
*encoding* defaults to ``'utf-8'``.
276
*errors* defaults to ``'replace'``, meaning invalid sequences are replaced
277
by a placeholder character.
279
Example: ``unquote('/El%20Ni%C3%B1o/')`` yields ``'/El Niño/'``.
282
.. function:: unquote_plus(string[, encoding[, errors]])
284
Like :func:`unquote`, but also replace plus signs by spaces, as required for
285
unquoting HTML form values.
287
*string* must be a :class:`str`.
289
Example: ``unquote_plus('/El+Ni%C3%B1o/')`` yields ``'/El Niño/'``.
291
.. function:: unquote_to_bytes(string)
293
Replace ``%xx`` escapes by their single-octet equivalent, and return a
294
:class:`bytes` object.
296
*string* may be either a :class:`str` or a :class:`bytes`.
298
If it is a :class:`str`, unescaped non-ASCII characters in *string*
299
are encoded into UTF-8 bytes.
301
Example: ``unquote_to_bytes('a%26%EF')`` yields
305
.. function:: urlencode(query[, doseq])
307
Convert a mapping object or a sequence of two-element tuples to a "url-encoded"
308
string, suitable to pass to :func:`urlopen` above as the optional *data*
309
argument. This is useful to pass a dictionary of form fields to a ``POST``
310
request. The resulting string is a series of ``key=value`` pairs separated by
311
``'&'`` characters, where both *key* and *value* are quoted using
312
:func:`quote_plus` above. If the optional parameter *doseq* is present and
313
evaluates to true, individual ``key=value`` pairs are generated for each element
314
of the sequence. When a sequence of two-element tuples is used as the *query*
315
argument, the first element of each tuple is a key and the second is a value.
316
The order of parameters in the encoded string will match the order of parameter
317
tuples in the sequence. This module provides the functions
318
:func:`parse_qs` and :func:`parse_qsl` which are used to parse query strings
319
into Python data structures.
324
:rfc:`1738` - Uniform Resource Locators (URL)
325
This specifies the formal syntax and semantics of absolute URLs.
327
:rfc:`1808` - Relative Uniform Resource Locators
328
This Request For Comments includes the rules for joining an absolute and a
329
relative URL, including a fair number of "Abnormal Examples" which govern the
330
treatment of border cases.
332
:rfc:`2396` - Uniform Resource Identifiers (URI): Generic Syntax
333
Document describing the generic syntactic requirements for both Uniform Resource
334
Names (URNs) and Uniform Resource Locators (URLs).
337
.. _urlparse-result-object:
339
Results of :func:`urlparse` and :func:`urlsplit`
340
------------------------------------------------
342
The result objects from the :func:`urlparse` and :func:`urlsplit` functions are
343
subclasses of the :class:`tuple` type. These subclasses add the attributes
344
described in those functions, as well as provide an additional method:
346
.. method:: ParseResult.geturl()
348
Return the re-combined version of the original URL as a string. This may differ
349
from the original URL in that the scheme will always be normalized to lower case
350
and empty components may be dropped. Specifically, empty parameters, queries,
351
and fragment identifiers will be removed.
353
The result of this method is a fixpoint if passed back through the original
356
>>> import urllib.parse
357
>>> url = 'HTTP://www.Python.org/doc/#'
359
>>> r1 = urllib.parse.urlsplit(url)
361
'http://www.Python.org/doc/'
363
>>> r2 = urllib.parse.urlsplit(r1.geturl())
365
'http://www.Python.org/doc/'
368
The following classes provide the implementations of the parse results:
370
.. class:: BaseResult
372
Base class for the concrete result classes. This provides most of the
373
attribute definitions. It does not provide a :meth:`geturl` method. It is
374
derived from :class:`tuple`, but does not override the :meth:`__init__` or
375
:meth:`__new__` methods.
378
.. class:: ParseResult(scheme, netloc, path, params, query, fragment)
380
Concrete class for :func:`urlparse` results. The :meth:`__new__` method is
381
overridden to support checking that the right number of arguments are passed.
384
.. class:: SplitResult(scheme, netloc, path, query, fragment)
386
Concrete class for :func:`urlsplit` results. The :meth:`__new__` method is
387
overridden to support checking that the right number of arguments are passed.
added
removed
Doc/library/urllib.parse.rst
