summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2014-12-25 02:23:18 (GMT)
committerR David Murray <rdmurray@bitdance.com>2014-12-25 02:23:18 (GMT)
commit8c4e112afcf6b2236c43273d007de5b61d4b6519 (patch)
treebba468ba3f6bf9b9c7ff1c6093ee0ca838cc9ded /Doc
parenta54f07504f2b555e97eed2213acd749dd53194b5 (diff)
downloadcpython-8c4e112afcf6b2236c43273d007de5b61d4b6519.zip
cpython-8c4e112afcf6b2236c43273d007de5b61d4b6519.tar.gz
cpython-8c4e112afcf6b2236c43273d007de5b61d4b6519.tar.bz2
#23040: Clarify treatment of encoding and errors when component is bytes.
Patch by Wojtek Ruszczewski.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/urllib.parse.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/Doc/library/urllib.parse.rst b/Doc/library/urllib.parse.rst
index 42aa4be..154a521 100644
--- a/Doc/library/urllib.parse.rst
+++ b/Doc/library/urllib.parse.rst
@@ -517,7 +517,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`.
@@ -532,8 +532,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.