deprecate_pybind11

lsst.utils.deprecate_pybind11(func, reason, category=<class 'FutureWarning'>)

Deprecate a pybind11-wrapped C++ interface function or method.

This needs to use a pass-through Python wrapper so that deprecated can update its docstring; pybind11 docstrings are native and cannot be modified.

Note that this is not a decorator; its output must be assigned to replace the method being deprecated.

Parameters:

reason : str

Reason for deprecation, passed to deprecated

category : Warning

Warning category, passed to deprecated

Returns:

func : function

Wrapped function