Add a FutureWarning to Dataset.__iter__ and Dataset.__len__ #1658
Conversation
This file contains hidden or 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
xref GH884 This will allow us to resolve a long-standing pain-point with consistency between pandas and xarray. CC pydata/xarray
jhamman
approved these changes
Oct 25, 2017
doc/data-structures.rst
Outdated
| ``ds.keys()``) the next major release of xarray, to only include data | ||
| variables instead of both data variables and coordinates. In the meantime, | ||
| please prefer iterating over keys in ``ds.data_vars`` or ``ds.coords``, or | ||
| ``ds.variables`` if you need both at once. |
There was a problem hiding this comment.
This could use some polishing. The first sentence should probably be split in two. Also, the "please prefer" statement is a bit awkward.
There was a problem hiding this comment.
I tried to keep this as a simple version of the full deprecation warning, and leave the detailed rationale to whats-new.rst. Let me know if this is any better...
doc/whats-new.rst
Outdated
| for membership in ``DataArray.coords``. In the next major version of | ||
| xarray, it will check membership in the array data found in | ||
| ``DataArray.values`` instead (:issue:`1267`). | ||
| - Directly iteration over and counting a ``Dataset`` (e.g., ``[k for k in ds]``, |
|
Yes, this was tested by making the warnings errors. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This will allow us to resolve a long-standing pain-point with consistency between pandas and xarray.
git diff upstream/master | flake8 --diffwhats-new.rstfor all changes andapi.rstfor new APICC @pydata/xarray