Use GMTParameteError for mutally exclusive parameters

Author: seisman

pygmt/src/grd2cpt.py

@@ -5,7 +5,7 @@
 import xarray as xr
 from pygmt._typing import PathLike
 from pygmt.clib import Session
-from pygmt.exceptions import GMTInvalidInput
+from pygmt.exceptions import GMTParameterError
 from pygmt.helpers import build_arg_list, fmt_docstring, kwargs_to_strings, use_alias
 
 __doctest_skip__ = ["grd2cpt"]
@@ -184,8 +184,7 @@ def grd2cpt(grid: PathLike | xr.DataArray, **kwargs):
     >>> fig.show()
     """
     if kwargs.get("W") is not None and kwargs.get("Ww") is not None:
-        msg = "Set only 'categorical' or 'cyclic' to True, not both."
-        raise GMTInvalidInput(msg)
+        raise GMTParameterError(exclusive={"categorical", "cyclic"})
 
     if (output := kwargs.pop("H", None)) is not None:
         kwargs["H"] = True

pygmt/src/grdfill.py

@@ -8,7 +8,7 @@
 import xarray as xr
 from pygmt._typing import PathLike
 from pygmt.clib import Session
-from pygmt.exceptions import GMTInvalidInput
+from pygmt.exceptions import GMTInvalidInput, GMTParameterError
 from pygmt.helpers import (
     build_arg_list,
     deprecate_parameter,
@@ -37,22 +37,22 @@ def _validate_params(
     >>> _validate_params(constantfill=20.0, gridfill="bggrid.nc")
     Traceback (most recent call last):
     ...
-    pygmt.exceptions.GMTInvalidInput: Parameters ... are mutually exclusive.
+    pygmt.exceptions.GMTParameterError: Mutually exclusive parameter...
     >>> _validate_params(constantfill=20.0, inquire=True)
     Traceback (most recent call last):
     ...
-    pygmt.exceptions.GMTInvalidInput: Parameters ... are mutually exclusive.
+    pygmt.exceptions.GMTParameterError: Mutually exclusive parameter...
     >>> _validate_params()
     Traceback (most recent call last):
     ...
     pygmt.exceptions.GMTInvalidInput: Need to specify parameter ...
     """
-    _fill_params = "'constantfill'/'gridfill'/'neighborfill'/'splinefill'"
+    _fill_params = {"constantfill", "gridfill", "neighborfill", "splinefill"}
     # The deprecated 'mode' parameter is given.
     if mode is not None:
         msg = (
             "The 'mode' parameter is deprecated since v0.15.0 and will be removed in "
-            f"v0.19.0. Use {_fill_params} instead."
+            f"v0.19.0. Use {', '.join(repr(par) for par in _fill_params)} instead."
         )
         warnings.warn(msg, FutureWarning, stacklevel=2)
 
@@ -61,8 +61,7 @@ def _validate_params(
         for param in [constantfill, gridfill, neighborfill, splinefill, inquire, mode]
     )
     if n_given > 1:  # More than one mutually exclusive parameter is given.
-        msg = f"Parameters {_fill_params}/'inquire'/'mode' are mutually exclusive."
-        raise GMTInvalidInput(msg)
+        raise GMTParameterError(exclusive=[*_fill_params, "inquire", "mode"])
     if n_given == 0:  # No parameters are given.
         msg = (
             f"Need to specify parameter {_fill_params} for filling holes or "

pygmt/src/grdtrack.py

@@ -292,8 +292,7 @@ def grdtrack(
     ... )
     """
     if points is not None and kwargs.get("E") is not None:
-        msg = "Can't set both 'points' and 'profile'."
-        raise GMTInvalidInput(msg)
+        raise GMTParameterError(exclusive=("points", "profile"))
 
     if points is None and kwargs.get("E") is None:
         msg = "Must give 'points' or set 'profile'."

pygmt/src/makecpt.py

@@ -3,7 +3,7 @@
 """
 
 from pygmt.clib import Session
-from pygmt.exceptions import GMTInvalidInput
+from pygmt.exceptions import GMTParameterError
 from pygmt.helpers import build_arg_list, fmt_docstring, kwargs_to_strings, use_alias
 
 
@@ -156,8 +156,7 @@ def makecpt(**kwargs):
         ``categorical=True``.
     """
     if kwargs.get("W") is not None and kwargs.get("Ww") is not None:
-        msg = "Set only categorical or cyclic to True, not both."
-        raise GMTInvalidInput(msg)
+        raise GMTParameterError(exclusive={"categorical", "cyclic"})
 
     if (output := kwargs.pop("H", None)) is not None:
         kwargs["H"] = True

pygmt/src/project.py

@@ -228,8 +228,7 @@ def project(
         msg = "The 'data' parameter must be specified unless 'generate' is used."
         raise GMTInvalidInput(msg)
     if kwargs.get("G") is not None and kwargs.get("F") is not None:
-        msg = "The 'convention' parameter is not allowed with 'generate'."
-        raise GMTInvalidInput(msg)
+        raise GMTParameterError(exclusive={"generate", "convention"})
 
     output_type = validate_output_table_type(output_type, outfile=outfile)
 

pygmt/src/subplot.py

@@ -5,7 +5,7 @@
 import contextlib
 
 from pygmt.clib import Session
-from pygmt.exceptions import GMTInvalidInput, GMTValueError
+from pygmt.exceptions import GMTParameterError, GMTValueError
 from pygmt.helpers import (
     build_arg_list,
     fmt_docstring,
@@ -156,8 +156,7 @@ def subplot(self, nrows=1, ncols=1, **kwargs):
         )
 
     if kwargs.get("Ff") and kwargs.get("Fs"):
-        msg = "Please provide either one of 'figsize' or 'subsize' only."
-        raise GMTInvalidInput(msg)
+        raise GMTParameterError(exclusive={"figsize", "subsize"})
 
     # Need to use separate sessions for "subplot begin" and "subplot end".
     # Otherwise, "subplot end" will use the last session, which may cause

pygmt/tests/test_grd2cpt.py

@@ -6,7 +6,7 @@
 
 import pytest
 from pygmt import Figure, grd2cpt
-from pygmt.exceptions import GMTInvalidInput, GMTTypeError, GMTValueError
+from pygmt.exceptions import GMTParameterError, GMTTypeError, GMTValueError
 from pygmt.helpers import GMTTempFile
 from pygmt.helpers.testing import load_static_earth_relief
 
@@ -70,5 +70,5 @@ def test_grd2cpt_categorical_and_cyclic(grid):
     """
     Use incorrect setting by setting both categorical and cyclic to True.
     """
-    with pytest.raises(GMTInvalidInput):
+    with pytest.raises(GMTParameterError):
         grd2cpt(grid=grid, cmap="batlow", categorical=True, cyclic=True)

pygmt/tests/test_grdfill.py

@@ -10,7 +10,7 @@
 import xarray as xr
 from pygmt import grdfill
 from pygmt.enums import GridRegistration, GridType
-from pygmt.exceptions import GMTInvalidInput
+from pygmt.exceptions import GMTInvalidInput, GMTParameterError
 from pygmt.helpers import GMTTempFile
 from pygmt.helpers.testing import load_static_earth_relief
 
@@ -136,7 +136,7 @@ def test_grdfill_inquire_and_fill(grid):
     """
     Test that grdfill fails if both inquire and fill parameters are given.
     """
-    with pytest.raises(GMTInvalidInput):
+    with pytest.raises(GMTParameterError):
         grdfill(grid=grid, inquire=True, constantfill=20)
 
 

pygmt/tests/test_grdtrack.py

@@ -170,5 +170,5 @@ def test_grdtrack_set_points_and_profile(dataarray, dataframe):
     """
     Run grdtrack but set both 'points' and 'profile'.
     """
-    with pytest.raises(GMTInvalidInput):
+    with pytest.raises(GMTParameterError):
         grdtrack(grid=dataarray, points=dataframe, profile="BL/TR")

pygmt/tests/test_makecpt.py

@@ -7,7 +7,7 @@
 import numpy as np
 import pytest
 from pygmt import Figure, makecpt
-from pygmt.exceptions import GMTInvalidInput, GMTValueError
+from pygmt.exceptions import GMTParameterError, GMTValueError
 from pygmt.helpers import GMTTempFile
 
 POINTS_DATA = Path(__file__).parent / "data" / "points.txt"
@@ -166,5 +166,5 @@ def test_makecpt_categorical_and_cyclic():
     """
     Use incorrect setting by setting both categorical and cyclic to True.
     """
-    with pytest.raises(GMTInvalidInput):
+    with pytest.raises(GMTParameterError):
         makecpt(cmap="batlow", categorical=True, cyclic=True)