pygmt.grdfill: Deprecate parameter 'mode' and add parameters 'constantfill/gridfill/neighborfill/splinefill' (deprecated since v0.15.0 and will be removed in v0.19.0) #3855
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
added
deprecation
Co-authored-by: Michael Grund <[email protected]>
Co-authored-by: Yvonne Fröhlich <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
This PR deprecates the legacy "mode" parameter in favor of more explicit fill parameters and adds tests to cover the updated behavior.
- Deprecate the "mode" parameter and warn/error when used with new parameters.
- Add new parameters (constantfill, gridfill, neighborfill, splinefill) to fill grid holes.
- Introduce additional tests for gridfill and the deprecated mode behavior.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| pygmt/tests/test_grdfill.py | Updated tests to use new parameters and added tests for gridfill and deprecated mode. |
| pygmt/src/grdfill.py | Refactored grdfill to use explicit fill parameters and introduced a helper to parse fill options. |
Comments suppressed due to low confidence (1)
pygmt/src/grdfill.py:142
- Consider increasing the stacklevel (e.g., to 2) in warnings.warn so that the deprecation warning correctly points to the user’s call site rather than the internal function call.
warnings.warn(
michaelgrund
approved these changes
Mar 20, 2025
yvonnefroehlich
approved these changes
Mar 21, 2025
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.
Address #3768 (comment).
Preview: https://pygmt-dev--3855.org.readthedocs.build/en/3855/api/generated/pygmt.grdfill.html#pygmt.grdfill
Changes in this PR:
modeparameter (will be removed in v0.19.0)constantfill/gridfill/neighborfill/splinefill, which are more Pythonic aliases for the grdfill -N option. With the new parameters, now it's possible to fill holes by sampling an xr.DataArray grid (via virtualfile)