summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2014-12-25 02:24:07 (GMT)
committerR David Murray <rdmurray@bitdance.com>2014-12-25 02:24:07 (GMT)
commit3ab6ba474410b2f49d3a76766999effa59875024 (patch)
tree2d929ebb78357a5d9044797f7779ca2bd439e848
parent3226f9618f1dfacc7d0a98b0821f8ab5b180e482 (diff)
parent8c4e112afcf6b2236c43273d007de5b61d4b6519 (diff)
downloadcpython-3ab6ba474410b2f49d3a76766999effa59875024.zip
cpython-3ab6ba474410b2f49d3a76766999effa59875024.tar.gz
cpython-3ab6ba474410b2f49d3a76766999effa59875024.tar.bz2
Merge: #23040: Clarify treatment of encoding and errors when component is bytes.
-rw-r--r--Doc/library/urllib.parse.rst7
-rw-r--r--Lib/urllib/parse.py9
2 files changed, 9 insertions, 7 deletions
diff --git a/Doc/library/urllib.parse.rst b/Doc/library/urllib.parse.rst
index 2c3a0b9..3ecdda1 100644
--- a/Doc/library/urllib.parse.rst
+++ b/Doc/library/urllib.parse.rst
@@ -522,7 +522,7 @@ task isn't already covered by the URL parsing functions above.
.. function:: urlencode(query, doseq=False, safe='', encoding=None, errors=None)
Convert a mapping object or a sequence of two-element tuples, which may
- either be a :class:`str` or a :class:`bytes`, to a "percent-encoded"
+ contain :class:`str` or :class:`bytes` objects, to a "percent-encoded"
string. If the resultant string is to be used as a *data* for POST
operation with :func:`~urllib.request.urlopen` function, then it should be
properly encoded to bytes, otherwise it would result in a :exc:`TypeError`.
@@ -537,8 +537,9 @@ task isn't already covered by the URL parsing functions above.
the value sequence for the key. The order of parameters in the encoded
string will match the order of parameter tuples in the sequence.
- When *query* parameter is a :class:`str`, the *safe*, *encoding* and *error*
- parameters are passed down to :func:`quote_plus` for encoding.
+ The *safe*, *encoding*, and *errors* parameters are passed down to
+ :func:`quote_plus` (the *encoding* and *errors* parameters are only passed
+ when a query element is a :class:`str`).
To reverse this encoding process, :func:`parse_qs` and :func:`parse_qsl` are
provided in this module to parse query strings into Python data structures.
diff --git a/Lib/urllib/parse.py b/Lib/urllib/parse.py
index 8bbeab6..821dae6 100644
--- a/Lib/urllib/parse.py
+++ b/Lib/urllib/parse.py
@@ -687,8 +687,8 @@ def quote(string, safe='/', encoding=None, errors=None):
called on a path where the existing slash characters are used as
reserved characters.
- string and safe may be either str or bytes objects. encoding must
- not be specified if string is a str.
+ string and safe may be either str or bytes objects. encoding and errors
+ must not be specified if string is a bytes object.
The optional encoding and errors parameters specify how to deal with
non-ASCII characters, as accepted by the str.encode method.
@@ -760,8 +760,9 @@ def urlencode(query, doseq=False, safe='', encoding=None, errors=None):
input.
The components of a query arg may each be either a string or a bytes type.
- When a component is a string, the safe, encoding and error parameters are
- sent to the quote_plus function for encoding.
+
+ The safe, encoding, and errors parameters are passed down to quote_plus()
+ (encoding and errors only if a component is a str).
"""
if hasattr(query, "items"):