navigate.tools.decorators.performance_monitor

navigate.tools.decorators.performance_monitor(prefix: str = 'General', display_args: Optional[callable] = None, display_result: Optional[callable] = None) → callable

Decorator for evaluating the duration of time necessary to execute a statement.

Parameters:

• prefix (str) – The function to be timed.

• display_args (callable, optional) – Whether to display the arguments passed to the function.

• display_result (callable, optional) – Whether to display the result of the function.

Returns:

decorator – The decorator function.

Return type:

callable