Merge lp:~cjwatson/lazr.restful/docutils-0.8-compat into lp:lazr.restful

[Colin Watson]

Fix compatibility with docutils >= 0.8 under "zope.testrunner --subunit".

When zope.testrunner is asked for subunit output, it replaces sys.stdout with a StringIO. Following http://repo.or.cz/docutils.git/commitdiff/14cde9fb, this confuses docutils into autoclosing the stdout stream in use by subunit, which broke the Launchpad test suite following an upgrade to docutils 0.14.

_PydocParser uses epydoc.markup.restructuredtext._DocumentPseudoWriter, which never writes any output, so the simplest fix for this is just to tell docutils.core.Publisher to use docutils.io.NullOutput for its output, which removes any risk of it going anywhere near stdout.

[Maximiliano Bertacchini (maxiberta)]

Looks good to me.

review: Approve

=== modified file 'setup.py'
--- setup.py	2016-02-17 01:07:21 +0000
+++ setup.py	2018-02-21 15:07:55 +0000
@@ -53,7 +53,7 @@
         'src/lazr/restful/NEWS.txt'),
     license='LGPL v3',
     install_requires=[
-        'docutils',
+        'docutils>=0.3.7',
         'epydoc', # used by wadl generation
         'grokcore.component==1.6',
         'lazr.batchnavigator>=1.2.0-dev',
 
=== modified file 'src/lazr/restful/NEWS.txt'
--- src/lazr/restful/NEWS.txt	2017-06-29 00:36:47 +0000
+++ src/lazr/restful/NEWS.txt	2018-02-21 15:07:55 +0000
@@ -2,6 +2,12 @@
 NEWS for lazr.restful
 =====================
 
+0.20.1
+======
+
+Adjust docstring rendering to avoid closing sys.stdout when running under
+"zope.testrunner --subunit" with docutils >= 0.8.
+
 0.20.0 (2017-06-29)
 ===================
 
 
=== modified file 'src/lazr/restful/tales.py'
--- src/lazr/restful/tales.py	2016-02-17 01:07:21 +0000
+++ src/lazr/restful/tales.py	2018-02-21 15:07:55 +0000
@@ -83,7 +83,8 @@
         self.writer = _DocumentPseudoWriter()
         self.publisher = Publisher(_EpydocReader(self.errors),
             writer=self.writer,
-            source_class=io.StringInput)
+            source_class=io.StringInput,
+            destination_class=io.NullOutput)
         self.publisher.set_components('standalone', 'restructuredtext',
             'pseudoxml')
         settings_overrides={