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
|
from __future__ import annotations
import os.path
import sys
from typing import Any
import pytest
from sphinx.cmd import make_mode
from sphinx.cmd.build import get_parser
from sphinx.cmd.make_mode import run_make_mode
broken_argparse = (
sys.version_info[:3] <= (3, 12, 6)
) # fmt: skip
DEFAULTS = {
'filenames': [],
'jobs': 1,
'force_all': False,
'freshenv': False,
'doctreedir': None,
'confdir': None,
'noconfig': False,
'define': [],
'htmldefine': [],
'tags': [],
'nitpicky': False,
'verbosity': 0,
'quiet': False,
'really_quiet': False,
'color': 'auto',
'warnfile': None,
'warningiserror': False,
'keep_going': False,
'traceback': False,
'pdb': False,
'exception_on_warning': False,
}
EXPECTED_BUILD_MAIN = {
'builder': 'html',
'sourcedir': 'source_dir',
'outputdir': 'build_dir',
'filenames': ['filename1', 'filename2'],
'freshenv': True,
'noconfig': True,
'quiet': True,
}
EXPECTED_MAKE_MODE = {
'builder': 'html',
'sourcedir': 'source_dir',
'outputdir': os.path.join('build_dir', 'html'),
'doctreedir': os.path.join('build_dir', 'doctrees'),
'filenames': ['filename1', 'filename2'],
'freshenv': True,
'noconfig': True,
'quiet': True,
}
BUILDER_BUILD_MAIN = [
'--builder',
'html',
]
BUILDER_MAKE_MODE = [
'html',
]
POSITIONAL_DIRS = [
'source_dir',
'build_dir',
]
POSITIONAL_FILENAMES = [
'filename1',
'filename2',
]
POSITIONAL = POSITIONAL_DIRS + POSITIONAL_FILENAMES
POSITIONAL_MAKE_MODE = BUILDER_MAKE_MODE + POSITIONAL
EARLY_OPTS = [
'--quiet',
]
LATE_OPTS = [
'-E',
'--isolated',
]
OPTS = EARLY_OPTS + LATE_OPTS
def parse_arguments(args: list[str]) -> dict[str, Any]:
parsed = vars(get_parser().parse_args(args))
return {k: v for k, v in parsed.items() if k not in DEFAULTS or v != DEFAULTS[k]}
def test_build_main_parse_arguments_pos_first() -> None:
# <positional...> <opts>
args = [
*POSITIONAL,
*OPTS,
]
assert parse_arguments(args) == EXPECTED_BUILD_MAIN
def test_build_main_parse_arguments_pos_last() -> None:
# <opts> <positional...>
args = [
*OPTS,
*POSITIONAL,
]
assert parse_arguments(args) == EXPECTED_BUILD_MAIN
def test_build_main_parse_arguments_pos_middle() -> None:
# <opts> <positional...> <opts>
args = [
*EARLY_OPTS,
*BUILDER_BUILD_MAIN,
*POSITIONAL,
*LATE_OPTS,
]
assert parse_arguments(args) == EXPECTED_BUILD_MAIN
@pytest.mark.xfail(
broken_argparse,
reason='sphinx-build does not yet support filenames after options',
)
def test_build_main_parse_arguments_filenames_last() -> None:
args = [
*POSITIONAL_DIRS,
*OPTS,
*POSITIONAL_FILENAMES,
]
assert parse_arguments(args) == EXPECTED_BUILD_MAIN
def test_build_main_parse_arguments_pos_intermixed(
capsys: pytest.CaptureFixture[str],
) -> None:
args = [
*EARLY_OPTS,
*BUILDER_BUILD_MAIN,
*POSITIONAL_DIRS,
*LATE_OPTS,
*POSITIONAL_FILENAMES,
]
if broken_argparse:
with pytest.raises(SystemExit):
parse_arguments(args)
stderr = capsys.readouterr().err.splitlines()
assert stderr[-1].endswith('error: unrecognized arguments: filename1 filename2')
else:
assert parse_arguments(args) == EXPECTED_BUILD_MAIN
def test_make_mode_parse_arguments_pos_first(monkeypatch: pytest.MonkeyPatch) -> None:
# -M <positional...> <opts>
monkeypatch.setattr(make_mode, 'build_main', parse_arguments)
args = [
*POSITIONAL_MAKE_MODE,
*OPTS,
]
assert run_make_mode(args) == EXPECTED_MAKE_MODE
def test_make_mode_parse_arguments_pos_last(
monkeypatch: pytest.MonkeyPatch,
capsys: pytest.CaptureFixture[str],
) -> None:
# -M <opts> <positional...>
monkeypatch.setattr(make_mode, 'build_main', parse_arguments)
args = [
*OPTS,
*POSITIONAL_MAKE_MODE,
]
with pytest.raises(SystemExit):
run_make_mode(args)
stderr = capsys.readouterr().err.splitlines()
assert stderr[-1].endswith('error: argument --builder/-b: expected one argument')
def test_make_mode_parse_arguments_pos_middle(
monkeypatch: pytest.MonkeyPatch,
capsys: pytest.CaptureFixture[str],
) -> None:
# -M <opts> <positional...> <opts>
monkeypatch.setattr(make_mode, 'build_main', parse_arguments)
args = [
*EARLY_OPTS,
*POSITIONAL_MAKE_MODE,
*LATE_OPTS,
]
with pytest.raises(SystemExit):
run_make_mode(args)
stderr = capsys.readouterr().err.splitlines()
assert stderr[-1].endswith('error: argument --builder/-b: expected one argument')
@pytest.mark.xfail(
broken_argparse,
reason='sphinx-build does not yet support filenames after options',
)
def test_make_mode_parse_arguments_filenames_last(
monkeypatch: pytest.MonkeyPatch,
) -> None:
# -M <positional...> <opts> <filenames...>
monkeypatch.setattr(make_mode, 'build_main', parse_arguments)
args = [
*BUILDER_MAKE_MODE,
*POSITIONAL_DIRS,
*OPTS,
*POSITIONAL_FILENAMES,
]
assert run_make_mode(args) == EXPECTED_MAKE_MODE
def test_make_mode_parse_arguments_pos_intermixed(
monkeypatch: pytest.MonkeyPatch,
capsys: pytest.CaptureFixture[str],
) -> None:
# -M <opts> <positional...> <opts> <filenames...>
monkeypatch.setattr(make_mode, 'build_main', parse_arguments)
args = [
*EARLY_OPTS,
*BUILDER_MAKE_MODE,
*POSITIONAL_DIRS,
*LATE_OPTS,
*POSITIONAL_FILENAMES,
]
with pytest.raises(SystemExit):
run_make_mode(args)
stderr = capsys.readouterr().err.splitlines()
assert stderr[-1].endswith('error: argument --builder/-b: expected one argument')
|
