pytest-print adds the printer fixture you can use to print messages to the user (directly to the pytest runner, not stdout)
Project description
pytest-print
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 (so that the end user does not need to wonder if the test froze/dead locked or not).
Install
pip install pytest-print
CLI flags
The following flags are registered for the pytest command:
--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)
API
This library provides the following fixtures that help you print messages within a pytest run (bypasses the pytest output capture, so it will show up in the standard output, even if the test passes):
-
printer: Printter
- function level fixture, when called prints a message line (with very simple formatting), -
printer_session: Printter
- session scoped fixture same as above but using (this exists as a backwards compatibility layer, as we didn't want to switch the originally function scope variant to session one), -
pretty_printer: PrettyPrintter
- session scoped fixture, when called prints a message line (with fancy formatting of space for indentation,⏩
icon for every message, and elapsed time format in form of[{elapsed:.20f}]
) and also allows creating a printer that will be indented one level deeper (and optionally use a different icon). -
create_pretty_printer: PrettyPrinterFactory
- allows the caller to customize the fancy formatter as they wish. Takes oneformatter
argument, whose arguments should be interpreted as:┌──────┐ ┌──────────┐┌─────────┐┌────────┐ │ pre │ ==│ head ││ icon ││ space │ └──────┘ └──────────┘└─────────┘└────────┘ ┌─────────────┐┌───────┐┌──────┐┌────────────┐ │ indentation ││ timer ││ pre ││ msg │ └─────────────┘└───────┘└──────┘└────────────┘ ┌───────┐┌────────────────────┐┌──────┐┌────────────┐ │ timer ││ spacer ││ pre ││ msg │ └───────┘└────────────────────┘└──────┘└────────────┘ ┌───────┐┌────────────────────┐┌────────────────────┐┌──────┐┌────────────┐ │ timer ││ spacer ││ spacer ││ pre ││ msg │ └───────┘└────────────────────┘└────────────────────┘└──────┘└────────────┘
Example: printer_session
from __future__ import annotations
from typing import TYPE_CHECKING, Iterator
import pytest
if TYPE_CHECKING:
from pytest_print import Printer
@pytest.fixture(scope="session")
def _expensive_setup(printer_session: Printer) -> Iterator[None]:
printer_session("setup")
yield
printer_session("teardown")
@pytest.mark.usefixtures("_expensive_setup")
def test_run(printer_session: Printer) -> None:
printer_session("running")
pytest magic.py -vvvv
...
magic.py::test_run
setup expensive operation
running test
magic.py::test_run PASSED
teardown expensive operation
Example: pretty_printer
from __future__ import annotations
from typing import TYPE_CHECKING
import pytest
from pytest_print import Formatter
if TYPE_CHECKING:
from pytest_print import PrettyPrinter, PrettyPrinterFactory
@pytest.fixture(scope="session")
def pretty(create_pretty_printer: PrettyPrinterFactory) -> PrettyPrinter:
formatter = Formatter(indentation=" ", head=" ", space=" ", icon="⏩", timer_fmt="[{elapsed:.20f}]")
return create_pretty_printer(formatter=formatter)
def test_long_running(pretty: PrettyPrinter) -> None:
pretty("Starting test")
pretty_printer_1 = pretty.indent(icon="🚀")
pretty_printer_1("Drill down to 1st level details")
pretty_printer_2 = pretty_printer_1.indent(icon="🚀")
pretty_printer_2("Drill down to 2nd level details")
pretty("Finished test")
magic.py::test_long_running
⏩ Starting test
🚀 Drill down to 1st level details
🚀 Drill down to 2nd level details
⏩ Finished test
magic.py::test_long_running PASSED
Example: create_pretty_printer
If you need nested messages you can use the printer_factory
fixture or the pprinter
.
from __future__ import annotations
from typing import TYPE_CHECKING
import pytest
from pytest_print import Formatter
if TYPE_CHECKING:
from pytest_print import PrettyPrinter, PrettyPrinterFactory
@pytest.fixture(scope="session")
def pretty(create_pretty_printer: PrettyPrinterFactory) -> PrettyPrinter:
formatter = Formatter(
indentation=" I ",
head=" H ",
space=" S ",
icon="🧹",
timer_fmt="[{elapsed:.5f}]",
)
return create_pretty_printer(formatter=formatter)
def test_long_running(pretty: PrettyPrinter) -> None:
pretty("Starting test")
pretty_printer_1 = pretty.indent(icon="🚀")
pretty_printer_1("Drill down to 1st level details")
pretty_printer_2 = pretty_printer_1.indent(icon="🚀")
pretty_printer_2("Drill down to 2nd level details")
pretty("Finished test")
pytest magic.py --print --print-relative-time
...
magic.py
I [0.00022] H 🧹 S Starting test
[0.00029] H 🚀 S Drill down to 1st level details
[0.00034] H 🚀 S Drill down to 2nd level details
I [0.00038] H 🧹 S Finished test
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pytest_print-1.1.0.tar.gz
.
File metadata
- Download URL: pytest_print-1.1.0.tar.gz
- Upload date:
- Size: 12.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
15cf4236c735a8f1865403f7a9fbbb95f6b6b98f3759046f9f30a24c8a32018d
|
|
MD5 |
324bd4ec0e093e787c9471616bed132f
|
|
BLAKE2b-256 |
79eb18c4bdcb4e0ee39ee15d9456469f3da73db033ce37e8e68501426c870bbc
|
Provenance
The following attestation bundles were made for pytest_print-1.1.0.tar.gz
:
Publisher:
release.yaml
on pytest-dev/pytest-print
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1
-
Predicate type:
https://docs.pypi.org/attestations/publish/v1
-
Subject name:
pytest_print-1.1.0.tar.gz
-
Subject digest:
15cf4236c735a8f1865403f7a9fbbb95f6b6b98f3759046f9f30a24c8a32018d
- Sigstore transparency entry: 173953247
- Sigstore integration time:
-
Permalink:
pytest-dev/pytest-print@99efc063756c37c4d62e08e13e618b4f97d32516
-
Branch / Tag:
refs/tags/1.1.0
- Owner: https://github.com/pytest-dev
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com
-
Runner Environment:
github-hosted
-
Publication workflow:
release.yaml@99efc063756c37c4d62e08e13e618b4f97d32516
-
Trigger Event:
push
-
Statement type:
File details
Details for the file pytest_print-1.1.0-py3-none-any.whl
.
File metadata
- Download URL: pytest_print-1.1.0-py3-none-any.whl
- Upload date:
- Size: 7.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
ec82a8bbe5e1d4f6b3a287c2c119de7e5cdf57a31981e9dba2a4809c5829bb5e
|
|
MD5 |
5a4e30628c16540100e61b943d32ae7c
|
|
BLAKE2b-256 |
333eaf3a9fa14a014241dc8c0637fdddc02440a7ffa678247c374dd96416a447
|
Provenance
The following attestation bundles were made for pytest_print-1.1.0-py3-none-any.whl
:
Publisher:
release.yaml
on pytest-dev/pytest-print
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1
-
Predicate type:
https://docs.pypi.org/attestations/publish/v1
-
Subject name:
pytest_print-1.1.0-py3-none-any.whl
-
Subject digest:
ec82a8bbe5e1d4f6b3a287c2c119de7e5cdf57a31981e9dba2a4809c5829bb5e
- Sigstore transparency entry: 173953249
- Sigstore integration time:
-
Permalink:
pytest-dev/pytest-print@99efc063756c37c4d62e08e13e618b4f97d32516
-
Branch / Tag:
refs/tags/1.1.0
- Owner: https://github.com/pytest-dev
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com
-
Runner Environment:
github-hosted
-
Publication workflow:
release.yaml@99efc063756c37c4d62e08e13e618b4f97d32516
-
Trigger Event:
push
-
Statement type: