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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
# For reference, here is a copy of the scikit-learn copyright notice:
# BSD 3-Clause License
# Copyright (c) 2007-2021 The scikit-learn developers.
# All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
# * Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
# * Neither the name of the copyright holder nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
import inspect
import warnings
from collections.abc import Callable
from functools import wraps
from typing import Any, Self, TypeVar
from xarray.core.options import OPTIONS
from xarray.core.utils import emit_user_level_warning
T = TypeVar("T", bound=Callable)
POSITIONAL_OR_KEYWORD = inspect.Parameter.POSITIONAL_OR_KEYWORD
KEYWORD_ONLY = inspect.Parameter.KEYWORD_ONLY
POSITIONAL_ONLY = inspect.Parameter.POSITIONAL_ONLY
EMPTY = inspect.Parameter.empty
def _deprecate_positional_args(version) -> Callable[[T], T]:
"""Decorator for methods that issues warnings for positional arguments
Using the keyword-only argument syntax in pep 3102, arguments after the
``*`` will issue a warning when passed as a positional argument.
Parameters
----------
version : str
version of the library when the positional arguments were deprecated
Examples
--------
Deprecate passing `b` as positional argument:
def func(a, b=1):
pass
@_deprecate_positional_args("v0.1.0")
def func(a, *, b=2):
pass
func(1, 2)
Notes
-----
This function is adapted from scikit-learn under the terms of its license. See
licences/SCIKIT_LEARN_LICENSE
"""
def _decorator(func):
signature = inspect.signature(func)
pos_or_kw_args = []
kwonly_args = []
for name, param in signature.parameters.items():
if param.kind in (POSITIONAL_OR_KEYWORD, POSITIONAL_ONLY):
pos_or_kw_args.append(name)
elif param.kind == KEYWORD_ONLY:
kwonly_args.append(name)
if param.default is EMPTY:
# IMHO `def f(a, *, b):` does not make sense -> disallow it
# if removing this constraint -> need to add these to kwargs as well
raise TypeError("Keyword-only param without default disallowed.")
@wraps(func)
def inner(*args, **kwargs):
name = func.__name__
n_extra_args = len(args) - len(pos_or_kw_args)
if n_extra_args > 0:
extra_args = ", ".join(kwonly_args[:n_extra_args])
warnings.warn(
f"Passing '{extra_args}' as positional argument(s) to {name} "
f"was deprecated in version {version} and will raise an error two "
"releases later. Please pass them as keyword arguments."
"",
FutureWarning,
stacklevel=2,
)
zip_args = zip(
kwonly_args[:n_extra_args], args[-n_extra_args:], strict=True
)
kwargs.update(zip_args)
return func(*args[:-n_extra_args], **kwargs)
return func(*args, **kwargs)
return inner
return _decorator
def deprecate_dims(func: T, old_name="dims") -> T:
"""
For functions that previously took `dims` as a kwarg, and have now transitioned to
`dim`. This decorator will issue a warning if `dims` is passed while forwarding it
to `dim`.
"""
@wraps(func)
def wrapper(*args, **kwargs):
if old_name in kwargs:
emit_user_level_warning(
f"The `{old_name}` argument has been renamed to `dim`, and will be removed "
"in the future. This renaming is taking place throughout xarray over the "
"next few releases.",
# Upgrade to `DeprecationWarning` in the future, when the renaming is complete.
PendingDeprecationWarning,
)
kwargs["dim"] = kwargs.pop(old_name)
return func(*args, **kwargs)
# We're quite confident we're just returning `T` from this function, so it's fine to ignore typing
# within the function.
return wrapper # type: ignore[return-value]
class CombineKwargDefault:
"""Object that handles deprecation cycle for kwarg default values.
Similar to ReprObject
"""
_old: str
_new: str | None
_name: str
def __init__(self, *, name: str, old: str, new: str | None):
self._name = name
self._old = old
self._new = new
def __repr__(self) -> str:
return str(self._value)
def __eq__(self, other: Self | Any) -> bool:
return (
self._value == other._value
if isinstance(other, type(self))
else self._value == other
)
@property
def _value(self) -> str | None:
return self._new if OPTIONS["use_new_combine_kwarg_defaults"] else self._old
def __hash__(self) -> int:
return hash(self._value)
def __dask_tokenize__(self) -> object:
from dask.base import normalize_token
return normalize_token((type(self), self._value))
def warning_message(self, message: str, recommend_set_options: bool = True) -> str:
if recommend_set_options:
recommendation = (
" To opt in to new defaults and get rid of these warnings now "
"use `set_options(use_new_combine_kwarg_defaults=True) or "
f"set {self._name} explicitly."
)
else:
recommendation = (
f" The recommendation is to set {self._name} explicitly for this case."
)
return (
f"In a future version of xarray the default value for {self._name} will "
f"change from {self._name}={self._old!r} to {self._name}={self._new!r}. "
+ message
+ recommendation
)
def error_message(self) -> str:
return (
f" Error might be related to new default (`{self._name}={self._new!r}`). "
f"Previously the default was `{self._name}={self._old!r}`. "
f"The recommendation is to set {self._name!r} explicitly for this case."
)
_DATA_VARS_DEFAULT = CombineKwargDefault(name="data_vars", old="all", new=None)
_COORDS_DEFAULT = CombineKwargDefault(name="coords", old="different", new="minimal")
_COMPAT_CONCAT_DEFAULT = CombineKwargDefault(
name="compat", old="equals", new="override"
)
_COMPAT_DEFAULT = CombineKwargDefault(name="compat", old="no_conflicts", new="override")
_JOIN_DEFAULT = CombineKwargDefault(name="join", old="outer", new="exact")
|
