Skip to content

add documentation of register_assert_rewrite #4032

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

Merged
merged 5 commits into from
Sep 25, 2018
Merged

add documentation of register_assert_rewrite #4032

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2b76233
add documentation of register_assert_rewrite
hjwp Sep 25, 2018
97748b6
mention conftest.py as a good place to do it.
hjwp Sep 25, 2018
11442f2
fix rst syntax thing
hjwp Sep 25, 2018
19ec300
fix rst syntax again
hjwp Sep 25, 2018
b03bad5
Fix linting
nicoddemus Sep 25, 2018
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
8 changes: 6 additions & 2 deletions doc/en/assert.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,8 +264,12 @@ Advanced assertion introspection
Reporting details about a failing assertion is achieved by rewriting assert
statements before they are run. Rewritten assert statements put introspection
information into the assertion failure message. ``pytest`` only rewrites test
modules directly discovered by its test collection process, so asserts in
supporting modules which are not themselves test modules will not be rewritten.
modules directly discovered by its test collection process, so **asserts in
supporting modules which are not themselves test modules will not be rewritten**.

You can manually enable assertion rewriting for an imported module by calling
`register_assert_rewrite <https://docs.pytest.org/en/latest/writing_plugins.html#assertion-rewriting>`_
before you import it (a good place to do that is in ``conftest.py``).

.. note::

Expand Down