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
|
"""test hook function and configuration"""
from __future__ import annotations
from pathlib import Path
import subprocess
import sys
import pytest
from .conftest import FixtureProject
def test_tool_build(new_project: FixtureProject, tmp_path: Path) -> None:
"""test sphinx 'build' tool"""
new_project.add_tool_config(
"""\
[[tool.hatch.build.targets.wheel.hooks.sphinx.tools]]
tool = "build"
source = "source"
out_dir = "output/html"
format = "html"
"""
)
(new_project.path / "docs" / "source").mkdir(exist_ok=True, parents=True)
(new_project.path / "docs" / "source" / "conf.py").write_text(
"""\
project = 'Test Project'
extensions = [
'sphinx.ext.autodoc',
]
html_theme = 'default'
html_static_path = ['_static']
"""
)
(new_project.path / "docs" / "source" / "index.rst").write_text(
"""\
Test Documentation
=====================
Contents
--------
**Test Project** is a Fake Python library.
.. toctree::
:maxdepth: 1
Indices and Search
------------------
* :ref:`genindex`
* :ref:`search`
"""
)
new_project.build()
# Check that the file got created in the source tree
assert (new_project.path / "docs" / "output" / "html" / "objects.inv").exists()
assert (new_project.path / "docs" / "output" / "html" / "index.html").exists()
extract_dir = tmp_path / "extract"
extract_dir.mkdir()
with new_project.wheel() as whl:
whl.extractall(extract_dir)
# Check that the file made it into the wheel
assert (extract_dir / "my-test-app" / "docs" / "html" / "index.html").exists()
def test_tool_apidoc(new_project: FixtureProject, tmp_path: Path) -> None:
"""test sphinx 'apiddoc' tool"""
new_project.add_tool_config(
"""\
[[tool.hatch.build.targets.wheel.hooks.sphinx.tools]]
tool = "apidoc"
out_dir = "output/api"
"""
)
(new_project.path / "docs").mkdir(exist_ok=True)
new_project.build()
# Check that the file got created in the source tree
assert (new_project.path / "docs" / "output" / "api" / "modules.rst").exists()
extract_dir = tmp_path / "extract"
extract_dir.mkdir()
with new_project.wheel() as whl:
whl.extractall(extract_dir)
# Check that the file made it into the wheel
assert (extract_dir / "my-test-app" / "docs" / "api" / "modules.rst").exists()
def test_tool_custom_strings(new_project: FixtureProject, tmp_path: Path) -> None:
"""test 'custom' commands tool"""
new_project.add_tool_config(
"""\
[[tool.hatch.build.targets.wheel.hooks.sphinx.tools]]
tool = "custom"
out_dir = "output"
shell = true
expand_globs = false
commands = [
"touch output/foo.html",
"touch output/a1.html output/a2.html",
"rm output/a*.html",
]
"""
)
(new_project.path / "docs").mkdir(exist_ok=True)
new_project.build()
# Check that the files got created in the source tree
assert (new_project.path / "docs" / "output" / "foo.html").exists()
# Check handling of multi-arg commands with spaces (shell=True)
assert not (new_project.path / "docs" / "output" / "a1.html").exists()
extract_dir = tmp_path / "extract"
extract_dir.mkdir()
with new_project.wheel() as whl:
whl.extractall(extract_dir)
# Check that the file made it into the wheel
assert (extract_dir / "my-test-app" / "docs" / "foo.html").exists()
def test_tool_custom_lists_globs(new_project: FixtureProject, tmp_path: Path) -> None:
"""test 'custom' commands tool"""
new_project.add_tool_config(
"""\
[[tool.hatch.build.targets.wheel.hooks.sphinx.tools]]
tool = "custom"
out_dir = "output"
shell = false
expand_globs = true
commands = [
"touch output/foo.html output/bar.html",
"rm output/f*.html",
["touch", "output/3 4.html", "output/c1.html", "output/c2.html"],
["rm", "output/c*.html"],
]
"""
)
(new_project.path / "docs").mkdir(exist_ok=True)
new_project.build()
# Check for shell=False but expand_globs=True where plugin does globbing
assert not (new_project.path / "docs" / "output" / "foo.html").exists()
assert (new_project.path / "docs" / "output" / "bar.html").exists()
assert (new_project.path / "docs" / "output" / "3 4.html").exists()
assert not (new_project.path / "docs" / "output" / "c1.html").exists()
extract_dir = tmp_path / "extract"
extract_dir.mkdir()
with new_project.wheel() as whl:
whl.extractall(extract_dir)
# Check that the file made it into the wheel
assert (extract_dir / "my-test-app" / "docs" / "bar.html").exists()
@pytest.mark.skipif(sys.platform.startswith("win"), reason="Windows does not support filenames with glob characters")
def test_tool_custom_lists_noglobs(new_project: FixtureProject, tmp_path: Path) -> None:
"""test 'custom' commands tool"""
new_project.add_tool_config(
"""\
[[tool.hatch.build.targets.wheel.hooks.sphinx.tools]]
tool = "custom"
out_dir = "output"
shell = false
expand_globs = false
commands = [
["touch", "output/1*.html"],
["touch", "output/2*.html"],
["touch", "output/a b.html"],
]
"""
)
(new_project.path / "docs").mkdir(exist_ok=True)
new_project.build()
# test for shell=False where wildcards will not be expanded
assert (new_project.path / "docs" / "output" / "1*.html").exists()
assert (new_project.path / "docs" / "output" / "a b.html").exists()
extract_dir = tmp_path / "extract"
extract_dir.mkdir()
with new_project.wheel() as whl:
whl.extractall(extract_dir)
# Check that the file made it into the wheel
assert (extract_dir / "my-test-app" / "docs" / "1*.html").exists()
assert (extract_dir / "my-test-app" / "docs" / "a b.html").exists()
def test_tool_custom_config_error(new_project: FixtureProject) -> None:
"""test 'custom' commands tool config errors"""
new_project.add_tool_config(
"""\
[[tool.hatch.build.targets.wheel.hooks.sphinx.tools]]
tool = "custom"
out_dir = "output"
shell = true
expand_globs = false
commands = [
["touch", "output/3\\\\ 4.html", "output/b1.html", "output/b2.html"],
]
"""
)
(new_project.path / "docs").mkdir(exist_ok=True)
# Check that the invalid configuration errors out
with pytest.raises(subprocess.CalledProcessError):
new_project.build()
|
