LSSTApplications  17.0+124,17.0+14,17.0+73,18.0.0+37,18.0.0+80,18.0.0-4-g68ffd23+4,18.1.0-1-g0001055+12,18.1.0-1-g03d53ef+5,18.1.0-1-g1349e88+55,18.1.0-1-g2505f39+44,18.1.0-1-g5315e5e+4,18.1.0-1-g5e4b7ea+14,18.1.0-1-g7e8fceb+4,18.1.0-1-g85f8cd4+48,18.1.0-1-g8ff0b9f+4,18.1.0-1-ga2c679d+1,18.1.0-1-gd55f500+35,18.1.0-10-gb58edde+2,18.1.0-11-g0997b02+4,18.1.0-13-gfe4edf0b+12,18.1.0-14-g259bd21+21,18.1.0-19-gdb69f3f+2,18.1.0-2-g5f9922c+24,18.1.0-2-gd3b74e5+11,18.1.0-2-gfbf3545+32,18.1.0-26-g728bddb4+5,18.1.0-27-g6ff7ca9+2,18.1.0-3-g52aa583+25,18.1.0-3-g8ea57af+9,18.1.0-3-gb69f684+42,18.1.0-3-gfcaddf3+6,18.1.0-32-gd8786685a,18.1.0-4-gf3f9b77+6,18.1.0-5-g1dd662b+2,18.1.0-5-g6dbcb01+41,18.1.0-6-gae77429+3,18.1.0-7-g9d75d83+9,18.1.0-7-gae09a6d+30,18.1.0-9-gc381ef5+4,w.2019.45
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 Nov 16 2019 09:15:53 for LSSTApplications by   doxygen 1.8.13