add check for valid dimension name before creating new variable #360
Conversation
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
Add function to ensure that added variables do not use unvalid dimension names.
lkstrp
reviewed
Nov 27, 2024
There was a problem hiding this comment.
Hey @tom-welfonder, thanks for the contribution! And sorry for taking a while. That looks like a useful check. Just some minor things.
Comment on lines
+380
to
+383
| contains_unsupported_dim_names = any( | ||
| dim in unsupported_dim_names for dim in list(ds.dims) | ||
| ) | ||
| if contains_unsupported_dim_names: |
There was a problem hiding this comment.
Suggested change
| contains_unsupported_dim_names = any( | |
| dim in unsupported_dim_names for dim in list(ds.dims) | |
| ) | |
| if contains_unsupported_dim_names: | |
| if any(dim in unsupported_dim_names for dim in ds.dims): |
Maybe a little more condensed?
Comment on lines
+388
to
+389
| else: | ||
| return |
| @@ -357,6 +357,37 @@ def check_force_dim_names(self, ds: DataArray | Dataset) -> None: | |||
| else: | |||
| return | |||
|
|
|||
| def check_valid_dim_names(self, ds: DataArray | Dataset) -> None: | |||
There was a problem hiding this comment.
Suggested change
| def check_valid_dim_names(self, ds: DataArray | Dataset) -> None: | |
| def _check_valid_dim_names(self, ds: DataArray | Dataset) -> None: |
| @@ -464,6 +495,7 @@ def add_variables( | |||
| ) | |||
| (data,) = xr.broadcast(data) | |||
| self.check_force_dim_names(data) | |||
| self.check_valid_dim_names(data) | |||
There was a problem hiding this comment.
Suggested change
| self.check_valid_dim_names(data) | |
| self._check_valid_dim_names(data) |
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.
Add function to ensure that added variables do not use unvalid dimension names.
Add test for variable assignment with invalid dimension name.
This code adds a more meaning full error message if users try to create new variables with invalid dimension names.
Old behavior is described in #359.