LSSTApplications  17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
LSSTDataManagementBasePackage
Functions
lsst.utils.deprecated Namespace Reference

Functions

def deprecate_pybind11 (func, reason, category=FutureWarning)
 

Function Documentation

◆ deprecate_pybind11()

def lsst.utils.deprecated.deprecate_pybind11 (   func,
  reason,
  category = FutureWarning 
) 
Deprecate a pybind11-wrapped C++ interface function or method.

This needs to use a pass-through Python wrapper so that
`~deprecated.sphinx.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.sphinx.deprecated`
category : `Warning`
    Warning category, passed to `~deprecated.sphinx.deprecated`

Returns
-------
func : function
    Wrapped function

Example
-------
ExposureF.getCalib = deprecate_pybind11(ExposureF.getCalib,
        reason="Replaced by getPhotoCalib. (Will be removed in 18.0)",
        category=FutureWarning))

Definition at line 26 of file deprecated.py.

26 def deprecate_pybind11(func, reason, category=FutureWarning):
27  """Deprecate a pybind11-wrapped C++ interface function or method.
28 
29  This needs to use a pass-through Python wrapper so that
30  `~deprecated.sphinx.deprecated` can update its docstring; pybind11
31  docstrings are native and cannot be modified.
32 
33  Note that this is not a decorator; its output must be assigned to
34  replace the method being deprecated.
35 
36  Parameters
37  ----------
38  reason : `str`
39  Reason for deprecation, passed to `~deprecated.sphinx.deprecated`
40  category : `Warning`
41  Warning category, passed to `~deprecated.sphinx.deprecated`
42 
43  Returns
44  -------
45  func : function
46  Wrapped function
47 
48  Example
49  -------
50  ExposureF.getCalib = deprecate_pybind11(ExposureF.getCalib,
51  reason="Replaced by getPhotoCalib. (Will be removed in 18.0)",
52  category=FutureWarning))
53  """
54  @functools.wraps(func)
55  def internal(*args, **kwargs):
56  return func(*args, **kwargs)
57  return deprecated.sphinx.deprecated(reason=reason, category=category)(internal)
58 
lsst::utils.deprecated.deprecate_pybind11
def deprecate_pybind11(func, reason, category=FutureWarning)
Definition: deprecated.py:26
Generated on Sat Jun 8 2019 08:10:27 for LSSTApplications by   doxygen 1.8.13