Skip to content

core.print

Functions

print_run_time 

print_run_time(func)

Decorator to measure and print function execution time.

A decorator that wraps a function to measure its execution time and print the result. The timing is measured in seconds and displayed with the function name.

Parameters:

Name Type Description Default
func Callable

The function to be decorated.

 required

Returns:

Name Type Description
function Callable

Wrapped function that prints execution time.

Examples:

>>> @print_run_time
... def slow_function():
...     time.sleep(1)
...     return "done"
>>> result = slow_function()
Run time for slow_function: 1.000123
>>> result
'done'
Source code in pyadvtools/core/print.py 
 6
 7
 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
34
35
36
37
def print_run_time(func: Callable) -> Callable:
    """Decorator to measure and print function execution time.

    A decorator that wraps a function to measure its execution time and
    print the result. The timing is measured in seconds and displayed
    with the function name.

    Args:
        func: The function to be decorated.

    Returns:
        function: Wrapped function that prints execution time.

    Examples:
        >>> @print_run_time
        ... def slow_function():
        ...     time.sleep(1)
        ...     return "done"
        >>> result = slow_function()
        Run time for slow_function: 1.000123
        >>> result
        'done'
    """

    @wraps(func)
    def wrapper(*args, **kwargs):
        start_time = time.time()
        result = func(*args, **kwargs)
        print(f"Run time for {func.__name__}: {time.time() - start_time}")
        return result

    return wrapper