1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
|
# Licensed under a 3-clause BSD style license - see LICENSE.rst
import os
import sys
import pytest
from . import *
from ....tests import *
from ....utils import iteritems
pytest.importorskip('sphinx') # skips these tests if sphinx not present
class FakeConfig(object):
"""
Mocks up a sphinx configuration setting construct for automodapi tests
"""
def __init__(self, **kwargs):
for k, v in iteritems(kwargs):
setattr(self, k, v)
class FakeApp(object):
"""
Mocks up a `sphinx.application.Application` object for automodapi tests
"""
# Some default config values
_defaults = {
'automodapi_toctreedirnm': 'api',
'automodapi_writereprocessed': False
}
def __init__(self, **configs):
config = self._defaults.copy()
config.update(configs)
self.config = FakeConfig(**config)
self.info = []
self.warnings = []
def info(self, msg, loc):
self.info.append((msg, loc))
def warn(self, msg, loc):
self.warnings.append((msg, loc))
am_replacer_str = """
This comes before
.. automodapi:: astropy_helpers.sphinx.ext.tests.test_automodapi
{options}
This comes after
"""
am_replacer_basic_expected = """
This comes before
astropy_helpers.sphinx.ext.tests.test_automodapi Module
-------------------------------------------------------
.. automodule:: astropy_helpers.sphinx.ext.tests.test_automodapi
Functions
^^^^^^^^^
.. automodsumm:: astropy_helpers.sphinx.ext.tests.test_automodapi
:functions-only:
:toctree: api/
Classes
^^^^^^^
.. automodsumm:: astropy_helpers.sphinx.ext.tests.test_automodapi
:classes-only:
:toctree: api/
Class Inheritance Diagram
^^^^^^^^^^^^^^^^^^^^^^^^^
.. automod-diagram:: astropy_helpers.sphinx.ext.tests.test_automodapi
:private-bases:
:parts: 1
{empty}
This comes after
""".format(empty='').replace('/', os.sep)
# the .format is necessary for editors that remove empty-line whitespace
def test_am_replacer_basic():
"""
Tests replacing an ".. automodapi::" with the automodapi no-option
template
"""
from ..automodapi import automodapi_replace
fakeapp = FakeApp()
result = automodapi_replace(am_replacer_str.format(options=''), fakeapp)
assert result == am_replacer_basic_expected
am_replacer_noinh_expected = """
This comes before
astropy_helpers.sphinx.ext.tests.test_automodapi Module
-------------------------------------------------------
.. automodule:: astropy_helpers.sphinx.ext.tests.test_automodapi
Functions
^^^^^^^^^
.. automodsumm:: astropy_helpers.sphinx.ext.tests.test_automodapi
:functions-only:
:toctree: api/
Classes
^^^^^^^
.. automodsumm:: astropy_helpers.sphinx.ext.tests.test_automodapi
:classes-only:
:toctree: api/
This comes after
""".format(empty='').replace('/', os.sep)
def test_am_replacer_noinh():
"""
Tests replacing an ".. automodapi::" with no-inheritance-diagram
option
"""
from ..automodapi import automodapi_replace
fakeapp = FakeApp()
ops = ['', ':no-inheritance-diagram:']
ostr = '\n '.join(ops)
result = automodapi_replace(am_replacer_str.format(options=ostr), fakeapp)
assert result == am_replacer_noinh_expected
am_replacer_titleandhdrs_expected = """
This comes before
astropy_helpers.sphinx.ext.tests.test_automodapi Module
&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&
.. automodule:: astropy_helpers.sphinx.ext.tests.test_automodapi
Functions
*********
.. automodsumm:: astropy_helpers.sphinx.ext.tests.test_automodapi
:functions-only:
:toctree: api/
Classes
*******
.. automodsumm:: astropy_helpers.sphinx.ext.tests.test_automodapi
:classes-only:
:toctree: api/
Class Inheritance Diagram
*************************
.. automod-diagram:: astropy_helpers.sphinx.ext.tests.test_automodapi
:private-bases:
:parts: 1
{empty}
This comes after
""".format(empty='').replace('/', os.sep)
def test_am_replacer_titleandhdrs():
"""
Tests replacing an ".. automodapi::" entry with title-setting and header
character options.
"""
from ..automodapi import automodapi_replace
fakeapp = FakeApp()
ops = ['', ':title: A new title', ':headings: &*']
ostr = '\n '.join(ops)
result = automodapi_replace(am_replacer_str.format(options=ostr), fakeapp)
assert result == am_replacer_titleandhdrs_expected
am_replacer_nomain_str = """
This comes before
.. automodapi:: astropy_helpers.sphinx.ext.automodapi
:no-main-docstr:
This comes after
"""
am_replacer_nomain_expected = """
This comes before
astropy_helpers.sphinx.ext.automodapi Module
--------------------------------------------
Functions
^^^^^^^^^
.. automodsumm:: astropy_helpers.sphinx.ext.automodapi
:functions-only:
:toctree: api/
This comes after
""".format(empty='').replace('/', os.sep)
def test_am_replacer_nomain():
"""
Tests replacing an ".. automodapi::" with "no-main-docstring" .
"""
from ..automodapi import automodapi_replace
fakeapp = FakeApp()
result = automodapi_replace(am_replacer_nomain_str, fakeapp)
assert result == am_replacer_nomain_expected
am_replacer_skip_str = """
This comes before
.. automodapi:: astropy_helpers.sphinx.ext.automodapi
:skip: something1
:skip: something2
This comes after
"""
am_replacer_skip_expected = """
This comes before
astropy_helpers.sphinx.ext.automodapi Module
--------------------------------------------
.. automodule:: astropy_helpers.sphinx.ext.automodapi
Functions
^^^^^^^^^
.. automodsumm:: astropy_helpers.sphinx.ext.automodapi
:functions-only:
:toctree: api/
:skip: something1,something2
This comes after
""".format(empty='').replace('/', os.sep)
def test_am_replacer_skip():
"""
Tests using the ":skip: option in an ".. automodapi::" .
"""
from ..automodapi import automodapi_replace
fakeapp = FakeApp()
result = automodapi_replace(am_replacer_skip_str, fakeapp)
assert result == am_replacer_skip_expected
am_replacer_invalidop_str = """
This comes before
.. automodapi:: astropy_helpers.sphinx.ext.automodapi
:invalid-option:
This comes after
"""
def test_am_replacer_invalidop():
"""
Tests that a sphinx warning is produced with an invalid option.
"""
from ..automodapi import automodapi_replace
fakeapp = FakeApp()
automodapi_replace(am_replacer_invalidop_str, fakeapp)
expected_warnings = [('Found additional options invalid-option in '
'automodapi.', None)]
assert fakeapp.warnings == expected_warnings
am_replacer_cython_str = """
This comes before
.. automodapi:: _eva_.unit02
{options}
This comes after
"""
am_replacer_cython_expected = """
This comes before
_eva_.unit02 Module
-------------------
.. automodule:: _eva_.unit02
Functions
^^^^^^^^^
.. automodsumm:: _eva_.unit02
:functions-only:
:toctree: api/
This comes after
""".format(empty='').replace('/', os.sep)
def test_am_replacer_cython(cython_testpackage):
"""
Tests replacing an ".. automodapi::" for a Cython module.
"""
from ..automodapi import automodapi_replace
fakeapp = FakeApp()
result = automodapi_replace(am_replacer_cython_str.format(options=''),
fakeapp)
assert result == am_replacer_cython_expected
|
