Timings

Timer

class tdg.performance.Timer(log, message, stop_message=None, time=<built-in function perf_counter>, per=1)

Bases: object

A simple timer which provides a context manager for use with with statements.

Parameters

• log (A logger’s convenience function, such as .debug or .info.) – Where to log the timer.

• message (str) – The message on entry and exit from the timer’s context, unless stop_message is also provided, in which case this is only on entry.

• stop_message (str) – An optionally different message to print on completion.

• time (a function which returns times that can be subtracted to get an interval.) – Examples include time.perf_counter or time.process_time as in the standard library.

• per (int) – How many to divide by to determine the marginal cost.

For example,

>>> with Timer(logger.debug, 'Task', per=10):
>>>     time.sleep(0.3, time=time.process_time)
2023-04-27 22:39:18,076 root      DEBUG Task ...
2023-04-27 22:39:18,383 root      DEBUG ... Task [0.001954 seconds] (0.000195 seconds each)
>>> with Timer(logger.debug, 'Begin', 'End', time=time.process_time):
>>>     time.sleep(0.3)
2023-04-27 22:39:51,286 root      DEBUG Begin ...
2023-04-27 22:39:51,604 root      DEBUG ... End [0.001070 seconds]
>>> with tdg.performance.Timer(logger.debug, 'With perf_counter', time=time.perf_counter):
>>>     time.sleep(0.3)
2023-04-27 22:45:55,955 root      DEBUG With perf_counter ...
2023-04-27 22:45:56,258 root      DEBUG ... With perf_counter [0.300386 seconds]

start()

Start the timer.

stop()

Stop the timer.

elapsed()

The difference between the stop and start time. If the timer was never start()ed, 0; if the timer was never stop()ped, stop now and and subtract.