Skip to main content

Measure execution time of any function

Project description

philiprehberger-timerfunc

Tests PyPI version License

Measure execution time of any function.

Installation

pip install philiprehberger-timerfunc

Usage

Context Manager

from philiprehberger_timerfunc import timer

with timer() as t:
    do_work()
print(f"Took {t.elapsed_ms:.1f}ms")

Decorator

from philiprehberger_timerfunc import timed

@timed
def process_data():
    ...  # logs: "process_data took 42.3ms"

@timed(threshold_ms=100)
def api_call():
    ...  # only logs if slower than 100ms

Benchmark

from philiprehberger_timerfunc import benchmark

result = benchmark(my_function, args=(data,), iterations=1000)
print(f"Mean: {result.mean_ms:.2f}ms, P95: {result.p95_ms:.2f}ms")
print(result)  # full stats summary

API

Function / Class Description
timer() Context manager returning TimerResult
@timed / @timed(threshold_ms=0) Decorator logging execution time
benchmark(fn, args, kwargs, iterations, warmup) Returns BenchmarkResult

Development

pip install -e .
python -m pytest tests/ -v

License

MIT

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

philiprehberger_timerfunc-0.1.6.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

philiprehberger_timerfunc-0.1.6-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

Details for the file philiprehberger_timerfunc-0.1.6.tar.gz.

File metadata

File hashes

Hashes for philiprehberger_timerfunc-0.1.6.tar.gz
Algorithm Hash digest
SHA256 b578a437ca6a092cf32c0cc5f0e7252245e24ce60dbabd75fe0f8b2e94200cfe
MD5 0e90a420c7e73451a987047d7b0177b7
BLAKE2b-256 057480123cd18b635a673ccd3145a6f94b6c8f398bd4f8e8a58427ec288d34f0

See more details on using hashes here.

File details

Details for the file philiprehberger_timerfunc-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for philiprehberger_timerfunc-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 5ceed38f4e4a06318c2fe04efbaf52f616bd04ece8d594b7127841a0b65e7aed
MD5 febb406b19bc2d6cce778e171eddd28d
BLAKE2b-256 0fdd76381f927308226ebe3a3ba1f85ce87fa0bbbb0aa230f71c33911eae0c67

See more details on using hashes here.

Supported by

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