lsst.ip.diffim  18.1.0-14-g259bd21+5
deprecated.py
Go to the documentation of this file.
1 # This file is part of ip_diffim.
2 #
3 # Developed for the LSST Data Management System.
4 # This product includes software developed by the LSST Project
5 # (http://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 <http://www.gnu.org/licenses/>.
21 __all__ = ["deprecate_policy"]
22 
23 import warnings
24 import functools
25 from lsst.pex.policy import Policy
26 
27 
28 def deprecate_policy(func, policy_args=None):
29  """Issue a deprecation warning if one of the supplied arguments
30  is a Policy, and convert that to a PropertySet.
31 
32  Parameters
33  ----------
34  policy_args : `~collections.abc.Sequence`, optional
35  Known positions of likely `~lsst.pex.Policy` arguments for the wrapped
36  function. Can be out of range since some pybind11 constructors take
37  different numbers of arguments. If `None` all arguments will be
38  checked.
39  """
40 
41  @functools.wraps(func)
42  def internal(*args, **kwargs):
43  newargs = list(args)
44 
45  if policy_args is None:
46  # Check all arguments
47  args_to_check = range(len(args))
48  else:
49  max_i = len(newargs) - 1
50  args_to_check = [p for p in policy_args if p <= max_i]
51 
52  for i in args_to_check:
53  a = newargs[i]
54  if isinstance(a, Policy):
55  warnings.warn(f"pexPolicy in argument {i} is deprecated. Replace with PropertySet"
56  " (Policy support will be removed in v19)",
57  FutureWarning, stacklevel=2)
58  a = a.asPropertySet()
59  newargs[i] = a
60  return func(*newargs, **kwargs)
61 
62  return internal
def deprecate_policy(func, policy_args=None)
Definition: deprecated.py:28