| 1 |
import sys |
| 2 |
import os |
| 3 |
import tempfile |
| 4 |
import shutil |
| 5 |
from io import StringIO |
| 6 |
|
| 7 |
from docutils import nodes |
| 8 |
from docutils.parsers.rst import directives, roles |
| 9 |
from sphinx import application |
| 10 |
from sphinx.builders.latex import LaTeXBuilder |
| 11 |
from sphinx.pycode import ModuleAnalyzer |
| 12 |
|
| 13 |
|
| 14 |
rootdir = os.path.abspath(os.path.dirname(__file__) or '.') |
| 15 |
|
| 16 |
|
| 17 |
class ListOutput(object): |
| 18 |
""" |
| 19 |
File-like object that collects written text in a list. |
| 20 |
""" |
| 21 |
def __init__(self, name): |
| 22 |
self.name = name |
| 23 |
self.content = [] |
| 24 |
|
| 25 |
def reset(self): |
| 26 |
del self.content[:] |
| 27 |
|
| 28 |
def write(self, text): |
| 29 |
self.content.append(text) |
| 30 |
|
| 31 |
|
| 32 |
class SphinxTestApp(application.Sphinx): |
| 33 |
""" |
| 34 |
A subclass of :class:`Sphinx` that runs on the test root, with some |
| 35 |
better default values for the initialization parameters. |
| 36 |
""" |
| 37 |
|
| 38 |
def __init__( |
| 39 |
self, |
| 40 |
buildername='html', |
| 41 |
testroot=None, |
| 42 |
srcdir=None, |
| 43 |
freshenv=False, |
| 44 |
confoverrides=None, |
| 45 |
status=None, |
| 46 |
warning=None, |
| 47 |
tags=None, |
| 48 |
docutilsconf=None, |
| 49 |
): |
| 50 |
if testroot is None: |
| 51 |
defaultsrcdir = 'root' |
| 52 |
testroot = os.path.join(rootdir, 'root') |
| 53 |
else: |
| 54 |
defaultsrcdir = 'test-' + testroot |
| 55 |
testroot = os.path.join(rootdir, 'roots', ('test-' + testroot)) |
| 56 |
|
| 57 |
self.__tempdir = os.path.abspath(tempfile.mkdtemp()) |
| 58 |
|
| 59 |
|
| 60 |
if srcdir is None: |
| 61 |
srcdir = os.path.join(self.__tempdir, defaultsrcdir) |
| 62 |
else: |
| 63 |
srcdir = os.path.join(self.__tempdir, srcdir) |
| 64 |
|
| 65 |
if not os.path.exists(srcdir): |
| 66 |
shutil.copytree(testroot, srcdir, symlinks=False) |
| 67 |
|
| 68 |
if docutilsconf is not None: |
| 69 |
with open(os.path.join(srcdir, 'docutils.conf')) as f: |
| 70 |
f.write(docutilsconf) |
| 71 |
|
| 72 |
builddir = os.path.join(srcdir, '_build') |
| 73 |
# if confdir is None: |
| 74 |
confdir = srcdir |
| 75 |
# if outdir is None: |
| 76 |
outdir = os.path.join(builddir, buildername) |
| 77 |
if not os.path.exists(outdir): |
| 78 |
os.makedirs(outdir) |
| 79 |
|
| 80 |
doctreedir = os.path.join(builddir, 'doctrees') |
| 81 |
if not os.path.exists(doctreedir): |
| 82 |
os.makedirs(doctreedir) |
| 83 |
if confoverrides is None: |
| 84 |
confoverrides = {} |
| 85 |
if status is None: |
| 86 |
status = StringIO() |
| 87 |
if warning is None: |
| 88 |
warning = ListOutput('stderr') |
| 89 |
# if warningiserror is None: |
| 90 |
warningiserror = False |
| 91 |
|
| 92 |
self._saved_path = sys.path[:] |
| 93 |
self._saved_directives = directives._directives.copy() |
| 94 |
self._saved_roles = roles._roles.copy() |
| 95 |
|
| 96 |
self._saved_nodeclasses = set( |
| 97 |
v for v in dir(nodes.GenericNodeVisitor) |
| 98 |
if v.startswith('visit_') |
| 99 |
) |
| 100 |
|
| 101 |
try: |
| 102 |
application.Sphinx.__init__( |
| 103 |
self, |
| 104 |
srcdir, |
| 105 |
confdir, |
| 106 |
outdir, |
| 107 |
doctreedir, |
| 108 |
buildername, |
| 109 |
confoverrides, |
| 110 |
status, |
| 111 |
warning, |
| 112 |
freshenv, |
| 113 |
warningiserror, |
| 114 |
tags, |
| 115 |
) |
| 116 |
except: |
| 117 |
self.cleanup() |
| 118 |
raise |
| 119 |
|
| 120 |
def cleanup(self, doctrees=False): |
| 121 |
shutil.rmtree(self.__tempdir) |
| 122 |
ModuleAnalyzer.cache.clear() |
| 123 |
LaTeXBuilder.usepackages = [] |
| 124 |
sys.path[:] = self._saved_path |
| 125 |
sys.modules.pop('autodoc_fodder', None) |
| 126 |
directives._directives = self._saved_directives |
| 127 |
roles._roles = self._saved_roles |
| 128 |
for method in dir(nodes.GenericNodeVisitor): |
| 129 |
if ( |
| 130 |
method.startswith('visit_') and |
| 131 |
method not in self._saved_nodeclasses |
| 132 |
): |
| 133 |
delattr(nodes.GenericNodeVisitor, 'visit_' + method[6:]) |
| 134 |
delattr(nodes.GenericNodeVisitor, 'depart_' + method[6:]) |
| 135 |
|
| 136 |
def __repr__(self): |
| 137 |
klass_name = self.__class__.__name__ |
| 138 |
builder_name = self.builder.name |
| 139 |
return f'<{klass_name} buildername={buildername:r}>' |