philiprehberger-timerfunc
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(f"Fastest: {result.fastest:.2f}ms, Slowest: {result.slowest:.2f}ms")
print(result) # full stats summary
Comparing benchmarks
from philiprehberger_timerfunc import benchmark, compare_benchmarks
old = benchmark(old_impl, iterations=1000)
new = benchmark(new_impl, iterations=1000)
ratio = compare_benchmarks(new, old)
# ratio > 1 means `new` is faster than `old` (old took proportionally longer)
print(f"new is {ratio:.2f}x faster than old")
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 |
BenchmarkResult.fastest |
Duration of the fastest run (ms); alias of min_ms |
BenchmarkResult.slowest |
Duration of the slowest run (ms); alias of max_ms |
compare_benchmarks(a, b) |
Returns b.mean / a.mean; values > 1 mean a is faster |
Development
pip install -e .
python -m pytest tests/ -v
Support
If you find this project useful:
License
Metadata
Release files for philiprehberger-timerfunc 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| philiprehberger_timerfunc-0.2.0.tar.gz | 173.1 kB | Without provenance | Details for philiprehberger_timerfunc-0.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| philiprehberger_timerfunc-0.2.0-py3-none-any.whl | Python 3 | none | any | Details for philiprehberger_timerfunc-0.2.0-py3-none-any.whl |
Total release size: 178.3 kB
Release files / philiprehberger_timerfunc-0.2.0.tar.gz
| Download URL | philiprehberger_timerfunc-0.2.0.tar.gz |
|---|---|
| Size | 173.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
32f79823400e91f66c4fb0dcf827b085c8eb5955151b9c0aaf365d16570339b3
|
|
BLAKE2b-256 checksum How to use checksums |
ee478656df09c5df36597368036df0c8ddf60ffa7d4d12f87121b503248ad71f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.13
|
Release files / philiprehberger_timerfunc-0.2.0-py3-none-any.whl
| Download URL | philiprehberger_timerfunc-0.2.0-py3-none-any.whl |
|---|---|
| Size | 5.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2ea75a1ab61d2ffaec7be76d2282350b8711df3cb35cdb364dc374b202e18539
|
|
BLAKE2b-256 checksum How to use checksums |
b71a528262e00865e4f76f4dc38e2bc15f3660574cacd74447ddad0c20d4f668
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.13
|
Security for philiprehberger-timerfunc 0.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.