Skip to main content

A timer plugin for pytest

Project description

pytest-timer

Porting of nose-timer plugin for pytest. A timer plugin for pytest (how much time does every test take?).

PyPI version Build Status codecov Code style: black

Install

To install the latest release from PyPI:

pip install pytest-timer

To install pytest-timer with termcolor for colored durations:

pip install pytest-timer[termcolor]

To install pytest-timer with colorama for colored durations:

pip install pytest-timer[colorama]

Or to install the latest development version from Git:

pip install git+git://github.com/skudriashev/pytest-timer.git

Or to install the latest from source:

git clone https://github.com/skudriashev/pytest-timer.git
cd pytest-timer
pip install .

You can also make a developer install if you plan on modifying the source frequently:

pip install -e .

Usage

After installing pytest-timer plugin the following report will be added:

========================== pytest-timer ==========================
[success] tests/test_plugin.py::TestPlugin::test_loaded2: 0.0002s
[success] tests/test_plugin.py::TestPlugin::test_loaded: 0.0002s

How do I show only the n slowest tests?

For example, to show only the 10 slowest tests, run pytest with the --timer-top-n flag:

pytest --timer-top-n 10

How do I turn off pretty colors?

In some cases, you may want to disable colors completely. This is done by using the --timer-no-color flag. This is useful when running tests in a headless console.

How do I filter results by colors?

It is possible to filter results by color. To do so, you can use the --timer-filter flag:

pytest --timer-filter ok
pytest --timer-filter warning
pytest --timer-filter error

Or to apply several filters at once:

pytest --timer-filter warning,error

License

pytest-timer is MIT Licensed library.

Contribute

  • Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
  • Fork the repository on GitHub to start making your changes to the master branch (or branch off of it).
  • Write a test which shows that the bug was fixed or that the feature works as expected.
  • Send a pull request and bug the maintainer until it gets merged and published.
  • Make sure to add yourself to the author's file in setup.py and the Contributors section below :)

Contributors

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest-timer-1.0.0.tar.gz (5.8 kB view hashes)

Uploaded Source

Built Distribution

pytest_timer-1.0.0-py3-none-any.whl (5.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page