Skip to main content

Python benchmark tool

Project description

bma-benchmark-py

Python benchmark library

Installation

pip3 install bma_benchmark

Usage

from bma_benchmark import Benchmark

benchmark = Benchmark()

@benchmark(base=True)
def my_function1():
    # do some job
    1 + 1

@benchmark(name='benchmark2')
def my_function2():
    # do some job
    1 * 1

benchmark.run()
# equal to
#benchmark.run(number=100, precision=3, units='s', print_result=True)

results

Decorator arguments

  • name override benchmark name (default: function name)
  • base use as the base benchmark to measure difference from (True/False)

Benchmark.run() arguments

  • number number of function executions
  • precision digits after comma for numbers
  • units min/max/avg units (s, ms, us or ns)
  • print_result automatically print results (True/False)

Calling sub-processes

The module can call sub-processes to measure difference between different library versions in different virtual environments or between different versions of Python interpreter.

Primary script

from bma_benchmark import Benchmark

benchmark = Benchmark()

# define some local benchmarks if required
@benchmark
def bench1():
    pass

benchmark.append_sub('./sub1.py')
benchmark.run()

Secondary scripts

make sure the scripts have execution permissions (chmod +x):

#!/path/to/some/other/python

from bma_benchmark import Benchmark

benchmark = Benchmark()

# define benchmarks
@benchmark
def bench2():
    pass

benchmark.sub()

The secondary scripts can contain "base" argument in a decorator as well. The "sub()" method outputs benchmark results to stdout in JSON format to synchronize with the primary, so secondary benchmarks must not print anything.

Project details


Download files

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

Source Distribution

bma_benchmark-0.0.2.tar.gz (4.8 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page