How to modularize your py.test fixtures

pytest-fixture-modularization.md

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.

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'

Awesome ikonst!

Also note that the respective directories referred to in tests.unit.fixtures.some_stuff" need to have __init__.py files for the plugins to be loaded by pytest.

https://docs.pytest.org/en/documentation-restructure/how-to/writing_plugins.html#requiring-loading-plugins-in-a-test-module-or-conftest-file

Fixtures with a

@pytest.fixture(scope="session", autouse=True)

scope need to be in the conftest.py file directly.

With python3 you run it as python -m pytest

Otherwise you see following error:

$ python -m py.test
/usr/local/Cellar/python/3.7.3/Frameworks/Python.framework/Versions/3.7/lib/python3.7/runpy.py:125: RuntimeWarning: 'py.test' found in sys.modules after import of package 'py', but prior to execution of 'py.test'; this may result in unpredictable behaviour
  warn(RuntimeWarning(msg))
/Users/jpadhye/.local/share/virtualenvs/sse-test-bench-4eGiHs-X/bin/python: loader for pytest cannot handle py.test

Thanks for sharing!

Oh thank you! Just what I need at the moment.

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

* tests/unit/conftest.py:
  ```python
  pytest_plugins = [
     "tests.unit.fixtures.some_stuff",
  ]
  ```

* tests/unit/fixtures/some_stuff.py:
  ```python
  import pytest
  
  @pytest.fixture
  def foo():
      return 'foobar'
  ```

I really like your idea!

I've replaced

       pytest_plugins = [
          "tests.unit.fixtures.some_stuff",
       ]

with

from glob import glob

pytest_plugins = [
   fixture.replace("/", ".").replace("fixtures.py", "fixtures") for fixture in glob("*/tests/fixtures.py")
]

Then any fixture located in */tests/fixtures.py will be added automatically without extra work from me. You can adjust the pattern to fit your application's structure.

In case, someone else likes the combination of both ideas by @ramast and @ikonst, I've adapted it to look up all fixtures, defined in their own file under the fixtures folder:

# conftest.py

from glob import glob


def refactor(string: str) -> str:
    return string.replace("/", ".").replace("\\", ".").replace(".py", "")


pytest_plugins = [
    refactor(fixture) for fixture in glob("tests/fixtures/*.py") if "__" not in fixture
]

So, this should work, if you project setup looks like this:

./
├── src
├── tests
│   ├── conftest.py
│   ├── fixtures
│   │   ├── my_fixture.py

edit: I noticed, that I was executing pytest from tests instead of root. Fixed the discovery path and shortened string manipulation.

I do something similar in my projects.

• walk_packages.py:

  from pkgutil import ModuleInfo
  from pkgutil import walk_packages
  from types import ModuleType
  from typing import Iterable
  
  
  def get_packages_in_module(m: ModuleType) -> Iterable[ModuleInfo]:
      return walk_packages(m.__path__, prefix=m.__name__ + '.')  # type: ignore
  
  
  def get_package_paths_in_module(m: ModuleType) -> Iterable[str]:
      return [package.name for package in get_packages_in_module(m)]

• conftest.py

  import tests.fixtures
  from tests.helpers.walk_packages import get_package_paths_in_module
  
  pytest_plugins = [
      ...
      *get_package_paths_in_module(tests.fixtures),
  ]

Admittedly the glob-and-string-substitution variant is a little shorter :)

@peterhurford and @ikonst Thank you, this post helped me.

In case, someone else likes the combination of both ideas by @ramast and @ikonst, I've adapted it to look up all fixtures, defined in their own file under the fixtures folder:

# conftest.py

from glob import glob


def refactor(string: str) -> str:
    return string.replace("/", ".").replace("\\", ".").replace(".py", "")


pytest_plugins = [
    refactor(fixture) for fixture in glob("tests/fixtures/*.py") if "__" not in fixture
]

So, this should work, if you project setup looks like this:

./
├── src
├── tests
│   ├── conftest.py
│   ├── fixtures
│   │   ├── my_fixture.py

edit: I noticed, that I was executing pytest from tests instead of root. Fixed the discovery path and shortened string manipulation.

Thanks a lot man.. this work like a charm for me..

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

* tests/unit/conftest.py:
  ```python
  pytest_plugins = [
     "tests.unit.fixtures.some_stuff",
  ]
  ```

* tests/unit/fixtures/some_stuff.py:
  ```python
  import pytest
  
  @pytest.fixture
  def foo():
      return 'foobar'
  ```

Thanks for you idea @ikonst!
Just made my conftest as package and add it as plugin!

When i try to run the code

def add(x, y):

it tries to find x as fixtures.

Can we call a fixture with parameter? in above example add is a fixture method which has parameter

whenever we call fixture, we just mention fixture name,, so if i have to use add, where i can mention x or y..

Is this what you are looking for, @gauravkhuraana?

@christian-steinmeyer thank you for replying.
I saw that parmeterization concept i see, that applies to test method instead of fixture

Here is my fixture

import pytest
@pytest.fixture
def sum2Nbrs(a,b):
    return a+b

The test function is like

@pytest.mark.usefixtures("sum2Nbrs")
def test_2NbrsAddViaFixture(sum2Nbrs):
    print("The sume of numbers is", sum2Nbrs(2,4))

When i run this function i get

below is the error

file S:\Automation\python\tests\test_fixturesCall.py, line 7
def test_2NbrsAddViaFixture(sum2Nbrs):
file S:\Automation\python\tests\fixtures\MathsFixtures.py, line 3
@pytest.fixture
def sum2Nbrs(a,b):

E fixture 'a' not found

i would like to call fixture and not test method with parameters as shown above.

My test function should take 2 parameters and give me the sum of them

How about

import pytest
@pytest.fixture
def sum2Nbrs():
    def sum(a, b):
        return a+b

    return sum

Thanks a lot christian , this did what i wanted to achieve

Actual Code/ Fixtures

@pytest.fixture
def sum2Nbrs():
 def sum(a,b):
    return a+b
 return sum   

Calling Code/fixture

def test_2NbrsAddViaFixture(sum2Nbrs):
    print("The sume of numbers is", sum2Nbrs(2,4))

This is a good way to parameterize the fixtures by creating another function(sum) under them(sum2Nbrs).

Calling the function directly mentioning the fixture name without subfunction(sum2Nbrs(2,4) )
We did not explicit took the name sum while calling.

Thank you

Does pytest try to import all the fixtures from the pytest_plugins variable? I was wondering if the method mentioned in this post can be applied to resolve dependency issues that occur with so many fixtures being present in a single file, something like only the fixtures that are needed are imported... (I cant necessarily have multiple conftest files as I want to import and resuse fixtures across different directories)?

Does pytest try to import all the fixtures from the pytest_plugins variable?

Yes, every module in pytest_plugins is loaded and all fixtures in that module are made available to all tests.

glob("tests/fixtures/*.py") if "__" not in fixture

Can be replaced with

glob("tests/fixtures/[!__]*.py")

or even

glob("tests/fixtures/[!_]*.py")

to also skip filenames that start with single underscore.

Just a solution I've come across for anyone reading:

# conftest.py
here = os.path.dirname(os.path.realpath(__file__))

pytest_plugins = []

def _as_module(root: str, path: str) -> str:
    path = os.path.join(root, path)
    path = path.replace(here, "")
    path = path.replace(".py", "")
    path = path.replace(os.path.sep, ".")[1:]
    return "test." + path


for root, dirs, files in os.walk(here, topdown=True):
    dirs[:] = [d for d in dirs if d.startswith("test")]
    pytest_plugins += [_as_module(root, f) for f in files if f.endswith("fixtures.py")]

It allows you to have a fixtures file in any subdirectory

.../test
   __init__.py
   conftest.py
   /test_f1
      __init__.py
      fixtures.py
   
      /test_subf1
         __init__.py
         fixtures.py
   
      /test_subf2
         __init__.py
         endswith_fixtures.py
         extra_fixtures.py
   
   /test_f2
      __init__.py
      fixtures.py

@eddiebergman That's what the code in https://gist.github.com/peterhurford/09f7dcda0ab04b95c026c60fa49c2a68#gistcomment-3453453 (using pkgutil.walk_packages) already does.

@ikonst Ahh, I didn't know it supported the same layout with fixtures in each dir, very nice

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

* tests/unit/conftest.py:
  ```python
  pytest_plugins = [
     "tests.unit.fixtures.some_stuff",
  ]

• tests/unit/fixtures/some_stuff.py:

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

Thanks for you idea @ikonst! Just made my conftest as package and add it as plugin!

Can you share how did you share the conftest as a package? Can that package be pip installed across other repo/projects?

There's no much difference between a conftest.py and a pytest plugin (only one I can think of, is that a top-level conftest can have a pytest_plugins section).

If you want to make a Python package with pytest fixtures, see https://docs.pytest.org/en/6.2.x/writing_plugins.html

Hello everyone, thank you for all the insightful comments.
If you use PyCharm, it seems that, for now, you won't be able to use the glob approach because of this issue, which cleans up the "unused import" needed with this approach.

My recommendation would be to use the hard-coded list and maintain the conftest.py file.
With this, you also do not need to import the fixture in your test file.

Otherwise, here's a summary of the above:

tests/conftest.py

from glob import glob
def _as_module(fixture_path: str) -> str:
    return fixture_path.replace("/", ".").replace("\\", ".").replace(".py", "")


pytest_plugins = [
    _as_module(fixture) for fixture in glob("tests/fixtures/[!_]*.py")
]

tests/fixtures/example.py

@pytest.fixture()
def example():
    return []

tests/unit/mytest.py

# If you did not hardcode pytest_plugins, you might need `from tests.fixtures.example import example`
def test_get_a_list(example):
    assert isinstance(example, list)

pytest_plugins

It worked like a charm, thank you.

Great gist on modularization of conftest, it works great, thanks!

And thanks to @ryanjdillon for the tip about init.py, it solved a mypy problem for me.

Another option would be to have multiple nested directories/packages containing your tests, and each directory can have its own conftest.py with its own fixtures, adding on to the ones provided by the conftest.py files in parent directories as written in the official doc here