funkuhr

stopuhr.funkuhr(msg: str, printer: callable = <built-in function print>, res: int = 2, print_kwargs: list[str] | bool = False)

Decorate a function to measure the time taken in a block.

Wraps the stopuhr function to provide a decorator for benchmarking functions.

Example

>>> from stopuhr import funkuhr

>>> @funkuhr("Busy Function")
>>> def busy_function():
>>>     time.sleep(0.2)

>>> busy_function()
Busy Function took 0.20s

It is possible to add arguments to the message.

It is also possible to add all arguments to the message.

Parameters:

• func (callable) – The function to decorate.

• msg (str) – The message to print.

• printer (callable, optional) – The function to print with. Defaults to print.

• res (int, optional) – The number of decimal places to round to. Defaults to 2.

• print_kwargs (list[str] | bool, optional) – The arguments to be added to the msg. If a list, only the arguments in the list will be added to the message. If True, all arguments will added. If False, no arguments will be added. Additions to the message will have the form: f”{msg} (with {arg1=val1, arg2=val2, …})”. Defaults to False.

Raises:

ValueError – If any of the print_kwargs are not in the functions signature.