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 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
|
from __future__ import annotations
import copy
import itertools
import json
import logging
import os
import sys
import sysconfig
from pathlib import Path
from textwrap import dedent
from typing import TYPE_CHECKING, NamedTuple
import pytest
from setuptools.dist import Distribution
from python_discovery import DiskCache, PythonInfo, PythonSpec
from python_discovery import _cached_py_info as cached_py_info
from python_discovery._py_info import VersionInfo
if TYPE_CHECKING:
from pytest_mock import MockerFixture
IS_PYPY = PythonInfo.current_system().implementation == "PyPy"
CURRENT = PythonInfo.current_system()
@pytest.mark.graalpy
def test_current_as_json() -> None:
result = CURRENT.to_json()
parsed = json.loads(result)
major, minor, micro, releaselevel, serial = sys.version_info
free_threaded = sysconfig.get_config_var("Py_GIL_DISABLED") == 1
assert parsed["version_info"] == {
"major": major,
"minor": minor,
"micro": micro,
"releaselevel": releaselevel,
"serial": serial,
}
assert parsed["free_threaded"] is free_threaded
def test_bad_exe_py_info_raise(tmp_path: Path, session_cache: DiskCache) -> None:
exe = str(tmp_path)
with pytest.raises(RuntimeError) as context:
PythonInfo.from_exe(exe, session_cache)
msg = str(context.value)
assert "code" in msg
assert exe in msg
def test_bad_exe_py_info_no_raise(
tmp_path: Path,
caplog: pytest.LogCaptureFixture,
capsys: pytest.CaptureFixture[str],
session_cache: DiskCache,
) -> None:
caplog.set_level(logging.NOTSET)
exe = str(tmp_path)
result = PythonInfo.from_exe(exe, session_cache, raise_on_error=False)
assert result is None
out, _ = capsys.readouterr()
assert not out
messages = [r.message for r in caplog.records if r.name != "filelock"]
assert len(messages) == 4
assert "get interpreter info via cmd: " in messages[0]
assert "retrying" in messages[1]
assert "get interpreter info via cmd: " in messages[2]
assert str(exe) in messages[3]
assert "code" in messages[3]
@pytest.mark.parametrize(
"spec",
itertools.chain(
[sys.executable],
[
f"{impl}{'.'.join(str(i) for i in ver)}{'t' if CURRENT.free_threaded else ''}{arch}"
for impl, ver, arch in itertools.product(
(
[CURRENT.implementation]
+ (["python"] if CURRENT.implementation == "CPython" else [])
+ (
[CURRENT.implementation.lower()]
if CURRENT.implementation != CURRENT.implementation.lower()
else []
)
),
[sys.version_info[0 : i + 1] for i in range(3)],
["", f"-{CURRENT.architecture}"],
)
],
),
)
def test_satisfy_py_info(spec: str) -> None:
parsed_spec = PythonSpec.from_string_spec(spec)
matches = CURRENT.satisfies(parsed_spec, impl_must_match=True)
assert matches is True
def test_satisfy_not_arch() -> None:
parsed_spec = PythonSpec.from_string_spec(
f"{CURRENT.implementation}-{64 if CURRENT.architecture == 32 else 32}",
)
matches = CURRENT.satisfies(parsed_spec, impl_must_match=True)
assert matches is False
def test_satisfy_not_threaded() -> None:
parsed_spec = PythonSpec.from_string_spec(
f"{CURRENT.implementation}{CURRENT.version_info.major}{'' if CURRENT.free_threaded else 't'}",
)
matches = CURRENT.satisfies(parsed_spec, impl_must_match=True)
assert matches is False
def _generate_not_match_current_interpreter_version() -> list[str]:
result: list[str] = []
for depth in range(3):
ver: list[int] = [int(part) for part in sys.version_info[0 : depth + 1]]
for idx in range(len(ver)):
for offset in [-1, 1]:
temp = ver.copy()
temp[idx] += offset
result.append(".".join(str(part) for part in temp))
return result
_NON_MATCH_VER = _generate_not_match_current_interpreter_version()
@pytest.mark.parametrize("spec", _NON_MATCH_VER)
def test_satisfy_not_version(spec: str) -> None:
parsed_spec = PythonSpec.from_string_spec(f"{CURRENT.implementation}{spec}")
matches = CURRENT.satisfies(parsed_spec, impl_must_match=True)
assert matches is False
def test_py_info_cached_error(mocker: MockerFixture, tmp_path: Path, session_cache: DiskCache) -> None:
spy = mocker.spy(cached_py_info, "_run_subprocess")
with pytest.raises(RuntimeError):
PythonInfo.from_exe(str(tmp_path), session_cache)
with pytest.raises(RuntimeError):
PythonInfo.from_exe(str(tmp_path), session_cache)
assert spy.call_count == 2
def test_py_info_cache_clear(mocker: MockerFixture, session_cache: DiskCache) -> None:
result = PythonInfo.from_exe(sys.executable, session_cache)
assert result is not None
PythonInfo.clear_cache(session_cache)
assert not cached_py_info._CACHE
spy = mocker.spy(cached_py_info, "_run_subprocess")
info = PythonInfo.from_exe(sys.executable, session_cache)
assert info is not None
native_difference = 1 if info.system_executable == info.executable else 0
assert spy.call_count + native_difference >= 1
class PyInfoMock(NamedTuple):
implementation: str
architecture: int
version_info: VersionInfo
@pytest.mark.parametrize(
("target", "position", "discovered"),
[
(
PyInfoMock("CPython", 64, VersionInfo(3, 6, 8, "final", 0)),
0,
[
PyInfoMock("CPython", 64, VersionInfo(3, 6, 9, "final", 0)),
PyInfoMock("PyPy", 64, VersionInfo(3, 6, 8, "final", 0)),
],
),
(
PyInfoMock("CPython", 64, VersionInfo(3, 6, 8, "final", 0)),
0,
[
PyInfoMock("CPython", 64, VersionInfo(3, 6, 9, "final", 0)),
PyInfoMock("CPython", 32, VersionInfo(3, 6, 9, "final", 0)),
],
),
(
PyInfoMock("CPython", 64, VersionInfo(3, 8, 1, "final", 0)),
0,
[
PyInfoMock("CPython", 32, VersionInfo(2, 7, 12, "rc", 2)),
PyInfoMock("PyPy", 64, VersionInfo(3, 8, 1, "final", 0)),
],
),
],
)
def test_system_executable_no_exact_match(
target: PyInfoMock,
discovered: list[PyInfoMock],
position: int,
*,
tmp_path: Path,
mocker: MockerFixture,
caplog: pytest.LogCaptureFixture,
session_cache: DiskCache,
) -> None:
caplog.set_level(logging.DEBUG)
def _make_py_info(of: PyInfoMock) -> PythonInfo:
base = copy.deepcopy(CURRENT)
base.implementation = of.implementation
base.version_info = of.version_info
base.architecture = of.architecture
return base
discovered_with_path: dict[str, PythonInfo] = {}
names: list[str] = []
selected = None
for pos, i in enumerate(discovered):
path = tmp_path / str(pos)
path.write_text("", encoding="utf-8")
py_info = _make_py_info(i)
py_info.system_executable = CURRENT.system_executable
py_info.executable = CURRENT.system_executable
py_info.base_executable = str(path) # ty: ignore[unresolved-attribute]
if pos == position:
selected = py_info
discovered_with_path[str(path)] = py_info
names.append(path.name)
target_py_info = _make_py_info(target)
mocker.patch.object(target_py_info, "_find_possible_exe_names", return_value=names)
mocker.patch.object(target_py_info, "_find_possible_folders", return_value=[str(tmp_path)])
def func(exe_path: str, _cache: object = None, **_kwargs: object) -> PythonInfo:
return discovered_with_path[exe_path]
mocker.patch.object(target_py_info, "from_exe", side_effect=func)
target_py_info.real_prefix = str(tmp_path)
target_py_info.system_executable = None
target_py_info.executable = str(tmp_path)
mapped = target_py_info.resolve_to_system(session_cache, target_py_info)
assert mapped.system_executable == CURRENT.system_executable
found = discovered_with_path[mapped.base_executable]
assert found is selected
assert caplog.records[0].msg == "discover exe for %s in %s"
for record in caplog.records[1:-1]:
assert record.message.startswith("refused interpreter ")
assert record.levelno == logging.DEBUG
warn_similar = caplog.records[-1]
assert warn_similar.levelno == logging.DEBUG
assert warn_similar.msg.startswith("no exact match found, chosen most similar")
def test_py_info_ignores_distutils_config(monkeypatch: pytest.MonkeyPatch, tmp_path: Path) -> None:
raw = f"""
[install]
prefix={tmp_path}{os.sep}prefix
install_purelib={tmp_path}{os.sep}purelib
install_platlib={tmp_path}{os.sep}platlib
install_headers={tmp_path}{os.sep}headers
install_scripts={tmp_path}{os.sep}scripts
install_data={tmp_path}{os.sep}data
"""
(tmp_path / "setup.cfg").write_text(dedent(raw), encoding="utf-8")
monkeypatch.chdir(tmp_path)
py_info = PythonInfo.from_exe(sys.executable)
assert py_info is not None
distutils = py_info.distutils_install
for key, value in distutils.items(): # pragma: no cover # distutils_install is empty with "venv" scheme
assert not value.startswith(str(tmp_path)), f"{key}={value}"
def test_discover_exe_on_path_non_spec_name_match(mocker: MockerFixture) -> None:
suffixed_name = f"python{CURRENT.version_info.major}.{CURRENT.version_info.minor}m"
if sys.platform == "win32": # pragma: win32 cover
suffixed_name += Path(CURRENT.original_executable).suffix
spec = PythonSpec.from_string_spec(suffixed_name)
mocker.patch.object(CURRENT, "original_executable", str(Path(CURRENT.executable).parent / suffixed_name))
assert CURRENT.satisfies(spec, impl_must_match=True) is True
def test_discover_exe_on_path_non_spec_name_not_match(mocker: MockerFixture) -> None:
suffixed_name = f"python{CURRENT.version_info.major}.{CURRENT.version_info.minor}m"
if sys.platform == "win32": # pragma: win32 cover
suffixed_name += Path(CURRENT.original_executable).suffix
spec = PythonSpec.from_string_spec(suffixed_name)
mocker.patch.object(
CURRENT,
"original_executable",
str(Path(CURRENT.executable).parent / f"e{suffixed_name}"),
)
assert CURRENT.satisfies(spec, impl_must_match=True) is False
@pytest.mark.skipif(IS_PYPY, reason="setuptools distutils patching does not work")
def test_py_info_setuptools() -> None:
assert Distribution
PythonInfo()
@pytest.mark.usefixtures("_skip_if_test_in_system")
def test_py_info_to_system_raises( # pragma: no cover # skipped in venv environments
session_cache: DiskCache,
mocker: MockerFixture,
caplog: pytest.LogCaptureFixture,
) -> None:
caplog.set_level(logging.DEBUG)
mocker.patch.object(PythonInfo, "_find_possible_folders", return_value=[])
result = PythonInfo.from_exe(sys.executable, cache=session_cache, raise_on_error=False)
assert result is None
log = caplog.records[-1]
assert log.levelno == logging.INFO
expected = f"ignore {sys.executable} due cannot resolve system due to RuntimeError('failed to detect "
assert expected in log.message
def test_sysconfig_vars_include_shared_lib_keys() -> None:
for key in ("Py_ENABLE_SHARED", "INSTSONAME", "LIBDIR"):
assert key in CURRENT.sysconfig_vars
def test_py_info_has_sysconfig_platform() -> None:
assert hasattr(CURRENT, "sysconfig_platform")
assert CURRENT.sysconfig_platform is not None
assert isinstance(CURRENT.sysconfig_platform, str)
assert len(CURRENT.sysconfig_platform) > 0
def test_py_info_machine_property() -> None:
machine = CURRENT.machine
assert machine is not None
assert isinstance(machine, str)
assert len(machine) > 0
known_isas = {"arm64", "i686", "loongarch64", "ppc64", "ppc64le", "riscv64", "s390x", "x86", "x86_64"}
assert machine in known_isas, f"unexpected machine value: {machine}"
def test_py_info_machine_in_spec() -> None:
spec = CURRENT.spec
assert CURRENT.machine in spec
assert f"-{CURRENT.architecture}-{CURRENT.machine}" in spec
def test_py_info_sysconfig_platform_matches_sysconfig() -> None:
assert CURRENT.sysconfig_platform == sysconfig.get_platform()
@pytest.mark.parametrize(
("platform", "expected"),
[
pytest.param("win32", "x86", id="win32"),
pytest.param("win-amd64", "x86_64", id="win-amd64"),
pytest.param("win-arm64", "arm64", id="win-arm64"),
pytest.param("linux-x86_64", "x86_64", id="linux-x86_64"),
pytest.param("linux-aarch64", "arm64", id="linux-aarch64"),
pytest.param("linux-riscv64", "riscv64", id="linux-riscv64"),
pytest.param("linux-ppc64le", "ppc64le", id="linux-ppc64le"),
pytest.param("linux-s390x", "s390x", id="linux-s390x"),
pytest.param("macosx-14.0-arm64", "arm64", id="macos-arm64"),
pytest.param("macosx-14.0-x86_64", "x86_64", id="macos-x86_64"),
],
)
def test_py_info_machine_derivation(platform: str, expected: str) -> None:
info = copy.deepcopy(CURRENT)
info.sysconfig_platform = platform
assert info.machine == expected
@pytest.mark.parametrize("runtime_isa", ["arm64", "x86_64"])
def test_py_info_machine_derivation_universal2(mocker: MockerFixture, runtime_isa: str) -> None:
info = copy.deepcopy(CURRENT)
info.sysconfig_platform = "macosx-11.0-universal2"
mocker.patch("python_discovery._py_info.platform.machine", return_value=runtime_isa)
assert info.machine == runtime_isa
def test_py_info_satisfies_with_machine() -> None:
threaded = "t" if CURRENT.free_threaded else ""
spec_str = (
f"{CURRENT.implementation}{CURRENT.version_info.major}{threaded}-{CURRENT.architecture}-{CURRENT.machine}"
)
parsed_spec = PythonSpec.from_string_spec(spec_str)
assert CURRENT.satisfies(parsed_spec, impl_must_match=True) is True
def test_py_info_satisfies_not_machine() -> None:
other_machine = "arm64" if CURRENT.machine != "arm64" else "x86_64"
spec_str = f"{CURRENT.implementation}-{CURRENT.architecture}-{other_machine}"
parsed_spec = PythonSpec.from_string_spec(spec_str)
assert CURRENT.satisfies(parsed_spec, impl_must_match=True) is False
def test_py_info_satisfies_no_machine_in_spec() -> None:
threaded = "t" if CURRENT.free_threaded else ""
spec_str = f"{CURRENT.implementation}{CURRENT.version_info.major}{threaded}-{CURRENT.architecture}"
parsed_spec = PythonSpec.from_string_spec(spec_str)
assert parsed_spec.machine is None
assert CURRENT.satisfies(parsed_spec, impl_must_match=True) is True
@pytest.mark.parametrize(
("platform", "spec_machine"),
[
pytest.param("linux-x86_64", "amd64", id="amd64-matches-x86_64"),
pytest.param("macosx-14.0-arm64", "aarch64", id="aarch64-matches-arm64"),
],
)
def test_py_info_satisfies_machine_cross_os_normalization(platform: str, spec_machine: str) -> None:
info = copy.deepcopy(CURRENT)
info.sysconfig_platform = platform
spec = PythonSpec.from_string_spec(f"{info.implementation}-{info.architecture}-{spec_machine}")
assert info.satisfies(spec, impl_must_match=True) is True
def test_py_info_to_dict_includes_sysconfig_platform() -> None:
data = CURRENT.to_dict()
assert "sysconfig_platform" in data
assert data["sysconfig_platform"] == sysconfig.get_platform()
def test_py_info_json_round_trip() -> None:
json_str = CURRENT.to_json()
parsed = json.loads(json_str)
assert "sysconfig_platform" in parsed
restored = PythonInfo.from_json(json_str)
assert restored.sysconfig_platform == CURRENT.sysconfig_platform
assert restored.machine == CURRENT.machine
@pytest.mark.parametrize(
("target_platform", "discovered_platforms", "expected_idx"),
[
pytest.param("linux-x86_64", ["linux-aarch64", "linux-x86_64"], 1, id="x86_64-over-aarch64"),
pytest.param("macosx-14.0-arm64", ["macosx-14.0-x86_64", "macosx-14.0-arm64"], 1, id="arm64-over-x86_64"),
],
)
def test_select_most_likely_prefers_machine_match(
target_platform: str,
discovered_platforms: list[str],
expected_idx: int,
) -> None:
target = copy.deepcopy(CURRENT)
target.sysconfig_platform = target_platform
discovered = [copy.deepcopy(CURRENT) for _ in discovered_platforms]
for d, plat in zip(discovered, discovered_platforms):
d.sysconfig_platform = plat
result = PythonInfo._select_most_likely(discovered, target)
assert result.sysconfig_platform == discovered_platforms[expected_idx]
|