Raise exception when using diff with a non-existent dimension
#8962
Conversation
|
Thank you for opening this pull request! It may take us a few days to respond here, so thank you for being patient. |
| @@ -3861,6 +3861,12 @@ def test_dataarray_diff_n1(self) -> None: | |||
| expected = DataArray(np.diff(da.values, axis=1), dims=["x", "y"]) | |||
| assert_equal(expected, actual) | |||
|
|
|||
| def test_dataarray_diff_dim_nonexist(self) -> None: | |||
| # uncomment this code for test corresponding to pushed changes | |||
| # with pytest.raises(KeyError, match=r"dim provided not present"): | |||
There was a problem hiding this comment.
This can use pytest.warns
| @@ -7726,6 +7726,7 @@ def diff( | |||
| n: int = 1, | |||
| *, | |||
| label: Literal["upper", "lower"] = "upper", | |||
| dims_found=False, | |||
There was a problem hiding this comment.
Do we need this? I think it can be defined inside the function
| - Fix for :py:meth:`DataSet.diff` and consequently :py:meth:`DataArray.diff` to | ||
| raise a KeyError when `diff` is parameterized with a dimension that does not | ||
| exist in callee's DataSet/DataArray. (:issue:`7748`) |
There was a problem hiding this comment.
This is fine, though we can also simplify the language a bit — cut words like consequently / parameterized with!
dcherian
changed the title
diff with a non-existent dimension
|
@nathanredmond are you planning on finishing this? Seems like a good idea. |
| if dims_found: | ||
| return difference | ||
| else: | ||
| from warnings import warn |
There was a problem hiding this comment.
(these can be reduced to a single if not dims_found, and then it'll fall through to the return difference below)
whats-new.rst