httpserver.py: remove the now deprecated werkzeug.urls.url_decode call

csernazs · csernazs · commit 0eb6fa3ee9ed · 2023-05-16T20:44:55.000+02:00
diff --git a/pytest_httpserver/httpserver.py b/pytest_httpserver/httpserver.py
@@ -5,6 +5,7 @@
 import re
 import threading
 import time
+import urllib.parse
 from collections import defaultdict
 from contextlib import contextmanager
 from contextlib import suppress
@@ -22,7 +23,6 @@
 from typing import Tuple
 from typing import Union
 
-import werkzeug.urls
 from werkzeug.datastructures import MultiDict
 from werkzeug.http import parse_authorization_header
 from werkzeug.serving import make_server
@@ -216,7 +216,7 @@ def __init__(self, query_dict: Union[Mapping, MultiDict]):
         self.query_dict = query_dict
 
     def get_comparing_values(self, request_query_string: bytes) -> tuple:
-        query = werkzeug.urls.url_decode(request_query_string)
+        query = MultiDict(urllib.parse.parse_qsl(request_query_string.decode("utf-8")))
         if isinstance(self.query_dict, MultiDict):
             return (query, self.query_dict)
         else:
diff --git a/releasenotes/notes/werkzeug-urls-url_decode-deprecation-fix-56fe3c183b53f83b.yaml b/releasenotes/notes/werkzeug-urls-url_decode-deprecation-fix-56fe3c183b53f83b.yaml
@@ -0,0 +1,6 @@
+---
+fixes:
+  - |
+    Fix Werkzeug deprecation warning about ``werkzeug.urls.url_decode`` call. This
+    call has been changed to ``urllib.parse.parse_qsl`` in the implementation.
+    This fix should not introduce any functional change for the users.
diff --git a/tests/test_parse_qs.py b/tests/test_parse_qs.py
@@ -0,0 +1,30 @@
+import urllib.parse
+from typing import List
+from typing import Tuple
+
+import pytest
+import werkzeug.urls
+from werkzeug.datastructures import MultiDict
+
+parse_qsl_semicolon_cases = [
+    ("&", []),
+    ("&&", []),
+    ("&a=b", [("a", "b")]),
+    ("a=a+b&b=b+c", [("a", "a b"), ("b", "b c")]),
+    ("a=1&a=2", [("a", "1"), ("a", "2")]),
+    ("a=", [("a", "")]),
+    ("a=foo bar&b=bar foo", [("a", "foo bar"), ("b", "bar foo")]),
+    ("a=foo%20bar&b=bar%20foo", [("a", "foo bar"), ("b", "bar foo")]),
+    ("a=%20%21%22%23%24%25%26%27%28%29%2A%2B%2C%2F%3A%3B%3D%3F%40%5B%5D", [("a", " !\"#$%&'()*+,/:;=?@[]")]),
+]
+
+
+@pytest.mark.parametrize("qs,expected", parse_qsl_semicolon_cases)
+def test_qsl(qs: str, expected: List[Tuple[bytes, bytes]]):
+    assert urllib.parse.parse_qsl(qs, keep_blank_values=True) == expected
+
+
+@pytest.mark.skip(reason="skipped to avoid werkzeug warnings")
+@pytest.mark.parametrize("qs,expected", parse_qsl_semicolon_cases)
+def test_qsl_werkzeug(qs: str, expected: List[Tuple[bytes, bytes]]):
+    assert werkzeug.urls.url_decode(qs) == MultiDict(expected)
diff --git a/tests/test_release.py b/tests/test_release.py
@@ -205,6 +205,7 @@ def test_sdist_contents(build: Build, version: str):
             "test_oneshot.py",
             "test_ordered.py",
             "test_permanent.py",
+            "test_parse_qs.py",
             "test_port_changing.py",
             "test_querymatcher.py",
             "test_querystring.py",
