Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Quick and easy python benchmarking.

Project description

Quickly find where your code is spending its time.

Build Status

Benchit is intended to be a minimalistic library that times how long it takes to get from point A to point B. It helps detect unoptimized code.

Benchit is only compatible with python 3. For python 2 support, use benchit==0.2.6 (https://pypi.python.org/pypi/bench-it/0.2.6)

Installation

pip install bench-it

Example

from benchit import BenchIt
from time import sleep


def demo_benchmark():
    b = BenchIt()  # starts the timer

    # do stuff
    sleep(1); b()  # Add marker after this code.  Code used as marker name.

    sleep(.2);
    sleep(.3);
    sleep(.4);
    b("More stuff done")  # Add a custom named marker

    for i in range(1, 5):
      sleep(.1); b()  # Code can be marked in a loop

    b.display()  # Display output as a table


demo_benchmark()


BenchIt
+-----------------+----------------+------------+------+----------+---------+---------+
| Marker          | Method         |       Line | Hits | Avg Time | Runtime | Percent |
+-----------------+----------------+------------+------+----------+---------+---------+
| sleep(1)        | demo_benchmark |  demo.py:9 |    1 |  1.01341 | 1.01341 |   43.33 |
| More stuff Done | demo_benchmark | demo.py:14 |    1 |  0.91278 | 0.91278 |   39.03 |
| sleep(.1)       | demo_benchmark | demo.py:17 |    4 |  0.10306 | 0.41223 |   17.63 |
+-----------------+----------------+------------+------+----------+---------+---------+
Total runtime: 2.33860

How to Use

Instantiating the class starts the timer. BenchIt is run as a singleton. Re-instantiating anywhere in your code will pull in the previously instantiated timer. To create a new timer, initialize BenchIt with a unique name.

b = BenchIt()

b2 = BenchIt()  # b == b2

b3 = BenchIt("Timer A")  # b != b3

Set a marker after some code.

call_a_method(); b()  # Quickly add a marker after a method

method1()
method2()
b("Two methods called")  # Or create a manual marker after a chunk of code

Stop and display the table for analysis.

b.display()

Methods

benchit.__init__() Instantiate and start the timer.

benchit.__call__(marker_name) Add marker at this point.

benchit.stop() Optionally, stop the timer at a point.

benchit.display() Display the table. Stops the timer if running.

Credits

Project details


Release history Release notifications

This version
History Node

1.0.1

History Node

1.0.0

History Node

0.2.6

History Node

0.2.5

History Node

0.2.4

History Node

0.2.3

History Node

0.2.2

History Node

0.2.1

History Node

0.2

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
bench_it-1.0.1-py2.py3-none-any.whl (19.1 kB) Copy SHA256 hash SHA256 Wheel 2.7 Mar 21, 2018
bench-it-1.0.1.tar.gz (16.2 kB) Copy SHA256 hash SHA256 Source None Mar 21, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page