pytest icon indicating copy to clipboard operation
pytest copied to clipboard

pytest --doctest-modules crashes on file-level `__test__ = False`

Open kaddkaka opened this issue 1 year ago • 7 comments

A file level __test__ = False succesfully stops pytest from collecting any test from that file, however when running pytest --doctest- modules on the same file, this error appears:

/sw/Python/Ubuntu-22.04/3.10.5/lib/python3.10/site-packages/_pytest/runner.py:341: in from_call
    result: Optional[TResult] = func()
/sw/Python/Ubuntu-22.04/3.10.5/lib/python3.10/site-packages/_pytest/runner.py:372: in <lambda>
    call = CallInfo.from_call(lambda: list(collector.collect()), "collect")
/sw/Python/Ubuntu-22.04/3.10.5/lib/python3.10/site-packages/_pytest/doctest.py:587: in collect
    for test in finder.find(module, module.__name__):
/sw/Python/Ubuntu-22.04/3.10.5/lib/python3.10/doctest.py:940: in find
    self._find(tests, obj, name, module, source_lines, globs, {})
/sw/Python/Ubuntu-22.04/3.10.5/lib/python3.10/site-packages/_pytest/doctest.py:536: in _find
    super()._find(  # type:ignore[misc]
/sw/Python/Ubuntu-22.04/3.10.5/lib/python3.10/doctest.py:1018: in _find
    for valname, val in getattr(obj, '__test__', {}).items():
E   AttributeError: 'bool' object has no attribute 'items'

It's enoough to have a file with only this content to see the behavior:

__test__ = False

Version: pytest 7.4.3

kaddkaka avatar Dec 21 '23 11:12 kaddkaka

This looks like a issue with the stdlib

RonnyPfannschmidt avatar Dec 21 '23 12:12 RonnyPfannschmidt

@RonnyPfannschmidt do you have any idea on how to investigate or fix?

kaddkaka avatar Dec 21 '23 13:12 kaddkaka

based on https://docs.python.org/3/library/doctest.html#which-docstrings-are-examined the code in the stdlib is incorrect, a upstream bug needs to be opened

RonnyPfannschmidt avatar Dec 21 '23 13:12 RonnyPfannschmidt

Thanks, I tested __test__ = {} which seems to have the intended effect on both pytest and doctest.

Where would such a bug be opened? python/cpython?

kaddkaka avatar Dec 21 '23 13:12 kaddkaka

cpython

RonnyPfannschmidt avatar Dec 21 '23 14:12 RonnyPfannschmidt

There is a workaround. I had the same problem and this is how I 'fixed' it. Instead of using :

__test__ = False,

do this:

pytestmark = pytest.mark.skip

ValdonVitija avatar Jan 15 '24 20:01 ValdonVitija

There is a workaround. I had the same problem and this is how I 'fixed' it. Instead of using :

__test__ = False,

do this:

pytestmark = pytest.mark.skip

Where is this documented and what's the difference?

Why not just __test__ = {}?

kaddkaka avatar Jan 16 '24 05:01 kaddkaka