More fixes

Author: seisman

pygmt/datasets/load_remote_dataset.py

@@ -7,7 +7,7 @@
 from typing import Any, Literal, NamedTuple
 
 import xarray as xr
-from pygmt.exceptions import GMTInvalidInput, GMTValueError
+from pygmt.exceptions import GMTParameterError, GMTValueError
 
 with contextlib.suppress(ImportError):
     # rioxarray is needed to register the rio accessor
@@ -572,11 +572,13 @@ def _load_remote_dataset(
             reg = registration[0]
 
     if resinfo.tiled and region is None:
-        msg = (
-            f"The 'region' parameter is required for {dataset.description} "
-            f"resolution '{resolution}'."
+        raise GMTParameterError(
+            required=["region"],
+            reason=(
+                f"Parameter 'region' is required for {dataset.description} resolution "
+                f"{resolution!r} with tiled grids."
+            ),
         )
-        raise GMTInvalidInput(msg)
 
     fname = f"@{prefix}_{resolution}_{reg}"
     grid = xr.load_dataarray(

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, GMTParameterError
+from pygmt.exceptions import GMTParameterError
 from pygmt.helpers import (
     build_arg_list,
     deprecate_parameter,
@@ -45,7 +45,7 @@ def _validate_params(
     >>> _validate_params()
     Traceback (most recent call last):
     ...
-    pygmt.exceptions.GMTInvalidInput: Need to specify parameter ...
+    pygmt.exceptions.GMTParameterError: ...
     """
     _fill_params = {"constantfill", "gridfill", "neighborfill", "splinefill"}
     # The deprecated 'mode' parameter is given.
@@ -63,11 +63,13 @@ def _validate_params(
     if n_given > 1:  # More than one mutually exclusive parameter is given.
         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 "
-            "'inquire' for inquiring the bounds of each hole."
+        raise GMTParameterError(
+            required=_fill_params,
+            reason=(
+                f"Need to specify parameter {_fill_params!r} for filling holes or "
+                "'inquire' for inquiring the bounds of each hole."
+            ),
         )
-        raise GMTInvalidInput(msg)
 
 
 def _parse_fill_mode(

pygmt/src/grdgradient.py

@@ -5,7 +5,7 @@
 import xarray as xr
 from pygmt._typing import PathLike
 from pygmt.clib import Session
-from pygmt.exceptions import GMTInvalidInput, GMTParameterError
+from pygmt.exceptions import GMTParameterError
 from pygmt.helpers import (
     args_in_kwargs,
     build_arg_list,
@@ -162,8 +162,10 @@ def grdgradient(
     >>> new_grid = pygmt.grdgradient(grid=grid, azimuth=10)
     """
     if kwargs.get("Q") is not None and kwargs.get("N") is None:
-        msg = "Must specify normalize if tiles is specified."
-        raise GMTInvalidInput(msg)
+        raise GMTParameterError(
+            required=["normalize"],
+            reason="Must specify 'normalize' if 'tiles' is specified.",
+        )
     if not args_in_kwargs(args=["A", "D", "E"], kwargs=kwargs):
         raise GMTParameterError(require_any={"azimuth", "direction", "radiance"})
 

pygmt/src/grdimage.py

@@ -5,7 +5,6 @@
 import xarray as xr
 from pygmt._typing import PathLike
 from pygmt.clib import Session
-from pygmt.exceptions import GMTInvalidInput
 from pygmt.helpers import (
     build_arg_list,
     fmt_docstring,
@@ -164,7 +163,7 @@ def grdimage(self, grid: PathLike | xr.DataArray, **kwargs):
             "Parameter 'img_out'/'A' is not implemented. "
             "Please consider submitting a feature request to us."
         )
-        raise GMTInvalidInput(msg)
+        raise NotImplementedError(msg)
 
     with Session() as lib:
         with (

pygmt/src/project.py

@@ -8,7 +8,7 @@
 import pandas as pd
 from pygmt._typing import PathLike, TableLike
 from pygmt.clib import Session
-from pygmt.exceptions import GMTInvalidInput, GMTParameterError
+from pygmt.exceptions import GMTParameterError
 from pygmt.helpers import (
     build_arg_list,
     fmt_docstring,
@@ -225,8 +225,10 @@ def project(
     if kwargs.get("C") is None:
         raise GMTParameterError(required={"center"})
     if kwargs.get("G") is None and data is None:
-        msg = "The 'data' parameter must be specified unless 'generate' is used."
-        raise GMTInvalidInput(msg)
+        raise GMTParameterError(
+            required={"data"},
+            reason="Parameter 'data' must be specified unless 'generate' is used.",
+        )
     if kwargs.get("G") is not None and kwargs.get("F") is not None:
         raise GMTParameterError(exclusive={"generate", "convention"})
 

pygmt/tests/test_datasets_load_remote_datasets.py

@@ -5,7 +5,7 @@
 import pytest
 from pygmt.datasets.load_remote_dataset import _load_remote_dataset
 from pygmt.enums import GridRegistration
-from pygmt.exceptions import GMTInvalidInput, GMTValueError
+from pygmt.exceptions import GMTParameterError, GMTValueError
 
 
 def load_remote_dataset_wrapper(resolution="01d", region=None, registration=None):
@@ -61,7 +61,7 @@ def test_load_remote_dataset_tiled_grid_without_region():
     Make sure _load_remote_dataset fails when trying to load a tiled grid without
     specifying a region.
     """
-    with pytest.raises(GMTInvalidInput):
+    with pytest.raises(GMTParameterError):
         load_remote_dataset_wrapper(resolution="01m")
 
 

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, GMTParameterError
+from pygmt.exceptions import GMTParameterError
 from pygmt.helpers import GMTTempFile
 from pygmt.helpers.testing import load_static_earth_relief
 
@@ -128,7 +128,7 @@ def test_grdfill_required_args(grid):
     """
     Test that grdfill fails without filling parameters or 'inquire'.
     """
-    with pytest.raises(GMTInvalidInput):
+    with pytest.raises(GMTParameterError):
         grdfill(grid=grid)
 
 

pygmt/tests/test_grdgradient.py

@@ -8,7 +8,7 @@
 import xarray as xr
 from pygmt import grdgradient
 from pygmt.enums import GridRegistration, GridType
-from pygmt.exceptions import GMTInvalidInput, GMTParameterError
+from pygmt.exceptions import GMTParameterError
 from pygmt.helpers import GMTTempFile
 from pygmt.helpers.testing import load_static_earth_relief
 
@@ -82,6 +82,6 @@ def test_grdgradient_fails(grid):
     """
     with pytest.raises(GMTParameterError):
         grdgradient(grid=grid)  # fails without required arguments
-    with pytest.raises(GMTInvalidInput):
+    with pytest.raises(GMTParameterError):
         # fails when tiles is specified but not normalize
         grdgradient(grid=grid, azimuth=10, direction="c", tiles="c")

pygmt/tests/test_grdimage.py

@@ -10,7 +10,7 @@
 from pygmt.clib import __gmt_version__
 from pygmt.datasets import load_earth_relief
 from pygmt.enums import GridRegistration, GridType
-from pygmt.exceptions import GMTInvalidInput, GMTTypeError
+from pygmt.exceptions import GMTTypeError
 from pygmt.helpers.testing import check_figures_equal
 
 
@@ -252,9 +252,9 @@ def test_grdimage_imgout_fails(grid):
     Test that an exception is raised if img_out/A is given.
     """
     fig = Figure()
-    with pytest.raises(GMTInvalidInput):
+    with pytest.raises(NotImplementedError):
         fig.grdimage(grid, img_out="out.png")
-    with pytest.raises(GMTInvalidInput):
+    with pytest.raises(NotImplementedError):
         fig.grdimage(grid, A="out.png")
 
 

pygmt/tests/test_grdtrack.py

@@ -9,7 +9,7 @@
 import pandas as pd
 import pytest
 from pygmt import grdtrack
-from pygmt.exceptions import GMTInvalidInput, GMTParameterError, GMTTypeError
+from pygmt.exceptions import GMTParameterError, GMTTypeError
 from pygmt.helpers import GMTTempFile
 from pygmt.helpers.testing import load_static_earth_relief
 
@@ -154,7 +154,7 @@ def test_grdtrack_without_outfile_setting(dataarray, dataframe):
     """
     Run grdtrack by not passing in outfile parameter setting.
     """
-    with pytest.raises(GMTInvalidInput):
+    with pytest.raises(GMTParameterError):
         grdtrack(points=dataframe, grid=dataarray)