package scoped fixture

[jefflieu]

I have this hierarchy of files:
pytest/
- conftest.py (1)
- package1/
----- init.py
----- conftest.py(2)
----- test_1.py
----- test_1b.py
- package2/
----- __init__py
----- conftest.py (3)
----- test_1.py

In the conftest.py (1) I have this:

@pytest.fixture(scope="package")
def root_fixture():
    print("root setup")
    yield None
    print("root teardown")

---

However, the printout is like this:

=================================================================== PASSES 
___________________________________________________________________ test_1 ___________________________________________________________________
----------------------------------------------------------- Captured stdout setup ------------------------------------------------------------
root setup
------------------------------------------------------------ Captured stdout call ------------------------------------------------------------
Test 1
__________________________________________________________________ test_1b ___________________________________________________________________
------------------------------------------------------------ Captured stdout call ------------------------------------------------------------
Test 1b
___________________________________________________________________ test_2 ___________________________________________________________________
------------------------------------------------------------ Captured stdout call ------------------------------------------------------------
Test 2
---------------------------------------------------------- Captured stdout teardown ----------------------------------------------------------
root teardown
========================================================== short test summary info ===========================================================
PASSED package1/test_1.py::test_1
PASSED package1/test_1b.py::test_1b
PASSED package2/test_2.py::test_2
============================================================= 3 passed in 0.01s 

The root_fixture is run as if it's "session" scoped.

Am I doing something wrong or is this a bug?

If I change the root_fixture's scope to "module" ... it behaves as I would expect.

=================================================================== PASSES
___________________________________________________________________ test_1 ___________________________________________________________________
----------------------------------------------------------- Captured stdout setup ------------------------------------------------------------
root setup
------------------------------------------------------------ Captured stdout call ------------------------------------------------------------
Test 1
---------------------------------------------------------- Captured stdout teardown ----------------------------------------------------------
root teardown
__________________________________________________________________ test_1b ___________________________________________________________________
----------------------------------------------------------- Captured stdout setup ------------------------------------------------------------
root setup
------------------------------------------------------------ Captured stdout call ------------------------------------------------------------
Test 1b
---------------------------------------------------------- Captured stdout teardown ----------------------------------------------------------
root teardown
___________________________________________________________________ test_2 ___________________________________________________________________
----------------------------------------------------------- Captured stdout setup ------------------------------------------------------------
root setup
------------------------------------------------------------ Captured stdout call ------------------------------------------------------------
Test 2
---------------------------------------------------------- Captured stdout teardown ----------------------------------------------------------
root teardown
========================================================== short test summary info 
PASSED package1/test_1.py::test_1
PASSED package1/test_1b.py::test_1b
PASSED package2/test_2.py::test_2
============================================================= 3 passed in 0.01s 

Am I doing something wrong?

[jefflieu]

fixture_scope.zip

[Colelyman]

I believe this is the expected behavior, and the confusion may be coming from (the somewhat confusing) definitions of modules and packages (see the docs for the canonical definitions).

In this case, I believe that your directory pytest (or fixture_scope in your zip) is the package (which means that root_fixture only runs once for all of the tests). Furthermore, pytest/package1 and pytest/package2 would be subpackages that contain the modules pytest/package1/test_1.py, pytest/package1/test_1b.py, and pytest/package2/test_1.py (where the root_fixture runs for each module). Another way to think of a module is to think of it as a file/script.

Does that make sense?

[Colelyman]

In other words package1 and package2 are subpackages, and the @pytest.fixture(scope="package") decorator only refers to the outer package, not the subpackages.

[jefflieu]

ah ... I see. I didn't see the fixture_scope as a package --> your explanation does explain it. Thanks! ...
So I can't put that fixture which I want to be "subpackage" scoped in that conftest.py (1) file then.
I have to put root_fixture under conftest.py (2) and conftest.py (3)