Merge lp:~cjwatson/lazr.restful/py3-resource-return-bytes into lp:lazr.restful

[Colin Watson]

Return bytes from HTTPResource.__call__ implementations.

[Ioana Lasc (ilasc)]

review: Approve

=== modified file 'src/lazr/restful/_resource.py'
--- src/lazr/restful/_resource.py	2020-09-24 10:01:25 +0000
+++ src/lazr/restful/_resource.py	2021-01-20 23:25:25 +0000
@@ -911,7 +911,7 @@
 
     def __call__(self):
         """Handle a GET, PUT, or PATCH request."""
-        result = ""
+        result = b""
         method = self.getRequestMethod()
         try:
             if method == "GET":
@@ -1251,7 +1251,7 @@
             self.request.response.setStatus(209)
             media_type = self.getPreferredSupportedContentType()
             self.request.response.setHeader('Content-type', media_type)
-            return self._representation(media_type)
+            return self._representation(media_type).encode('UTF-8')
         else:
             # The object moved. Serve a redirect to its new location.
             # This might not necessarily be the location of the entry!
@@ -1288,10 +1288,10 @@
         media_type = self.handleConditionalGET()
         if media_type is None:
             # The conditional GET succeeded. Serve nothing.
-            return ""
+            return b""
         else:
             self.request.response.setHeader('Content-Type', media_type)
-            return self._representation(media_type)
+            return self._representation(media_type).encode('UTF-8')
 
     def do_PUT(self, media_type, representation):
         """Overwrite the field's existing value with a new value."""
@@ -1328,7 +1328,7 @@
         elif media_type == self.XHTML_TYPE:
             name, value = self.unmarshallFieldToHTML(
                 self.context.name, self.context.field)
-            return encode_value(value)
+            return decode_value(value)
         else:
             raise AssertionError(
                     "No representation implementation for media type %s"
@@ -1564,10 +1564,10 @@
             media_type = self.handleConditionalGET()
             if media_type is None:
                 # The conditional GET succeeded. Serve nothing.
-                return ""
+                return b""
             else:
                 self.request.response.setHeader('Content-Type', media_type)
-                return self._representation(media_type)
+                return self._representation(media_type).encode('UTF-8')
 
     def do_PUT(self, media_type, representation):
         """Modify the entry's state to match the given representation.
@@ -1708,7 +1708,7 @@
         """Return a representation of this entry, of the given media type."""
 
         if media_type in [self.WADL_TYPE, self.DEPRECATED_WADL_TYPE]:
-            return self.toWADL().encode("utf-8")
+            return self.toWADL()
         elif media_type in (self.JSON_TYPE, self.JSON_PLUS_XHTML_TYPE):
             cache = self._representation_cache
             if cache is None:
@@ -1754,7 +1754,7 @@
                     representation = simplejson.dumps(json)
             return representation
         elif media_type == self.XHTML_TYPE:
-            return self.toXHTML().encode("utf-8")
+            return self.toXHTML()
         else:
             raise AssertionError(
                     "No representation implementation for media type %s"
@@ -1929,16 +1929,16 @@
         self.setCachingHeaders()
         if media_type is None:
             # The conditional GET succeeded. Serve nothing.
-            return ""
+            return b""
         elif media_type in [self.WADL_TYPE, self.DEPRECATED_WADL_TYPE]:
-            result = self.toWADL().encode("utf-8")
+            result = self.toWADL()
         elif media_type == self.JSON_TYPE:
             # Serve a JSON map containing links to all the top-level
             # resources.
             result = simplejson.dumps(self, cls=ResourceJSONEncoder)
 
         self.request.response.setHeader('Content-Type', media_type)
-        return result
+        return result.encode("utf-8")
 
     def toWADL(self):
         # Find all resource types.
 
=== modified file 'src/lazr/restful/docs/webservice.rst'
--- src/lazr/restful/docs/webservice.rst	2021-01-18 11:58:31 +0000
+++ src/lazr/restful/docs/webservice.rst	2021-01-20 23:25:25 +0000
@@ -1094,7 +1094,7 @@
     >>> import simplejson
     >>> import six
     >>> response = app(request)
-    >>> representation = simplejson.loads(six.text_type(response))
+    >>> representation = simplejson.loads(six.ensure_text(response))
 
     >>> print(representation["authors_collection_link"])
     http://api.cookbooks.dev/beta/authors