From 9d7a6994dc8df4294325461483e1174dd001dc62 Mon Sep 17 00:00:00 2001 From: Matt Belisle Date: Tue, 30 Oct 2018 13:22:39 -0500 Subject: [PATCH 1/3] [3.7] Adding Doc/library entries for max_num_fields (cherry picked from commit 6580698e13) Co-authored-by: Matt Belisle --- Doc/library/urllib.parse.rst | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/Doc/library/urllib.parse.rst b/Doc/library/urllib.parse.rst index 2d3488bb5eef54..82cff9a303fcf5 100644 --- a/Doc/library/urllib.parse.rst +++ b/Doc/library/urllib.parse.rst @@ -137,7 +137,7 @@ or on combining URL components into a URL string. 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 :mimetype:`application/x-www-form-urlencoded`). Data are returned as a @@ -158,16 +158,22 @@ or on combining URL components into a URL string. percent-encoded sequences into Unicode characters, as accepted by the :meth:`bytes.decode` method. + The optional argument *max_num_fields* is a flag for the maximum number of + fields to read. If set, then throws a :exc:`ValueError` if there are more + than *max_num_fields* fields read. Default is *None*. + Use the :func:`urllib.parse.urlencode` function (with the ``doseq`` parameter set to ``True``) to convert such dictionaries into query strings. - .. versionchanged:: 3.2 Add *encoding* and *errors* parameters. + .. versionchanged:: 3.7.2 + Added *max_num_fields* param. -.. 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 :mimetype:`application/x-www-form-urlencoded`). Data are returned as a list of @@ -187,12 +193,18 @@ or on combining URL components into a URL string. percent-encoded sequences into Unicode characters, as accepted by the :meth:`bytes.decode` method. + The optional argument *max_num_fields* is a flag for the maximum number of + fields to read. If set, then throws a :exc:`ValueError` if there are more + than *max_num_fields* fields read. Default is *None*. + Use the :func:`urllib.parse.urlencode` function to convert such lists of pairs into query strings. .. versionchanged:: 3.2 Add *encoding* and *errors* parameters. + .. versionchanged:: 3.7.2 + Added *max_num_fields* param. .. function:: urlunparse(parts) From 87a43bcde5422f0cda175e37137e2d7308f1a5a0 Mon Sep 17 00:00:00 2001 From: Matt Belisle Date: Tue, 30 Oct 2018 14:53:54 -0500 Subject: [PATCH 2/3] param -> parameter --- Doc/library/urllib.parse.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/library/urllib.parse.rst b/Doc/library/urllib.parse.rst index 82cff9a303fcf5..61c59e3668cc3e 100644 --- a/Doc/library/urllib.parse.rst +++ b/Doc/library/urllib.parse.rst @@ -170,7 +170,7 @@ or on combining URL components into a URL string. Add *encoding* and *errors* parameters. .. versionchanged:: 3.7.2 - Added *max_num_fields* param. + Added *max_num_fields* parameter. .. function:: parse_qsl(qs, keep_blank_values=False, strict_parsing=False, encoding='utf-8', errors='replace', max_num_fields=None) @@ -204,7 +204,7 @@ or on combining URL components into a URL string. Add *encoding* and *errors* parameters. .. versionchanged:: 3.7.2 - Added *max_num_fields* param. + Added *max_num_fields* parameter. .. function:: urlunparse(parts) From c682caa398029eae6c2af91365d1b09f9572ea18 Mon Sep 17 00:00:00 2001 From: Matt Belisle Date: Tue, 30 Oct 2018 15:17:36 -0500 Subject: [PATCH 3/3] Changing max_num_fields wording --- Doc/library/urllib.parse.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Doc/library/urllib.parse.rst b/Doc/library/urllib.parse.rst index 61c59e3668cc3e..0c8f0f607314a0 100644 --- a/Doc/library/urllib.parse.rst +++ b/Doc/library/urllib.parse.rst @@ -158,9 +158,9 @@ or on combining URL components into a URL string. percent-encoded sequences into Unicode characters, as accepted by the :meth:`bytes.decode` method. - The optional argument *max_num_fields* is a flag for the maximum number of - fields to read. If set, then throws a :exc:`ValueError` if there are more - than *max_num_fields* fields read. Default is *None*. + 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`` parameter set to ``True``) to convert such dictionaries into query @@ -193,9 +193,9 @@ or on combining URL components into a URL string. percent-encoded sequences into Unicode characters, as accepted by the :meth:`bytes.decode` method. - The optional argument *max_num_fields* is a flag for the maximum number of - fields to read. If set, then throws a :exc:`ValueError` if there are more - than *max_num_fields* fields read. Default is *None*. + 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 query strings.