Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skudriashev/pytest-timer
A timer plugin for pytest (how much time does every test take?)
https://github.com/skudriashev/pytest-timer
Last synced: about 2 months ago
JSON representation
A timer plugin for pytest (how much time does every test take?)
- Host: GitHub
- URL: https://github.com/skudriashev/pytest-timer
- Owner: skudriashev
- License: mit
- Created: 2020-03-15T20:06:39.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-12-26T22:20:43.000Z (about 1 year ago)
- Last Synced: 2024-04-29T20:06:27.408Z (9 months ago)
- Language: Python
- Size: 39.1 KB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pytest-timer
Porting of [nose-timer](https://github.com/mahmoudimus/nose-timer) plugin for pytest. A timer plugin for pytest (how much time does every test take?).
[](https://badge.fury.io/py/pytest-timer)
[](https://codecov.io/gh/skudriashev/pytest-timer)
[](https://github.com/psf/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
- [@skudriashev](https://github.com/skudriashev)