LSSTApplications  19.0.0-14-gb0260a2+492360823e,20.0.0+1c463ce1c5,20.0.0+332b39b81b,20.0.0+34a42eae2c,20.0.0+41b643067b,20.0.0+6e3b0e79d6,20.0.0+8558dd3f48,20.0.0+90990fb0e1,20.0.0+b0de6306d8,20.0.0+b290a576ab,20.0.0+b2ea66fa67,20.0.0+c2e041a55f,20.0.0+dcf29472a8,20.0.0+f45b7d88f4,20.0.0+fd13e6d5b6,20.0.0-1-g10df615+0d65e0fd03,20.0.0-1-g253301a+dcf29472a8,20.0.0-1-g498fb60+ff88705a28,20.0.0-1-g4d801e7+20a86399e6,20.0.0-1-g8a53f90+2817c06967,20.0.0-1-gc96f8cb+41b643067b,20.0.0-1-gd1c87d7+2817c06967,20.0.0-1-gdb27ee5+0eaf4f30a3,20.0.0-11-gda4966f+0cec7fe7b8,20.0.0-17-g98646ba4+f780282b58,20.0.0-2-g25c5319+ec537bc764,20.0.0-2-gec03fae+3bc057fb2a,20.0.0-27-g22bab1b+96b59cb0f5,20.0.0-3-gd2e950e+f45b7d88f4,20.0.0-4-g4a2362f+f45b7d88f4,20.0.0-5-gac0d578b1+6c871ee35c,20.0.0-5-gfcebe35+d7a723b4eb,20.0.0-6-g01203fff+106a5fd355,20.0.0-7-g3c4151b+2efbc3ed6b,20.0.0-8-g9573cbd+0eaf4f30a3,20.0.0-8-gc2abeef+41b643067b,w.2020.32
LSSTDataManagementBasePackage
Functions
lsst.utils.deprecated Namespace Reference

Functions

def deprecate_pybind11 (obj, reason, version=None, category=FutureWarning)
 
def suppress_deprecations (category=FutureWarning)
 

Function Documentation

◆ deprecate_pybind11()

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

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
----------
obj : function, method, or class
    The function, method, or class to deprecate.
reason : `str`
    Reason for deprecation, passed to `~deprecated.sphinx.deprecated`
version : 'str'
    Next major version in which the interface will be deprecated,
    passed to `~deprecated.sphinx.deprecated`
category : `Warning`
    Warning category, passed to `~deprecated.sphinx.deprecated`

Returns
-------
obj : function, method, or class
    Wrapped function, method, or class

Examples
--------
.. code-block:: python

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

Definition at line 32 of file deprecated.py.

32 def deprecate_pybind11(obj, reason, version=None, category=FutureWarning):
33  """Deprecate a pybind11-wrapped C++ interface function, method or class.
34 
35  This needs to use a pass-through Python wrapper so that
36  `~deprecated.sphinx.deprecated` can update its docstring; pybind11
37  docstrings are native and cannot be modified.
38 
39  Note that this is not a decorator; its output must be assigned to
40  replace the method being deprecated.
41 
42  Parameters
43  ----------
44  obj : function, method, or class
45  The function, method, or class to deprecate.
46  reason : `str`
47  Reason for deprecation, passed to `~deprecated.sphinx.deprecated`
48  version : 'str'
49  Next major version in which the interface will be deprecated,
50  passed to `~deprecated.sphinx.deprecated`
51  category : `Warning`
52  Warning category, passed to `~deprecated.sphinx.deprecated`
53 
54  Returns
55  -------
56  obj : function, method, or class
57  Wrapped function, method, or class
58 
59  Examples
60  --------
61  .. code-block:: python
62 
63  ExposureF.getCalib = deprecate_pybind11(ExposureF.getCalib,
64  reason="Replaced by getPhotoCalib. (Will be removed in 18.0)",
65  version="17.0", category=FutureWarning))
66  """
67 
68  @functools.wraps(obj)
69  def internal(*args, **kwargs):
70  return obj(*args, **kwargs)
71 
72  return deprecated.sphinx.deprecated(
73  reason=reason,
74  version=version,
75  category=category)(internal)
76 
77 
78 @contextmanager

◆ suppress_deprecations()

def lsst.utils.deprecated.suppress_deprecations (   category = FutureWarning)
Suppress warnings generated by `deprecated.sphinx.deprecated`.

Naively, one might attempt to suppress these warnings by using
`~warnings.catch_warnings`. However, `~deprecated.sphinx.deprecated`
attempts to install its own filter, overriding that. This convenience
method works around this and properly suppresses the warnings by providing
a mock `~warnings.simplefilter` for `~deprecated.sphinx.deprecated` to
call.

Parameters
----------
category : `Warning` or subclass
    The category of warning to suppress.

Definition at line 79 of file deprecated.py.

79 def suppress_deprecations(category=FutureWarning):
80  """Suppress warnings generated by `deprecated.sphinx.deprecated`.
81 
82  Naively, one might attempt to suppress these warnings by using
83  `~warnings.catch_warnings`. However, `~deprecated.sphinx.deprecated`
84  attempts to install its own filter, overriding that. This convenience
85  method works around this and properly suppresses the warnings by providing
86  a mock `~warnings.simplefilter` for `~deprecated.sphinx.deprecated` to
87  call.
88 
89  Parameters
90  ----------
91  category : `Warning` or subclass
92  The category of warning to suppress.
93  """
94  with warnings.catch_warnings():
95  warnings.simplefilter("ignore", category)
96  with unittest.mock.patch.object(warnings, "simplefilter"):
97  yield
lsst::utils.deprecated.suppress_deprecations
def suppress_deprecations(category=FutureWarning)
Definition: deprecated.py:79
lsst::utils.deprecated.deprecate_pybind11
def deprecate_pybind11(obj, reason, version=None, category=FutureWarning)
Definition: deprecated.py:32