py.test --doctest-modules fails if python setup.py build has been run.

[pytestbot]

Originally reported by: Tom Prince (BitBucket: tomprince, GitHub: tomprince)

---

py.test will recurse into the distutils build directory looking for modules to run doc-tests for, but will try to import them from the root directory, leading to a mismatch between files:

________________________________________________________ ERROR collecting service_identity/_common.py _________________________________________________________
../../dev/tmp-111d346bc44a488b/lib/python2.7/site-packages/py/_path/local.py:639: in pyimport
>               raise self.ImportMismatchError(modname, modfile, self)
E               ImportMismatchError: ('service_identity._common', '/Users/cougar/src/service_identity/build/lib/service_identity/_common.py', local('/Users/cougar/src/service_identity/service_identity/_common.py'))

---

• Bitbucket: https://bitbucket.org/pytest-dev/pytest/issue/539

[reubano]

What's the status on this issue?

[RonnyPfannschmidt]

so far it hasn't been changed, one should use the testdirs ini setting instead

[reubano]

@RonnyPfannschmidt what do I put exactly? I didn't see a testdirs option in the docs. This is my setup.cfg:

[pytest]
addopts=--doctest-modules
testpaths=bin tests examples riko
norecursedirs=lib include .tox

[nicoddemus]

@reubano, @RonnyPfannschmidt probably meant testpaths. Are you having the same problem, even with the setup.cfg above?

[reubano]

Yes, this setup doesn't work.

[nicoddemus]

@reubano sorry for not getting back to this sooner.

Could you please post your full terminal output?

[Erotemic]

This behavior also occurs for xdoctest (my extended doctest plugin). I see the behavior if I run python setup.py install (instead of python setup.py develop, which works) and then pytest. The regular unittests work fine, but when it parses the doctest it parses them from the source folder instead of the folder that was installed. Thus I get an error like:

E           _pytest.nodes.Collector.CollectError: import file mismatch:
E           imported module 'xdoctest.utils.util_stream' has this __file__ attribute:
E             /home/joncrall/.local/conda/envs/py36/lib/python3.6/site-packages/xdoctest-0.5.9-py3.6.egg/xdoctest/utils/util_stream.py
E           which is not the same as the test file we want to collect:
E             /home/joncrall/code/xdoctest/xdoctest/utils/util_stream.py
E           HINT: remove __pycache__ / .pyc files and/or use a unique basename for your test file modules

The behavior is the same with the builtin doctest plugin, so its not just an issue with xdoctest.

The reason I tested this way instead of doing an in-source build and testing was because there was an issue that only occurred when my package was installed (running it from the source tree was not a problem).

[graingert]

@nicoddemus It seems that this link https://pytest.readthedocs.io/en/stable/customize.html?highlight=testpaths#confval-testpaths is broken

[nicoddemus]

@graingert thanks, updated the link in the original post: https://docs.pytest.org/en/latest/reference.html#confval-testpaths

[nicoddemus]

Btw, I have just tried the original issue (doctest modules in the build folder) and it has been fixed since we have updated the default norecursedirs option to include build by default.

I'm closing this issue then, if others have similar problems let's post them here and/or open a new issue if it's a different problem. 👍