extra_ds_tools.decorators.func_decorators

Module Contents

Functions

timeit_arg_info_dec(→ Callable)

Decorator that prints the time a function took to execute, and information on its parameters and arguments.

extra_ds_tools.decorators.func_decorators.timeit_arg_info_dec(function: None = None, print_output: bool = True, param_info: bool = True, round_seconds: Optional[int] = None) → Callable

Decorator that prints the time a function took to execute, and information on its parameters and arguments.

Parameters

• function (None, optional) – For compatability and should always be None, by default None

• print_output (bool, optional) – If True prints the output of the decorated function, by default True

• param_info (bool, optional) – If true prints information about parameters and their arguments, by default True

• round_seconds (Optional[int], optional) – If set rounds the amount of seconds it took the decorated func to exectute, by default None

Returns

The decorated function

Return type

Callable

Examples

>>> @timeit_arg_info_dec
>>> def illustrate_decorater(a_number: int, text: str, lst: List[int], df: pd.DataFrame, either: bool = True, *args, **kwargs):
>>>     from time import sleep
>>>     sleep(1)
>>>     return "Look how informative!"
>>>
>>> illustrate_decorater(42,
                        'Bob',
                        list(range(100)),
                        pd.DataFrame([list(range(1,10))]),
                        either=False,
                        **{'Even': 'this works!'})
illustrate_decorater()
---------------------------------------------------------------------------------------------------------------------------------
    param          type_hint                    default_value    arg_type                     arg_value                 arg_len
--  -------------  ---------------------------  ---------------  ---------------------------  ------------------------  ---------
0  a_number       int                                           int                          42
1  text           str                                           str                          Bob                       3
2  lst            List[int]                                     list                         [0, 1, 2,  .. 7, 98, 99]  100
3  df             pandas.core.frame.DataFrame                   pandas.core.frame.DataFrame                            (1, 9)
4  either         bool                         True             bool                         False
5  kwarg['Even']                                                str                          this works!               11
illustrate_decorater() took 1.0050599575042725 seconds to run.
Returned:
Look how informative!
---------------------------------------------------------------------------------------------------------------------------------

>>> @timeit_arg_info_dec(print_output=False, round_seconds=1)
>>> def illustrate_decorater(a_number: int, text: str, lst: List[int], df: pd.DataFrame, either: bool = True, *args, **kwargs):
>>>     from time import sleep
>>>     sleep(1)
>>>     return "Look how informative!"
>>>
>>> illustrate_decorater(42,
                        'Bob',
                        list(range(100)),
                        pd.DataFrame([list(range(1,10))]),
                        either=False,
                        **{'Even': 'this works!'})
test_timeit_dec()
------------------------------------------------------------------------------------------------------------------------------
    param        type_hint                   default_value    arg_type                     arg_value                 arg_len
--  -----------  --------------------------  ---------------  ---------------------------  ------------------------  ---------
0  getal        int                                          int                          1
1  woord                                    ''               str                          int                       3
2  lol          Union[List[str], NoneType]  None             numpy.ndarray                [10 10 10  ..  10 10 10]  (10,)
3  args[3]                                                   int                          1
4  args[4]                                                   int                          2
5  kwarg['0']                                                list                         [10, 10, 1 .. 0, 10, 10]  10
6  kwarg['df']                                               pandas.core.frame.DataFrame                            (1, 1)
test_timeit_dec() took 1.0049090385437012 seconds to run.
Returned:
None
------------------------------------------------------------------------------------------------------------------------------

See also

Uses: args_and_kwargs_repr()