Skip to content

BREAKING: Raise GMTParameterError exception for conflicts_with parameters. Previously raise GMTInvalidInput #4387

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 13 commits into
base: main
Choose a base branch
from
Open

BREAKING: Raise GMTParameterError exception for conflicts_with parameters. Previously raise GMTInvalidInput #4387

Chuan1937 wants to merge 13 commits into from

Conversation

@Chuan1937
Copy link
Contributor

@Chuan1937 Chuan1937 commented Feb 4, 2026 •
edited
Loading

Add GMTParameterError: conflicts_with

@seisman
This is the fourth 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}'
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 Feb 4, 2026
View reviewed changes
Chuan1937 and others added 4 commits February 4, 2026 17:21
@Chuan1937 @seisman
Update pygmt/src/_common.py
406eb7b 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937 @seisman
Update pygmt/src/_common.py
b28747d 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937 @seisman
Update pygmt/src/grdview.py
c15f3f3 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937
fix check
25bad04
@Chuan1937 Chuan1937 requested a review from seisman February 4, 2026 09:26
seisman
seisman reviewed Feb 4, 2026
View reviewed changes
seisman
seisman reviewed Feb 4, 2026
View reviewed changes
Chuan1937 and others added 3 commits February 4, 2026 17:36
@Chuan1937 @seisman
Update pygmt/src/grdview.py
7d9bd89 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937 @seisman
Update pygmt/src/_common.py
fc029ad 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937 @seisman
Update pygmt/src/_common.py
47f3e1e 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@seisman seisman added maintenance Boring but important stuff for the core devs final review call This PR requires final review and approval from a second reviewer labels Feb 4, 2026
@seisman seisman added this to the 0.19.0 milestone Feb 4, 2026
@seisman seisman self-requested a review February 4, 2026 09:43
@seisman
Copy link
Member

seisman commented Feb 4, 2026

Please also update pygmt/alias.py.

@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Feb 4, 2026
seisman
seisman reviewed Feb 4, 2026
View reviewed changes
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

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