Create a gist now

Instantly share code, notes, and snippets.

Embed
What would you like to do?
How to modularize your py.test fixtures

Using py.test is great and the support for test fixtures is pretty awesome. However, in order to share your fixtures across your entire module, py.test suggests you define all your fixtures within one single conftest.py file. This is impractical if you have a large quantity of fixtures -- for better organization and readibility, you would much rather define your fixtures across multiple, well-named files. But how do you do that? ...No one on the internet seemed to know.

Turns out, however, you can define fixtures in individual files like this:

tests/fixtures/add.py

import pytest

@pytest.fixture
def add(x, y):
    x + y

Then you can import these fixtures in your conftest.py:

tests/conftest.py

import pytest
from fixtures.add import add

...and then you're good to test!

tests/adding_test.py

import pytest

@pytest.mark.usefixtures("add")
def test_adding(add):
    assert add(2, 3) == 5

Because of the modularity, tests will have to be run with python -m py.test instead of py.test directly.

@delaurentum

This comment has been minimized.

Show comment
Hide comment

thanks

@AndrewBMartin

This comment has been minimized.

Show comment
Hide comment
@AndrewBMartin

AndrewBMartin Oct 17, 2017

I'm having trouble making this work when running multiple tests at the same time. Would appreciate any insight you might have. Please see the SO question.

Thank you

I'm having trouble making this work when running multiple tests at the same time. Would appreciate any insight you might have. Please see the SO question.

Thank you

@boxysean

This comment has been minimized.

Show comment
Hide comment

thank you

@ikonst

This comment has been minimized.

Show comment
Hide comment
@ikonst

ikonst Mar 6, 2018

You can simply create "local pytest plugins" which can be nothing more than Python files with fixtures, e.g.

  • tests/unit/conftest.py:

    pytest_plugins = [
       "tests.unit.fixtures.some_stuff",
    ]
  • tests/unit/fixtures/some_stuff.py:

    import pytest
    
    @pytest.fixture
    def foo():
        return 'foobar'

ikonst commented Mar 6, 2018

You can simply create "local pytest plugins" which can be nothing more than Python files with fixtures, e.g.

  • tests/unit/conftest.py:

    pytest_plugins = [
       "tests.unit.fixtures.some_stuff",
    ]
  • tests/unit/fixtures/some_stuff.py:

    import pytest
    
    @pytest.fixture
    def foo():
        return 'foobar'
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment