Can I make the pytest doctest module ignore a file?

Question

We use pytest to test our project and have enabled --doctest-modules by default to collect all of our doctests from across the project.

However there is one wsgi.py which may not be imported during test collection, but I cant get pytest to ignore it.

I tried putting it in the collect_ignore list in conftest.py but apparently the doctest module does not use this list.

The only thing that does work is putting the whole directory of wsgi.py into norecursedirs in the pytest config file, but this obviously hides the whole directory, which I don't want.

Is there a way to make the doctest module ignore just a certain file?

This may be helpful https://docs.pytest.org/en/stable/example/pythoncollection.html — Erel Segal-Halevi, Feb 01 '21 at 19:08

Grygorii Iermolenko · Answer 1 · 2019-03-07T13:51:10.237

8

As MasterAndrey has mentioned, pytest_ignore_collect should do the trick. Important to note that you should put conftest.py to root folder (the one you run tests from).
Example:

import sys

def pytest_ignore_collect(path):
    if sys.version_info[0] > 2:
        if str(path).endswith("__py2.py"):
            return True
    else:
        if str(path).endswith("__py3.py"):
            return True

Since pytest v4.3.0 there is also --ignore-glob flag which allows to ignore by pattern. Example: pytest --doctest-modules --ignore-glob="*__py3.py" dir/

edited Mar 07 '19 at 13:51

answered Mar 07 '19 at 12:39

Grygorii Iermolenko

301
3
5

1

The crucial part for me was to put this `pytest_ignore_collect` hook in a conftest.py in the *root* of the project. We had a conftest.py in our `tests` directory with several settings, and placing the hook there did not work. – patrickdepinguin Jun 09 '19 at 18:19
hmmm ... this just gives me a whole load of `E KeyError: '--doctest-modules'` – joel Aug 07 '20 at 21:45

score 6 · Answer 2 · edited Oct 09 '17 at 00:39

6

You can use hook to conditionally exclude some folders from test discovery. https://docs.pytest.org/en/latest/writing_plugins.html

def pytest_ignore_collect(path, config):
    """ return True to prevent considering this path for collection.
    This hook is consulted for all files and directories prior to calling
    more specific hooks.
    """

edited Oct 09 '17 at 00:39

futurulus

391
3
9

answered Dec 29 '16 at 06:29

ANDgineer

505
3
12

Can I make the pytest doctest module ignore a file?

2 Answers2