Merge branch 'main' into AliasSystem/projection

Author: seisman

pygmt/src/grdimage.py

@@ -6,13 +6,7 @@
 from pygmt._typing import PathLike
 from pygmt.alias import AliasSystem
 from pygmt.clib import Session
-from pygmt.exceptions import GMTInvalidInput
-from pygmt.helpers import (
-    build_arg_list,
-    fmt_docstring,
-    kwargs_to_strings,
-    use_alias,
-)
+from pygmt.helpers import build_arg_list, fmt_docstring, kwargs_to_strings, use_alias
 
 __doctest_skip__ = ["grdimage"]
 
@@ -171,7 +165,7 @@ def grdimage(
             "Parameter 'img_out'/'A' is not implemented. "
             "Please consider submitting a feature request to us."
         )
-        raise GMTInvalidInput(msg)
+        raise NotImplementedError(msg)
 
     aliasdict = AliasSystem().add_common(
         J=projection,

pygmt/tests/test_alias_system.py

@@ -15,6 +15,7 @@ def func(
     label=None,
     text=None,
     offset=None,
+    panel=False,
     **kwargs,
 ):
     """
@@ -30,6 +31,7 @@ def func(
         ],
     ).add_common(
         J=projection,
+        c=panel,
     )
     aliasdict.merge(kwargs)
     return build_arg_list(aliasdict)
@@ -97,3 +99,14 @@ def test_alias_system_multiple_aliases_short_form():
 
     with pytest.raises(GMTInvalidInput, match=msg):
         func(text="efg", U="efg")
+
+
+def test_alias_system_common_parameter_panel():
+    """
+    Test that the alias system works with the panel parameter.
+    """
+    assert func(panel=True) == ["-c"]
+    assert func(panel=False) == []
+    assert func(panel=(1, 2)) == ["-c1,2"]
+    assert func(panel=1) == ["-c1"]
+    assert func(panel="1,2") == ["-c1,2"]

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")