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
|
from __future__ import annotations
import pickle
import pytest
import xarray as xr
from xarray.core.extensions import register_datatree_accessor
from xarray.tests import assert_identical
@register_datatree_accessor("example_accessor")
@xr.register_dataset_accessor("example_accessor")
@xr.register_dataarray_accessor("example_accessor")
class ExampleAccessor:
"""For the pickling tests below."""
def __init__(self, xarray_obj):
self.obj = xarray_obj
class TestAccessor:
def test_register(self) -> None:
@register_datatree_accessor("demo")
@xr.register_dataset_accessor("demo")
@xr.register_dataarray_accessor("demo")
class DemoAccessor:
"""Demo accessor."""
def __init__(self, xarray_obj):
self._obj = xarray_obj
@property
def foo(self):
return "bar"
dt: xr.DataTree = xr.DataTree()
assert dt.demo.foo == "bar"
ds = xr.Dataset()
assert ds.demo.foo == "bar"
da = xr.DataArray(0)
assert da.demo.foo == "bar"
# accessor is cached
assert ds.demo is ds.demo
# check descriptor
assert ds.demo.__doc__ == "Demo accessor."
# TODO: typing doesn't seem to work with accessors
assert xr.Dataset.demo.__doc__ == "Demo accessor." # type: ignore[attr-defined]
assert isinstance(ds.demo, DemoAccessor)
assert xr.Dataset.demo is DemoAccessor # type: ignore[attr-defined]
# ensure we can remove it
del xr.Dataset.demo # type: ignore[attr-defined]
assert not hasattr(xr.Dataset, "demo")
with pytest.warns(Warning, match="overriding a preexisting attribute"):
@xr.register_dataarray_accessor("demo")
class Foo:
pass
# it didn't get registered again
assert not hasattr(xr.Dataset, "demo")
def test_pickle_dataset(self) -> None:
ds = xr.Dataset()
ds_restored = pickle.loads(pickle.dumps(ds))
assert_identical(ds, ds_restored)
# state save on the accessor is restored
assert ds.example_accessor is ds.example_accessor
ds.example_accessor.value = "foo"
ds_restored = pickle.loads(pickle.dumps(ds))
assert_identical(ds, ds_restored)
assert ds_restored.example_accessor.value == "foo"
def test_pickle_dataarray(self) -> None:
array = xr.Dataset()
assert array.example_accessor is array.example_accessor
array_restored = pickle.loads(pickle.dumps(array))
assert_identical(array, array_restored)
def test_broken_accessor(self) -> None:
# regression test for GH933
@xr.register_dataset_accessor("stupid_accessor")
class BrokenAccessor:
def __init__(self, xarray_obj):
raise AttributeError("broken")
with pytest.raises(RuntimeError, match=r"error initializing"):
_ = xr.Dataset().stupid_accessor
|
