issues: 807764700
This data as json
| id | node_id | number | title | user | state | locked | assignee | milestone | comments | created_at | updated_at | closed_at | author_association | active_lock_reason | draft | pull_request | body | reactions | performed_via_github_app | state_reason | repo | type |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 807764700 | MDExOlB1bGxSZXF1ZXN0NTcyOTQ4MDQ3 | 4904 | add typing to unary and binary arithmetic operators | 32801740 | closed | 0 | 21 | 2021-02-13T15:01:59Z | 2021-04-14T16:01:06Z | 2021-04-14T15:59:59Z | CONTRIBUTOR | 0 | pydata/xarray/pulls/4904 |
This draft PR is for soliciting feedback on an approach to adding typing to unary and binary operators for xarray classes. The approach involves generating a stub file using a simple script. In order to untangle the various helper classes implementing arithmetic throughout the code base I have refactored the code, thereby getting rid of the injection of the operators after class definition. It now inserts the operators during construction of the subclasses leveraging Python's For this example python file:
```
from typing import TYPE_CHECKING
from xarray import DataArray # noqa: F401
from xarray import Dataset # noqa: F401
from xarray import Variable # noqa: F401
ds = Dataset({"v": ("x", [2])})
da = DataArray([3], dims="x")
var = Variable("x", [4])
ds00 = -ds
ds01 = ds + ds
ds02 = da - ds
ds03 = ds * da
ds04 = var / ds
ds05 = ds // var
ds06 = ds & 1
ds07 = 2 | ds
ds08 = ds == ds
ds09 = ds != da
ds10 = da <= ds
ds11 = ds > var
ds12 = var >= ds
da0 = +da
da1 = da % da
da2 = da ** var
da3 = var ^ da
da4 = da & 123
da5 = 1.23 * da
da6 = da == da
da7 = da != var
da8 = var < da
var0 = ~var
var1 = var + var
var2 = var & 1
var3 = 3 ^ var
var4 = var != var
if TYPE_CHECKING:
reveal_locals() # noqa: F821
for k, v in tuple(vars().items()):
if k[0].islower():
print(k, type(v))
```
the status quo gives this mypy output:
```
temp.py:11: error: Unsupported operand type for unary - ("Dataset")
temp.py:18: error: Unsupported operand types for | ("int" and "Dataset")
temp.py:25: error: Unsupported operand type for unary + ("DataArray")
temp.py:30: error: Unsupported operand types for * ("float" and "DataArray")
temp.py:35: error: Unsupported operand type for ~ ("Variable")
temp.py:38: error: Unsupported operand types for ^ ("int" and "Variable")
temp.py:42: note: Revealed local types are:
temp.py:42: note: TYPE_CHECKING: builtins.bool
temp.py:42: note: da: xarray.core.dataarray.DataArray
temp.py:42: note: da0: Any
temp.py:42: note: da1: Any
temp.py:42: note: da2: Any
temp.py:42: note: da3: Any
temp.py:42: note: da4: Any
temp.py:42: note: da5: builtins.float
temp.py:42: note: da6: Any
temp.py:42: note: da7: Any
temp.py:42: note: da8: Any
temp.py:42: note: ds: xarray.core.dataset.Dataset
temp.py:42: note: ds00: Any
temp.py:42: note: ds01: Any
temp.py:42: note: ds02: Any
temp.py:42: note: ds03: Any
temp.py:42: note: ds04: Any
temp.py:42: note: ds05: Any
temp.py:42: note: ds06: Any
temp.py:42: note: ds07: builtins.int
temp.py:42: note: ds08: Any
temp.py:42: note: ds09: Any
temp.py:42: note: ds10: Any
temp.py:42: note: ds11: Any
temp.py:42: note: ds12: Any
temp.py:42: note: var: xarray.core.variable.Variable
temp.py:42: note: var0: Any
temp.py:42: note: var1: Any
temp.py:42: note: var2: Any
temp.py:42: note: var3: builtins.int
temp.py:42: note: var4: Any
Found 6 errors in 1 file (checked 127 source files)
```
With this PR the output now becomes:
```
temp.py:42: note: Revealed local types are:
temp.py:42: note: da: xarray.core.dataarray.DataArray
temp.py:42: note: da0: xarray.core.dataarray.DataArray*
temp.py:42: note: da1: xarray.core.dataarray.DataArray*
temp.py:42: note: da2: xarray.core.dataarray.DataArray*
temp.py:42: note: da3: xarray.core.dataarray.DataArray*
temp.py:42: note: da4: xarray.core.dataarray.DataArray*
temp.py:42: note: da5: xarray.core.dataarray.DataArray*
temp.py:42: note: da6: xarray.core.dataarray.DataArray*
temp.py:42: note: da7: xarray.core.dataarray.DataArray*
temp.py:42: note: da8: xarray.core.dataarray.DataArray*
temp.py:42: note: ds: xarray.core.dataset.Dataset
temp.py:42: note: ds00: xarray.core.dataset.Dataset*
temp.py:42: note: ds01: xarray.core.dataset.Dataset*
temp.py:42: note: ds02: xarray.core.dataset.Dataset*
temp.py:42: note: ds03: xarray.core.dataset.Dataset*
temp.py:42: note: ds04: xarray.core.dataset.Dataset*
temp.py:42: note: ds05: xarray.core.dataset.Dataset*
temp.py:42: note: ds06: xarray.core.dataset.Dataset*
temp.py:42: note: ds07: xarray.core.dataset.Dataset*
temp.py:42: note: ds08: xarray.core.dataset.Dataset*
temp.py:42: note: ds09: xarray.core.dataset.Dataset*
temp.py:42: note: ds10: xarray.core.dataset.Dataset*
temp.py:42: note: ds11: xarray.core.dataset.Dataset*
temp.py:42: note: ds12: xarray.core.dataset.Dataset*
temp.py:42: note: var: xarray.core.variable.Variable
temp.py:42: note: var0: xarray.core.variable.Variable*
temp.py:42: note: var1: xarray.core.variable.Variable*
temp.py:42: note: var2: xarray.core.variable.Variable*
temp.py:42: note: var3: xarray.core.variable.Variable*
temp.py:42: note: var4: xarray.core.variable.Variable*
```
|
{
"url": "https://api.github.com/repos/pydata/xarray/issues/4904/reactions",
"total_count": 0,
"+1": 0,
"-1": 0,
"laugh": 0,
"hooray": 0,
"confused": 0,
"heart": 0,
"rocket": 0,
"eyes": 0
} |
13221727 | pull |