Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify PytestPluginManager._is_in_confcutdir #12007

Merged
merged 2 commits into from
Feb 18, 2024
Merged

Clarify PytestPluginManager._is_in_confcutdir #12007

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b85b386
Clarify PytestPluginManager._is_in_confcutdir
nicoddemus Feb 18, 2024
84bdd6f
Update src/_pytest/config/__init__.py
nicoddemus Feb 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 10 additions & 7 deletions src/_pytest/config/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -578,12 +578,18 @@ def _set_initial_conftests(
self._try_load_conftest(invocation_dir, importmode, rootpath)

def _is_in_confcutdir(self, path: Path) -> bool:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about renaming this to focus on the purpose of the method rather than the implementation detail?

Suggested change
def _is_in_confcutdir(self, path: Path) -> bool:
def _should_load_conftests_from(self, path: Path) -> bool:

"""Whether a path is within the confcutdir.

When false, should not load conftest.
"""
"""Whether to consider the given path to load conftests from."""
if self._confcutdir is None:
return True
# The semantics here are literally:
# Do not load a conftest if it is found upwards from confcut dir.
# But this is *not* the same as:
# Load only conftests from confcutdir or below.
# At first glance they might seem the same thing, however we do support use cases where
# we want to load conftests that are not found in confcutdir or below, but are found
# in completely different directory hierarchies like packages installed
# in out-of-source trees.
# (see #9767 for a regression where the logic was inverted).
return path not in self._confcutdir.parents

def _try_load_conftest(
Expand All @@ -609,9 +615,6 @@ def _loadconftestmodules(
if directory in self._dirpath2confmods:
return

# XXX these days we may rather want to use config.rootpath
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment is outdated, we always configure confcutdir nowadays:

pytest/src/_pytest/config/__init__.py

Lines 1334 to 1339 in 40011b8

if self.known_args_namespace.confcutdir is None:
if self.inipath is not None:
confcutdir = str(self.inipath.parent)
else:
confcutdir = str(self.rootpath)
self.known_args_namespace.confcutdir = confcutdir

# and allow users to opt into looking into the rootdir parent
# directories instead of requiring to specify confcutdir.
clist = []
for parent in reversed((directory, *directory.parents)):
if self._is_in_confcutdir(parent):
Expand Down