| docs | |
| tests |        |
| package |      |
A py.test fixture for benchmarking code. It will group the tests into rounds that are calibrated to the chosen timer. See calibration and FAQ.
- Free software: BSD license
pip install pytest-benchmarkAvailable at: pytest-benchmark.readthedocs.org.
This plugin provides a benchmark fixture. This fixture is a callable object that will benchmark any function passed to it.
Example:
def something(duration=0.000001):
"""
Function that needs some serious benchmarking.
"""
time.sleep(duration)
# You may return anything you want, like the result of a computation
return 123
def test_my_stuff(benchmark):
# benchmark something
result = benchmark(something)
# Extra code, to verify that the run completed correctly.
# Sometimes you may want to check the result, fast functions
# are no good if they return incorrect results :-)
assert result == 123You can also pass extra arguments:
def test_my_stuff(benchmark):
benchmark(time.sleep, 0.02)Or even keyword arguments:
def test_my_stuff(benchmark):
benchmark(time.sleep, duration=0.02)Another pattern seen in the wild, that is not recommended for micro-benchmarks (very fast code) but may be convenient:
def test_my_stuff(benchmark):
@benchmark
def something(): # unnecessary function call
time.sleep(0.000001)A better way is to just benchmark the final function:
def test_my_stuff(benchmark):
benchmark(time.sleep, 0.000001) # way more accurate results!If you need to do fine control over how the benchmark is run (like a setup function, exact control of iterations and rounds) there's a special mode - pedantic:
def my_special_setup():
...
def test_with_setup(benchmark):
benchmark.pedantic(something, setup=my_special_setup, args=(1, 2, 3), kwargs={'foo': 'bar'}, iterations=10, rounds=100)Normal run:
Compare mode (--benchmark-compare):
Histogram (--benchmark-histogram):
To run the all tests run:
tox- Timing code and ideas taken from: https://bitbucket.org/haypo/misc/src/tip/python/benchmark.py