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 docs.pytest.org/en/stable/example/pythoncollection.html — Erel Segal-Halevi
– Erel Segal-Halevi, Commented Feb 1, 2021 at 19:08

Grygorii Iermolenko · Accepted Answer · 2019-03-07 13:51:10Z

9

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 7, 2019 at 13:51

answered Mar 7, 2019 at 12:39

Grygorii Iermolenko

3313 silver badges6 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

patrickdepinguin Over a year ago

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.

joel Over a year ago

hmmm ... this just gives me a whole load of E KeyError: '--doctest-modules'

jGaboardi Over a year ago

In the current version (pytest==8.3.2), the path positional argument is deprecated in favor of collection_path.

futurulus · Accepted Answer · 2017-10-09 00:39:25Z

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 9, 2017 at 0:39

futurulus

4114 silver badges10 bronze badges

answered Dec 29, 2016 at 6:29

ANDgineer

7205 silver badges14 bronze badges

Collectives™ on Stack Overflow

Can I make the pytest doctest module ignore a file?

2 Answers 2

3 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related