qiskit.utils.deprecate_function¶
- deprecate_function(msg, stacklevel=2, category=<class 'DeprecationWarning'>)[source]¶
Emit a warning prior to calling decorated function.
- Parameters
msg (
str) -- Warning message to emit.stacklevel (
int) -- The warning stackevel to use, defaults to 2.category (
Type[Warning]) -- warning category, defaults to DeprecationWarning
- Returns
The decorated, deprecated callable.
- Return type
Callable