Pytest fail when autouse fixture is applied and --doctest-modules is set #1057

vitalk · 2015-09-23T12:01:02Z

When --doctest-modules option is set but module has no doctests available, then pytest raises AssertionError. This issue occurs only if autouse fixture is applied.

# test_doctest_module.py

def test_a():
    """
    >>> assert 2 + 2 == 4
    """
    assert 2 + 2 == 4

# test_no_doctest_module.py

def test_a():
    assert 2 + 2 == 4

# conftest.py
import pytest


@pytest.fixture(autouse=True)
def __autoused_fixture(request):
    pass

$ py.test test_doctest_module.py --doctest-modules
================================== test session starts ==================================
platform darwin -- Python 2.7.9, pytest-2.8.0, py-1.4.30, pluggy-0.3.1
rootdir: /Users/vital/.virtualenvs/tmp-83f75479bea7798, inifile:
collected 2 items

test_doctest_module.py ..

$ py.test test_no_doctest_module.py --doctest-modules
================================== test session starts ==================================
platform darwin -- Python 2.7.9, pytest-2.8.0, py-1.4.30, pluggy-0.3.1
rootdir: /Users/vital/.virtualenvs/tmp-83f75479bea7798, inifile:
collected 1 items

test_no_doctest_module.py .ETraceback (most recent call last):
  File "/Users/vital/.virtualenvs/tmp-83f75479bea7798/bin/py.test", line 11, in <module>
    sys.exit(main())
  File "/Users/vital/.virtualenvs/tmp-83f75479bea7798/lib/python2.7/site-packages/_pytest/config.py", line 48, in main
    return config.hook.pytest_cmdline_main(config=config)
  File "/Users/vital/.virtualenvs/tmp-83f75479bea7798/lib/python2.7/site-packages/_pytest/vendored_packages/pluggy.py", line 724, in __call__
    return self._hookexec(self, self._nonwrappers + self._wrappers, kwargs)
  File "/Users/vital/.virtualenvs/tmp-83f75479bea7798/lib/python2.7/site-packages/_pytest/vendored_packages/pluggy.py", line 338, in _hookexec
    return self._inner_hookexec(hook, methods, kwargs)
  File "/Users/vital/.virtualenvs/tmp-83f75479bea7798/lib/python2.7/site-packages/_pytest/vendored_packages/pluggy.py", line 333, in <lambda>
    _MultiCall(methods, kwargs, hook.spec_opts).execute()
  File "/Users/vital/.virtualenvs/tmp-83f75479bea7798/lib/python2.7/site-packages/_pytest/vendored_packages/pluggy.py", line 596, in execute
    res = hook_impl.function(*args)
  File "/Users/vital/.virtualenvs/tmp-83f75479bea7798/lib/python2.7/site-packages/_pytest/main.py", line 115, in pytest_cmdline_main
    return wrap_session(config, _main)
  File "/Users/vital/.virtualenvs/tmp-83f75479bea7798/lib/python2.7/site-packages/_pytest/main.py", line 110, in wrap_session
    exitstatus=session.exitstatus)
  File "/Users/vital/.virtualenvs/tmp-83f75479bea7798/lib/python2.7/site-packages/_pytest/vendored_packages/pluggy.py", line 724, in __call__
    return self._hookexec(self, self._nonwrappers + self._wrappers, kwargs)
  File "/Users/vital/.virtualenvs/tmp-83f75479bea7798/lib/python2.7/site-packages/_pytest/vendored_packages/pluggy.py", line 338, in _hookexec
    return self._inner_hookexec(hook, methods, kwargs)
  File "/Users/vital/.virtualenvs/tmp-83f75479bea7798/lib/python2.7/site-packages/_pytest/vendored_packages/pluggy.py", line 333, in <lambda>
    _MultiCall(methods, kwargs, hook.spec_opts).execute()
  File "/Users/vital/.virtualenvs/tmp-83f75479bea7798/lib/python2.7/site-packages/_pytest/vendored_packages/pluggy.py", line 595, in execute
    return _wrapped_call(hook_impl.function(*args), self.execute)
  File "/Users/vital/.virtualenvs/tmp-83f75479bea7798/lib/python2.7/site-packages/_pytest/vendored_packages/pluggy.py", line 249, in _wrapped_call
    wrap_controller.send(call_outcome)
  File "/Users/vital/.virtualenvs/tmp-83f75479bea7798/lib/python2.7/site-packages/_pytest/terminal.py", line 361, in pytest_sessionfinish
    outcome.get_result()
  File "/Users/vital/.virtualenvs/tmp-83f75479bea7798/lib/python2.7/site-packages/_pytest/vendored_packages/pluggy.py", line 279, in get_result
    _reraise(*ex)  # noqa
  File "/Users/vital/.virtualenvs/tmp-83f75479bea7798/lib/python2.7/site-packages/_pytest/vendored_packages/pluggy.py", line 264, in __init__
    self.result = func()
  File "/Users/vital/.virtualenvs/tmp-83f75479bea7798/lib/python2.7/site-packages/_pytest/vendored_packages/pluggy.py", line 596, in execute
    res = hook_impl.function(*args)
  File "/Users/vital/.virtualenvs/tmp-83f75479bea7798/lib/python2.7/site-packages/_pytest/runner.py", line 55, in pytest_sessionfinish
    session._setupstate.teardown_all()
  File "/Users/vital/.virtualenvs/tmp-83f75479bea7798/lib/python2.7/site-packages/_pytest/runner.py", line 375, in teardown_all
    self._pop_and_teardown()
  File "/Users/vital/.virtualenvs/tmp-83f75479bea7798/lib/python2.7/site-packages/_pytest/runner.py", line 348, in _pop_and_teardown
    self._teardown_with_finalization(colitem)
  File "/Users/vital/.virtualenvs/tmp-83f75479bea7798/lib/python2.7/site-packages/_pytest/runner.py", line 371, in _teardown_with_finalization
    or isinstance(colitem, tuple)
_pytest.assertion.reinterpret.AssertionError: assert (<DoctestModule 'test_no_doctest_module.py'> is None or <DoctestModule 'test_no_doctest_module.py'> in [<Session 'tmp-83f75479bea7798'>] or isinstance(<DoctestModule 'test_no_doctest_module.py'>, tuple))
 +  where [<Session 'tmp-83f75479bea7798'>] = [<Session 'tmp-83f75479bea7798'>]
 +    where [<Session 'tmp-83f75479bea7798'>] = <_pytest.runner.SetupState object at 0x10e5be7d0>.stack

$ echo > conftest.py
$ py.test test_no_doctest_module.py --doctest-modules
================================== test session starts ==================================
platform darwin -- Python 2.7.9, pytest-2.8.0, py-1.4.30, pluggy-0.3.1
rootdir: /Users/vital/.virtualenvs/tmp-83f75479bea7798, inifile:
collected 1 items

test_no_doctest_module.py .

=============================== 1 passed in 0.03 seconds ================================```

The text was updated successfully, but these errors were encountered:

The main problem was that previously DoctestModule was setting up its fixtures during collection, instead of letting each DoctestItem make its own fixture setup Fix pytest-dev#1100 Fix pytest-dev#1057

nicoddemus · 2015-10-03T19:12:25Z

Hi @vitalk, I just opened a PR which fixes this. Could you please confirm that it fixes your test suite?

pip install git+https://github.com/nicoddemus/pytest@doctest-fixtures-fix

vitalk · 2015-10-05T11:10:09Z

Works like a charm! Thank you.

bukzor · 2015-10-07T16:59:48Z

We're having this issue as well.

Please to merge and release.

nicoddemus · 2015-10-07T17:06:10Z

@bukzor could you please test the PR branch as well?

bukzor · 2015-10-07T17:09:00Z

yep, it's fixed on that branch

nicoddemus · 2015-10-07T17:27:16Z

Thanks! 😄

bukzor · 2015-10-07T17:46:08Z

Please to merge and release.

ionelmc · 2015-10-16T09:45:26Z

Did this get released yet?

The-Compiler · 2015-10-16T09:51:17Z

No - it didn't make it into 2.8.2 and there's no 2.8.3 yet. But AFAIK @RonnyPfannschmidt plans to release 2.8.3 soon.

twexler · 2015-11-09T18:54:15Z

Any progress on a 2.8.3 release? This issue is definitely still there.

As we introduced an py.test autouse fixture, we cannot currently also run doctest-modules due to a bug in py.test (2.8.1, 2.8.2): pytest-dev/pytest#1057 Looks like a fix is planned for 2.8.3 release. Until then we have to disable doctests in modules.

…ev/pytest#1057

…odules pytest-dev/pytest#1057 That means no more testpaths option. Leverage .gitignore instead. Manually exclude setup.py and tldextract_app folder.

vitalk mentioned this issue Sep 23, 2015

pytest-flask breaks in pytest 2.8 when using --doctest-modules pytest-dev/pytest-flask#37

Closed

ionelmc mentioned this issue Sep 30, 2015

pytest-cov 2.1.0 doesn't work with pytest 2.8.0 pytest-dev/pytest-cov#91

Closed

ionelmc added the type: bug problem that needs to be addressed label Sep 30, 2015

nicoddemus mentioned this issue Oct 2, 2015

Exception while using module scoped fixture (ok in 2.7.3 and broken in 2.8.x) #1100

Closed

nicoddemus added a commit to nicoddemus/pytest that referenced this issue Oct 2, 2015

Add failing test for #pytest-dev#1057 and pytest-dev#1100

8e5536e

nicoddemus mentioned this issue Oct 2, 2015

Fix autouse fixtures and doctest modules #1102

Merged

bukzor mentioned this issue Oct 7, 2015

no heartbeat during debug Yelp/pgctl#89

Merged

RonnyPfannschmidt closed this as completed in #1102 Oct 10, 2015

acjackson mentioned this issue Nov 12, 2015

"Database access not allowed" in Doctests (Django) #1180

Closed

john-kurkowski added a commit to john-kurkowski/tldextract that referenced this issue Nov 16, 2015

Use py.test PR branch while waiting for official release for pytest-d…

a51b078

…ev/pytest#1057

kmike mentioned this issue Jan 22, 2016

[MRG+1] shell command's ability to open local files + tests scrapy/scrapy#1710

Merged

pytestbot mentioned this issue Jun 18, 2018

Fixture autouse and module imports in test suite (question) #3597

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Pytest fail when autouse fixture is applied and --doctest-modules is set #1057

Pytest fail when autouse fixture is applied and --doctest-modules is set #1057

vitalk commented Sep 23, 2015

nicoddemus commented Oct 3, 2015

Uh oh!

vitalk commented Oct 5, 2015

Uh oh!

bukzor commented Oct 7, 2015

Uh oh!

nicoddemus commented Oct 7, 2015

Uh oh!

bukzor commented Oct 7, 2015

Uh oh!

nicoddemus commented Oct 7, 2015

Uh oh!

bukzor commented Oct 7, 2015

Uh oh!

ionelmc commented Oct 16, 2015

Uh oh!

The-Compiler commented Oct 16, 2015

Uh oh!

twexler commented Nov 9, 2015

Uh oh!

Uh oh!

Pytest fail when autouse fixture is applied and --doctest-modules is set #1057

Pytest fail when autouse fixture is applied and --doctest-modules is set #1057

Comments

vitalk commented Sep 23, 2015

nicoddemus commented Oct 3, 2015

Uh oh!

vitalk commented Oct 5, 2015

Uh oh!

bukzor commented Oct 7, 2015

Uh oh!

nicoddemus commented Oct 7, 2015

Uh oh!

bukzor commented Oct 7, 2015

Uh oh!

nicoddemus commented Oct 7, 2015

Uh oh!

bukzor commented Oct 7, 2015

Uh oh!

ionelmc commented Oct 16, 2015

Uh oh!

The-Compiler commented Oct 16, 2015

Uh oh!

twexler commented Nov 9, 2015

Uh oh!