LSSTApplications  19.0.0-14-gb0260a2+68b5710e34,20.0.0+34a42eae2c,20.0.0+5e413b1bb7,20.0.0+8220981c08,20.0.0+8558dd3f48,20.0.0+9105c11c27,20.0.0+9c492b2baa,20.0.0+b290a576ab,20.0.0+b2ea66fa67,20.0.0+bdb47f006b,20.0.0+c80b78a72c,20.0.0+ca71b4c878,20.0.0+dcf29472a8,20.0.0+f45b7d88f4,20.0.0+ff38a75775,20.0.0-1-g10df615+0301c91ccb,20.0.0-1-g253301a+dcf29472a8,20.0.0-1-g498fb60+ff88705a28,20.0.0-1-g4d801e7+0fef26433e,20.0.0-1-g8a53f90+2817c06967,20.0.0-1-gc96f8cb+9c492b2baa,20.0.0-1-gd1c87d7+2817c06967,20.0.0-1-gdb27ee5+60996fbbb1,20.0.0-11-gda4966f+51d1f94bfc,20.0.0-17-g98646ba4+6d72394450,20.0.0-2-g25c5319+53d663580f,20.0.0-2-gec03fae+3bc057fb2a,20.0.0-27-g22bab1b+63c2eb6a9e,20.0.0-3-gd2e950e+f45b7d88f4,20.0.0-4-g4a2362f+f45b7d88f4,20.0.0-4-ge48a6ca+6f08222a1e,20.0.0-5-gac0d578b1+6c871ee35c,20.0.0-6-g01203fff+c632a9a46a,20.0.0-7-g3c4151b+49dfb5b924,20.0.0-8-g9573cbd+60996fbbb1,20.0.0-8-gc2abeef+9c492b2baa,w.2020.32
LSSTDataManagementBasePackage
deprecated.py
Go to the documentation of this file.
1 # This file is part of lsst.utils.
2 #
3 # Developed for the LSST Data Management System.
4 # This product includes software developed by the LSST Project
5 # (https://www.lsst.org).
6 # See the COPYRIGHT file at the top-level directory of this distribution
7 # for details of code ownership.
8 #
9 # This program is free software: you can redistribute it and/or modify
10 # it under the terms of the GNU General Public License as published by
11 # the Free Software Foundation, either version 3 of the License, or
12 # (at your option) any later version.
13 #
14 # This program is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
18 #
19 # You should have received a copy of the GNU General Public License
20 # along with this program. If not, see <https://www.gnu.org/licenses/>.
21 
22 __all__ = ['deprecate_pybind11', 'suppress_deprecations']
23 
24 import deprecated.sphinx
25 import functools
26 import unittest.mock
27 import warnings
28 
29 from contextlib import contextmanager
30 
31 
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
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