Skip to content

docs: document doctest fixture parametrization limit #14487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MukundaKatta wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −0
Open

docs: document doctest fixture parametrization limit #14487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog/13038.doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document that doctests do not support parametrized fixtures, including parametrized autouse fixtures.
6 changes: 6 additions & 0 deletions doc/en/how-to/doctest.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,12 @@ 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.

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
multiple backends or configurations, consider moving those checks into normal
test functions or a dedicated doctest plugin.


.. _`doctest_namespace`:

Expand Down
Loading