proxystore.utils.timer¶

Timing utilities.

Warning

This module is an internal implementation detail which may change between releases without notice (see Versioning and Compatibility).

Timer ¶

Timer()

Performance timer with nanosecond precision.

Example

from proxystore.utils.timer import Timer

with Timer() as timer:
    ...

print(timer.elapsed_ms)

Example

from proxystore.utils.timer import Timer

timer = Timer()
timer.start()
...
timer.stop()

print(timer.elapsed_ms)

Raises:

RuntimeError –

If the elapsed time is accessed before the timer is stopped or the context block is exited.

Source code in proxystore/utils/timer.py

def __init__(self) -> None:
    self._start = 0
    self._end = 0
    self._running = False

elapsed_ns: int

Elapsed time in nanoseconds.

elapsed_ms: float

Elapsed time in milliseconds.

elapsed_s: float

Elapsed time in seconds.

start() -> Self

Start the timer.

Source code in proxystore/utils/timer.py

def start(self) -> Self:
    """Start the timer."""
    self._running = True
    self._start = time.perf_counter_ns()
    return self

stop() -> Self

Stop the timer.

Source code in proxystore/utils/timer.py

def stop(self) -> Self:
    """Stop the timer."""
    self._end = time.perf_counter_ns()
    self._running = False
    return self