Skip to content

BREAKING: Raise GMTParameterError exception for missing required parameters. Previously raise GMTInvalidInput #4374

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
Chuan1937 wants to merge 30 commits into
base: main
Choose a base branch
from
Open

BREAKING: Raise GMTParameterError exception for missing required parameters. Previously raise GMTInvalidInput #4374

Chuan1937 wants to merge 30 commits into from
+144 −100

Conversation

@Chuan1937
Copy link
Contributor

@Chuan1937 Chuan1937 commented Jan 28, 2026 •
edited
Loading

Add GMTParameterError and deprecate GMTInvalidInput.

@seisman
This is the first PR of #4003

Error types Preferred Parameter Name Alternative Parameter Names Error Message Template
Required required must_have, needed Missing required parameter: '{param}'
Missing required parameters: '{a}', '{b}'
At least one is required at_least_one need_one_of, , , any_of``one_of``required_any Missing required parameters: '{a}', '{b}', '{c}'. Must specify at least one.
Must specify at least one of the parameters: '{a}', '{b}', '{c}'
Exactly one is required exactly_one mutually_exclusive Mutually exclusive parameters: '{a}', '{b}', '{c}'. Specify exactly one.
At most one at_most_one mutually_exclusive Mutually exclusive parameters: '{a}', '{b}', '{c}'. Specify at most one
Conflicting conflicts_with conflicts, incompatible_with Conflicting parameters: '{a}' cannot be used with '{b}', '{c}'

seisman
seisman reviewed Jan 28, 2026
View reviewed changes
seisman
seisman reviewed Jan 28, 2026
View reviewed changes
@Chuan1937 Chuan1937 requested a review from seisman January 28, 2026 10:27
seisman
seisman reviewed Jan 28, 2026
View reviewed changes
@Chuan1937 @seisman
Update pygmt/exceptions.py
73b9c42 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
seisman
seisman reviewed Jan 28, 2026
View reviewed changes
@seisman seisman marked this pull request as draft January 28, 2026 11:06
@Chuan1937
add support for single parameter: string input, list input, and tuple…
8a778e4 
… input

update source files to support the new feature
@Chuan1937 Chuan1937 requested a review from seisman January 28, 2026 11:37
@Chuan1937 Chuan1937 changed the title Add GMTParameterError and deprecate GMTInvalidInput Add GMTParameterError and update source files Jan 28, 2026
seisman
seisman reviewed Jan 29, 2026
View reviewed changes
seisman
seisman reviewed Jan 29, 2026
View reviewed changes
Chuan1937 and others added 2 commits January 29, 2026 12:25
@Chuan1937 @seisman
Update pygmt/exceptions.py
c5d26b2 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937
sort all the exceptions alphabetically
c6c4b7f
@Chuan1937 Chuan1937 requested a review from seisman January 29, 2026 04:50
seisman
seisman reviewed Jan 29, 2026
View reviewed changes
@seisman seisman added the needs review This PR has higher priority and needs review. label Jan 29, 2026
seisman
seisman reviewed Jan 29, 2026
View reviewed changes
Chuan1937 and others added 5 commits January 29, 2026 20:58
@Chuan1937 @seisman
Update pygmt/exceptions.py
f9ffe43 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937 @seisman
Update pygmt/helpers/validators.py
3904c56 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937 @seisman
Update pygmt/params/box.py
b08f26a 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937 @seisman
Update pygmt/src/text.py
18975aa 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937
Merge branch 'main' into add-gmt-parameter-error
0c8e4dc
@Chuan1937 Chuan1937 requested a review from seisman January 29, 2026 12:59
@seisman
Copy link
Member

seisman commented Jan 29, 2026

Still need to update: filter1d, grdgradient, grdlandmask, grdproject, histogram, inset, magnetic_rose, meca, project, sphdistance, Line 216 in text, velo, xyz2grd,

@Chuan1937
change GMTInvalidInput to GMTParameterError in filter1d, grdlandmask,…
ab642f9 
… grdproject, meca, project, sphdistance, text, velo, xyz2grd
@Chuan1937
Copy link
Contributor Author

Chuan1937 commented Jan 29, 2026

grdgradient,histogram,magnetic_rose,inset don't need to change.

seisman
seisman reviewed Jan 29, 2026
View reviewed changes
@seisman
Copy link
Member

seisman commented Jan 29, 2026 •
edited
Loading

  • grdgradient: Line 168
  • histogram: Line 167
  • magnetic_rose: Line 115
  • inset: Line 143
  • datasets/load_remote_dataset.py: Line 571

@seisman seisman added this to the 0.19.0 milestone Jan 29, 2026
@seisman seisman changed the title Add GMTParameterError and update source files BREAKING: Raise GMTParameterError exception for missing required paramters. Previously raise GMTInvalidInput Jan 29, 2026
@seisman seisman changed the title BREAKING: Raise GMTParameterError exception for missing required paramters. Previously raise GMTInvalidInput BREAKING: Raise GMTParameterError exception for missing required parameters. Previously raise GMTInvalidInput Jan 29, 2026
@seisman seisman added the enhancement Improving an existing feature label Jan 29, 2026
seisman
seisman reviewed Jan 29, 2026
View reviewed changes
Chuan1937 and others added 5 commits January 30, 2026 09:03
@Chuan1937 @seisman
Update pygmt/src/project.py
7b3e955 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937 @seisman
Update pygmt/src/velo.py
99c6b04 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937 @seisman
Update pygmt/src/text.py
40942f0 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937
Merge branch 'main' into add-gmt-parameter-error
94e8985
@Chuan1937
update GMTParameterError for load_remote_dataset, grdgradient, histog…
9ceec08 
…ram, inset, magnetic_rose, project
seisman
seisman reviewed Jan 30, 2026
View reviewed changes
Chuan1937 and others added 3 commits January 30, 2026 09:27
@Chuan1937 @seisman
Update pygmt/datasets/load_remote_dataset.py
784c5cd 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937 @seisman
Update pygmt/src/grdgradient.py
04c8a8d 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937 @seisman
Update pygmt/src/inset.py
9981c91 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@seisman
Copy link
Member

seisman commented Jan 30, 2026

Please update failing tests related to the changes.

@Chuan1937 Chuan1937 requested a review from seisman January 30, 2026 02:21
@seisman seisman added maintenance Boring but important stuff for the core devs and removed enhancement Improving an existing feature labels Jan 30, 2026
@seisman seisman marked this pull request as ready for review January 30, 2026 02:46
@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Jan 30, 2026
@seisman seisman requested a review from a team January 30, 2026 02:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@seisman seisman seisman approved these changes

Assignees

No one assigned

Labels

final review call This PR requires final review and approval from a second reviewer maintenance Boring but important stuff for the core devs

Projects

None yet

Milestone

0.19.0

Development

Successfully merging this pull request may close these issues.

2 participants

@Chuan1937 @seisman