Fix module fixtures with --doctest-modules

AUTHORS

@@ -334,6 +334,7 @@ Mike Fiedler (miketheman)
 Mike Hoyle (hoylemd)
 Mike Lundy
 Milan Lesnek
+minbang930
 Miro Hrončok
 Mulat Mekonen
 mrbean-bremen

changelog/14533.breaking.rst

@@ -0,0 +1,8 @@
+When using :option:`--doctest-modules`, autouse fixtures with ``module``, ``package`` or ``session`` scope that are defined inline in Python test modules (not plugins or conftests) will now possibly execute twice.
+
+If this is undesirable, move the fixture definition to a ``conftest.py`` file if possible.
+
+Technical explanation for those interested:
+When using `--doctest-modules`, pytest possibly collects Python modules twice, once as :class:`pytest.Module` and once as a ``DoctestModule`` (depending on the configuration).
+Due to improvements in pytest's fixture implementation, if e.g. the ``DoctestModule`` collects a fixture, it is now visible to it only, and not to the ``Module``.
+This means that both need to register the fixtures independently.

doc/en/how-to/doctest.rst

@@ -42,7 +42,7 @@ By default, pytest will collect ``test*.txt`` files looking for doctest directiv
 can pass additional globs using the :option:`--doctest-glob` option (multi-allowed).
 
 In addition to text files, you can also execute doctests directly from docstrings of your classes
-and functions, including from test modules:
+and functions, including from test modules, using the :option:`--doctest-modules` option:
 
 .. code-block:: python
 
@@ -224,6 +224,9 @@ unless explicitly configured by :confval:`python_files`.
 Also, the :ref:`usefixtures <usefixtures>` mark and fixtures marked as :ref:`autouse <autouse>` are supported
 when executing text doctest files.
 
+Python doctest modules are collected independently from Python test files.
+Fixture scope is not shared between the two.
+
 Doctests do not support fixtures that depend on parametrization, because doctest
 collection does not perform the same test generation as normal test functions.
 This includes parametrized autouse fixtures. If you need to run doctests against

pyproject.toml

@@ -377,6 +377,7 @@ testpaths = [
 ]
 norecursedirs = [
     "testing/example_scripts",
+    "testing/plugins_integration",
     ".*",
     "build",
     "dist",

src/_pytest/doctest.py

@@ -552,8 +552,7 @@ def _from_module(self, module, object):
             else:
                 raise
 
-        # While doctests currently don't support fixtures directly, we still
-        # need to pick up autouse fixtures.
+        # doctests supports fixtures via `getfixture` and autouse.
         self.session._fixturemanager.parsefactories(self)
 
         # Uses internal doctest module parsing mechanism.

src/_pytest/fixtures.py

@@ -1707,7 +1707,6 @@ def __init__(self, session: Session) -> None:
         # TODO: The order of the FixtureDefs list of each arg is significant,
         #       explain.
         self._arg2fixturedefs: Final[dict[str, list[FixtureDef[Any]]]] = {}
-        self._holderobjseen: Final[set[object]] = set()
         # A mapping from a node to a list of autouse fixture names it defines.
         # The Session entry holds global usefixtures from config.
         self._node_autousenames: Final[dict[nodes.Node, list[str]]] = {
@@ -2070,16 +2069,13 @@ def parsefactories(
             assert isinstance(node_or_obj, nodes.Node)
             holderobj = cast(object, node_or_obj.obj)  # type: ignore[attr-defined]
             effective_node = node_or_obj
-        if holderobj in self._holderobjseen:
-            return
 
         # Avoid accessing `@property` (and other descriptors) when iterating fixtures.
         if not safe_isclass(holderobj) and not isinstance(holderobj, types.ModuleType):
             holderobj_tp: object = type(holderobj)
         else:
             holderobj_tp = holderobj
 
-        self._holderobjseen.add(holderobj)
         for name in dir(holderobj):
             # The attribute can be an arbitrary descriptor, so the attribute
             # access below can raise. safe_getattr() ignores such exceptions.

testing/test_doctest.py

@@ -600,6 +600,37 @@ def test_doctestmodule_with_fixtures(self, pytester: Pytester):
         reprec = pytester.inline_run(p, "--doctest-modules")
         reprec.assertoutcome(passed=1)
 
+    def test_module_fixture_available_to_normal_test_with_doctestmodules(
+        self, pytester: Pytester
+    ) -> None:
+        """Regression test for #14533.
+
+        Module-level fixtures collected with ``--doctest-modules`` are available
+        both to normal tests and doctests in the same file.
+        """
+        pytester.makepyfile(
+            """
+            import pytest
+
+            @pytest.fixture
+            def fix():
+                return "fix"
+
+            def test(fix):
+                assert fix == "fix"
+
+            def func():
+                '''My function.
+
+                >>> getfixture("fix")
+                'fix'
+                '''
+            """
+        )
+
+        result = pytester.runpytest("--doctest-modules")
+        result.assert_outcomes(passed=2)
+
     def test_doctestmodule_three_tests(self, pytester: Pytester):
         p = pytester.makepyfile(
             """
@@ -1302,6 +1333,37 @@ def bar():
         result = pytester.runpytest("--doctest-modules")
         result.stdout.fnmatch_lines(["*2 passed*"])
 
+    def test_doctest_and_python_fixtures_not_shared(self, pytester: Pytester) -> None:
+        """Fixture scopes are not shared between doctest and python modules.
+
+        This test is not meant as a hard behavioral test -- sharing scope is
+        also an acceptable behavior (see #14533). But this test ensures and
+        behavior change is done knowingly.
+        """
+        pytester.makepyfile(
+            r"""
+            import pytest
+
+            @pytest.fixture(scope="session", autouse=True)
+            def auto():
+                with open("out", "a", encoding="utf-8") as f:
+                    f.write("RUN\n")
+
+            def test():
+                pass
+
+            def func():
+                '''My function.
+
+                >>> 1 + 1
+                2
+                '''
+        """
+        )
+        result = pytester.runpytest("--doctest-modules")
+        result.assert_outcomes(passed=2)
+        assert Path("out").read_text("utf-8").split() == ["RUN"] * 2
+
     @pytest.mark.parametrize("scope", SCOPES)
     @pytest.mark.parametrize("enable_doctest", [True, False])
     def test_fixture_scopes(self, pytester, scope, enable_doctest):

tox.ini

@@ -182,6 +182,7 @@ description =
 pip_pre=true
 changedir = testing/plugins_integration
 deps = -rtesting/plugins_integration/requirements.txt
+allowlist_externals = pip
 setenv =
     PYTHONPATH=.
 commands =