-
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
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.
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
Add discover_imports
in conf, don't collect imported classes named Test* closes #12749`
#12810
base: main
Are you sure you want to change the base?
Changes from 1 commit
222457d
fa3b631
68ac4a1
a6ee0bc
eb8592c
935c06d
191456e
f1821ea
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
Add :confval:`collect_imported_tests`, when enabled (default is disabled) will make sure to not consider classes/functions which are imported by a test file and contains Test/test_*/*_test. | ||
New :confval:`collect_imported_tests`: when enabled (the default) pytest will collect classes/functions in test modules even if they are imported from another file. | ||
|
||
Setting this to False will make pytest collect classes/functions from test files only if they are defined in that file (as opposed to imported there). | ||
|
||
-- by :user:`FreerGit` |
Original file line number | Diff line number | Diff line change | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
@@ -1839,9 +1839,17 @@ passed multiple times. The expected format is ``name=value``. For example:: | |||||||||
pytest testing doc | ||||||||||
|
||||||||||
|
||||||||||
.. confval:: tmp_path_retention_count | ||||||||||
.. confval:: collect_imported_tests | ||||||||||
|
||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
Setting this to `false` will make pytest collect classes/functions from test | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
files only if they are defined in that file (as opposed to imported there). | ||||||||||
|
||||||||||
.. code-block:: ini | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||||||||||
|
||||||||||
[pytest] | ||||||||||
collect_imported_tests = false | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
||||||||||
.. confval:: tmp_path_retention_count | ||||||||||
|
||||||||||
How many sessions should we keep the `tmp_path` directories, | ||||||||||
according to `tmp_path_retention_policy`. | ||||||||||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -82,7 +82,7 @@ | |
"collect_imported_tests", | ||
"Whether to collect tests in imported modules outside `testpaths`", | ||
type="bool", | ||
default=False, | ||
default=True, | ||
) | ||
group = parser.getgroup("general", "Running and selection options") | ||
group._addoption( | ||
|
@@ -973,13 +973,13 @@ | |
self.trace("genitems", node) | ||
if isinstance(node, nodes.Item): | ||
node.ihook.pytest_itemcollected(item=node) | ||
if self.config.getini("collect_imported_tests"): | ||
if not self.config.getini("collect_imported_tests"): | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Previously this code was placed in In fact, it is important for this to be tested too: the following collection hooks should not receive any item that was discarded due to
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hi! Thought I would pick up this issue again after some wait. Is there any examples on how I could test these hooks? Im unsure on how to extract that information from the hooks. Im assuming this is problematic because extensions to pytest could be listening to these hooks? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Usually we write a
Exactly. |
||
if isinstance(node.parent, Module) and isinstance(node, Function): | ||
if inspect.isfunction(node._getobj()): | ||
fn_defined_at = node._getobj().__module__ | ||
in_module = node.parent._getobj().__name__ | ||
if fn_defined_at != in_module: | ||
return | ||
yield node | ||
else: | ||
assert isinstance(node, nodes.Collector) | ||
|
@@ -988,16 +988,16 @@ | |
handle_dupes = not (keepduplicates and isinstance(node, nodes.File)) | ||
rep, duplicate = self._collect_one_node(node, handle_dupes) | ||
|
||
if self.config.getini("collect_imported_tests"): | ||
if not self.config.getini("collect_imported_tests"): | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same comment here, this logic should be moved to |
||
for subnode in rep.result: | ||
if isinstance(subnode, Class) and isinstance( | ||
subnode.parent, Module | ||
): | ||
if inspect.isclass(subnode._getobj()): | ||
class_defined_at = subnode._getobj().__module__ | ||
in_module = subnode.parent._getobj().__name__ | ||
if class_defined_at != in_module: | ||
rep.result.remove(subnode) | ||
|
||
if duplicate and not keepduplicates: | ||
return | ||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -55,7 +55,7 @@ def test_collect_imports_disabled(pytester: Pytester) -> None: | |||||
collect_imported_tests = false | ||||||
""") | ||||||
|
||||||
run_import_class_test(pytester, errors=1) | ||||||
run_import_class_test(pytester, passed=1) | ||||||
|
||||||
|
||||||
def test_collect_imports_default(pytester: Pytester) -> None: | ||||||
|
@@ -74,7 +74,7 @@ def test_collect_imports_enabled(pytester: Pytester) -> None: | |||||
collect_imported_tests = true | ||||||
""") | ||||||
|
||||||
run_import_class_test(pytester, passed=1) | ||||||
run_import_class_test(pytester, errors=1) | ||||||
|
||||||
|
||||||
def run_import_functions_test( | ||||||
|
@@ -137,14 +137,32 @@ def test_collect_function_imports_enabled(pytester: Pytester) -> None: | |||||
collect_imported_tests = true | ||||||
""") | ||||||
|
||||||
run_import_functions_test(pytester, passed=1, errors=0, failed=0) | ||||||
run_import_functions_test(pytester, passed=2, errors=0, failed=1) | ||||||
|
||||||
|
||||||
def test_collect_function_imports_disabled(pytester: Pytester) -> None: | ||||||
pytester.makeini(""" | ||||||
[pytest] | ||||||
testpaths = "tests" | ||||||
# testpaths = "tests" | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this was meant to be:
Suggested change
But I don't think There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I ment delete that commented line but forgot. You're right There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Oh in that case make sure to add a comment/docstring mentioning that if you want to keep the test. |
||||||
collect_imported_tests = false | ||||||
""") | ||||||
|
||||||
run_import_functions_test(pytester, passed=1, errors=0, failed=0) | ||||||
|
||||||
|
||||||
def test_behaviour_without_testpaths_set_and_false(pytester: Pytester) -> None: | ||||||
pytester.makeini(""" | ||||||
[pytest] | ||||||
collect_imported_tests = false | ||||||
""") | ||||||
|
||||||
run_import_functions_test(pytester, passed=1, errors=0, failed=0) | ||||||
|
||||||
|
||||||
def test_behaviour_without_testpaths_set_and_true(pytester: Pytester) -> None: | ||||||
pytester.makeini(""" | ||||||
[pytest] | ||||||
collect_imported_tests = true | ||||||
""") | ||||||
|
||||||
run_import_functions_test(pytester, passed=2, errors=0, failed=1) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you move this closer to the other options alphabetically?