Timer

Module provides tools for timing information.

Example

>>> import ClearMap.Utils.Timer as timer
>>> t = timer.Timer()
>>> for i in range(100000000):
>>>     x = 10 + i
>>> t.print_elapsed_time('test')

class Timer(head=None)

Bases: object

Class to stop time and print results in formatted way

time

The time since the timer was started.

Type:

float

head

Option prefix to the timing string.

Type:

str or None

elapsed_time(head=None, as_string=True)

Calculate elapsed time and return as formated string

Arguments

head: str or None

Prefix to the timing string.

as_string: bool

If True, return as string, else return elapsed time as float.

Returns

time: str or float

The elapsed time information.

format_time(t)

Format time to string.

Arguments

t: float

Time in seconds to format.

Returns

time: str

The time as ‘hours:minutes:seconds:milliseconds’.

print_elapsed_time(head=None, beep=False, reset=False)

Print elapsed time.

Arguments

head: str or None

Prefix to the timing string.

beep: bool

If True, beep in addition to print the time.

reset: bool

If True, reset the timer after printing.

reset()

Reset the timer

start()

Start the timer

timed(label: str = '', logger=None)

Context manager — times a code block.

timeit(method)

Decorator — times a method call.