about-time

4.2.2 · active · verified Fri Apr 10

Easily measure timing and throughput of code blocks, with beautiful human friendly representations. It offers highly readable output for durations and counts, supporting various units from nanoseconds to days, and is particularly useful for profiling iterable operations like generators. The current version is 4.2.2, with active development indicated by frequent releases.

Warnings

breaking Version 4.2.2 dropped support for Python 3.7. Ensure your environment is Python 3.8 or newer for compatibility.
Fix: Upgrade to Python 3.8+ or pin `about-time` to a version <4.2.2 if Python 3.7 is required.
breaking Version 4.0.0 introduced significant changes to the API and output, including new global features, new objects for each operation, and simpler human-friendly representations. Code written for pre-4.0 versions may require adaptation.
Fix: Refer to the official documentation for migration guidelines if upgrading from versions prior to 4.0.0.
gotcha Prior to version 4.2.2, the `precision` parameter for output formatting was not truly optional, potentially causing unexpected behavior. This was fixed in 4.2.2.
Fix: Upgrade to version 4.2.2 or higher to ensure the `precision` parameter behaves as expected.

Install

pip install about-time Install stable version

Imports

about_time
```
from about_time import about_time
```

Quickstart

Demonstrates basic usage with a context manager and advanced usage for profiling iterables/generators, showing human-readable output and direct attribute access.

import time
from about_time import about_time

# Example 1: Basic timing with a context manager
with about_time('Doing some work'):
    time.sleep(0.123)
    _ = [x * x for x in range(1000000)]

# Example 2: Timing an iterable (e.g., a generator)
def my_generator(n):
    for i in range(n):
        time.sleep(0.001)
        yield i

with about_time('Processing generator items') as t:
    total_sum = sum(my_generator(10))
    print(f'Total sum: {total_sum}')

# Accessing detailed results after the block
print(f"Duration: {t.duration_human}")
print(f"Throughput: {t.throughput_human}")

view raw JSON →