Merge lp:~cjwatson/lazr.restful/py3-normalize-doctests into lp:lazr.restful

[Colin Watson]

Make doctests of tracebacks work on both Python 2 and 3.

zope.testing.renormalizing allows this to work reasonably cleanly. The only downside is that expected exception messages have to be written on a single line.

[Ioana Lasc (ilasc)]

review: Approve

=== modified file 'setup.py'
--- setup.py	2020-02-13 00:01:12 +0000
+++ setup.py	2020-08-21 16:29:09 +0000
@@ -88,6 +88,7 @@
         "Programming Language :: Python"],
     extras_require=dict(
         docs=['Sphinx'],
+        test=['zope.testing>=4.6.0'],
         xml=['lxml',] # requiring this of normal users is too much
     ),
     test_suite='lazr.restful.tests',
 
=== modified file 'src/lazr/restful/docs/fields.rst'
--- src/lazr/restful/docs/fields.rst	2019-11-04 09:54:43 +0000
+++ src/lazr/restful/docs/fields.rst	2020-08-21 16:29:09 +0000
@@ -43,16 +43,18 @@
 But if the object isn't iterable, NotAContainer is raised.
 
     >>> int_collection.validate(object())
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
       ...
-    NotAContainer: <object...>
+    zope.schema._bootstrapinterfaces.NotAContainer: <object...>
 
 If the iterable contains an invalid item, WrongContainedType is raised.
 
     >>> int_collection.validate(['a', 1, 2, 'b'])
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
       ...
-    WrongContainedType: ...
+    zope.schema._bootstrapinterfaces.WrongContainedType: ...
 
 =========
 Reference
@@ -77,9 +79,10 @@
     ...     pass
     >>> fake = Fake()
     >>> reference.validate(fake)
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
       ...
-    SchemaNotProvided: ...
+    zope.schema._bootstrapinterfaces.SchemaNotProvided: ...
 
     >>> directlyProvides(fake, MySchema)
     >>> reference.validate(fake)
@@ -92,9 +95,10 @@
 
     >>> fake.a_value = 'bad'
     >>> reference.validate(fake)
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
       ...
-    ConstraintNotSatisfied...
+    zope.schema._bootstrapinterfaces.ConstraintNotSatisfied: ...
 
     >>> fake.a_value = 'good'
     >>> reference.validate(fake)
 
=== modified file 'src/lazr/restful/docs/interface.rst'
--- src/lazr/restful/docs/interface.rst	2020-02-04 11:52:59 +0000
+++ src/lazr/restful/docs/interface.rst	2020-08-21 16:29:09 +0000
@@ -174,9 +174,10 @@
 raised:
 
     >>> copy_field(MyModel['age'], title='This should be unicode')
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
       ...
-    WrongType: ...
+    zope.schema._bootstrapinterfaces.WrongType: ...
 
 That function can only be called on an IField:
 
 
=== modified file 'src/lazr/restful/docs/multiversion.rst'
--- src/lazr/restful/docs/multiversion.rst	2020-02-04 13:17:32 +0000
+++ src/lazr/restful/docs/multiversion.rst	2020-08-21 16:29:09 +0000
@@ -412,9 +412,10 @@
     >>> from zope.component import getAdapter
 
     >>> getAdapter(C1, IEntry)
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
     ...
-    ComponentLookupError: ...
+    zope.interface.interfaces.ComponentLookupError: ...
 
 When adapting Contact to IEntry you must provide a versioned request
 object. The IEntry object you get back will implement the appropriate
@@ -792,9 +793,10 @@
 
     >>> request = create_web_service_request('/1.0/contact_list')
     >>> resource = request.traverse(None)
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
     ...
-    NotFound: Object: <PostBetaServiceRootResource...>, name: u'contact_list'
+    zope.publisher.interfaces.NotFound: Object: <PostBetaServiceRootResource...>, name: ...'contact_list'
 
 Here's the contact list under its correct URL.
 
@@ -845,9 +847,10 @@
     >>> request_10 = create_web_service_request(
     ...     '/1.0/contacts/Cleo Python/fax')
     >>> field = request_10.traverse(None)
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
     ...
-    NotFound: Object: <Contact object...>, name: u'fax'
+    zope.publisher.interfaces.NotFound: Object: <Contact object...>, name: ...'fax'
 
 We can invoke a named operation. Note that the name of the operation
 is now 'find' (it was 'findContacts' in 'beta'). And note that
@@ -962,16 +965,18 @@
     >>> request_beta = create_web_service_request(
     ...     '/dev/contacts/Cleo Python/fax')
     >>> field = request_beta.traverse(None)
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
     ...
-    NotFound: Object: <Contact object...>, name: u'fax'
+    zope.publisher.interfaces.NotFound: Object: <Contact object...>, name: ...'fax'
 
     >>> request_beta = create_web_service_request(
     ...     '/dev/contacts/Cleo Python/fax_number')
     >>> field = request_beta.traverse(None)
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
     ...
-    NotFound: Object: <Contact object...>, name: u'fax_number'
+    zope.publisher.interfaces.NotFound: Object: <Contact object...>, name: ...'fax_number'
 
 We can invoke a named operation.
 
 
=== modified file 'src/lazr/restful/docs/webservice-declarations.rst'
--- src/lazr/restful/docs/webservice-declarations.rst	2020-08-10 16:48:03 +0000
+++ src/lazr/restful/docs/webservice-declarations.rst	2020-08-21 16:29:09 +0000
@@ -2651,12 +2651,10 @@
 explaining the problem.
 
     >>> register_test_module('wrongorder', WrongOrderVersions)
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
     ...
-    ConfigurationExecutionError: ...AssertionError...
-    Annotations on "WrongOrderVersions.method" put an earlier version
-    on top of a later version: "beta", "2.0", "1.0". The correct order
-    is: "beta", "1.0", "2.0"...
+    zope.configuration.config.ConfigurationExecutionError: ...AssertionError... Annotations on "WrongOrderVersions.method" put an earlier version on top of a later version: "beta", "2.0", "1.0". The correct order is: "beta", "1.0", "2.0"...
 
 Here's a class in which a named operation is removed in version 1.0
 and then annotated without being reinstated.
@@ -2673,11 +2671,10 @@
     ...         """A method."""
 
     >>> register_test_module('annotatingremoved', AnnotatingARemovedMethod)
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
     ...
-    ConfigurationExecutionError: ... Method "method" contains
-    annotations for version "2.0", even though it's not published in
-    that version. The bad annotations are: "as", "params"...
+    zope.configuration.config.ConfigurationExecutionError: ... Method "method" contains annotations for version "2.0", even though it's not published in that version. The bad annotations are: "as", "params"...
 
 Mutators as named operations
 ----------------------------
@@ -2745,9 +2742,10 @@
 named operations.
 
     >>> operation_for(context, '2.0', 'set_value')
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
     ...
-    ComponentLookupError: ...
+    zope.interface.interfaces.ComponentLookupError: ...
 
 Here's an entry that defines a mutator method in version 2.0, after
 the cutoff point.
@@ -2777,14 +2775,16 @@
 
     >>> context = Mutator20()
     >>> operation_for(context, '1.0', 'set_value')
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
     ...
-    ComponentLookupError: ...
+    zope.interface.interfaces.ComponentLookupError: ...
 
     >>> operation_for(context, '2.0', 'set_value')
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
     ...
-    ComponentLookupError: ...
+    zope.interface.interfaces.ComponentLookupError: ...
 
 Edge cases
 ==========
@@ -2826,9 +2826,10 @@
 defined yet.
 
     >>> print(operation_for(context, 'beta', 'set_value').__class__.__name__)
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
     ...
-    ComponentLookupError: ...
+    zope.interface.interfaces.ComponentLookupError: ...
 
 The operation is available in both '1.0', and '2.0', even though
 mutator operations aren't published as named operations after
@@ -2845,9 +2846,10 @@
 a mutator.
 
     >>> operation_for(context, '3.0', 'set_value')
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
     ...
-    ComponentLookupError: ...
+    zope.interface.interfaces.ComponentLookupError: ...
 
 But the mutator is active, as you can see by modifying the entry's field:
 
@@ -2958,9 +2960,10 @@
 
     >>> context = BetaMutator2()
     >>> operation_for(context, 'beta', 'set_value')
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
     ...
-    ComponentLookupError: ...
+    zope.interface.interfaces.ComponentLookupError: ...
 
 Getting the old behavior back
 -----------------------------
 
=== modified file 'src/lazr/restful/docs/webservice.rst'
--- src/lazr/restful/docs/webservice.rst	2020-08-17 11:46:51 +0000
+++ src/lazr/restful/docs/webservice.rst	2020-08-21 16:29:09 +0000
@@ -692,9 +692,10 @@
     >>> verifyObject(IAuthorEntry, InvalidAuthorEntry(A1, request))
     True
     >>> IAuthorEntry.validateInvariants(InvalidAuthorEntry(A1, request))
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
       ...
-    Invalid: InvalidAuthorEntry doesn't provide its ICookbookEntry schema.
+    zope.interface.exceptions.Invalid: InvalidAuthorEntry doesn't provide its ICookbookEntry schema.
 
 Other entries are defined similarly.
 
@@ -1748,9 +1749,10 @@
     ...     "Baked beans")
     >>> get_request = create_web_service_request(private_recipe_url)
     >>> recipe_resource = get_request.traverse(app)
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
     ...
-    Unauthorized: (<Recipe object...>, 'dish', ...)
+    zope.security.interfaces.Unauthorized: (<Recipe object...>, 'dish', ...)
 
 The recipe will not show up in collections:
 
@@ -1858,10 +1860,10 @@
     >>> cover_url = quote('/beta/cookbooks/The Joy of Cooking/cover')
     >>> get_request = create_web_service_request(cover_url)
     >>> file_resource = get_request.traverse(app)
-    >>> file_resource()
+    >>> file_resource()  # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
     ...
-    NotFound: ... name: 'cover'
+    zope.publisher.interfaces.NotFound: ... name: 'cover'
 
     >>> print(C2.cover)
     None
@@ -1897,10 +1899,10 @@
 
     >>> get_request = create_web_service_request(cover_url)
     >>> file_resource = get_request.traverse(app)
-    >>> file_resource()
+    >>> file_resource()  # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
     ...
-    NotFound: ... name: 'cover'
+    zope.publisher.interfaces.NotFound: ... name: 'cover'
 
     >>> print(C2.cover)
     None
@@ -1924,24 +1926,27 @@
 Requesting a non-existent top-level collection:
 
     >>> create_web_service_request('/beta/nosuchcollection').traverse(app)
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
     ...
-    NotFound: ... name: u'nosuchcollection'
+    zope.publisher.interfaces.NotFound: ... name: ...'nosuchcollection'
 
 Requesting a non-existent cookbook:
 
     >>> create_web_service_request('/beta/cookbooks/104').traverse(app)
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
     ...
-    NotFound: ... name: u'104'
+    zope.publisher.interfaces.NotFound: ... name: ...'104'
 
 Requesting a non-existent comment:
 
     >>> create_web_service_request(
     ...  '/beta/cookbooks/The%20Joy%20of%20Cooking/comments/10').traverse(app)
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
     ...
-    NotFound: ... name: u'comments/10'
+    zope.publisher.interfaces.NotFound: ... name: ...'comments/10'
 
 Manipulating entries
 ====================
@@ -2108,9 +2113,10 @@
 
     >>> resource = create_web_service_request(
     ...     recipe_url, method='GET').traverse(app)
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
     ...
-    NotFound: ... name: u'recipes/Foies de voilaille en aspic'
+    zope.publisher.interfaces.NotFound: ... name: ...'recipes/Foies de voilaille en aspic'
 
 
 Within a template
 
=== modified file 'src/lazr/restful/example/base/tests/representation-cache.txt'
--- src/lazr/restful/example/base/tests/representation-cache.txt	2020-07-22 23:22:26 +0000
+++ src/lazr/restful/example/base/tests/representation-cache.txt	2020-08-21 16:29:09 +0000
@@ -13,9 +13,10 @@
     >>> from zope.component import getUtility
     >>> from lazr.restful.interfaces import IRepresentationCache
     >>> getUtility(IRepresentationCache)
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
     ...
-    ComponentLookupError: ...
+    zope.interface.interfaces.ComponentLookupError: ...
 
 DictionaryBasedRepresentationCache
 ==================================
 
=== modified file 'src/lazr/restful/example/base/tests/test_integration.py'
--- src/lazr/restful/example/base/tests/test_integration.py	2020-02-04 11:52:59 +0000
+++ src/lazr/restful/example/base/tests/test_integration.py	2020-08-21 16:29:09 +0000
@@ -12,6 +12,7 @@
 from pkg_resources import resource_filename
 
 from van.testing.layer import zcml_layer, wsgi_intercept_layer
+from zope.testing import renormalizing
 
 from lazr.restful.example.base.root import CookbookServiceRootResource
 from lazr.restful.testing.webservice import (
@@ -28,6 +29,10 @@
     doctest.NORMALIZE_WHITESPACE |
     doctest.REPORT_NDIFF)
 
+
+checker = renormalizing.OutputChecker()
+
+
 class FunctionalLayer:
     allow_teardown = False
     zcml = os.path.abspath(resource_filename('lazr.restful', 'ftesting.zcml'))
@@ -52,7 +57,8 @@
         'print_function': print_function,
         }
     suite = doctest.DocFileSuite(
-        *doctest_files, optionflags=DOCTEST_FLAGS, globs=globs)
+        *doctest_files, optionflags=DOCTEST_FLAGS, globs=globs,
+        checker=checker)
     suite.layer = WSGILayer
     tests.addTest(suite)
     return tests
 
=== modified file 'src/lazr/restful/example/base/tests/traversal.txt'
--- src/lazr/restful/example/base/tests/traversal.txt	2009-09-01 13:10:07 +0000
+++ src/lazr/restful/example/base/tests/traversal.txt	2020-08-21 16:29:09 +0000
@@ -21,6 +21,7 @@
 error.
 
     >>> container.publishTraverse(request, "nosuchname")
+    ... # doctest: +IGNORE_EXCEPTION_MODULE_IN_PYTHON2
     Traceback (most recent call last):
     ...
-    NotFound: ... name: 'nosuchname'
+    zope.publisher.interfaces.NotFound: ... name: 'nosuchname'
 
=== modified file 'src/lazr/restful/example/base_extended/tests/test_integration.py'
--- src/lazr/restful/example/base_extended/tests/test_integration.py	2020-02-04 11:52:59 +0000
+++ src/lazr/restful/example/base_extended/tests/test_integration.py	2020-08-21 16:29:09 +0000
@@ -12,12 +12,16 @@
 from pkg_resources import resource_filename
 
 from van.testing.layer import zcml_layer, wsgi_intercept_layer
+from zope.testing import renormalizing
 
 from lazr.restful.example.base.tests.test_integration import (
     CookbookWebServiceTestPublication, DOCTEST_FLAGS)
 from lazr.restful.testing.webservice import WebServiceApplication
 
 
+checker = renormalizing.OutputChecker()
+
+
 class FunctionalLayer:
     allow_teardown = False
     zcml = os.path.abspath(resource_filename(
@@ -40,7 +44,8 @@
         'print_function': print_function,
         }
     suite = doctest.DocFileSuite(
-        *doctest_files, optionflags=DOCTEST_FLAGS, globs=globs)
+        *doctest_files, optionflags=DOCTEST_FLAGS, globs=globs,
+        checker=checker)
     suite.layer = WSGILayer
     tests.addTest(suite)
     return tests
 
=== modified file 'src/lazr/restful/example/multiversion/tests/test_integration.py'
--- src/lazr/restful/example/multiversion/tests/test_integration.py	2020-02-04 11:52:59 +0000
+++ src/lazr/restful/example/multiversion/tests/test_integration.py	2020-08-21 16:29:09 +0000
@@ -11,8 +11,9 @@
 import doctest
 from pkg_resources import resource_filename
 
+from van.testing.layer import zcml_layer, wsgi_intercept_layer
 from zope.component import getUtility
-from van.testing.layer import zcml_layer, wsgi_intercept_layer
+from zope.testing import renormalizing
 
 from lazr.restful.example.multiversion.root import (
     MultiversionWebServiceRootResource)
@@ -27,6 +28,9 @@
     doctest.REPORT_NDIFF)
 
 
+checker = renormalizing.OutputChecker()
+
+
 class FunctionalLayer:
     zcml = os.path.abspath(resource_filename(
         'lazr.restful.example.multiversion', 'site.zcml'))
@@ -55,7 +59,8 @@
         'print_function': print_function,
         }
     suite = doctest.DocFileSuite(
-        *doctest_files, optionflags=DOCTEST_FLAGS, globs=globs)
+        *doctest_files, optionflags=DOCTEST_FLAGS, globs=globs,
+        checker=checker)
     suite.layer = WSGILayer
     tests.addTest(suite)
     return tests
 
=== modified file 'src/lazr/restful/example/wsgi/tests/test_integration.py'
--- src/lazr/restful/example/wsgi/tests/test_integration.py	2020-02-04 11:52:59 +0000
+++ src/lazr/restful/example/wsgi/tests/test_integration.py	2020-08-21 16:29:09 +0000
@@ -11,8 +11,9 @@
 import doctest
 from pkg_resources import resource_filename
 
+from van.testing.layer import zcml_layer, wsgi_intercept_layer
 from zope.component import getUtility
-from van.testing.layer import zcml_layer, wsgi_intercept_layer
+from zope.testing import renormalizing
 
 from lazr.restful.example.wsgi.root import WSGIExampleWebServiceRootResource
 from lazr.restful.interfaces import IWebServiceConfiguration
@@ -25,6 +26,10 @@
     doctest.NORMALIZE_WHITESPACE |
     doctest.REPORT_NDIFF)
 
+
+checker = renormalizing.OutputChecker()
+
+
 class FunctionalLayer:
     zcml = os.path.abspath(resource_filename(
         'lazr.restful.example.wsgi', 'site.zcml'))
@@ -52,7 +57,8 @@
         'print_function': print_function,
         }
     suite = doctest.DocFileSuite(
-        *doctest_files, optionflags=DOCTEST_FLAGS, globs=globs)
+        *doctest_files, optionflags=DOCTEST_FLAGS, globs=globs,
+        checker=checker)
     suite.layer = WSGILayer
     tests.addTest(suite)
     return tests
 
=== modified file 'src/lazr/restful/tests/test_docs.py'
--- src/lazr/restful/tests/test_docs.py	2020-08-10 15:05:58 +0000
+++ src/lazr/restful/tests/test_docs.py	2020-08-21 16:29:09 +0000
@@ -27,7 +27,7 @@
 import os
 from pkg_resources import (
     resource_filename, resource_exists, resource_listdir, cleanup_resources)
-
+from zope.testing import renormalizing
 from zope.testing.cleanup import cleanUp
 
 
@@ -37,6 +37,9 @@
     doctest.REPORT_NDIFF)
 
 
+checker = renormalizing.OutputChecker()
+
+
 def tearDown(test):
     """Run registered clean-up function."""
     cleanUp()
@@ -58,5 +61,5 @@
         }
     tests.addTest(doctest.DocFileSuite(
         *doctest_files, module_relative=False, optionflags=DOCTEST_FLAGS,
-        tearDown=tearDown, globs=globs, encoding='UTF-8'))
+        tearDown=tearDown, globs=globs, encoding='UTF-8', checker=checker))
     return tests