Merge lp:~cjwatson/lazr.restful/py3-doctest-trivial into lp:lazr.restful

[Colin Watson]

Fix various simple doctest failures on Python 3.

These are mainly bytes/text issues, with a couple of other small adjustments.

[Cristian Gonzalez (cristiangsp)]

Looks good!

review: Approve

=== modified file 'src/lazr/restful/docs/interface.rst'
--- src/lazr/restful/docs/interface.rst	2020-09-07 09:54:10 +0000
+++ src/lazr/restful/docs/interface.rst	2021-01-18 12:01:41 +0000
@@ -173,7 +173,7 @@
 If the value for an overridden field is invalid, an exception will be
 raised:
 
-    >>> copy_field(MyModel['age'], title='This should be unicode')
+    >>> copy_field(MyModel['age'], title=b'This should be unicode')
     ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
       ...
 
=== modified file 'src/lazr/restful/docs/webservice-declarations.rst'
--- src/lazr/restful/docs/webservice-declarations.rst	2020-09-07 09:54:10 +0000
+++ src/lazr/restful/docs/webservice-declarations.rst	2021-01-18 12:01:41 +0000
@@ -227,7 +227,7 @@
     ...     pass
     Traceback (most recent call last):
       ...
-    TypeError: __init__() takes exactly 2 arguments (1 given)
+    TypeError: __init__() ...
 
     >>> @exported_as_webservice_collection("not an interface")
     ... class InvalidEntrySchema(Interface):
 
=== modified file 'src/lazr/restful/docs/webservice.rst'
--- src/lazr/restful/docs/webservice.rst	2020-09-07 09:54:10 +0000
+++ src/lazr/restful/docs/webservice.rst	2021-01-18 12:01:41 +0000
@@ -1124,7 +1124,7 @@
     >>> wadl_request = create_web_service_request(
     ...     '/beta/', environ=wadl_headers)
     >>> wadl_resource = wadl_request.traverse(app)
-    >>> print(wadl_resource(wadl_request))
+    >>> print(wadl_resource(wadl_request).decode('UTF-8'))
     <?xml version="1.0"?>
     <!DOCTYPE...
     <wadl:application ...>
@@ -1169,7 +1169,7 @@
 
     >>> def load_json(s):
     ...     """Convert a JSON string to Unicode and then load it."""
-    ...     return simplejson.loads(six.text_type(s))
+    ...     return simplejson.loads(six.ensure_text(s))
 
     >>> representation = load_json(collection())
     >>> print(representation['resource_type_link'])
@@ -1682,7 +1682,7 @@
     ...         headers['HTTP_IF_NONE_MATCH'] = etag
     ...     get_request = create_web_service_request(
     ...         julia_url, environ=headers)
-    ...     entity_body = get_request.traverse(app)()
+    ...     entity_body = six.ensure_text(get_request.traverse(app)())
     ...     return dict(entity_body=entity_body,
     ...                 response=get_request.response)
 
@@ -1824,8 +1824,8 @@
     >>> 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)()
-    '{...}'
+    >>> print(six.ensure_text(put_request.traverse(app)()))
+    {...}
 
 And since no special permission is necessary to _change_ a person's
 'favorite_recipe', it's possible to set it to a visible recipe using
@@ -1837,8 +1837,8 @@
     >>> 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)()
-    '{...}'
+    >>> print(six.ensure_text(put_request.traverse(app)()))
+    {...}
 
 After that PUT, James Beard's 'favorite_recipe' attribute is no longer
 redacted. It's the value set by the PUT request.
@@ -1901,8 +1901,8 @@
     >>> file_resource = put_request.traverse(app)
     >>> file_resource()
 
-    >>> C2.cover.representation
-    'Pretend...'
+    >>> print(six.ensure_str(C2.cover.representation))
+    Pretend...
 
 At this point it exists:
 
@@ -1938,7 +1938,7 @@
 
     >>> field_resource = create_web_service_request(
     ...     '/beta/cookbooks/The%20Joy%20of%20Cooking/name').traverse(app)
-    >>> print(field_resource())
+    >>> print(six.ensure_text(field_resource()))
     "The Joy of Cooking"
 
 Requesting non available resources
@@ -2063,11 +2063,11 @@
     ...         '/beta/cookbooks/The%20Joy%20of%20Cooking',
     ...         body=simplejson.dumps(representation).encode('UTF-8'),
     ...         environ=headers, method='PATCH', hostname=host).traverse(app)
-    ...     return resource()
+    ...     return six.ensure_text(resource())
     >>> path = '/beta/authors/Julia%20Child'
 
-    >>> change_joy_author(u'http://api.cookbooks.dev' + path)
-    '{...}'
+    >>> print(change_joy_author(u'http://api.cookbooks.dev' + path))
+    {...}
 
     >>> joy_resource = create_web_service_request(
     ...     '/beta/cookbooks/The%20Joy%20of%20Cooking').traverse(app)
@@ -2126,7 +2126,7 @@
 
     >>> resource = create_web_service_request(
     ...     recipe_url, method='GET').traverse(app)
-    >>> print(resource())
+    >>> print(six.ensure_text(resource()))
     {...}
 
     >>> resource = create_web_service_request(
 
=== modified file 'src/lazr/restful/example/base/tests/entry.txt'
--- src/lazr/restful/example/base/tests/entry.txt	2020-09-07 09:54:10 +0000
+++ src/lazr/restful/example/base/tests/entry.txt	2021-01-18 12:01:41 +0000
@@ -31,8 +31,8 @@
 convert it into Unicode.
 
     >>> construsions_url = quote("/cookbooks/Construsions un repas")
-    >>> webservice.get(construsions_url).jsonBody()['cuisine']
-    u'Fran\xe7aise'
+    >>> print(webservice.get(construsions_url).jsonBody()['cuisine'])
+    Française
 
 Content negotiation
 ===================
@@ -118,7 +118,9 @@
 Getting the XHTML representation works correctly even when some of the fields
 have non-ascii values.
 
-    >>> print(webservice.get(construsions_url, 'application/xhtml+xml'))
+    >>> import six
+    >>> print(six.text_type(
+    ...     webservice.get(construsions_url, 'application/xhtml+xml')))
     HTTP/1.1 200 Ok
     ...
     <dl ...>
 
=== modified file 'src/lazr/restful/example/base/tests/root.txt'
--- src/lazr/restful/example/base/tests/root.txt	2020-09-07 09:54:10 +0000
+++ src/lazr/restful/example/base/tests/root.txt	2021-01-18 12:01:41 +0000
@@ -80,8 +80,8 @@
     ...     '/', headers={'If-None-Match' : etag})
     >>> conditional_response.status
     304
-    >>> conditional_response.body
-    ''
+    >>> print(conditional_response.body.decode('UTF-8'))
+    <BLANKLINE>
 
     >>> conditional_response = webservice.get(
     ...     '/', headers={'If-None-Match' : '"a-very-old-etag"'})
 
=== modified file 'src/lazr/restful/example/base/tests/test_integration.py'
--- src/lazr/restful/example/base/tests/test_integration.py	2020-08-21 16:16:09 +0000
+++ src/lazr/restful/example/base/tests/test_integration.py	2021-01-18 12:01:41 +0000
@@ -58,7 +58,7 @@
         }
     suite = doctest.DocFileSuite(
         *doctest_files, optionflags=DOCTEST_FLAGS, globs=globs,
-        checker=checker)
+        encoding='UTF-8', checker=checker)
     suite.layer = WSGILayer
     tests.addTest(suite)
     return tests
 
=== modified file 'src/lazr/restful/example/base/tests/wadl.txt'
--- src/lazr/restful/example/base/tests/wadl.txt	2020-09-02 22:25:01 +0000
+++ src/lazr/restful/example/base/tests/wadl.txt	2021-01-18 12:01:41 +0000
@@ -21,7 +21,7 @@
 
 It's an XML document.
 
-    >>> print(wadl)
+    >>> print(wadl.decode('UTF-8'))
     <?xml version="1.0"?>
     <wadl:application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns="http://research.sun.com/wadl/2006/10"
@@ -35,7 +35,8 @@
     >>> from lxml import etree
     >>> from lazr.restful import WADL_SCHEMA_FILE
 
-    >>> wadl_schema = etree.XMLSchema(etree.parse(open(WADL_SCHEMA_FILE)))
+    >>> with open(WADL_SCHEMA_FILE) as wadl_schema_file:
+    ...     wadl_schema = etree.XMLSchema(etree.parse(wadl_schema_file))
     >>> from io import StringIO
     >>> def validate(body):
     ...     res = wadl_schema.validate(
 
=== modified file 'src/lazr/restful/example/multiversion/tests/introduction.txt'
--- src/lazr/restful/example/multiversion/tests/introduction.txt	2020-09-07 09:54:10 +0000
+++ src/lazr/restful/example/multiversion/tests/introduction.txt	2021-01-18 12:01:41 +0000
@@ -245,8 +245,9 @@
 If an entry field is not published in a certain version, the
 corresponding field resource does not exist for that version.
 
-    >>> print(webservice.get('/pairs/foo/deleted', api_version='beta').body)
-    Object: <...>, name: u'deleted'
+    >>> print(webservice.get(
+    ...     '/pairs/foo/deleted', api_version='beta').body.decode('UTF-8'))
+    Object: <...>, name: ...'deleted'
 
     >>> print(webservice.get(
     ...     '/pairs/foo/deleted', api_version='3.0').jsonBody())
 
=== modified file 'src/lazr/restful/example/multiversion/tests/wadl.txt'
--- src/lazr/restful/example/multiversion/tests/wadl.txt	2020-02-04 11:52:59 +0000
+++ src/lazr/restful/example/multiversion/tests/wadl.txt	2021-01-18 12:01:41 +0000
@@ -111,13 +111,13 @@
 Now if we request the WADL for 3.0 it will include a description of
 total_size_link.
 
-    >>> webservice.get('/', media_type='application/vnd.sun.wadl+xml',
-    ...     api_version='3.0').body
-    '...<wadl:param style="plain" name="total_size_link"...'
+    >>> print(webservice.get('/', media_type='application/vnd.sun.wadl+xml',
+    ...     api_version='3.0').body.decode('UTF-8'))
+    <?xml version="1.0"?>...<wadl:param style="plain" name="total_size_link"...
 
 If we request an earlier version, total_size_link is not described.
 
     >>> wadl = webservice.get('/', media_type='application/vnd.sun.wadl+xml',
-    ...     api_version='2.0').body
+    ...     api_version='2.0').body.decode('UTF-8')
     >>> 'total_size_link' in wadl
     False