Skip to content

redplanet.helper_functions.misc.timer 

timer(message='', d=3)

A context manager that measures the time taken to execute the code block within it.

Parameters:

Name Type Description Default
message str

A message to display when the code block is executed, by default nothing.

 ''
d int

The number of decimal places to display in the elapsed time, by default 3.

 3

Examples:

>>> from redplanet.helper_functions.misc import timer
>>> with timer('Elapsed time: '):
...     print(f'Sum of first 10^7 squared integers: {sum(x*x for x in range(10_000_000)):,}')

Sum of first 10^7 squared integers: 333,333,283,333,335,000,000 Elapsed time: 0.886 seconds

Source code in src/redplanet/helper_functions/misc.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
@contextmanager
def timer(message='', d=3):
    """
    A context manager that measures the time taken to execute the code block within it.

    Parameters
    ----------
    message : str, optional
        A message to display when the code block is executed, by default nothing.
    d : int, optional
        The number of decimal places to display in the elapsed time, by default 3.

    Examples
    --------
    >>> from redplanet.helper_functions.misc import timer
    >>> with timer('Elapsed time: '):
    ...     print(f'Sum of first 10^7 squared integers: {sum(x*x for x in range(10_000_000)):,}')

    Sum of first 10^7 squared integers: 333,333,283,333,335,000,000
    Elapsed time: 0.886 seconds
    """
    start = time.time()
    yield
    end = time.time()
    elapsed = end - start
    print(f"{message}{elapsed:.{d}f} seconds")