-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Picking up #1118: Do not convert subclasses of ndarray
unless required
#2956
Closed
Closed
Changes from 16 commits
Commits
Show all changes
42 commits
Select commit
Hold shift + click to select a range
dcc4bfe
import the unittest test suite for quantities
keewis f6925be
make sure no divide by zero occurs
keewis ef13531
use asanyarray instead of asarray in as_compatible_data
keewis b373ecf
preserve ndarray subclasses with the data accessor
keewis a2aced1
now the sel test passes, too, so don't xfail it
keewis 97683a4
remove the last divide-by-zero possibility
keewis 2ece12b
add quantities to some of the requirements files
keewis 7a25fb6
rename the test file to match the name of the original test file
keewis 4348e0b
remove trailing whitespace
keewis dbeaed8
fix a typo
keewis f792478
replace the single data fixture with multiple smaller ones
keewis b2e3ae2
add a test for combining data arrays
keewis 453c693
replace the requires_quantities decorator with skipif on module level
keewis 0d4b543
convert the test methods from the namespace class to functions
keewis 8beaf76
also check that units on the data itself survive
keewis b4d4288
fix the order of imports
keewis 1ad1d6d
assert in the comparison function instead of asserting the result
keewis 2b654a5
use data creation helpers instead of data fixtures
keewis c52bdf4
add an option to switch on the support for subclasses
keewis 92e62b3
modify duck_array_ops.asarray to work like asanyarray if enabled
keewis 280abf3
add a function that uses asanyarray instead of asarray if the option …
keewis 24d2771
use the new asarray function instead of using options directly
keewis 2ea846e
explicitly convert matrix objects to ndarrays
keewis 5a4db0c
wrap the option name and validator lines
keewis 9809596
add tests to ensure the matrix and MaskedArray classes get converted
keewis b4cab61
fix the indentation of a parenthesis
keewis 6f398e5
fix the line length of a decorator call
keewis 54522e3
Merge commit 'f172c673' into member-arrays-with-units
keewis ee15176
black
keewis 3bc5c5c
black2
keewis c1e513a
Merge commit 'd089df38' into member-arrays-with-units
keewis 5477bca
Merge branch 'master' into member-arrays-with-units
keewis c787809
move the function deciding between asarray and asanyarray to npcompat
keewis c653eaa
make sure the original arrays are used as comparison
keewis 5aee870
isort
keewis c2944c5
allow passing custom arrays to the helper functions
keewis 8e7d7ce
create the test data in the tests to increase the readability
keewis 25f5800
Merge branch 'master' into member-arrays-with-units
keewis e13e273
black
keewis a89a1e5
reuse the coordinate dict
keewis fe6a799
ignore the missing type annotations for quantities
keewis c4d8512
Merge branch 'master' into member-arrays-with-units
keewis File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -30,6 +30,7 @@ dependencies: | |
- iris>=1.10 | ||
- pydap | ||
- lxml | ||
- quantities | ||
- pip: | ||
- cfgrib>=0.9.2 | ||
- mypy==0.660 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -28,6 +28,7 @@ dependencies: | |
- lxml | ||
- eccodes | ||
- pydap | ||
- quantities | ||
- pip: | ||
- cfgrib>=0.9.2 | ||
- mypy==0.650 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,121 @@ | ||
import numpy as np | ||
import pytest | ||
|
||
from xarray import DataArray | ||
|
||
try: | ||
import quantities as pq | ||
has_quantities = True | ||
except ImportError: | ||
has_quantities = False | ||
|
||
pytestmark = pytest.mark.skipif( | ||
not has_quantities, | ||
reason="requires python-quantities", | ||
) | ||
|
||
|
||
def equal_with_units(a, b): | ||
a = a if not isinstance(a, DataArray) else a.data | ||
b = b if not isinstance(b, DataArray) else b.data | ||
|
||
return ( | ||
(hasattr(a, "units") and hasattr(b, "units")) | ||
and a.units == b.units | ||
and np.allclose(a.magnitude, b.magnitude) | ||
) | ||
|
||
|
||
@pytest.fixture | ||
def data(): | ||
return (np.arange(10 * 20).reshape(10, 20) + 1) * pq.V | ||
|
||
|
||
@pytest.fixture | ||
def coords(): | ||
return { | ||
'x': (np.arange(10) + 1) * pq.A, | ||
'y': np.arange(20) + 1, | ||
'xp': (np.arange(10) + 1) * pq.J, | ||
} | ||
|
||
|
||
@pytest.fixture | ||
def data_array(data, coords): | ||
coords['xp'] = (['x'], coords['xp']) | ||
return DataArray( | ||
data, | ||
dims=('x', 'y'), | ||
coords=coords, | ||
) | ||
|
||
|
||
def with_keys(mapping, keys): | ||
return { | ||
key: value | ||
for key, value in mapping.items() | ||
if key in keys | ||
} | ||
|
||
|
||
def test_units_in_data_and_coords(data_array): | ||
assert equal_with_units(data_array.data, data_array) | ||
assert equal_with_units(data_array.xp.data, data_array.xp) | ||
|
||
|
||
def test_arithmetics(data_array, data, coords): | ||
v = data | ||
da = data_array | ||
|
||
f = np.arange(10 * 20).reshape(10, 20) * pq.A | ||
g = DataArray(f, dims=['x', 'y'], coords=with_keys(coords, ['x', 'y'])) | ||
assert equal_with_units(da * g, v * f) | ||
|
||
# swapped dimension order | ||
f = np.arange(20 * 10).reshape(20, 10) * pq.V | ||
g = DataArray(f, dims=['y', 'x'], coords=with_keys(coords, ['x', 'y'])) | ||
assert equal_with_units(da + g, v + f.T) | ||
|
||
# broadcasting | ||
f = (np.arange(10) + 1) * pq.m | ||
g = DataArray(f, dims=['x'], coords=with_keys(coords, ['x'])) | ||
assert equal_with_units(da / g, v / f[:, None]) | ||
|
||
|
||
@pytest.mark.xfail(reason="units don't survive through combining yet") | ||
def test_combine(data_array): | ||
from xarray import concat | ||
|
||
a = data_array[:, :10] | ||
b = data_array[:, 10:] | ||
|
||
assert equal_with_units(concat([a, b], dim='y'), data_array) | ||
|
||
|
||
def test_unit_checking(data_array, coords): | ||
da = data_array | ||
|
||
f = np.arange(10 * 20).reshape(10, 20) * pq.A | ||
g = DataArray(f, dims=['x', 'y'], coords=with_keys(coords, ['x', 'y'])) | ||
with pytest.raises(ValueError, | ||
match="Unable to convert between units"): | ||
da + g | ||
|
||
|
||
@pytest.mark.xfail(reason="units in indexes not supported") | ||
def test_units_in_indexes(data_array, coords): | ||
""" Test if units survive through xarray indexes. | ||
Indexes are borrowed from Pandas, and Pandas does not support | ||
units. Therefore, we currently don't intend to support units on | ||
indexes either. | ||
""" | ||
assert equal_with_units(data_array.x, coords['x']) | ||
|
||
|
||
def test_sel(data_array, coords, data): | ||
assert equal_with_units(data_array.sel(y=coords['y'][0]), data[:, 0]) | ||
|
||
|
||
@pytest.mark.xfail | ||
def test_mean(data_array, data): | ||
assert equal_with_units(data_array.mean('x'), data.mean(0)) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a minor point, but I would recommend against using pytest fixtures for test data. (Though we do use this style currently in xarray in a few places.)
Fixtures are great for setup/teardown (e.g., cleaning up temporary files), but when you test depends on data values, it's best if the data values can be found in the test itself. Otherwise, the logic in a test is not self-contained, which means you have to understand a much bigger context of code.
All this is true for even helper functions, but pytest's fixtures are even more magical:
So in summary:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
right, so I used helper functions instead