POC: Implement the new alias system, general parameter classes and some refactors #3238
Conversation
This file contains hidden or 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
4 tasks
seisman
force-pushed
the
alias-system
branch
2 times, most recently
from
05dd80e to
87736a0
Compare
This was referenced Sep 25, 2024
seisman
added
run/benchmark
This was referenced Jul 10, 2025
github-project-automation
bot
moved this from In Progress
to Done
in Pythonic GMT arguments
seisman
added
enhancement
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.
See #3239 for the detailed context.
This PR implements the new alias system proposed in #3239. It also add some new features and refactor some wrappers to show how the new alias system will affect the current codes.
Here is a summary of changes in this PR:
pygmt/alias.py: Implement the new alias systempygmt/params/base.py: Implement theBaseParamclass as a base class for other parameter classespygmt/params/box.py: Implement theBoxclass, showing how to define new classes in a simple waypygmt/params/frame.py: Impement theFrameclass, showing that the current design works work for the most complicated GMT optionpygmt/src/basemap.py: Refactor so that you can try the newFrameparameter inFigure.basemappygmt/src/dimfilter.py: How the new alias system can affect grid-related modulespygmt/src/image.py: How the new alias system can replace the old alias systempygmt/src/logo.py: Refactor so that you can try theBoxclasspygmt/src/scalebar.py: Initial implementation of the high-level wrapper for adding a scale bar.pygmt/src/timestamp.py:Figure.timestampis one of the wrappers that don't use the alias system. Using the new alias system can simplify the code.pygmt/src/coast.py/pygmt/src/binstats.py: How to support long-form argumentsThis is just the initial implementation. So, some doctests and tests are still missing. We will break this PR into multiple smaller PRs and make the implementation more robust after people generally agree with the design of the new alias system.
Preview: