Skip to content

Commit 4d91ec2

Browse files
committed
add deprecated aliases
1 parent ca483b5 commit 4d91ec2

File tree

1 file changed

+28
-3
lines changed

1 file changed

+28
-3
lines changed

scoringrules/__init__.py

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
from importlib.metadata import version
2+
import functools
3+
import warnings
24

35
from scoringrules._brier import (
46
brier_score,
@@ -95,13 +97,36 @@
9597
owgksmv_ensemble,
9698
vrgksmv_ensemble,
9799
)
98-
99100
from scoringrules._quantile import quantile_score
100-
101101
from scoringrules.backend import backends, register_backend
102102

103-
__version__ = version("scoringrules")
104103

104+
def _deprecated_alias(new_func, old_func_name, remove_version):
105+
"""Return a deprecated alias for a renamed function."""
106+
107+
@functools.wraps(new_func)
108+
def wrapper(*args, **kwargs):
109+
warnings.warn(
110+
f"{old_func_name} is deprecated and will be removed in {remove_version}. "
111+
f"Use {new_func.__name__} instead.",
112+
DeprecationWarning,
113+
)
114+
return new_func(*args, **kwargs)
115+
116+
return wrapper
117+
118+
119+
energy_score = _deprecated_alias(es_ensemble, "energy_score", "v1.0.0")
120+
owenergy_score = _deprecated_alias(owes_ensemble, "owenergy_score", "v1.0.0")
121+
twenergy_score = _deprecated_alias(twes_ensemble, "twenergy_score", "v1.0.0")
122+
vrenergy_score = _deprecated_alias(vres_ensemble, "vrenergy_score", "v1.0.0")
123+
124+
variogram_score = _deprecated_alias(vs_ensemble, "variogram_score", "v1.0.0")
125+
owvariogram_score = _deprecated_alias(owvs_ensemble, "owvariogram_score", "v1.0.0")
126+
twvariogram_score = _deprecated_alias(twvs_ensemble, "twvariogram_score", "v1.0.0")
127+
vrvariogram_score = _deprecated_alias(vrvs_ensemble, "vrvariogram_score", "v1.0.0")
128+
129+
__version__ = version("scoringrules")
105130

106131
__all__ = [
107132
"register_backend",

0 commit comments

Comments
 (0)