Add new exception GMTValueError for invalid values #3985
Conversation
seisman
force-pushed
the
exception/valueerror
branch
2 times, most recently
from
ddf56de to
efa6715
Compare
seisman
changed the title
seisman
force-pushed
the
exception/valueerror
branch
15 times, most recently
from
340b235 to
8472d86
Compare
seisman
changed the title
seisman
force-pushed
the
exception/valueerror
branch
from
8472d86 to
a590758
Compare
There was a problem hiding this comment.
Thinking if this should be marked as a breaking change, because the exception type changes from GMTInvalidInput to GMTValueError, and code like try: ... except GMTInvalidInput: ... would break. But unsure if users even have code like that which matches on GMTInvalidInput.
Other than that, some minor suggestions/questions below.
| @@ -51,3 +54,57 @@ class GMTImageComparisonFailure(AssertionError): # noqa: N818 | |||
| """ | |||
| Raised when a comparison between two images fails. | |||
| """ | |||
|
|
|||
|
|
|||
| class GMTValueError(GMTError): | |||
There was a problem hiding this comment.
Should this be subclassed from both GMTError and ValueError?
pygmt/exceptions.py
Outdated
| Traceback (most recent call last): | ||
| ... | ||
| pygmt...GMTValueError: Invalid .... Explain why it's invalid. | ||
| """ |
There was a problem hiding this comment.
Include another test where the input to choices is an enum like GridRegistration or GridType?
| msg = ( | ||
| f"Invalid grid registration: '{value}'. Should be either " | ||
| "GridRegistration.GRIDLINE (0) or GridRegistration.PIXEL (1)." | ||
| raise GMTValueError( | ||
| value, description="grid registration", choices=GridRegistration |
There was a problem hiding this comment.
Highlighting this for the above comment, to check that enums like GridRegistration are formatted properly. I.e. the error should still print "GridRegistration.GRIDLINE (0) or GridRegistration.PIXEL (1)" per #3696 (comment)
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Add new exception GMTValueError. The error message will be like
Address #3984 and #3707.