pytimings.timer

Main module.

Module Contents

Classes

TimingDelta	Elapsed wall/system/user time for a section, all in seconds.
TimingData
Timings

Functions

scoped_timing(→ collections.abc.Iterator[None])	Start timer on entering block scope, stop it (and optionally output) on exiting.
cummulative_scoped_timing(→ collections.abc.Iterator[None])	Start timer on entering block scope, stop it (and optionally output) on exiting.
function_timer(→ collections.abc.Callable)

Attributes

THREAD_TIME
WALL_TIME
SYS_TIME
USER_TIME
global_timings

pytimings.timer.THREAD_TIME = 'thread'

pytimings.timer.WALL_TIME = 'wall'

pytimings.timer.SYS_TIME = 'sys'

pytimings.timer.USER_TIME = 'user'

class pytimings.timer.TimingDelta

Bases: NamedTuple

Elapsed wall/system/user time for a section, all in seconds.

wall: float

sys: float

user: float

exception pytimings.timer.NoTimerError(section: str, timings: Timings | None = None, is_unstopped: bool = False)

Bases: Exception

Common base class for all non-exit exceptions.

section

timings

is_unstopped = False

class pytimings.timer.TimingData(name: str)

name

_end_resources = None

_end_times: dict[str, float] | None = None

_process

_start_times

_get() → dict[str, float]

stop() → None

delta() → TimingDelta

class pytimings.timer.Timings

_commited_deltas: dict[str, TimingDelta]

_known_timers_map: dict[str, tuple[bool, TimingData | None]]

extra_data: dict

start(section_name: str) → None

set this to begin a named section

stop(section_name: str | None = None) → TimingDelta | None

stop named section’s counter or all of them if section_name is None

reset(section_name: str | None = None) → None

set elapsed time back to 0 for a given section or all of them if section_name is None

walltime(section_name: str) → float

get runtime of section in seconds

add_walltime(section_name: str, time: float) → None

delta(section_name: str) → TimingDelta

get the full delta tuple

output_files(output_dir: str | pathlib.Path, csv_base: str) → pathlib.Path

output all recorded measures to a csv file

output_console() → None

output the recorded walltime per section to the console

output_all_measures(out=None) → None

output all recorded measures

add_extra_data(data: dict) → None

Use this for configuration data that makes the csv more informative.

The data is also rendered in the console output.

pytimings.timer.global_timings

pytimings.timer.scoped_timing(section_name: str, log_function: collections.abc.Callable[[str], None] | None = None, timings: Timings | None = None, format: str = '') → collections.abc.Iterator[None]

Start timer on entering block scope, stop it (and optionally output) on exiting.

The printout will only show walltime for the current scope. See pytimings.timer.cummulative_scoped_timing() for a version with cummulative output.

pytimings.timer.cummulative_scoped_timing(section_name: str, log_function: collections.abc.Callable[[str], None] | None = None, timings: Timings | None = None, format: str = '') → collections.abc.Iterator[None]

Start timer on entering block scope, stop it (and optionally output) on exiting.

The printout will show the cummulated walltime for all scopes with this section name. See pytimings.timer.scoped_timing() for a version with non-cummulative output.

pytimings.timer.function_timer(section_name: str | None = None, log_function: collections.abc.Callable[[str], None] | None = None, timings: Timings | None = None) → collections.abc.Callable