Skip to content

pytest-print adds the printer fixture you can use to print messages to the user (directly to the pytest runner, not stdout)

License

Notifications You must be signed in to change notification settings

pytest-dev/pytest-print

Repository files navigation

pytest-print

PyPI PyPI - Implementation PyPI - Python Version Downloads PyPI - License check

Allows to print extra content onto the PyTest reporting. This can be used for example to report sub-steps for long running tests, or to print debug information in your tests when you cannot debug the code.

install

pip install pytest-print

The plugin provides ability to print information during the tests runs.

flags

  • --print by default the module activates print when pytest verbosity is greater than zero, this allows to bypass this and force print irrespective of the verbosity
  • --print-relative-time will print the relative time since the start of the test (display how long it takes to reach prints)

use cases

sub-step reporting

For tests that are long running this can provide feedback to the end-user that what is just happening in the background.

def test_server_parallel_requests(printer, tmpdir):
    printer("create virtual environment into {}".format(tmpdir))
    create_virtual_environment(tmpdir)

    printer("start server from virtual env")
    start_server(tmpdir)

    printer("do the parallel request test")
    parallel_requests()
$ py.test --vv
============================= test session starts ==============================
platform linux -- Python 3.6.4, pytest-3.5.0, py-1.5.3, pluggy-0.6.0
collecting ... collected 1 item

test_printer_progress.py::test_server_parallel_requests
    create virtual environment
    start server from virtual env
    do the parallel request test
PASSED                                                                   [100%]

=========================== 1 passed in 0.02 seconds ===========================

About

pytest-print adds the printer fixture you can use to print messages to the user (directly to the pytest runner, not stdout)

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages