Merge lp:~cjwatson/lazr.restful/py3-request-body into lp:lazr.restful

[Colin Watson]

Adjust request creation for Python 3.

The body_instream argument to BaseRequest (and its subclasses) is supposed to be a binary file object.

[Tom Wardill (twom)]

review: Approve

=== modified file 'src/lazr/restful/docs/webservice-marshallers.rst'
--- src/lazr/restful/docs/webservice-marshallers.rst	2020-06-30 15:52:03 +0000
+++ src/lazr/restful/docs/webservice-marshallers.rst	2020-07-22 23:16:15 +0000
@@ -457,8 +457,8 @@
 Since multipart/form-data can be used to upload data, file-like objects
 are read.
 
-    >>> from cStringIO import StringIO
-    >>> marshaller.marshall_from_request(StringIO('A line of data'))
+    >>> from io import BytesIO
+    >>> marshaller.marshall_from_request(BytesIO(b'A line of data'))
     'A line of data'
 
 Bytes field used in an entry are stored in the librarian, so their

=== modified file 'src/lazr/restful/docs/webservice.rst'
--- src/lazr/restful/docs/webservice.rst	2020-02-04 13:17:32 +0000
+++ src/lazr/restful/docs/webservice.rst	2020-07-22 23:16:15 +0000
@@ -1275,8 +1275,8 @@
 operation's definition doesn't set send_modified_event to True, no
 event will be sent and modified_cookbook_set() won't be called.
 
-    >>> body = ("ws.op=create_cookbook&title=Beard%20on%20Bread&"
-    ...         "author_name=James%20Beard")
+    >>> body = (b"ws.op=create_cookbook&title=Beard%20on%20Bread&"
+    ...         b"author_name=James%20Beard")
     >>> request = create_web_service_request(
     ...     '/beta/cookbooks', 'POST', body,
     ...     {'CONTENT_TYPE' : 'application/x-www-form-urlencoded'})
@@ -1290,8 +1290,8 @@
 
 Here we create a cookbook for a new author.
 
-    >>> body = ("ws.op=create_cookbook&title=Everyday%20Greens&"
-    ...         "author_name=Deborah%20Madison")
+    >>> body = (b"ws.op=create_cookbook&title=Everyday%20Greens&"
+    ...         b"author_name=Deborah%20Madison")
     >>> request = create_web_service_request(
     ...     '/beta/cookbooks', 'POST', body,
     ...     {'CONTENT_TYPE' : 'application/x-www-form-urlencoded'})
@@ -1315,7 +1315,7 @@
 this operation's definition does set send_modified_event to True, an
 event will be sent and modified_cookbook_set() will be called.
 
-    >>> body = "ws.op=make_more_interesting"
+    >>> body = b"ws.op=make_more_interesting"
     >>> request = create_web_service_request(
     ...     '/beta/cookbooks/Everyday%20Greens', 'POST', body,
     ...     {'CONTENT_TYPE' : 'application/x-www-form-urlencoded'})
@@ -1389,8 +1389,8 @@
 For instance, creating a new cookbook and making a request to its URL
 will wrap it into an ``EntryResource``.
 
-    >>> body = ("ws.op=create_cookbook&title=Feijoada&"
-    ...         "author_name=Fernando%20Yokota")
+    >>> body = (b"ws.op=create_cookbook&title=Feijoada&"
+    ...         b"author_name=Fernando%20Yokota")
     >>> request = create_web_service_request(
     ...     '/beta/cookbooks', 'POST', body,
     ...     {'CONTENT_TYPE' : 'application/x-www-form-urlencoded'})
@@ -1795,7 +1795,7 @@
 set the field value to 'tag:launchpad.net:2008:redacted'.
 
     >>> headers = {'CONTENT_TYPE' : 'application/json'}
-    >>> body = simplejson.dumps(author)
+    >>> body = simplejson.dumps(author).encode('UTF-8')
     >>> put_request = create_web_service_request(
     ...     beard_url, body=body, environ=headers, method='PUT')
     >>> put_request.traverse(app)()
@@ -1808,7 +1808,7 @@
     >>> author['favorite_recipe_link'] = 'http://' + quote(
     ...     'api.cookbooks.dev/beta/cookbooks/'
     ...     'The Joy of Cooking/recipes/Roast chicken')
-    >>> body = simplejson.dumps(author)
+    >>> body = simplejson.dumps(author).encode('UTF-8')
     >>> put_request = create_web_service_request(
     ...     beard_url, body=body, environ=headers, method='PUT')
     >>> put_request.traverse(app)()
@@ -1828,7 +1828,7 @@
 
     >>> author['favorite_recipe_link'] = (
     ...     'http://api.cookbooks.dev' + private_recipe_url)
-    >>> body = simplejson.dumps(author)
+    >>> body = simplejson.dumps(author).encode('UTF-8')
     >>> put_request = create_web_service_request(
     ...     beard_url, body=body, environ=headers, method='PUT')
     >>> print(put_request.traverse(app)())
@@ -1869,7 +1869,7 @@
 A cookbook can be given a cover with PUT.
 
     >>> headers = {'CONTENT_TYPE' : 'image/png'}
-    >>> body = 'Pretend this is an image.'
+    >>> body = b'Pretend this is an image.'
     >>> put_request = create_web_service_request(
     ...     cover_url, body=body, environ=headers, method='PUT')
     >>> file_resource = put_request.traverse(app)
@@ -1958,8 +1958,8 @@
 non-ASCII characters.
 
     >>> headers = {'CONTENT_TYPE' : 'application/json'}
-    >>> body = '''{"name" : "The Joy of Cooking (revised)",
-    ...            "cuisine" : "\xd7\x97\xd7\x95\xd7\x9e\xd7\x95\xd7\xa1"}'''
+    >>> body = b'''{"name" : "The Joy of Cooking (revised)",
+    ...             "cuisine" : "\xd7\x97\xd7\x95\xd7\x9e\xd7\x95\xd7\xa1"}'''
 
     >>> patch_request = create_web_service_request(
     ...     '/beta/cookbooks/The%20Joy%20of%20Cooking', body=body,
@@ -1993,7 +1993,7 @@
 intercepted by the modified_cookbook() listener.
 
     >>> joy['name'] = 'The Joy of Cooking'
-    >>> body = simplejson.dumps(joy)
+    >>> body = simplejson.dumps(joy).encode('UTF-8')
     >>> put_request = create_web_service_request(
     ...     '/beta/cookbooks/The%20Joy%20of%20Cooking%20%28revised%29',
     ...     body=body, environ=headers, method='PUT')
@@ -2032,8 +2032,8 @@
     ...     representation = {'author_link' : new_author_link}
     ...     resource = create_web_service_request(
     ...         '/beta/cookbooks/The%20Joy%20of%20Cooking',
-    ...         body=simplejson.dumps(representation), environ=headers,
-    ...         method='PATCH', hostname=host).traverse(app)
+    ...         body=simplejson.dumps(representation).encode('UTF-8'),
+    ...         environ=headers, method='PATCH', hostname=host).traverse(app)
     ...     return resource()
     >>> path = '/beta/authors/Julia%20Child'
 

=== modified file 'src/lazr/restful/marshallers.py'
--- src/lazr/restful/marshallers.py	2020-06-30 15:52:03 +0000
+++ src/lazr/restful/marshallers.py	2020-07-22 23:16:15 +0000
@@ -25,8 +25,8 @@
     ]
 
 from datetime import datetime
+from io import BytesIO
 import pytz
-from StringIO import StringIO
 
 import simplejson
 from six.moves.urllib.parse import unquote
@@ -121,7 +121,7 @@
         server_url = self.request.get('SERVER_URL')
         if server_url is not None:
             environ['SERVER_URL'] = server_url
-        request = config.createRequest(StringIO(), environ)
+        request = config.createRequest(BytesIO(), environ)
         request.setTraversalStack(path_parts)
         root = request.publication.getApplication(self.request)
         return request.traverse(root)

=== modified file 'src/lazr/restful/testing/webservice.py'
--- src/lazr/restful/testing/webservice.py	2020-02-04 21:53:16 +0000
+++ src/lazr/restful/testing/webservice.py	2020-07-22 23:16:15 +0000
@@ -20,7 +20,7 @@
     'WebServiceTestPublication',
     ]
 
-from cStringIO import StringIO
+from io import BytesIO
 import simplejson
 import sys
 from types import ModuleType
@@ -81,10 +81,10 @@
     if environ is not None:
         test_environ.update(environ)
     if body is None:
-        body_instream = StringIO('')
+        body_instream = BytesIO(b'')
     else:
         test_environ['CONTENT_LENGTH'] = len(body)
-        body_instream = StringIO(body)
+        body_instream = BytesIO(body)
     request = config.createRequest(body_instream, test_environ)
 
     request.processInputs()

=== modified file 'src/lazr/restful/tests/test_webservice.py'
--- src/lazr/restful/tests/test_webservice.py	2020-02-19 16:09:10 +0000
+++ src/lazr/restful/tests/test_webservice.py	2020-07-22 23:16:15 +0000
@@ -8,6 +8,7 @@
 
 from contextlib import contextmanager
 from cStringIO import StringIO
+from io import BytesIO
 from lxml import etree
 from operator import attrgetter
 from textwrap import dedent
@@ -156,7 +157,7 @@
     def request(self, media_type=None):
         media_type = media_type or self.default_media_type
         request = getUtility(IWebServiceConfiguration).createRequest(
-            StringIO(""), {'HTTP_ACCEPT' : media_type})
+            BytesIO(b""), {'HTTP_ACCEPT' : media_type})
         newInteraction(request)
         yield request
         endInteraction()