/
generate_ops.py
293 lines (250 loc) · 9.16 KB
/
generate_ops.py
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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
"""Generate module and stub file for arithmetic operators of various xarray classes.
For internal xarray development use only.
Usage:
python xarray/util/generate_ops.py > xarray/core/_typed_ops.py
"""
# Note: the comments in https://github.com/pydata/xarray/pull/4904 provide some
# background to some of the design choices made here.
from __future__ import annotations
from collections.abc import Iterator, Sequence
from typing import Optional
BINOPS_EQNE = (("__eq__", "nputils.array_eq"), ("__ne__", "nputils.array_ne"))
BINOPS_CMP = (
("__lt__", "operator.lt"),
("__le__", "operator.le"),
("__gt__", "operator.gt"),
("__ge__", "operator.ge"),
)
BINOPS_NUM = (
("__add__", "operator.add"),
("__sub__", "operator.sub"),
("__mul__", "operator.mul"),
("__pow__", "operator.pow"),
("__truediv__", "operator.truediv"),
("__floordiv__", "operator.floordiv"),
("__mod__", "operator.mod"),
("__and__", "operator.and_"),
("__xor__", "operator.xor"),
("__or__", "operator.or_"),
("__lshift__", "operator.lshift"),
("__rshift__", "operator.rshift"),
)
BINOPS_REFLEXIVE = (
("__radd__", "operator.add"),
("__rsub__", "operator.sub"),
("__rmul__", "operator.mul"),
("__rpow__", "operator.pow"),
("__rtruediv__", "operator.truediv"),
("__rfloordiv__", "operator.floordiv"),
("__rmod__", "operator.mod"),
("__rand__", "operator.and_"),
("__rxor__", "operator.xor"),
("__ror__", "operator.or_"),
)
BINOPS_INPLACE = (
("__iadd__", "operator.iadd"),
("__isub__", "operator.isub"),
("__imul__", "operator.imul"),
("__ipow__", "operator.ipow"),
("__itruediv__", "operator.itruediv"),
("__ifloordiv__", "operator.ifloordiv"),
("__imod__", "operator.imod"),
("__iand__", "operator.iand"),
("__ixor__", "operator.ixor"),
("__ior__", "operator.ior"),
("__ilshift__", "operator.ilshift"),
("__irshift__", "operator.irshift"),
)
UNARY_OPS = (
("__neg__", "operator.neg"),
("__pos__", "operator.pos"),
("__abs__", "operator.abs"),
("__invert__", "operator.invert"),
)
# round method and numpy/pandas unary methods which don't modify the data shape,
# so the result should still be wrapped in an Variable/DataArray/Dataset
OTHER_UNARY_METHODS = (
("round", "ops.round_"),
("argsort", "ops.argsort"),
("conj", "ops.conj"),
("conjugate", "ops.conjugate"),
)
required_method_binary = """
def _binary_op(
self, other: {other_type}, f: Callable, reflexive: bool = False
) -> {return_type}:
raise NotImplementedError"""
template_binop = """
def {method}(self, other: {other_type}) -> {return_type}:{type_ignore}
return self._binary_op(other, {func})"""
template_binop_overload = """
@overload{overload_type_ignore}
def {method}(self, other: {overload_type}) -> {overload_type}:
...
@overload
def {method}(self, other: {other_type}) -> {return_type}:
...
def {method}(self, other: {other_type}) -> {return_type} | {overload_type}:{type_ignore}
return self._binary_op(other, {func})"""
template_reflexive = """
def {method}(self, other: {other_type}) -> {return_type}:
return self._binary_op(other, {func}, reflexive=True)"""
required_method_inplace = """
def _inplace_binary_op(self, other: {other_type}, f: Callable) -> Self:
raise NotImplementedError"""
template_inplace = """
def {method}(self, other: {other_type}) -> Self:{type_ignore}
return self._inplace_binary_op(other, {func})"""
required_method_unary = """
def _unary_op(self, f: Callable, *args: Any, **kwargs: Any) -> Self:
raise NotImplementedError"""
template_unary = """
def {method}(self) -> Self:
return self._unary_op({func})"""
template_other_unary = """
def {method}(self, *args: Any, **kwargs: Any) -> Self:
return self._unary_op({func}, *args, **kwargs)"""
unhashable = """
# When __eq__ is defined but __hash__ is not, then an object is unhashable,
# and it should be declared as follows:
__hash__: None # type:ignore[assignment]"""
# For some methods we override return type `bool` defined by base class `object`.
# We need to add "# type: ignore[override]"
# Keep an eye out for:
# https://discuss.python.org/t/make-type-hints-for-eq-of-primitives-less-strict/34240
# The type ignores might not be necessary anymore at some point.
#
# We require a "hack" to tell type checkers that e.g. Variable + DataArray = DataArray
# In reality this returns NotImplementes, but this is not a valid type in python 3.9.
# Therefore, we return DataArray. In reality this would call DataArray.__add__(Variable)
# TODO: change once python 3.10 is the minimum.
#
# Mypy seems to require that __iadd__ and __add__ have the same signature.
# This requires some extra type: ignores[misc] in the inplace methods :/
def _type_ignore(ignore: str) -> str:
return f" # type:ignore[{ignore}]" if ignore else ""
FuncType = Sequence[tuple[Optional[str], Optional[str]]]
OpsType = tuple[FuncType, str, dict[str, str]]
def binops(
other_type: str, return_type: str = "Self", type_ignore_eq: str = "override"
) -> list[OpsType]:
extras = {"other_type": other_type, "return_type": return_type}
return [
([(None, None)], required_method_binary, extras),
(BINOPS_NUM + BINOPS_CMP, template_binop, extras | {"type_ignore": ""}),
(
BINOPS_EQNE,
template_binop,
extras | {"type_ignore": _type_ignore(type_ignore_eq)},
),
([(None, None)], unhashable, extras),
(BINOPS_REFLEXIVE, template_reflexive, extras),
]
def binops_overload(
other_type: str,
overload_type: str,
return_type: str = "Self",
type_ignore_eq: str = "override",
) -> list[OpsType]:
extras = {"other_type": other_type, "return_type": return_type}
return [
([(None, None)], required_method_binary, extras),
(
BINOPS_NUM + BINOPS_CMP,
template_binop_overload,
extras
| {
"overload_type": overload_type,
"type_ignore": "",
"overload_type_ignore": "",
},
),
(
BINOPS_EQNE,
template_binop_overload,
extras
| {
"overload_type": overload_type,
"type_ignore": "",
"overload_type_ignore": _type_ignore(type_ignore_eq),
},
),
([(None, None)], unhashable, extras),
(BINOPS_REFLEXIVE, template_reflexive, extras),
]
def inplace(other_type: str, type_ignore: str = "") -> list[OpsType]:
extras = {"other_type": other_type}
return [
([(None, None)], required_method_inplace, extras),
(
BINOPS_INPLACE,
template_inplace,
extras | {"type_ignore": _type_ignore(type_ignore)},
),
]
def unops() -> list[OpsType]:
return [
([(None, None)], required_method_unary, {}),
(UNARY_OPS, template_unary, {}),
(OTHER_UNARY_METHODS, template_other_unary, {}),
]
ops_info = {}
ops_info["DatasetOpsMixin"] = (
binops(other_type="DsCompatible") + inplace(other_type="DsCompatible") + unops()
)
ops_info["DataArrayOpsMixin"] = (
binops(other_type="DaCompatible") + inplace(other_type="DaCompatible") + unops()
)
ops_info["VariableOpsMixin"] = (
binops_overload(other_type="VarCompatible", overload_type="T_DataArray")
+ inplace(other_type="VarCompatible", type_ignore="misc")
+ unops()
)
ops_info["DatasetGroupByOpsMixin"] = binops(
other_type="GroupByCompatible", return_type="Dataset"
)
ops_info["DataArrayGroupByOpsMixin"] = binops(
other_type="T_Xarray", return_type="T_Xarray"
)
MODULE_PREAMBLE = '''\
"""Mixin classes with arithmetic operators."""
# This file was generated using xarray.util.generate_ops. Do not edit manually.
from __future__ import annotations
import operator
from typing import TYPE_CHECKING, Any, Callable, overload
from xarray.core import nputils, ops
from xarray.core.types import (
DaCompatible,
DsCompatible,
GroupByCompatible,
Self,
T_DataArray,
T_Xarray,
VarCompatible,
)
if TYPE_CHECKING:
from xarray.core.dataset import Dataset'''
CLASS_PREAMBLE = """{newline}
class {cls_name}:
__slots__ = ()"""
COPY_DOCSTRING = """\
{method}.__doc__ = {func}.__doc__"""
def render(ops_info: dict[str, list[OpsType]]) -> Iterator[str]:
"""Render the module or stub file."""
yield MODULE_PREAMBLE
for cls_name, method_blocks in ops_info.items():
yield CLASS_PREAMBLE.format(cls_name=cls_name, newline="\n")
yield from _render_classbody(method_blocks)
def _render_classbody(method_blocks: list[OpsType]) -> Iterator[str]:
for method_func_pairs, template, extra in method_blocks:
if template:
for method, func in method_func_pairs:
yield template.format(method=method, func=func, **extra)
yield ""
for method_func_pairs, *_ in method_blocks:
for method, func in method_func_pairs:
if method and func:
yield COPY_DOCSTRING.format(method=method, func=func)
if __name__ == "__main__":
for line in render(ops_info):
print(line)