summaryrefslogtreecommitdiffstats
path: root/Doc/library/urllib.parse.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/library/urllib.parse.rst')
-rw-r--r--Doc/library/urllib.parse.rst40
1 files changed, 23 insertions, 17 deletions
diff --git a/Doc/library/urllib.parse.rst b/Doc/library/urllib.parse.rst
index 3d13efc..add07a5 100644
--- a/Doc/library/urllib.parse.rst
+++ b/Doc/library/urllib.parse.rst
@@ -310,23 +310,29 @@ The :mod:`urllib.parse` module defines the following functions:
``b'a&\xef'``.
-.. function:: urlencode(query, doseq=False)
-
- Convert a mapping object or a sequence of two-element tuples to a
- "url-encoded" string, suitable to pass to :func:`urlopen` above as the
- optional *data* argument. This is useful to pass a dictionary of form
- fields to a ``POST`` request. The resulting string is a series of
- ``key=value`` pairs separated by ``'&'`` characters, where both *key* and
- *value* are quoted using :func:`quote_plus` above. When a sequence of
- two-element tuples is used as the *query* argument, the first element of
- each tuple is a key and the second is a value. The value element in itself
- can be a sequence and in that case, if the optional parameter *doseq* is
- evaluates to *True*, individual ``key=value`` pairs separated by ``'&'`` are
- generated for each element of the value sequence for the key. The order of
- parameters in the encoded string will match the order of parameter tuples in
- the sequence. This module provides the functions :func:`parse_qs` and
- :func:`parse_qsl` which are used to parse query strings into Python data
- structures.
+.. 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 "url-encoded" string,
+ suitable to pass to :func:`urlopen` above as the optional *data* argument.
+ This is useful to pass a dictionary of form fields to a ``POST`` request.
+ The resulting string is a series of ``key=value`` pairs separated by ``'&'``
+ characters, where both *key* and *value* are quoted using :func:`quote_plus`
+ above. When a sequence of two-element tuples is used as the *query*
+ argument, the first element of each tuple is a key and the second is a
+ value. The value element in itself can be a sequence and in that case, if
+ the optional parameter *doseq* is evaluates to *True*, individual
+ ``key=value`` pairs separated by ``'&'`` are generated for each element of
+ the value sequence for the key. The order of parameters in the encoded
+ string will match the order of parameter tuples in the sequence. This module
+ provides the functions :func:`parse_qs` and :func:`parse_qsl` which are used
+ to parse query strings into Python data structures.
+
+ When *query* parameter is a :class:`str`, the *safe*, *encoding* and *error*
+ parameters are sent the :func:`quote_plus` for encoding.
+
+ .. versionchanged:: 3.2
+ query paramater supports bytes and string.
.. seealso::