store_function_input¶
- utilipy.decorators.func_io.store_function_input(function: Optional[Callable] = None, *, store_inputs: bool = True, _doc_style: str = 'numpy', _doc_fmt: Dict[str, Any] = {})[source]¶
Store Function Inputs.
Store the function inputs as a BoundArguments.
- Parameters
- functionCallable or None, optional
the function to be decoratored if None, then returns decorator to apply.
- store_inputsbool, optional
whether to return all the inputs to the function as a dictionary
- Returns
- wrapperCallable
wrapper for function does a few things includes the original function in a method
__wrapped__
- Other Parameters
- _doc_style: str or formatter, optional
default ‘numpy’ parameter to
utilipy.wraps- _doc_fmt: dict, optional
default None parameter to
utilipy.wraps