From 7e155eb17ae1cd347d268a4202a2327c023568fc Mon Sep 17 00:00:00 2001 From: dheerajck Date: Sun, 28 Apr 2024 19:34:40 +0530 Subject: [PATCH] Updated docs: Documented new way to detect if a code is running from within a pytest run --- doc/en/example/simple.rst | 25 +++++-------------------- 1 file changed, 5 insertions(+), 20 deletions(-) diff --git a/doc/en/example/simple.rst b/doc/en/example/simple.rst index 7064f61f0..b5561eee2 100644 --- a/doc/en/example/simple.rst +++ b/doc/en/example/simple.rst @@ -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 --------------------------------------------------------------