pytest-benchmark 1.0.0

py.test fixture for benchmarking code

A py.test fixture for benchmarking code.

• Free software: BSD license

Installation

pip install pytest-benchmark

Usage

def test_my_stuff(benchmark):
    with benchmark:
        # Code to be measured
        result = time.sleep(0.000001)

    # Extra code, to verify that the run completed correctly.
    # Note: this code is not measured.
    assert result is None

py.test command-line options:

--benchmark-max-time=BENCHMARK_MAX_TIME

Maximum time to spend in a benchmark (including overhead).

--benchmark-max-iterations=BENCHMARK_MAX_ITERATIONS

Maximum iterations to do.

--benchmark-min-iterations=BENCHMARK_MIN_ITERATIONS

Minium iterations, even if total time would exceed max-time.

--benchmark-scale=BENCHMARK_SCALE

Minium iterations, even if total time would exceed max-time.

--benchmark-timer=BENCHMARK_TIMER

Timer to use when measuring time.

--benchmark-disable-gc

Disable GC during benchmarks.

--benchmark-skip

Skip running any benchmarks.

--benchmark-only

Only run benchmarks.

Setting per-test options:

@pytest.mark.benchmark(
    group="group-name", max_time=0.5,
    max_iterations=5000, min_iterations=5,
    timer=time.time, disable_gc=True)
def test_my_stuff(benchmark):
    with benchmark:
        # Code to be measured
        result = time.sleep(0.000001)

    # Extra code, to verify that the run
    # completed correctly.
    # Note: this code is not measured.
    assert result is None

Documentation

https://pytest-benchmark.readthedocs.org/

Obligatory screenshot

Development

To run the all tests run:

tox

Changelog

1.0.0 (2014-12-15)

• Use a precise default timer for PyPy.

? (?)

• Readme and styling fixes (contributed by Marc Abramowitz)

• Lots of wild changes.