Merge pull request #283 from twm/282-params

Permit & and # in params

Author: twm

changelog.d/282.bugfix.rst

@@ -0,0 +1,2 @@
+In treq 20.3.0 the *params* argument didn't accept parameter names or values that contain the characters ``&`` or ``#``.
+Now these characters are properly escaped.

src/treq/client.py

@@ -10,7 +10,7 @@
 from twisted.python.components import proxyForInterface
 from twisted.python.compat import _PY3, unicode
 from twisted.python.filepath import FilePath
-from hyperlink import URL
+from hyperlink import parse as _parse_url
 
 from twisted.web.http_headers import Headers
 from twisted.web.iweb import IBodyProducer, IResponse
@@ -155,9 +155,9 @@ def request(self, method, url, **kwargs):
         method = method.encode('ascii').upper()
 
         if isinstance(url, unicode):
-            parsed_url = URL.from_text(url)
+            parsed_url = _parse_url(url)
         else:
-            parsed_url = URL.from_text(url.decode('ascii'))
+            parsed_url = _parse_url(url.decode('ascii'))
 
         # Join parameters provided in the URL
         # and the ones passed as argument.

src/treq/test/test_client.py

@@ -139,6 +139,33 @@ def test_request_tuple_query_param_coercion(self):
             None,
         )
 
+    def test_request_query_param_seps(self):
+        """
+        When the characters ``&`` and ``#`` are passed to *params* as param
+        names or values they are percent-escaped in the URL.
+
+        This reproduces https://github.com/twisted/treq/issues/282
+        """
+        self.client.request('GET', 'http://example.com/', params=(
+            ('ampersand', '&'),
+            ('&', 'ampersand'),
+            ('octothorpe', '#'),
+            ('#', 'octothorpe'),
+        ))
+
+        self.agent.request.assert_called_once_with(
+            b'GET',
+            (
+                b'http://example.com/'
+                b'?ampersand=%26'
+                b'&%26=ampersand'
+                b'&octothorpe=%23'
+                b'&%23=octothorpe'
+            ),
+            Headers({b'accept-encoding': [b'gzip']}),
+            None,
+        )
+
     def test_request_merge_query_params(self):
         self.client.request('GET', 'http://example.com/?baz=bax',
                             params={'foo': ['bar', 'baz']})