mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-14 12:46:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 12

bpo-35116, urllib.parse: Document the new max_num_fields parameter (GH-10247)

Browse source
This commit is contained in:
matthewbelisle-wf 2018-10-30 15:30:19 -05:00 • committed by Victor Stinner
parent a80af77087
commit 68f323715e
1 changed files with 16 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

18
Doc/library/urllib.parse.rst
View file

@ -137,7 +137,7 @@ or on combining URL components into a URL string.
returning :const:`None`. returning :const:`None`.
.. function:: parse_qs(qs, keep_blank_values=False, strict_parsing=False, encoding='utf-8', errors='replace') .. function:: parse_qs(qs, keep_blank_values=False, strict_parsing=False, encoding='utf-8', errors='replace', max_num_fields=None)
Parse a query string given as a string argument (data of type Parse a query string given as a string argument (data of type
:mimetype:`application/x-www-form-urlencoded`). Data are returned as a :mimetype:`application/x-www-form-urlencoded`). Data are returned as a
@ -158,6 +158,10 @@ or on combining URL components into a URL string.
percent-encoded sequences into Unicode characters, as accepted by the percent-encoded sequences into Unicode characters, as accepted by the
:meth:`bytes.decode` method. :meth:`bytes.decode` method.
The optional argument *max_num_fields* is the maximum number of fields to
read. If set, then throws a :exc:`ValueError` if there are more than
*max_num_fields* fields read.
Use the :func:`urllib.parse.urlencode` function (with the ``doseq`` Use the :func:`urllib.parse.urlencode` function (with the ``doseq``
parameter set to ``True``) to convert such dictionaries into query parameter set to ``True``) to convert such dictionaries into query
strings. strings.
@ -166,8 +170,11 @@ or on combining URL components into a URL string.
.. versionchanged:: 3.2 .. versionchanged:: 3.2
Add *encoding* and *errors* parameters. Add *encoding* and *errors* parameters.
.. versionchanged:: 3.8
Added *max_num_fields* parameter.
.. function:: parse_qsl(qs, keep_blank_values=False, strict_parsing=False, encoding='utf-8', errors='replace')
.. function:: parse_qsl(qs, keep_blank_values=False, strict_parsing=False, encoding='utf-8', errors='replace', max_num_fields=None)
Parse a query string given as a string argument (data of type Parse a query string given as a string argument (data of type
:mimetype:`application/x-www-form-urlencoded`). Data are returned as a list of :mimetype:`application/x-www-form-urlencoded`). Data are returned as a list of
@ -187,12 +194,19 @@ or on combining URL components into a URL string.
percent-encoded sequences into Unicode characters, as accepted by the percent-encoded sequences into Unicode characters, as accepted by the
:meth:`bytes.decode` method. :meth:`bytes.decode` method.
The optional argument *max_num_fields* is the maximum number of fields to
read. If set, then throws a :exc:`ValueError` if there are more than
*max_num_fields* fields read.
Use the :func:`urllib.parse.urlencode` function to convert such lists of pairs into Use the :func:`urllib.parse.urlencode` function to convert such lists of pairs into
query strings. query strings.
.. versionchanged:: 3.2 .. versionchanged:: 3.2
Add *encoding* and *errors* parameters. Add *encoding* and *errors* parameters.
.. versionchanged:: 3.8
Added *max_num_fields* parameter.
.. function:: urlunparse(parts) .. function:: urlunparse(parts)