1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
"""Utilities for deprecation"""
# Authors: Guillaume Lemaitre <g.lemaitre58@gmail.com>
# License: MIT
import warnings
def deprecate_parameter(sampler, version_deprecation, param_deprecated, new_param=None):
"""Helper to deprecate a parameter by another one.
Parameters
----------
sampler : sampler object,
The object which will be inspected.
version_deprecation : str,
The version from which the parameter will be deprecated. The format
should be ``'x.y'``.
param_deprecated : str,
The parameter being deprecated.
new_param : str,
The parameter used instead of the deprecated parameter. By default, no
parameter is expected.
"""
x, y = version_deprecation.split(".")
version_removed = x + "." + str(int(y) + 2)
if new_param is None:
if getattr(sampler, param_deprecated) is not None:
warnings.warn(
f"'{param_deprecated}' is deprecated from {version_deprecation} and "
f" will be removed in {version_removed} for the estimator "
f"{sampler.__class__}.",
category=FutureWarning,
)
else:
if getattr(sampler, param_deprecated) is not None:
warnings.warn(
f"'{param_deprecated}' is deprecated from {version_deprecation} and "
f"will be removed in {version_removed} for the estimator "
f"{sampler.__class__}. Use '{new_param}' instead.",
category=FutureWarning,
)
setattr(sampler, new_param, getattr(sampler, param_deprecated))
|
