__all__ = ['debug', 'timer', 'run_fct_get_stdout']

import inspect

import sys

import time

from io import StringIO

from typing import Callable

def debug(f) -> Callable:

"""Wrapper that prints function call, arguments, return value and the time elapsed.

How to use: @wrappers.debug

:param f: The function to be wrapped

:return: The wrapped function

"""

def wrapper(*args):

t_start = time.time()

return_value = f(*args)

t_end = time.time()

print('')

print('--debug--debug--debug--debug--debug--debug--debug--debug--debug--debug--')

print(f'-- Function: {_get_func_str(f)}')

print(f'-- Arguments: {args}')

print(f'-- Returned: {return_value}')

print(f'-- Time elapsed [ms]: {(t_end - t_start) * 1000}')

print('--debug--debug--debug--debug--debug--debug--debug--debug--debug--debug--')

print('')

return return_value

return wrapper

def timer(f) -> Callable:

"""Wrapper that times a function.

How to use: @wrappers.timer

:param f: The function to be wrapped

:return: The wrapped function

"""

def wrapper(*args):

t_start = time.time()

return_value = f(*args)

t_end = time.time()

print('')

print('--timer--timer--timer--timer--timer--timer--timer--timer--timer--timer--')

print(f'-- Function: {_get_func_str(f)}')

print(f'-- Time elapsed [ms]: {(t_end - t_start) * 1000}')

print('--timer--timer--timer--timer--timer--timer--timer--timer--timer--timer--')

print('')

return return_value

return wrapper

def _get_func_str(f: Callable) -> str:

"""Returns the name of a function including the argument names.

:param f: The function of which the name should be returned

:return: The name of the function f

"""

f_name = str(f).split(' ')[1]

f_args = str(inspect.getfullargspec(f).args) \

.replace('[', '(') \

.replace(']', ')') \

.replace('\'', '')

return f_name + f_args

def run_fct_get_stdout(fct: callable, *args) -> str:

"""Runs a function and collects stdout

:param fct: function to be run

:param args: arguments for the function

:return: collected stdout

"""

# redirect stdout

stdout_old = sys.stdout

stdout_read = StringIO()

sys.stdout = stdout_read

# run the function

fct(*args)

# Read stdout and restore it

sys.stdout = stdout_old

return stdout_read.getvalue()