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 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552
|
from __future__ import annotations
import os
import sys
import venv
from pathlib import Path
from typing import TYPE_CHECKING
import pytest
from pbs_installer import PythonVersion
from pytest_httpserver import HTTPServer
from pdm.environments import PythonEnvironment
from pdm.exceptions import PdmException, ProjectError
from pdm.models.requirements import parse_requirement
from pdm.models.specifiers import PySpecSet
from pdm.models.venv import get_venv_python
from pdm.utils import cd, is_path_relative_to, parse_version
if TYPE_CHECKING:
from pdm.project.core import Project
from pdm.pytest import PDMCallable
PYTHON_VERSIONS = ["3.8.7", "3.10.12", "3.10.11", "3.8.0", "3.10.13", "3.9.12"]
def get_python_versions() -> list[PythonVersion]:
python_versions = []
for v in PYTHON_VERSIONS:
major, minor, micro = v.split(".")
python_versions.append(PythonVersion("cpython", int(major), int(minor), int(micro)))
return python_versions
def test_project_python_with_pyenv_support(project, mocker, monkeypatch):
project._saved_python = None
project._python = None
monkeypatch.setenv("PDM_IGNORE_SAVED_PYTHON", "1")
mocker.patch("pdm.project.core.PYENV_ROOT", str(project.root))
pyenv_python = project.root / "shims/python"
if os.name == "nt":
pyenv_python = pyenv_python.with_suffix(".bat")
pyenv_python.parent.mkdir()
pyenv_python.touch()
mocker.patch(
"findpython.python.PythonVersion._get_version",
return_value=parse_version("3.8.0"),
)
mocker.patch("findpython.python.PythonVersion._get_interpreter", return_value=sys.executable)
assert Path(project.python.path) == pyenv_python
assert project.python.executable == Path(sys.executable)
# Clean cache
project._python = None
project.project_config["python.use_pyenv"] = False
assert Path(project.python.path) != pyenv_python
def test_project_config_items(project):
config = project.config
for item in ("python.use_pyenv", "pypi.url", "cache_dir"):
assert item in config
def test_project_config_set_invalid_key(project):
config = project.project_config
with pytest.raises(KeyError):
config["foo"] = "bar"
def test_project_sources_overriding_pypi(project):
project.project_config["pypi.url"] = "https://test.pypi.org/simple"
assert project.sources[0].url == "https://test.pypi.org/simple"
project.pyproject.settings["source"] = [{"url": "https://example.org/simple", "name": "pypi", "verify_ssl": True}]
assert project.sources[0].url == "https://example.org/simple"
def test_project_sources_env_var_expansion(project, monkeypatch):
monkeypatch.setenv("PYPI_USER", "user")
monkeypatch.setenv("PYPI_PASS", "password")
project.project_config["pypi.url"] = "https://${PYPI_USER}:${PYPI_PASS}@test.pypi.org/simple"
# expanded in sources
assert project.sources[0].url == "https://user:password@test.pypi.org/simple"
# not expanded in project config
assert project.project_config["pypi.url"] == "https://${PYPI_USER}:${PYPI_PASS}@test.pypi.org/simple"
project.pyproject.settings["source"] = [
{
"url": "https://${PYPI_USER}:${PYPI_PASS}@example.org/simple",
"name": "pypi",
"verify_ssl": True,
}
]
# expanded in sources
assert project.sources[0].url == "https://user:password@example.org/simple"
# not expanded in tool settings
assert project.pyproject.settings["source"][0]["url"] == "https://${PYPI_USER}:${PYPI_PASS}@example.org/simple"
project.pyproject.settings["source"] = [
{
"url": "https://${PYPI_USER}:${PYPI_PASS}@example2.org/simple",
"name": "example2",
"verify_ssl": True,
}
]
# expanded in sources
assert project.sources[1].url == "https://user:password@example2.org/simple"
# not expanded in tool settings
assert project.pyproject.settings["source"][0]["url"] == "https://${PYPI_USER}:${PYPI_PASS}@example2.org/simple"
def test_global_project(tmp_path, core):
project = core.create_project(tmp_path, True)
assert project.is_global
assert isinstance(project.environment, PythonEnvironment)
def test_auto_global_project(tmp_path, core):
tmp_path.joinpath(".pdm-home").mkdir()
(tmp_path / ".pdm-home/config.toml").write_text("[global_project]\nfallback = true\n")
with cd(tmp_path):
project = core.create_project(global_config=tmp_path / ".pdm-home/config.toml")
assert project.is_global
def test_project_use_venv(project):
project._saved_python = None
project._python = None
scripts = "Scripts" if os.name == "nt" else "bin"
suffix = ".exe" if os.name == "nt" else ""
venv.create(project.root / "venv", symlinks=True)
project.project_config["python.use_venv"] = True
env = project.environment
assert env.interpreter.executable == project.root / "venv" / scripts / f"python{suffix}"
assert not env.is_local
def test_project_packages_path(project):
packages_path = project.environment.packages_path
version = ".".join(map(str, sys.version_info[:2]))
if os.name == "nt" and sys.maxsize <= 2**32:
assert packages_path.name == version + "-32"
else:
assert packages_path.name == version
def test_project_auto_detect_venv(project):
venv.create(project.root / "test_venv")
scripts = "Scripts" if os.name == "nt" else "bin"
suffix = ".exe" if os.name == "nt" else ""
project.project_config["python.use_venv"] = True
project._python = None
project._saved_python = (project.root / "test_venv" / scripts / f"python{suffix}").as_posix()
assert not project.environment.is_local
@pytest.mark.path
def test_ignore_saved_python(project, monkeypatch):
project.project_config["python.use_venv"] = True
project._python = None
scripts = "Scripts" if os.name == "nt" else "bin"
suffix = ".exe" if os.name == "nt" else ""
venv.create(project.root / "venv", symlinks=True)
monkeypatch.setenv("PDM_IGNORE_SAVED_PYTHON", "1")
assert project.python.executable != project._saved_python
assert project.python.executable == project.root / "venv" / scripts / f"python{suffix}"
def test_select_dependencies(project):
project.pyproject.metadata["dependencies"] = ["requests"]
project.pyproject.metadata["optional-dependencies"] = {
"security": ["cryptography"],
"venv": ["virtualenv"],
}
project.pyproject.dependency_groups.update(
{
"test": ["pytest"],
"doc": ["mkdocs"],
"all": [{"include-group": "test"}, {"include-group": "doc"}],
}
)
assert sorted([r.key for r in project.get_dependencies()]) == ["requests"]
assert sorted([r.key for r in project.get_dependencies("security")]) == ["cryptography"]
assert sorted([r.key for r in project.get_dependencies("test")]) == ["pytest"]
assert sorted([r.key for r in project.get_dependencies("all")]) == ["mkdocs", "pytest"]
assert sorted(project.iter_groups()) == [
"all",
"default",
"doc",
"security",
"test",
"venv",
]
def test_invalid_dependency_group(project):
project.pyproject.dependency_groups.update(
{
"invalid": [{"invalid-key": True}],
"missing": [{"include-group": "missing-group"}],
"doc": ["mkdocs"],
}
)
assert sorted([r.key for r in project.get_dependencies("doc")]) == ["mkdocs"]
with pytest.raises(ProjectError, match="Invalid dependency group item"):
project.get_dependencies("invalid")
with pytest.raises(ProjectError, match="Dependency group 'missing-group' not found"):
project.get_dependencies("missing")
@pytest.mark.path
def test_set_non_exist_python_path(project_no_init):
project_no_init._saved_python = "non-exist-python"
project_no_init._python = None
assert project_no_init.python.executable.name != "non-exist-python"
@pytest.mark.usefixtures("venv_backends")
def test_create_venv_first_time(pdm, project, local_finder):
project.project_config.update({"venv.in_project": False})
project._saved_python = None
result = pdm(["install"], obj=project)
assert result.exit_code == 0
venv_parent = project.root / "venvs"
venv_path = next(venv_parent.iterdir(), None)
assert venv_path is not None
assert Path(project._saved_python).relative_to(venv_path)
@pytest.mark.usefixtures("venv_backends", "local_finder")
@pytest.mark.parametrize("with_pip", [True, False])
def test_create_venv_in_project(pdm, project, with_pip):
project.project_config.update({"venv.in_project": True, "venv.with_pip": with_pip})
project._saved_python = None
result = pdm(["install"], obj=project)
assert result.exit_code == 0
assert project.root.joinpath(".venv").exists()
working_set = project.environment.get_working_set()
assert ("pip" in working_set) is with_pip
@pytest.mark.usefixtures("venv_backends")
def test_find_interpreters_from_venv(pdm, project, local_finder):
project.project_config.update({"venv.in_project": False})
project._saved_python = None
result = pdm(["install"], obj=project)
assert result.exit_code == 0
venv_parent = project.root / "venvs"
venv_path = next(venv_parent.iterdir(), None)
venv_python = get_venv_python(venv_path)
assert any(venv_python == p.executable for p in project.find_interpreters())
@pytest.mark.usefixtures("local_finder")
def test_find_interpreters_without_duplicate_relative_paths(pdm, project):
project._saved_python = None
venv.create(project.root / ".venv", clear=True)
with cd(project.root):
bin_dir = "Scripts" if os.name == "nt" else "bin"
suffix = ".exe" if os.name == "nt" else ""
found = list(project.find_interpreters(f".venv/{bin_dir}/python{suffix}"))
assert len(found) == 1
def test_iter_project_venvs(project):
from pdm.cli.commands.venv.utils import get_venv_prefix, iter_venvs
from pdm.models.venv import get_venv_python
venv_parent = Path(project.config["venv.location"])
venv_prefix = get_venv_prefix(project)
for name in ("foo", "bar", "baz"):
venv_python = get_venv_python(venv_parent / (venv_prefix + name))
venv_python.parent.mkdir(parents=True)
venv_python.touch()
dot_venv_python = get_venv_python(project.root / ".venv")
dot_venv_python.parent.mkdir(parents=True)
dot_venv_python.touch()
venv_keys = [key for key, _ in iter_venvs(project)]
assert sorted(venv_keys) == ["bar", "baz", "foo", "in-project"]
def test_load_extra_sources(project):
project.pyproject.settings["source"] = [
{
"name": "custom",
"url": "https://custom.pypi.org/simple",
}
]
project.global_config["pypi.extra.url"] = "https://extra.pypi.org/simple"
sources = project.sources
assert len(sources) == 3
assert [item.name for item in sources] == ["pypi", "custom", "extra"]
project.global_config["pypi.ignore_stored_index"] = True
sources = project.sources
assert len(sources) == 1
assert [item.name for item in sources] == ["custom"]
def test_no_index_raise_error(project):
project.global_config["pypi.ignore_stored_index"] = True
with pytest.raises(PdmException, match="You must specify at least one index"):
with project.environment.get_finder():
pass
def test_access_index_with_auth(project, httpserver: HTTPServer):
httpserver.expect_request(
"/simple/my-package", method="GET", headers={"Authorization": "Basic Zm9vOmJhcg=="}
).respond_with_data("OK")
project.global_config.update(
{
"pypi.extra.url": httpserver.url_for("/simple"),
"pypi.extra.username": "foo",
"pypi.extra.password": "bar",
}
)
session = project.environment.session
resp = session.get(httpserver.url_for("/simple/my-package"))
assert resp.is_success
def test_configured_source_overwriting(project):
project.pyproject.settings["source"] = [
{
"name": "custom",
"url": "https://custom.pypi.org/simple",
}
]
project.global_config["pypi.custom.url"] = "https://extra.pypi.org/simple"
project.global_config["pypi.custom.verify_ssl"] = False
project.project_config["pypi.custom.username"] = "foo"
project.project_config["pypi.custom.password"] = "bar"
sources = project.sources
assert [source.name for source in sources] == ["pypi", "custom"]
custom_source = sources[1]
assert custom_source.url == "https://custom.pypi.org/simple"
assert custom_source.verify_ssl is False
assert custom_source.username == "foo"
assert custom_source.password == "bar"
def test_invoke_pdm_adding_configured_args(project, pdm, mocker):
project.pyproject.settings["options"] = {
"install": ["--no-self", "--no-editable"],
"add": ["--no-isolation"],
"lock": ["--no-cross-platform"],
}
project.pyproject.write()
parser = mocker.patch("argparse.ArgumentParser.parse_args")
pdm(["add", "requests"], obj=project)
parser.assert_called_with(["add", "--no-isolation", "requests"])
pdm(["install", "--check"], obj=project)
parser.assert_called_with(["install", "--no-self", "--no-editable", "--check"])
pdm(["lock", "--lockfile", "pdm.2.lock"], obj=project)
parser.assert_called_with(["lock", "--no-cross-platform", "--lockfile", "pdm.2.lock"])
pdm(["-c", "/dev/null", "lock"], obj=project)
parser.assert_called_with(["-c", "/dev/null", "lock", "--no-cross-platform"])
pdm(["--verbose", "add", "requests"], obj=project)
parser.assert_called_with(["--verbose", "add", "--no-isolation", "requests"])
@pytest.fixture()
def prepare_repository(repository, project):
repository.add_candidate("foo", "3.0", ">=3.8,<3.13")
repository.add_candidate("foo", "2.0", ">=3.7,<3.12")
repository.add_candidate("foo", "1.0", ">=3.7")
project.environment.python_requires = PySpecSet(">=3.9")
project.add_dependencies(["foo"])
@pytest.mark.usefixtures("prepare_repository")
@pytest.mark.parametrize("is_quiet,extra_args", [(True, ("-q",)), (False, ())])
def test_quiet_mode(pdm, project, is_quiet, extra_args, recwarn):
result = pdm(["lock", *extra_args], obj=project)
assert result.exit_code == 0
assert len(recwarn) > 0
assert 'For example, "<3.13,>=3.9"' in str(recwarn[0].message)
assert 'For example, "<3.12,>=3.9"' in str(recwarn[1].message)
assert ("to suppress these warnings" in result.stderr) is not is_quiet
assert project.get_locked_repository().candidates["foo"].version == "1.0"
@pytest.mark.usefixtures("prepare_repository")
@pytest.mark.parametrize("pattern,suppressed", [("foo", True), ("bar", False), ("*", True), ("f?o", True)])
def test_ignore_package_warning(pdm, project, recwarn, pattern, suppressed):
project.pyproject.settings["ignore_package_warnings"] = [pattern]
result = pdm(["lock"], obj=project)
assert result.exit_code == 0
assert (len(recwarn) == 0) is suppressed
def test_filter_sources_with_config(project):
project.pyproject.settings["source"] = [
{"name": "source1", "url": "https://source1.org/simple", "include_packages": ["foo", "foo-*"]},
{
"name": "source2",
"url": "https://source2.org/simple",
"include_packages": ["foo-bar", "bar*"],
"exclude_packages": ["baz-*"],
},
{"name": "pypi", "url": "https://pypi.org/simple"},
]
repository = project.get_repository()
def expect_sources(requirement: str, expected: list[str]) -> None:
sources = repository.get_filtered_sources(parse_requirement(requirement))
assert sorted([source.name for source in sources]) == sorted(expected)
expect_sources("foo", ["source1"])
expect_sources("foo-baz", ["source1"])
expect_sources("foo-bar", ["source1", "source2"])
expect_sources("bar-extra", ["source2"])
expect_sources("baz-extra", ["source1", "pypi"])
@pytest.mark.usefixtures("working_set")
def test_preserve_log_file(project, pdm, tmp_path, mocker):
pdm(["add", "requests"], obj=project, strict=True)
all_logs = list(tmp_path.joinpath("logs").iterdir())
assert len(all_logs) == 0
mocker.patch("pdm.installers.Synchronizer.synchronize", side_effect=Exception)
result = pdm(["add", "pytz"], obj=project)
assert result.exit_code != 0
install_log = next(tmp_path.joinpath("logs").glob("pdm-install-*.log"))
assert install_log.exists()
@pytest.mark.parametrize("use_venv", [True, False])
def test_find_interpreters_with_PDM_IGNORE_ACTIVE_VENV(
pdm: PDMCallable,
project: Project,
monkeypatch: pytest.MonkeyPatch,
use_venv: bool,
):
project._saved_python = None
project._python = None
project.project_config["python.use_venv"] = use_venv
venv.create(venv_path := project.root / "venv", symlinks=True)
monkeypatch.setenv("VIRTUAL_ENV", str(venv_path))
monkeypatch.setenv("PDM_IGNORE_ACTIVE_VENV", "1")
venv_python = get_venv_python(venv_path)
pythons = list(project.find_interpreters())
assert pythons, "PDM should find interpreters with PDM_IGNORE_ACTIVE_VENV"
# Test requires that some interpreters are available outside the venv
assert any(venv_python != p.executable for p in project.find_interpreters())
# No need to assert, exception raised if not found
interpreter = project.resolve_interpreter()
assert interpreter.executable != venv_python
if use_venv:
project.project_config["venv.in_project"] = True
pdm("install", strict=True, obj=project)
assert project._saved_python
python = Path(project._saved_python)
assert is_path_relative_to(python, project.root)
assert not is_path_relative_to(python, venv_path)
@pytest.mark.parametrize(
"var,key,settings,expected",
[
("PDM_VAR", "var", {}, "from-env"),
("pdm_var", "var", {}, "from-env"),
("PDM_NOPE", "var", {"var": "from-settings"}, "from-settings"),
("PDM_VAR", "var", {"var": "from-settings"}, "from-env"),
("PDM_NOPE", "nested.var", {"nested": {"var": "from-settings"}}, "from-settings"),
("PDM_NOPE", "noop", {}, None),
],
)
def test_env_or_setting(
project: Project,
monkeypatch: pytest.MonkeyPatch,
var: str,
key: str,
settings: dict,
expected: str | None,
):
monkeypatch.setenv("PDM_VAR", "from-env")
project.pyproject.settings.update(settings)
assert project.env_or_setting(var, key) == expected
@pytest.mark.parametrize(
"var,setting,expected",
[
(None, None, []),
("", None, []),
(" ", None, []),
(None, "", []),
(None, " ", []),
(None, [], []),
("var", None, ["var"]),
("val1,val2", None, ["val1", "val2"]),
("val1, val2", None, ["val1", "val2"]),
("val1, , , val2", None, ["val1", "val2"]),
(None, "val1,val2", ["val1", "val2"]),
(None, ["val1", "val2"], ["val1", "val2"]),
(None, [" val1", "val2 "], ["val1", "val2"]),
(None, [" val1", "", "val2 ", " "], ["val1", "val2"]),
(None, ["val1,val2", "val3,val4"], ["val1,val2", "val3,val4"]),
("val1,val2", ["val3", "val4"], ["val1", "val2"]),
],
)
def test_env_setting_list(
project: Project,
monkeypatch: pytest.MonkeyPatch,
var: str | None,
setting: str | list[str] | None,
expected: list[str],
):
if var is not None:
monkeypatch.setenv("PDM_VAR", var)
if setting is not None:
project.pyproject.settings["var"] = setting
assert project.environment._setting_list("PDM_VAR", "var") == expected
def test_project_best_match_max(project, mocker):
expected = PythonVersion("cpython", 3, 10, 13)
mocker.patch(
"pdm.project.core.get_all_installable_python_versions",
return_value=get_python_versions(),
)
assert project.get_best_matching_cpython_version() == expected
def test_project_best_match_min(project, mocker):
expected = PythonVersion("cpython", 3, 8, 0)
mocker.patch(
"pdm.project.core.get_all_installable_python_versions",
return_value=get_python_versions(),
)
assert project.get_best_matching_cpython_version(use_minimum=True) == expected
|