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
|
"""Test the autodoc extension. This tests mainly for private-members option."""
from __future__ import annotations
from typing import TYPE_CHECKING
import pytest
from tests.test_extensions.autodoc_util import do_autodoc
if TYPE_CHECKING:
from sphinx.testing.util import SphinxTestApp
@pytest.mark.sphinx('html', testroot='ext-autodoc')
def test_private_field(app: SphinxTestApp) -> None:
app.config.autoclass_content = 'class'
options = {'members': None}
actual = do_autodoc(app, 'module', 'target.private', options)
assert list(actual) == [
'',
'.. py:module:: target.private',
'',
'',
'.. py:data:: _PUBLIC_CONSTANT',
' :module: target.private',
' :value: None',
'',
' :meta public:',
'',
'',
'.. py:function:: _public_function(name)',
' :module: target.private',
'',
' public_function is a docstring().',
'',
' :meta public:',
'',
]
@pytest.mark.sphinx('html', testroot='ext-autodoc')
def test_private_field_and_private_members(app: SphinxTestApp) -> None:
app.config.autoclass_content = 'class'
options = {
'members': None,
'private-members': None,
}
actual = do_autodoc(app, 'module', 'target.private', options)
assert list(actual) == [
'',
'.. py:module:: target.private',
'',
'',
'.. py:data:: PRIVATE_CONSTANT',
' :module: target.private',
' :value: None',
'',
' :meta private:',
'',
'',
'.. py:data:: _PUBLIC_CONSTANT',
' :module: target.private',
' :value: None',
'',
' :meta public:',
'',
'',
'.. py:function:: _public_function(name)',
' :module: target.private',
'',
' public_function is a docstring().',
'',
' :meta public:',
'',
'',
'.. py:function:: private_function(name)',
' :module: target.private',
'',
' private_function is a docstring().',
'',
' :meta private:',
'',
]
@pytest.mark.sphinx('html', testroot='ext-autodoc')
def test_private_members(app: SphinxTestApp) -> None:
app.config.autoclass_content = 'class'
options = {
'members': None,
'private-members': '_PUBLIC_CONSTANT,_public_function',
}
actual = do_autodoc(app, 'module', 'target.private', options)
assert list(actual) == [
'',
'.. py:module:: target.private',
'',
'',
'.. py:data:: _PUBLIC_CONSTANT',
' :module: target.private',
' :value: None',
'',
' :meta public:',
'',
'',
'.. py:function:: _public_function(name)',
' :module: target.private',
'',
' public_function is a docstring().',
'',
' :meta public:',
'',
]
@pytest.mark.sphinx('html', testroot='ext-autodoc')
def test_private_attributes(app: SphinxTestApp) -> None:
app.config.autoclass_content = 'class'
options = {'members': None}
actual = do_autodoc(app, 'class', 'target.private.Foo', options)
assert list(actual) == [
'',
'.. py:class:: Foo()',
' :module: target.private',
'',
'',
' .. py:attribute:: Foo._public_attribute',
' :module: target.private',
' :value: 47',
'',
' A public class attribute whose name starts with an underscore.',
'',
' :meta public:',
'',
]
@pytest.mark.sphinx('html', testroot='ext-autodoc')
def test_private_attributes_and_private_members(app: SphinxTestApp) -> None:
app.config.autoclass_content = 'class'
options = {
'members': None,
'private-members': None,
}
actual = do_autodoc(app, 'class', 'target.private.Foo', options)
assert list(actual) == [
'',
'.. py:class:: Foo()',
' :module: target.private',
'',
'',
' .. py:attribute:: Foo._public_attribute',
' :module: target.private',
' :value: 47',
'',
' A public class attribute whose name starts with an underscore.',
'',
' :meta public:',
'',
'',
' .. py:attribute:: Foo.private_attribute',
' :module: target.private',
' :value: 11',
'',
' A private class attribute whose name does not start with an underscore.',
'',
' :meta private:',
'',
]
|
