Figure.coast/pygmt.select/pygmt.grdlandmask: Use long names ("crude"/"low"/"intermediate"/"high"/"full") for the 'resolution' parameter by seisman · Pull Request #3013 · GenericMappingTools/pygmt

seisman · 2024-01-18T08:47:37Z

This PR updates the resolution parameter for Figure.coast/pygmt.select/pygmt.grdlandmask to use long names.

…ll") for the 'resolution' parameter

codspeed-hq · 2024-10-30T01:37:24Z

CodSpeed Performance Report

Merging #3013 will not alter performance

_{Comparing coast/resolution (50f6406) with main (438edce)}

Summary

✅ 104 untouched benchmarks

seisman · 2024-10-30T02:09:05Z

Ping @GenericMappingTools/pygmt-maintainers for thoughts on the proposed changes towards more Pythonic arguments.

seisman · 2024-10-30T11:21:35Z

Actually, this PR is not needed if PR #3238 is implemented.

seisman · 2025-05-24T06:25:10Z

Actually, this PR is not needed if PR #3238 is implemented.

It's likely PR #3238 will take months to implement, so I feel it's better to have this PR merged before that PR>

weiji14 · 2025-05-24T08:08:58Z

+def _parse_coastline_resolution(
+ resolution: Literal["auto", "full", "high", "intermediate", "low", "crude", None],
+) -> Literal["a", "f", "h", "i", "l", "c", None]:


Thoughts on making a StrEnum out of this?

What are the benefits? This private function will likely be removed after #3239 is implemented.

GMT uses short-form arguments, but we prefer long-form arguments in PyGMT. Another example is in #3012. It will be a lot of work if we define StrEnum for all these cases. #3239 proposed a more general solution for it.

Yeah, StrEnum will be a lot more work, and we'll need to bring in something like pydantic (mentioned at #3239 (comment)) to fully enable runtime checks. Ok to keep this as is for now, and wait for #3239.

seisman · 2025-05-25T09:12:10Z

+ kwargs["D"] = kwargs.get("D", _parse_coastline_resolution(resolution))
+


The simplest form of this line is:
kwargs["D"] = _parse_coastline_resolution(resolution)
but to support short-form parameters like D="f", we have to write the code like:
kwargs["D"] = kwargs.get("D", _parse_coastline_resolution(resolution))
The D="resolution" line is also removed from the use_alias decorator. Otherwise, we have to write codes like below:
kwargs["D"] = _parse_coastline_resolution(kwgars.get("D"))
It's fine, but then ruff will complain that the resolution parameter is unused.

seisman · 2025-05-25T11:00:32Z

 A="area_thresh",
 B="frame",
 C="lakes",
- D="resolution",


After removing D="resolution", this alias won't be shown in the alias list. Need to wait for #3945.

seisman force-pushed the coast/resolution branch from e4ea5a1 to d9af3e0Compare April 23, 2024 06:58

seisman mentioned this pull request May 10, 2024
New alias system towards a more Pythonic interface #3239
Closed
4 tasks

seisman force-pushed the coast/resolution branch from d9af3e0 to 88be372Compare July 21, 2024 09:53

seisman changed the title ~~POC: coast: Make the 'resolution' parameter more Pythonic~~Figure.coast: Use long names ("crude"/"low"/"intermediate"/"high"/"full") for the 'resolution' parameterJul 21, 2024

seisman changed the title ~~Figure.coast: Use long names ("crude"/"low"/"intermediate"/"high"/"full") for the 'resolution' parameter~~Figure.coast/pygmt.select/pygmt.grdlandmask: Use long names ("crude"/"low"/"intermediate"/"high"/"full") for the 'resolution' parameterJul 22, 2024

seisman force-pushed the coast/resolution branch from b493d81 to 6840b39Compare September 29, 2024 10:49

seisman added 3 commits October 29, 2024 12:46

Figure.coast: Use long names ("crude"/"low"/"intermediate"/"high"/"fu…
44f983f
…ll") for the 'resolution' parameter

Also improve select and grdlandmask
4fae745

Remove the old aliases
5fac3ae

seisman force-pushed the coast/resolution branch from 6840b39 to 5fac3aeCompare October 29, 2024 04:47

Move the parser function into _common.py
5e1ebe8

seisman force-pushed the coast/resolution branch from fdf817e to 5e1ebe8Compare October 29, 2024 05:02

seisman added 3 commits October 29, 2024 13:10

Fix grdlandmask and improve docstrings
2cbe6c9

Fix doctests
e24bbd8

Merge branch 'main' into coast/resolution
1267a9c

seisman marked this pull request as ready for review October 30, 2024 01:23

seisman added needs review This PR has higher priority and needs review. run/benchmark Trigger the benchmark workflow in PRs enhancement Improving an existing feature labels Oct 30, 2024

seisman commented Oct 30, 2024
View reviewed changes

Comment threadpygmt/src/select.py Outdated
Comment threadpygmt/src/grdlandmask.py
Comment threadpygmt/src/coast.py

seisman self-assigned this Oct 30, 2024

seisman removed the needs review This PR has higher priority and needs review. label Oct 30, 2024

seisman marked this pull request as draft October 30, 2024 11:21

seisman added 4 commits May 24, 2025 12:48

Merge branch 'main' into coast/resolution
aaeb5f4

Reorder functions
af1fb75

Refactor function
c4b9692

Actually, auto is always supported
4c64859

seisman added 2 commits May 24, 2025 14:17

Fix _parse_coastline_resolution
8a57f61

Fix typing issue
5f6d3a1

seisman added this to the 0.16.0 milestone May 24, 2025

seisman added the needs review This PR has higher priority and needs review. label May 24, 2025

seisman marked this pull request as ready for review May 24, 2025 06:23

weiji14 reviewed May 24, 2025
View reviewed changes

Merge branch 'main' into coast/resolution
39987aa

seisman commented May 25, 2025
View reviewed changes

Merge branch 'main' into coast/resolution
ba50993

weiji14 approved these changes Jun 3, 2025
View reviewed changes

Merge branch 'main' into coast/resolution
50f6406

seisman merged commit 06dd1a5 into mainJun 3, 2025

seisman deleted the coast/resolution branch June 3, 2025 04:59

seisman removed needs review This PR has higher priority and needs review. run/benchmark Trigger the benchmark workflow in PRs labels Jun 3, 2025

seisman mentioned this pull request Jul 30, 2025
Figure.coast/pygmt.grdlandmask/pygmt.select: Refactor to use the new alias system for parameter 'resolution' #4013
Merged

Navigation Menu

Uh oh!

Figure.coast/pygmt.select/pygmt.grdlandmask: Use long names ("crude"/"low"/"intermediate"/"high"/"full") for the 'resolution' parameter - #3013

Figure.coast/pygmt.select/pygmt.grdlandmask: Use long names ("crude"/"low"/"intermediate"/"high"/"full") for the 'resolution' parameter#3013
seisman merged 16 commits into
mainfrom
coast/resolution

seisman commented Jan 18, 2024•
edited
Loading

Uh oh!

codspeed-hqBot commented Oct 30, 2024•
edited
Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

seisman commented Oct 30, 2024•
edited
Loading

Uh oh!

seisman commented Oct 30, 2024

Uh oh!

seisman commented May 24, 2025

Uh oh!

weiji14May 24, 2025

Uh oh!

seismanMay 24, 2025

Uh oh!

seismanMay 25, 2025

Uh oh!

weiji14Jun 3, 2025

Uh oh!

seismanMay 25, 2025•
edited
Loading

Uh oh!

seismanMay 25, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		kwargs["D"] = kwargs.get("D", _parse_coastline_resolution(resolution))

Uh oh!

Conversation

seisman commented Jan 18, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codspeed-hqBot commented Oct 30, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #3013 will not alter performance

Summary

Uh oh!

Uh oh!

Uh oh!

Uh oh!

seisman commented Oct 30, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

seisman commented Oct 30, 2024

Uh oh!

seisman commented May 24, 2025

Uh oh!

weiji14May 24, 2025

Choose a reason for hiding this comment

Uh oh!

seismanMay 24, 2025

Choose a reason for hiding this comment

Uh oh!

seismanMay 25, 2025

Choose a reason for hiding this comment

Uh oh!

weiji14Jun 3, 2025

Choose a reason for hiding this comment

Uh oh!

seismanMay 25, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

seismanMay 25, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

seisman commented Jan 18, 2024•
edited
Loading

codspeed-hqBot commented Oct 30, 2024•
edited
Loading

seisman commented Oct 30, 2024•
edited
Loading

seismanMay 25, 2025•
edited
Loading