BREAKING: Raise GMTParameterError exception for missing required parameters. Previously raise GMTInvalidInput by Chuan1937 · Pull Request #4374 · GenericMappingTools/pygmt

Chuan1937 · 2026-01-28T09:48:27Z

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}'`

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

… input update source files to support the new feature

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

…ram, inset, magnetic_rose, project

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

seisman · 2026-01-30T01:45:58Z

Please update failing tests related to the changes.

Chuan1937 added 2 commits January 28, 2026 17:46

Add GMTParameterError and deprecate GMTInvalidInput
8fe6a13

fix format
737defa

seisman reviewed Jan 28, 2026
View reviewed changes

Comment threadpygmt/exceptions.py Outdated

seisman reviewed Jan 28, 2026
View reviewed changes

Comment threadpygmt/exceptions.py Outdated

focus on required parameters
ae59d2f

Chuan1937 requested a review from seisman January 28, 2026 10:27

seisman reviewed Jan 28, 2026
View reviewed changes

Comment threadpygmt/exceptions.py Outdated

Update pygmt/exceptions.py
73b9c42
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

seisman reviewed Jan 28, 2026
View reviewed changes

Comment threadpygmt/exceptions.py Outdated
Comment threadpygmt/exceptions.py Outdated
Comment threadpygmt/exceptions.py Outdated

seisman marked this pull request as draft January 28, 2026 11:06

add support for single parameter: string input, list input, and tuple…
8a778e4
… input update source files to support the new feature

Chuan1937 requested a review from seisman January 28, 2026 11:37

Chuan1937 changed the title ~~Add GMTParameterError and deprecate GMTInvalidInput~~Add GMTParameterError and update source filesJan 28, 2026

Chuan1937 added 3 commits January 28, 2026 20:18

fix doctest and check GMTParameterError
db5d047

Merge branch 'main' into add-gmt-parameter-error
a2e65c1

Merge branch 'main' into add-gmt-parameter-error
a5743fd

seisman reviewed Jan 29, 2026
View reviewed changes

Comment threaddoc/api/index.rst Outdated

seisman reviewed Jan 29, 2026
View reviewed changes

Comment threadpygmt/exceptions.py Outdated

Xingchen Heand others added 2 commits January 29, 2026 12:25

Update pygmt/exceptions.py
c5d26b2
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

sort all the exceptions alphabetically
c6c4b7f

Chuan1937 requested a review from seisman January 29, 2026 04:50

seisman reviewed Jan 29, 2026
View reviewed changes

Comment threadpygmt/exceptions.py Outdated

seisman added the needs review This PR has higher priority and needs review. label Jan 29, 2026

seisman reviewed Jan 29, 2026
View reviewed changes

Comment threadpygmt/helpers/validators.py Outdated
Comment threadpygmt/params/box.py Outdated
Comment threadpygmt/src/text.py Outdated

Xingchen Heand others added 5 commits January 29, 2026 20:58

Update pygmt/exceptions.py
f9ffe43
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Update pygmt/helpers/validators.py
3904c56
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Update pygmt/params/box.py
b08f26a
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Update pygmt/src/text.py
18975aa
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Merge branch 'main' into add-gmt-parameter-error
0c8e4dc

Chuan1937 requested a review from seisman January 29, 2026 12:59

seisman added this to the 0.19.0 milestone Jan 29, 2026

seisman changed the title ~~Add GMTParameterError and update source files~~BREAKING: Raise GMTParameterError exception for missing required paramters. Previously raise GMTInvalidInputJan 29, 2026

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 GMTInvalidInputJan 29, 2026

seisman added the enhancement Improving an existing feature label Jan 29, 2026

seisman reviewed Jan 29, 2026
View reviewed changes

Comment threadpygmt/src/text.py Outdated

Xingchen Heand others added 5 commits January 30, 2026 09:03

Update pygmt/src/project.py
7b3e955
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Update pygmt/src/velo.py
99c6b04
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Update pygmt/src/text.py
40942f0
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Merge branch 'main' into add-gmt-parameter-error
94e8985

update GMTParameterError for load_remote_dataset, grdgradient, histog…
9ceec08
…ram, inset, magnetic_rose, project

seisman reviewed Jan 30, 2026
View reviewed changes

Comment threadpygmt/datasets/load_remote_dataset.py Outdated
Comment threadpygmt/src/grdgradient.py Outdated
Comment threadpygmt/src/inset.py Outdated

Xingchen Heand others added 3 commits January 30, 2026 09:27

Update pygmt/datasets/load_remote_dataset.py
784c5cd
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Update pygmt/src/grdgradient.py
04c8a8d
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Update pygmt/src/inset.py
9981c91
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

fix test check for GMTParameterError
fba11bd

Chuan1937 requested a review from seisman January 30, 2026 02:21

seisman added maintenance Boring but important stuff for the core devs and removed enhancement Improving an existing feature labels Jan 30, 2026

seisman marked this pull request as ready for review January 30, 2026 02:46

seisman approved these changes Jan 30, 2026
View reviewed changes

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 requested a review from a teamJanuary 30, 2026 02:49

seisman approved these changes Jan 31, 2026
View reviewed changes

seisman merged commit b0f364d into GenericMappingTools:mainJan 31, 2026
27 of 28 checks passed

seisman removed the final review call This PR requires final review and approval from a second reviewer label Jan 31, 2026

Chuan1937 deleted the add-gmt-parameter-error branch January 31, 2026 12:24

This was referenced Feb 6, 2026
GMTParameterError: Pass a list rather than a set to ensure parameter order do not change #4390
Merged
Add new exceptions for invalid inputs and deprecate GMTInvalidInput exception #3707
Open

Navigation Menu

Uh oh!

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

BREAKING: Raise GMTParameterError exception for missing required parameters. Previously raise GMTInvalidInput#4374
seisman merged 30 commits into
GenericMappingTools:mainfrom
Chuan1937:add-gmt-parameter-error

Chuan1937 commented Jan 28, 2026•
edited
Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

seisman commented Jan 30, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

Chuan1937 commented Jan 28, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

seisman commented Jan 30, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Chuan1937 commented Jan 28, 2026•
edited
Loading