Skip to content

Commit

Permalink
fix comment
Browse files Browse the repository at this point in the history
  • Loading branch information
sus-pe committed Nov 10, 2024
1 parent 8d54d89 commit c8f095b
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 12 deletions.
33 changes: 30 additions & 3 deletions src/_pytest/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
from pathlib import Path
import sys
from typing import AbstractSet
from typing import Any
from typing import Callable
from typing import Dict
from typing import final
Expand Down Expand Up @@ -365,6 +366,20 @@ def pytest_runtestloop(session: Session) -> bool:
return True


def _decode_toml_file(toml: Path) -> dict[str, Any] | None:
"""Attempt to decode a toml file into a dict, returning None if fails."""
if sys.version_info >= (3, 11):
import tomllib
else:
import tomli as tomllib

try:
toml_text = toml.read_text(encoding="utf-8")
return tomllib.loads(toml_text)
except tomllib.TOMLDecodeError:
return None

Check warning on line 380 in src/_pytest/main.py

View check run for this annotation

Codecov / codecov/patch

src/_pytest/main.py#L379-L380

Added lines #L379 - L380 were not covered by tests


def _in_build(path: Path) -> bool:
"""Attempt to detect if ``path`` is the root of a buildsystem's artifacts
by checking known dirnames patterns, and the presence of configuration in
Expand All @@ -374,9 +389,21 @@ def _in_build(path: Path) -> bool:
return False

if any(fnmatch_ex(pat, path) for pat in ("build", "dist")):
indicators = ("setup.py", "setup.cfg", "pyproject.toml")
if any((path.parent / f).is_file() for f in indicators):
return True
setup_cfg = path.parent / "setup.cfg"
if (setup_cfg).is_file():
setup_py = path.parent / "setup.py"
if setup_py.is_file():
return True

pyproject_toml = path.parent / "pyproject.toml"
if pyproject_toml.is_file():
config = _decode_toml_file(pyproject_toml)
if config:
if any(
"setuptools" in cfg
for cfg in config.get("build-system", {}).get("requires", {})
):
return True

return False

Expand Down
22 changes: 13 additions & 9 deletions testing/test_collection.py
Original file line number Diff line number Diff line change
Expand Up @@ -275,14 +275,10 @@ def test_missing_permissions_on_unselected_directory_doesnt_crash(
result.assert_outcomes(passed=1)

known_build_dirs = pytest.mark.parametrize("build_dir", ["build", "dist"])
known_buildsystem_env = pytest.mark.parametrize(
"buildsystem_indicator_file", ["setup.py", "setup.cfg", "pyproject.toml"]
)

@known_build_dirs
@known_buildsystem_env
def test_build_dirs_collected(
self, pytester: Pytester, build_dir: str, buildsystem_indicator_file: str
def test_build_dirs_collected_when_setuptools_setup_py_present(
self, pytester: Pytester, build_dir: str
) -> None:
tmp_path = pytester.path
ensure_file(tmp_path / build_dir / "test_module.py").write_text(
Expand All @@ -292,13 +288,17 @@ def test_build_dirs_collected(
result = pytester.runpytest("--collect-only").stdout.str()
assert "test_module" in result

ensure_file(tmp_path / buildsystem_indicator_file)
ensure_file(tmp_path / "setup.cfg")

result = pytester.runpytest("--collect-only").stdout.str()
assert "test_module" in result

ensure_file(tmp_path / "setup.py")
result = pytester.runpytest("--collect-only").stdout.str()
assert "test_module" not in result

@known_build_dirs
def test_build_dirs_collected_when_setuptools_configuration_present(
def test_build_dirs_collected_when_setuptools_present_in_pyproject_toml(
self, pytester: Pytester, build_dir: str
) -> None:
tmp_path = pytester.path
Expand All @@ -314,7 +314,11 @@ def test_build_dirs_collected_when_setuptools_configuration_present(
result = pytester.runpytest("--collect-only").stdout.str()
assert "test_module" in result

ensure_file(tmp_path / "setup.py")
ensure_file(tmp_path / "pyproject.toml").write_text(
'[build-system]\nrequires = ["setuptools", "setuptools-scm"]\n',
encoding="utf-8",
)
result = pytester.runpytest("--collect-only").stdout.str()
assert "test_module" not in result


Expand Down

0 comments on commit c8f095b

Please sign in to comment.