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 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
|
from __future__ import annotations
import copy
import logging
import os
import sys
from pathlib import Path
from typing import TYPE_CHECKING
from unittest.mock import MagicMock
import pytest
from python_discovery import DiskCache, PythonInfo, PythonSpec
from python_discovery._py_info import VersionInfo
try:
import tkinter as tk # pragma: no cover
except ImportError: # pragma: no cover
tk = None # type: ignore[assignment]
if TYPE_CHECKING:
from pytest_mock import MockerFixture
CURRENT = PythonInfo.current_system()
def test_py_info_pypy_version(mocker: MockerFixture) -> None:
mocker.patch("platform.python_implementation", return_value="PyPy")
mocker.patch.object(sys, "pypy_version_info", (7, 3, 11, "final", 0), create=True)
info = PythonInfo()
assert info.implementation == "PyPy"
assert info.pypy_version_info == (7, 3, 11, "final", 0)
def test_has_venv_attribute() -> None:
info = PythonInfo()
assert isinstance(info.has_venv, bool)
def test_tcl_tk_libs_with_env(mocker: MockerFixture) -> None:
mocker.patch.dict(os.environ, {"TCL_LIBRARY": "/some/path"})
mocker.patch.object(PythonInfo, "_get_tcl_tk_libs", return_value=("/tcl", "/tk"))
info = PythonInfo()
assert info.tcl_lib == "/tcl"
assert info.tk_lib == "/tk"
def test_get_tcl_tk_libs_returns_tuple() -> None:
tcl_path, tk_path = PythonInfo._get_tcl_tk_libs()
assert tcl_path is None or isinstance(tcl_path, str)
assert tk_path is None or isinstance(tk_path, str)
@pytest.mark.skipif(tk is None, reason="tkinter not available")
def test_get_tcl_tk_libs_tcl_error(mocker: MockerFixture) -> None: # pragma: no cover
mock_tcl = MagicMock()
mock_tcl.eval.side_effect = tk.TclError("fail")
mocker.patch("tkinter.Tcl", return_value=mock_tcl)
tcl, _tk = PythonInfo._get_tcl_tk_libs()
assert tcl is None
def test_fast_get_system_executable_not_venv() -> None:
info = PythonInfo()
info.real_prefix = None
info.base_prefix = info.prefix
assert info._fast_get_system_executable() == info.original_executable
def test_fast_get_system_executable_real_prefix() -> None:
info = PythonInfo()
info.real_prefix = "/some/real/prefix"
assert info._fast_get_system_executable() is None
def test_fast_get_system_executable_no_base_executable(mocker: MockerFixture) -> None:
info = PythonInfo()
info.real_prefix = None
info.base_prefix = "/different/prefix"
mocker.patch.object(sys, "_base_executable", None, create=True)
assert info._fast_get_system_executable() is None
def test_fast_get_system_executable_same_as_current(mocker: MockerFixture) -> None:
info = PythonInfo()
info.real_prefix = None
info.base_prefix = "/different/prefix"
mocker.patch.object(sys, "_base_executable", sys.executable, create=True)
assert info._fast_get_system_executable() is None
def test_try_posix_fallback_not_posix() -> None:
info = PythonInfo()
info.os = "nt"
assert info._try_posix_fallback_executable("/some/python") is None
def test_try_posix_fallback_old_python() -> None:
info = PythonInfo()
info.os = "posix"
info.version_info = VersionInfo(3, 10, 0, "final", 0)
assert info._try_posix_fallback_executable("/some/python") is None
def test_try_posix_fallback_finds_versioned(tmp_path: Path) -> None:
info = PythonInfo()
info.os = "posix"
info.version_info = VersionInfo(3, 12, 0, "final", 0)
info.implementation = "CPython"
base_exe = str(tmp_path / "python")
versioned = tmp_path / "python3"
versioned.touch()
result = info._try_posix_fallback_executable(base_exe)
assert result == str(versioned)
def test_try_posix_fallback_pypy(tmp_path: Path) -> None:
info = PythonInfo()
info.os = "posix"
info.version_info = VersionInfo(3, 12, 0, "final", 0)
info.implementation = "PyPy"
base_exe = str(tmp_path / "python")
pypy = tmp_path / "pypy3"
pypy.touch()
result = info._try_posix_fallback_executable(base_exe)
assert result == str(pypy)
def test_try_posix_fallback_not_found(tmp_path: Path) -> None:
info = PythonInfo()
info.os = "posix"
info.version_info = VersionInfo(3, 12, 0, "final", 0)
info.implementation = "CPython"
base_exe = str(tmp_path / "python")
assert info._try_posix_fallback_executable(base_exe) is None
def test_version_str() -> None:
assert CURRENT.version_str == ".".join(str(i) for i in sys.version_info[:3])
def test_version_release_str() -> None:
assert CURRENT.version_release_str == ".".join(str(i) for i in sys.version_info[:2])
def test_python_name() -> None:
assert CURRENT.python_name == f"python{sys.version_info.major}.{sys.version_info.minor}"
def test_is_old_virtualenv() -> None:
info = copy.deepcopy(CURRENT)
info.real_prefix = "/some/prefix"
assert info.is_old_virtualenv is True
info.real_prefix = None
assert info.is_old_virtualenv is False
def test_is_venv() -> None:
assert CURRENT.is_venv == (CURRENT.base_prefix is not None)
def test_system_prefix() -> None:
info = copy.deepcopy(CURRENT)
info.real_prefix = "/real"
assert info.system_prefix == "/real"
info.real_prefix = None
info.base_prefix = "/base"
assert info.system_prefix == "/base"
def test_system_exec_prefix() -> None:
info = copy.deepcopy(CURRENT)
info.real_prefix = "/real"
assert info.system_exec_prefix == "/real"
info.real_prefix = None
assert info.system_exec_prefix == info.base_exec_prefix or info.exec_prefix
def test_repr() -> None:
result = repr(CURRENT)
assert "PythonInfo" in result
def test_str() -> None:
result = str(CURRENT)
assert "PythonInfo" in result
assert "spec=" in result
def test_machine_none_platform() -> None:
info = copy.deepcopy(CURRENT)
info.sysconfig_platform = None
assert info.machine == "unknown"
def test_from_json_round_trip() -> None:
json_str = CURRENT.to_json()
restored = PythonInfo.from_json(json_str)
assert restored.version_info == CURRENT.version_info
assert restored.implementation == CURRENT.implementation
def test_from_dict() -> None:
data = CURRENT.to_dict()
restored = PythonInfo.from_dict(data)
assert restored.version_info == CURRENT.version_info
def test_resolve_to_system_circle(mocker: MockerFixture, caplog: pytest.LogCaptureFixture) -> None:
caplog.set_level(logging.DEBUG)
target = copy.deepcopy(CURRENT)
target.system_executable = None
target.real_prefix = None
target.base_prefix = "/prefix_a"
second = copy.deepcopy(CURRENT)
second.system_executable = None
second.real_prefix = None
second.base_prefix = "/prefix_b"
third = copy.deepcopy(CURRENT)
third.system_executable = None
third.real_prefix = None
third.base_prefix = "/prefix_a"
mocker.patch.object(PythonInfo, "discover_exe", side_effect=[second, third])
with pytest.raises(RuntimeError, match="prefixes are causing a circle"):
PythonInfo.resolve_to_system(None, target)
def test_resolve_to_system_single_prefix_self_link(mocker: MockerFixture, caplog: pytest.LogCaptureFixture) -> None:
caplog.set_level(logging.INFO)
target = copy.deepcopy(CURRENT)
target.system_executable = None
target.real_prefix = None
target.base_prefix = "/prefix_a"
second = copy.deepcopy(CURRENT)
second.system_executable = None
second.real_prefix = None
second.base_prefix = "/prefix_a"
mocker.patch.object(PythonInfo, "discover_exe", return_value=second)
result = PythonInfo.resolve_to_system(None, target)
assert result.system_executable is not None
assert any("links back to itself" in r.message for r in caplog.records)
def test_discover_exe_cache_hit() -> None:
info = copy.deepcopy(CURRENT)
cached = copy.deepcopy(CURRENT)
PythonInfo._cache_exe_discovery["/some/prefix", True] = cached
try:
result = info.discover_exe(MagicMock(), prefix="/some/prefix", exact=True)
assert result is cached
finally:
del PythonInfo._cache_exe_discovery["/some/prefix", True]
def test_check_exe_none_path(tmp_path: Path) -> None:
info = copy.deepcopy(CURRENT)
result = info._check_exe(MagicMock(), str(tmp_path), "nonexistent", [], dict(os.environ), exact=True)
assert result is None
def test_satisfies_version_specifier() -> None:
spec = PythonSpec.from_string_spec(f">={sys.version_info.major}.{sys.version_info.minor}")
assert CURRENT.satisfies(spec, impl_must_match=False) is True
def test_satisfies_version_specifier_fails() -> None:
spec = PythonSpec.from_string_spec(f">{sys.version_info.major + 1}")
assert CURRENT.satisfies(spec, impl_must_match=False) is False
@pytest.mark.parametrize(
("version_info", "spec_str", "expected"),
[
pytest.param(VersionInfo(3, 14, 0, "alpha", 1), ">=3.14.0a1", True, id="alpha_match_exact"),
pytest.param(VersionInfo(3, 14, 0, "beta", 1), ">=3.14.0b1", True, id="beta_match_exact"),
pytest.param(VersionInfo(3, 14, 0, "candidate", 1), ">=3.14.0rc1", True, id="rc_match_exact"),
pytest.param(VersionInfo(3, 15, 0, "alpha", 6), ">=3.15", True, id="prerelease_match_major_minor"),
pytest.param(VersionInfo(3, 15, 0, "alpha", 6), ">=3.15.0", False, id="prerelease_not_match_full_precision"),
pytest.param(VersionInfo(3, 15, 0, "alpha", 5), "<3.15.0a6", True, id="earlier_prerelease_less_than"),
pytest.param(VersionInfo(3, 15, 0, "alpha", 6), "<3.15.0a6", False, id="prerelease_not_less_than_itself"),
pytest.param(VersionInfo(3, 15, 0, "alpha", 6), ">=3.15.0a6", True, id="prerelease_match_itself"),
pytest.param(VersionInfo(3, 15, 0, "alpha", 6), ">=3.15.0a7", False, id="prerelease_not_match_later"),
pytest.param(VersionInfo(3, 15, 0, "final", 0), ">=3.15.0a6", True, id="final_greater_than_prerelease"),
pytest.param(VersionInfo(3, 15, 0, "final", 0), "<3.15.0a6", False, id="final_not_less_than_prerelease"),
pytest.param(VersionInfo(3, 15, 0, "final", 0), ">=3.15", True, id="final_match_major_minor"),
pytest.param(VersionInfo(3, 15, 1, "alpha", 1), ">=3.15.0", True, id="later_micro_prerelease_match"),
],
)
def test_satisfies_version_specifier_prerelease(version_info: VersionInfo, spec_str: str, expected: bool) -> None:
info = copy.deepcopy(CURRENT)
info.version_info = version_info
spec = PythonSpec.from_string_spec(spec_str)
assert info.satisfies(spec, impl_must_match=False) is expected
def test_satisfies_path_not_abs_basename_match() -> None:
info = copy.deepcopy(CURRENT)
basename = Path(info.original_executable).stem
spec = PythonSpec.from_string_spec(basename)
assert info.satisfies(spec, impl_must_match=False) is True
def test_satisfies_path_not_abs_basename_no_match() -> None:
info = copy.deepcopy(CURRENT)
spec = PythonSpec.from_string_spec("completely_different_name")
assert info.satisfies(spec, impl_must_match=False) is False
@pytest.mark.skipif(sys.platform == "win32", reason="win32 tested separately")
def test_satisfies_path_win32(mocker: MockerFixture) -> None:
info = copy.deepcopy(CURRENT)
mocker.patch.object(sys, "platform", "win32")
info.original_executable = "/some/path/python.exe"
spec = PythonSpec.from_string_spec("python")
spec.path = "python"
assert info.satisfies(spec, impl_must_match=False) is True
def test_distutils_install() -> None:
info = PythonInfo()
result = info._distutils_install()
assert isinstance(result, dict)
def test_install_path() -> None:
assert isinstance(CURRENT.install_path("purelib"), str)
def test_system_include() -> None:
result = CURRENT.system_include
assert isinstance(result, str)
def test_system_include_fallback(mocker: MockerFixture) -> None:
info = copy.deepcopy(CURRENT)
mocker.patch("os.path.exists", side_effect=lambda p: "include" not in p or "dist" in p.lower())
result = info.system_include
assert isinstance(result, str)
def test_sysconfig_path_missing_key() -> None:
assert not CURRENT.sysconfig_path("nonexistent_key")
def test_sysconfig_path_with_config_var() -> None:
result = CURRENT.sysconfig_path("stdlib", {})
assert isinstance(result, str)
def test_current_system_cached(session_cache: DiskCache) -> None:
PythonInfo._current_system = None
result1 = PythonInfo.current_system(session_cache)
result2 = PythonInfo.current_system(session_cache)
assert result1 is result2
def test_current_cached(session_cache: DiskCache) -> None:
PythonInfo._current = None
result1 = PythonInfo.current(session_cache)
result2 = PythonInfo.current(session_cache)
assert result1 is result2
def test_from_exe_resolve_error(mocker: MockerFixture, caplog: pytest.LogCaptureFixture) -> None:
caplog.set_level(logging.INFO)
fake_info = PythonInfo()
fake_info.original_executable = "/fake/python"
mocker.patch(
"python_discovery._cached_py_info.from_exe",
return_value=fake_info,
)
mocker.patch.object(PythonInfo, "resolve_to_system", side_effect=RuntimeError("test error"))
result = PythonInfo.from_exe(sys.executable, raise_on_error=False, resolve_to_host=True)
assert result is None
assert any("cannot resolve system" in r.message for r in caplog.records)
def test_sysconfig_path_no_config_var() -> None:
result = CURRENT.sysconfig_path("stdlib")
assert isinstance(result, str)
assert len(result) > 0
def test_satisfies_abs_spec_path_falls_through() -> None:
info = copy.deepcopy(CURRENT)
spec = PythonSpec("", None, None, None, None, None, "/some/other/python")
assert spec.is_abs is True
assert info.satisfies(spec, impl_must_match=False) is True
def test_satisfies_abs_spec_path_match() -> None:
info = copy.deepcopy(CURRENT)
spec = PythonSpec("", None, None, None, None, None, info.executable)
assert info.satisfies(spec, impl_must_match=False) is True
def test_current_returns_none_raises(mocker: MockerFixture) -> None:
PythonInfo._current = None
mocker.patch.object(PythonInfo, "from_exe", return_value=None)
with pytest.raises(RuntimeError, match="failed to query current Python interpreter"):
PythonInfo.current()
PythonInfo._current = None
def test_current_system_returns_none_raises(mocker: MockerFixture) -> None:
PythonInfo._current_system = None
mocker.patch.object(PythonInfo, "from_exe", return_value=None)
with pytest.raises(RuntimeError, match="failed to query current system Python interpreter"):
PythonInfo.current_system()
PythonInfo._current_system = None
def test_check_exe_from_exe_returns_none(tmp_path: Path, mocker: MockerFixture) -> None:
info = copy.deepcopy(CURRENT)
exe = tmp_path / "python"
exe.touch()
mocker.patch.object(PythonInfo, "from_exe", return_value=None)
result = info._check_exe(MagicMock(), str(tmp_path), "python", [], dict(os.environ), exact=True)
assert result is None
def test_check_exe_mismatch_not_exact(tmp_path: Path, mocker: MockerFixture) -> None:
info = copy.deepcopy(CURRENT)
exe = tmp_path / "python"
exe.touch()
other = copy.deepcopy(CURRENT)
other.architecture = 32 if info.architecture == 64 else 64
mocker.patch.object(PythonInfo, "from_exe", return_value=other)
discovered: list[PythonInfo] = []
result = info._check_exe(MagicMock(), str(tmp_path), "python", discovered, dict(os.environ), exact=False)
assert result is None
assert len(discovered) == 1
def test_check_exe_mismatch_exact(tmp_path: Path, mocker: MockerFixture) -> None:
info = copy.deepcopy(CURRENT)
exe = tmp_path / "python"
exe.touch()
other = copy.deepcopy(CURRENT)
other.architecture = 32 if info.architecture == 64 else 64
mocker.patch.object(PythonInfo, "from_exe", return_value=other)
discovered: list[PythonInfo] = []
result = info._check_exe(MagicMock(), str(tmp_path), "python", discovered, dict(os.environ), exact=True)
assert result is None
assert len(discovered) == 0
def test_find_possible_exe_names_free_threaded() -> None:
info = copy.deepcopy(CURRENT)
info.free_threaded = True
names = info._find_possible_exe_names()
assert any("t" in n for n in names)
def test_possible_base_python_basename() -> None:
info = copy.deepcopy(CURRENT)
info.executable = "/usr/bin/python"
info.implementation = "CPython"
names = list(info._possible_base())
assert "python" in names
assert "cpython" in names
def test_possible_base_case_sensitive(mocker: MockerFixture) -> None:
info = copy.deepcopy(CURRENT)
info.executable = "/usr/bin/CPython3.12"
info.implementation = "CPython"
mocker.patch("python_discovery._compat.fs_is_case_sensitive", return_value=True)
names = list(info._possible_base())
lower_names = [n for n in names if n.islower()]
upper_names = [n for n in names if n.isupper()]
assert len(lower_names) >= 1
assert len(upper_names) >= 1
def test_possible_base_case_sensitive_upper_equals_base(mocker: MockerFixture) -> None:
info = copy.deepcopy(CURRENT)
info.executable = "/usr/bin/JYTHON"
info.implementation = "JYTHON"
mocker.patch("python_discovery._compat.fs_is_case_sensitive", return_value=True)
names = list(info._possible_base())
assert "jython" in names
assert "JYTHON" in names
def test_resolve_to_system_resolved_from_exe(mocker: MockerFixture, caplog: pytest.LogCaptureFixture) -> None:
caplog.set_level(logging.DEBUG)
target = copy.deepcopy(CURRENT)
target.system_executable = "/some/system/python"
target.executable = "/some/venv/python"
resolved = copy.deepcopy(CURRENT)
resolved.system_executable = "/some/system/python"
resolved.executable = "/some/system/python"
mocker.patch.object(PythonInfo, "from_exe", return_value=resolved)
result = PythonInfo.resolve_to_system(None, target)
assert result.executable == "/some/venv/python"
def test_resolve_to_system_from_exe_returns_none(mocker: MockerFixture) -> None:
target = copy.deepcopy(CURRENT)
target.system_executable = "/some/system/python"
target.executable = "/some/venv/python"
mocker.patch.object(PythonInfo, "from_exe", return_value=None)
result = PythonInfo.resolve_to_system(None, target)
assert result.executable == "/some/venv/python"
|