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
|
from __future__ import annotations
import platform
import sys
import textwrap
from pathlib import Path
import pytest
from conftest import PackageInfo, VEnv, process_package
@pytest.mark.compile
@pytest.mark.configure
@pytest.mark.integration
@pytest.mark.parametrize("isolate", [True, False], ids=["isolated", "notisolated"])
@pytest.mark.parametrize(
"package",
[
pytest.param(
True,
id="package",
marks=[pytest.mark.xfail(reason="Only data folders supported currently")],
),
pytest.param(False, id="datafolder"),
],
)
@pytest.mark.usefixtures("navigate_editable")
@pytest.mark.xfail(
sys.version_info[:2] == (3, 9), reason="Python 3.9 not supported yet"
)
def test_navigate_editable(isolated, isolate, package):
isolate_args = ["--no-build-isolation"] if not isolate else []
isolated.install("pip>=23")
if not isolate:
isolated.install("scikit-build-core")
if package:
init_py = Path("python/shared_pkg/data/__init__.py")
init_py.touch()
isolated.install(
"-v", "--config-settings=build-dir=build/{wheel_tag}", *isolate_args, "-e", "."
)
value = isolated.execute("import shared_pkg; shared_pkg.call_c_method()")
assert value == "c_method"
value = isolated.execute("import shared_pkg; shared_pkg.call_py_method()")
assert value == "py_method"
value = isolated.execute("import shared_pkg; shared_pkg.read_py_data_txt()")
assert value == "Some_value_Py"
value = isolated.execute("import shared_pkg; shared_pkg.read_c_generated_txt()")
assert value == "Some_value_C"
@pytest.mark.compile
@pytest.mark.configure
@pytest.mark.integration
@pytest.mark.parametrize(
("editable", "editable_mode"), [(False, ""), (True, "redirect"), (True, "inplace")]
)
def test_cython_pxd(monkeypatch, tmp_path, editable, editable_mode, isolated):
editable_flag = ["-e"] if editable else []
config_mode_flags = []
if editable:
config_mode_flags.append(f"--config-settings=editable.mode={editable_mode}")
if editable_mode != "inplace":
config_mode_flags.append("--config-settings=build-dir=build/{wheel_tag}")
package1 = PackageInfo(
"cython_pxd_editable/pkg1",
)
tmp_path1 = tmp_path / "pkg1"
tmp_path1.mkdir()
process_package(package1, tmp_path1, monkeypatch)
ninja = [
"ninja" for f in isolated.wheelhouse.iterdir() if f.name.startswith("ninja-")
]
cmake = [
"cmake" for f in isolated.wheelhouse.iterdir() if f.name.startswith("cmake-")
]
isolated.install("pip>23")
isolated.install("cython", "scikit-build-core", *ninja, *cmake)
isolated.install(
"-v",
*config_mode_flags,
"--no-build-isolation",
*editable_flag,
".",
)
package2 = PackageInfo(
"cython_pxd_editable/pkg2",
)
tmp_path2 = tmp_path / "pkg2"
tmp_path2.mkdir()
process_package(package2, tmp_path2, monkeypatch)
isolated.install(
"-v",
*config_mode_flags,
"--no-build-isolation",
*editable_flag,
".",
)
@pytest.mark.compile
@pytest.mark.configure
@pytest.mark.integration
@pytest.mark.usefixtures("package_simplest_c")
def test_install_dir(isolated):
isolated.install("pip>=23")
isolated.install("scikit-build-core")
settings_overrides = {
"build-dir": "build/{wheel_tag}",
"wheel.install-dir": "other_pkg",
"editable.rebuild": "true",
}
# Create a dummy other_pkg package to satisfy the import
other_pkg_src = Path("./src/other_pkg")
other_pkg_src.joinpath("simplest").mkdir(parents=True)
other_pkg_src.joinpath("__init__.py").write_text(
textwrap.dedent(
"""
from .simplest._module import square
"""
)
)
other_pkg_src.joinpath("simplest/__init__.py").touch()
isolated.install(
"-v",
*[f"--config-settings={k}={v}" for k, v in settings_overrides.items()],
"--no-build-isolation",
"-e",
".",
)
# Make sure the package is correctly installed in the subdirectory
other_pkg_path = isolated.platlib / "other_pkg"
c_module_glob = list(other_pkg_path.glob("simplest/_module*"))
assert len(c_module_glob) == 1
c_module = c_module_glob[0]
assert c_module.exists()
# If `install-dir` was not taken into account it would install here
failed_c_module = other_pkg_path / "../simplest" / c_module.name
assert not failed_c_module.exists()
# Run an import in order to re-trigger the rebuild and check paths again
out = isolated.execute("import other_pkg.simplest")
assert "Running cmake" in out
assert c_module.exists()
assert not failed_c_module.exists()
def _setup_package_for_editable_layout_tests(
monkeypatch: pytest.MonkeyPatch,
tmp_path: Path,
editable: bool,
editable_mode: str,
isolated: VEnv,
) -> None:
editable_flag = ["-e"] if editable else []
config_mode_flags = []
if editable:
config_mode_flags.append(f"--config-settings=editable.mode={editable_mode}")
if editable_mode != "inplace":
config_mode_flags.append("--config-settings=build-dir=build/{wheel_tag}")
# Use a context so that we only change into the directory up until the point where
# we run the editable install. We do not want to be in that directory when importing
# to avoid importing the source directory instead of the installed package.
with monkeypatch.context() as m:
package = PackageInfo("importlib_editable")
process_package(package, tmp_path, m)
assert isolated.wheelhouse
ninja = [
"ninja"
for f in isolated.wheelhouse.iterdir()
if f.name.startswith("ninja-")
]
cmake = [
"cmake"
for f in isolated.wheelhouse.iterdir()
if f.name.startswith("cmake-")
]
isolated.install("pip>23")
isolated.install("scikit-build-core", *ninja, *cmake)
isolated.install(
"-v",
*config_mode_flags,
"--no-build-isolation",
*editable_flag,
".",
)
@pytest.mark.compile
@pytest.mark.configure
@pytest.mark.integration
@pytest.mark.parametrize(
("editable", "editable_mode"), [(False, ""), (True, "redirect"), (True, "inplace")]
)
def test_direct_import(monkeypatch, tmp_path, editable, editable_mode, isolated):
# TODO: Investigate these failures
if platform.system() == "Windows" and editable_mode == "inplace":
pytest.xfail("Windows fails to import the top-level extension module")
_setup_package_for_editable_layout_tests(
monkeypatch, tmp_path, editable, editable_mode, isolated
)
isolated.execute("import pkg")
isolated.execute("import pmod")
isolated.execute("import emod")
@pytest.mark.compile
@pytest.mark.configure
@pytest.mark.integration
@pytest.mark.parametrize(
("editable", "editable_mode"),
[
(False, ""),
pytest.param(
True,
"redirect",
marks=pytest.mark.xfail,
),
(True, "inplace"),
],
)
def test_importlib_resources(monkeypatch, tmp_path, editable, editable_mode, isolated):
if sys.version_info < (3, 9):
pytest.skip("importlib.resources.files is introduced in Python 3.9")
# TODO: Investigate these failures
if editable_mode == "redirect":
pytest.xfail("Redirect mode is at navigating importlib.resources.files")
if platform.system() == "Windows" and editable_mode == "inplace":
pytest.xfail("Windows fails to import the top-level extension module")
_setup_package_for_editable_layout_tests(
monkeypatch, tmp_path, editable, editable_mode, isolated
)
isolated.execute(
textwrap.dedent(
"""
from importlib import import_module
from importlib.resources import files
from pathlib import Path
def is_extension(path):
for ext in (".so", ".pyd"):
if ext in path.suffixes:
return True
return False
def check_pkg(pkg_name):
try:
pkg = import_module(pkg_name)
pkg_root = files(pkg)
print(f"pkg_root: [{type(pkg_root)}] {pkg_root}")
pkg_files = list(pkg_root.iterdir())
for path in pkg_files:
print(f"path: [{type(path)}] {path}")
assert any(is_extension(path) for path in pkg_files if isinstance(path, Path))
except Exception as err:
msg = f"Failed in {str(pkg)}"
raise RuntimeError(msg) from err
check_pkg("pkg")
check_pkg("pkg.sub_a")
check_pkg("pkg.sub_b")
check_pkg("pkg.sub_b.sub_c")
check_pkg("pkg.sub_b.sub_d")
"""
)
)
|
