Skip to content

Measurement

🤖 AI-Generated Content

This documentation was generated with AI assistance and is still being audited. Some, or potentially a lot, of this information may be inaccurate. Learn more.

provide.testkit.time.measurement

Time measurement fixtures for testing.

Fixtures for measuring execution time and benchmarking.

Classes

Functions

benchmark_timer 

benchmark_timer() -> BenchmarkTimer

Timer specifically for benchmarking code.

Returns:

Type Description
BenchmarkTimer

Benchmark timer with statistics.
Example

def test_with_benchmark(benchmark_timer): ... result, duration = benchmark_timer.measure(my_function, arg1, arg2) ... benchmark_timer.assert_faster_than(0.1) # Assert < 100ms

Source code in provide/testkit/time/measurement.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
@pytest.fixture
def benchmark_timer() -> BenchmarkTimer:
    """Timer specifically for benchmarking code.

    Returns:
        Benchmark timer with statistics.

    Example:
        >>> def test_with_benchmark(benchmark_timer):
        ...     result, duration = benchmark_timer.measure(my_function, arg1, arg2)
        ...     benchmark_timer.assert_faster_than(0.1)  # Assert < 100ms
    """
    return BenchmarkTimer()

timer 

timer() -> Timer

Timer fixture for measuring execution time.

Returns:

Type Description
Timer

Timer instance for measuring durations.
Example

def test_with_timer(timer): ... with timer: ... # Code to time ... pass ... print(f"Elapsed: {timer.elapsed}s")

Source code in provide/testkit/time/measurement.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
@pytest.fixture
def timer() -> Timer:
    """Timer fixture for measuring execution time.

    Returns:
        Timer instance for measuring durations.

    Example:
        >>> def test_with_timer(timer):
        ...     with timer:
        ...         # Code to time
        ...         pass
        ...     print(f"Elapsed: {timer.elapsed}s")
    """
    return Timer()