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 --with-timer --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 --with-timer --timer-filter ok
pytest --with-timer --timer-filter warning
pytest --with-timer --timer-filter error

Or to apply several filters at once:

pytest --with-timer --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.

Files for pytest-timer, version 0.0.10
Filename, size File type Python version Upload date Hashes
Filename, size pytest-timer-0.0.10.tar.gz (5.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page