Refactor filenames handling in Field.from_netcdf
#1787
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
Now that filenames is sanitized
Contributes to #1706
VeckoTheGecko
commented
Dec 5, 2024
Comment on lines
+574
to
610
| data_filenames = _get_dim_filenames(filenames, "data") | ||
| lonlat_filename_lst = _get_dim_filenames(filenames, "lon") | ||
| if isinstance(filenames, dict): | ||
| assert len(lonlat_filename) == 1 | ||
| if lonlat_filename != cls._get_dim_filenames(filenames, "lat"): | ||
| assert len(lonlat_filename_lst) == 1 | ||
| if lonlat_filename_lst != _get_dim_filenames(filenames, "lat"): | ||
| raise NotImplementedError( | ||
| "longitude and latitude dimensions are currently processed together from one single file" | ||
| ) | ||
| lonlat_filename = lonlat_filename[0] | ||
| lonlat_filename = lonlat_filename_lst[0] | ||
| if "depth" in dimensions: | ||
| depth_filename = cls._get_dim_filenames(filenames, "depth") | ||
| if isinstance(filenames, dict) and len(depth_filename) != 1: | ||
| depth_filename_lst = _get_dim_filenames(filenames, "depth") | ||
| if isinstance(filenames, dict) and len(depth_filename_lst) != 1: | ||
| raise NotImplementedError("Vertically adaptive meshes not implemented for from_netcdf()") | ||
| depth_filename = depth_filename[0] | ||
| depth_filename = depth_filename_lst[0] | ||
|
|
||
| netcdf_engine = kwargs.pop("netcdf_engine", "netcdf4") | ||
| gridindexingtype = kwargs.get("gridindexingtype", "nemo") |
There was a problem hiding this comment.
the *_lst additions are just to make mypy happy
|
|
||
|
|
||
| def _get_dim_filenames(filenames: T_SanitizedFilenames, dim: T_Dimensions) -> list[str]: | ||
| """Get's the relevant filenames for a given dimension.""" |
There was a problem hiding this comment.
Suggested change
| """Get's the relevant filenames for a given dimension.""" | |
| """Get the relevant filenames for a given dimension.""" |
Comment on lines
+2601
to
+2602
| 1. A sorted list of strings with the expanded glob expression | ||
| 2. A sorted list of strings with the expanded glob expressions |
There was a problem hiding this comment.
What's the difference between 1 and 2? Only whether there are multiple glob expressions?
There was a problem hiding this comment.
1 and 2 are the same. Just that in 1 the input was outside of a list. Perhaps it would be easier to illustrate these with examples actually rather than explain it here.
| files = [] | ||
| for f in filenames: | ||
| files.extend(_expand_filename(f)) | ||
| return sorted(files) |
There was a problem hiding this comment.
So does it mean we will always sort a list? What if users provide a non-sorted list by intention?
| 1. A sorted list of strings with the expanded glob expression | ||
| 2. A sorted list of strings with the expanded glob expressions | ||
| 3. A dictionary with same keys but values as in (1) or (2). | ||
|
|
There was a problem hiding this comment.
Also mention what the recursed flag does?
|
|
||
| See tests for examples. | ||
| """ | ||
| allowed_dimension_keys = ("lon", "lat", "depth", "data") |
There was a problem hiding this comment.
Should time not also be in this list?
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.
Changes:
filenamesfile object passed toField.from_netcdfmaking clear the data format (results inField.from_netcdfhaving support forPathobjects contributing to Codebase widePathobject support #1706)test_field.py