GMTDataArrayAccessor: Support passing values using enums GridRegistration and GridType for grid registration and type #3696
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
seisman
force-pushed
the
enums/grid-reg-type
branch
from
170a15d to
fd099b0
Compare
seisman
commented
Dec 19, 2024
seisman
commented
Dec 19, 2024
Merged
7 tasks
seisman
changed the title
weiji14
reviewed
Feb 10, 2025
pygmt/accessors.py
Outdated
| f"Invalid grid registration value: {value}, should be either " | ||
| "0 for Gridline registration or 1 for Pixel registration." | ||
| f"Invalid grid registration: '{value}'. " | ||
| "Should be either GridRegistration.GRIDLINE or GridRegistration.PIXEL." |
There was a problem hiding this comment.
Should we still mention the integer value of the enum? E.g. have the error message be:
"Should be either GridRegistration.GRIDLINE (0) or GridRegistration.PIXEL (1)."
Thoughts?
| @@ -105,24 +135,24 @@ def test_accessor_grid_source_file_not_exist(): | |||
| Check that the accessor fallbacks to the default registration and gtype when the | |||
| grid source file (i.e., grid.encoding["source"]) doesn't exist. | |||
| """ | |||
| # Load the 05m earth relief grid, which is stored as tiles | |||
| # Load the 05m earth relief grid, which is stored as tiles. | |||
There was a problem hiding this comment.
Do comments need to end with a full stop now?
There was a problem hiding this comment.
That's just my preference, since it's a complete sentence.
There was a problem hiding this comment.
Ah ok, I was afraid that you were using some experimental ruff linter 😆!
seisman
commented
Feb 10, 2025
weiji14
approved these changes
Feb 10, 2025
seisman
added
final review call
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.
Description of proposed changes
This PR improves the
GMTDataArrayAccessorby allowing setting grid registration and gtype using more readable enums, rather than numeric values.Refer to #499 (comment) for the initial thoughts but implemented using
enumsas proposed in #499 (comment).This PR does a few things:
GridReg/GridType.GMTDataArrayAccessorto support passing enum values (e.g.,grid.gmt.registration=GridReg.PIXEL, notgrid.gmt.registration=1).assert grid.gmt.registration==GridReg.PIXEL, notassert grid.gmt.registration==1test_accessor.pyThe plan is to cherry-pick the commit 8c7f8f6 into a separate PR and keep the other commits in this PR, so that we can have two separate entries in the release changelog.[Done in #3693]Please note that:
grid.gmt.registration = "gridline") initially proposed in Make a gmt xarray accessor to store metadata from grdinfo #499 (comment) are not supported in this PR. It's simple to support string-type values, but I feel it's not necessary (see the reverted changes in 259771a).TODO:
GridReg/GridTypeto API docs [in Add enums GridRegistration and GridType for grid registration and type #3693]Preview: https://pygmt-dev--3696.org.readthedocs.build/en/3696/api/generated/pygmt.GMTDataArrayAccessor.html
Reminders
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.