Updated docs: Documented new way to detect if a code is running from within a pytest run

This commit is contained in:
dheerajck 2024-04-28 19:34:40 +05:30 committed by Bruno Oliveira
parent 55e0a79b12
commit 7e155eb17a
1 changed files with 5 additions and 20 deletions

View File

@ -405,35 +405,20 @@ Detect if running from within a pytest run
Usually it is a bad idea to make application code
behave differently if called from a test. But if you
absolutely must find out if your application code is
running from a test you can do something like this:
running from a test you can do this:
.. code-block:: python
# content of your_module.py
import os
_called_from_test = False
.. code-block:: python
# content of conftest.py
def pytest_configure(config):
your_module._called_from_test = True
and then check for the ``your_module._called_from_test`` flag:
.. code-block:: python
if your_module._called_from_test:
# called from within a test run
if os.environ.get("PYTEST_VERSION") is not None:
# things you want to to do if your code is called by pytest
...
else:
# called "normally"
# things you want to to do if your code is not called by pytest
...
accordingly in your application.
Adding info to test report header
--------------------------------------------------------------