GMTParameterError: Pass a list rather than a set to ensure parameter order do not change (#4390)

seisman · web-flow · commit 430c8342696d · 2026-02-06T15:21:28.000+08:00
diff --git a/pygmt/exceptions.py b/pygmt/exceptions.py
@@ -139,22 +139,22 @@ class GMTParameterError(GMTError):
     Parameters
     ----------
     required
-       Name or a set of names of required parameters.
+        Name or a collection of names of required parameters.
     at_least_one
-       A set of parameter names, of which at least one must be specified.
+        A collection of parameter names, of which at least one must be specified.
     at_most_one
-       A set of mutually exclusive parameter names, of which at most one can be
-       specified.
+        A collection of mutually exclusive parameter names, of which at most one can be
+        specified.
     reason
         Detailed reason why the parameters are invalid.
     """
 
     def __init__(
         self,
         *,
-        required: str | set[str] | None = None,
-        at_least_one: set[str] | None = None,
-        at_most_one: set[str] | None = None,
+        required: str | Iterable[str] | None = None,
+        at_least_one: Iterable[str] | None = None,
+        at_most_one: Iterable[str] | None = None,
         reason: str | None = None,
     ):
         msg = []
diff --git a/pygmt/helpers/decorators.py b/pygmt/helpers/decorators.py
@@ -550,7 +550,7 @@ def new_module(*args, **kwargs):
             for short_param, long_alias in aliases.items():
                 if long_alias in kwargs and short_param in kwargs:
                     raise GMTParameterError(
-                        at_most_one={long_alias, short_param},
+                        at_most_one=[long_alias, short_param],
                         reason=f"Long-form parameter {long_alias!r} is recommended.",
                     )
                 if long_alias in kwargs:
@@ -820,7 +820,7 @@ def new_module(*args, **kwargs):
             if oldname in kwargs:
                 if newname in kwargs:
                     raise GMTParameterError(
-                        at_most_one={newname, oldname},
+                        at_most_one=[newname, oldname],
                         reason=f"{oldname!r} is deprecated and {newname!r} is recommended.",
                     )
                 msg = (
diff --git a/pygmt/src/coast.py b/pygmt/src/coast.py
@@ -242,7 +242,7 @@ def coast(  # noqa: PLR0913
         and not args_in_kwargs(args=["C", "E", "Q"], kwargs=kwargs)
     ):
         raise GMTParameterError(
-            at_least_one={
+            at_least_one=[
                 "land",
                 "water",
                 "rivers",
@@ -251,7 +251,7 @@ def coast(  # noqa: PLR0913
                 "lakes",
                 "dcw",
                 "Q",
-            }
+            ]
         )
 
     aliasdict = AliasSystem(
diff --git a/pygmt/src/dimfilter.py b/pygmt/src/dimfilter.py
@@ -144,7 +144,7 @@ def dimfilter(
     ... )
     """
     if not all(arg in kwargs for arg in ["D", "F", "N"]) and "Q" not in kwargs:
-        raise GMTParameterError(at_least_one={"distance", "filters", "sectors"})
+        raise GMTParameterError(at_least_one=["distance", "filters", "sectors"])
 
     aliasdict = AliasSystem(
         I=Alias(spacing, name="spacing", sep="/", size=2),
diff --git a/pygmt/src/grd2cpt.py b/pygmt/src/grd2cpt.py
@@ -199,7 +199,7 @@ def grd2cpt(
     >>> fig.show()
     """
     if kwargs.get("W") is not None and kwargs.get("Ww") is not None:
-        raise GMTParameterError(at_most_one={"categorical", "cyclic"})
+        raise GMTParameterError(at_most_one=["categorical", "cyclic"])
 
     if (output := kwargs.pop("H", None)) is not None:
         kwargs["H"] = True
diff --git a/pygmt/src/grdclip.py b/pygmt/src/grdclip.py
@@ -110,7 +110,7 @@ def grdclip(
     [np.float32(0.0), np.float32(10000.0)]
     """
     if all(v is None for v in (above, below, between, replace)):
-        raise GMTParameterError(at_least_one={"above", "below", "between", "replace"})
+        raise GMTParameterError(at_least_one=["above", "below", "between", "replace"])
 
     aliasdict = AliasSystem(
         Sa=Alias(above, name="above", sep="/", size=2),
diff --git a/pygmt/src/grdgradient.py b/pygmt/src/grdgradient.py
@@ -240,7 +240,7 @@ def grdgradient(  # noqa: PLR0913
         and kwargs.get("D") is None
         and kwargs.get("E", radiance) is None
     ):
-        raise GMTParameterError(at_least_one={"azimuth", "direction", "radiance"})
+        raise GMTParameterError(at_least_one=["azimuth", "direction", "radiance"])
 
     aliasdict = AliasSystem(
         A=Alias(azimuth, name="azimuth", sep="/", size=2),
diff --git a/pygmt/src/grdlandmask.py b/pygmt/src/grdlandmask.py
@@ -119,7 +119,7 @@ def grdlandmask(
     >>> landmask = pygmt.grdlandmask(spacing=1, region=[125, 130, 30, 35])
     """
     if kwargs.get("I", spacing) is None or kwargs.get("R", region) is None:
-        raise GMTParameterError(required={"region", "spacing"})
+        raise GMTParameterError(required=["region", "spacing"])
 
     aliasdict = AliasSystem(
         D=Alias(
diff --git a/pygmt/src/grdproject.py b/pygmt/src/grdproject.py
@@ -121,7 +121,7 @@ def grdproject(  # noqa: PLR0913
         raise GMTParameterError(required="projection")
 
     if kwargs.get("M", unit) is not None and kwargs.get("F", scaling) is not False:
-        raise GMTParameterError(at_most_one={"unit", "scaling"})
+        raise GMTParameterError(at_most_one=["unit", "scaling"])
 
     aliasdict = AliasSystem(
         C=Alias(center, name="center", sep="/", size=2),
diff --git a/pygmt/src/grdsample.py b/pygmt/src/grdsample.py
@@ -101,7 +101,7 @@ def grdsample(
     >>> new_grid = pygmt.grdsample(grid=grid, toggle=True, spacing=[0.5, 0.5])
     """
     if kwargs.get("T", toggle) and kwargs.get("r", registration):
-        raise GMTParameterError(at_most_one={"toggle", "registration"})
+        raise GMTParameterError(at_most_one=["toggle", "registration"])
 
     aliasdict = AliasSystem(
         I=Alias(spacing, name="spacing", sep="/", size=2),
diff --git a/pygmt/src/grdtrack.py b/pygmt/src/grdtrack.py
@@ -299,10 +299,10 @@ def grdtrack(
     ... )
     """
     if points is not None and kwargs.get("E") is not None:
-        raise GMTParameterError(at_most_one={"points", "profile"})
+        raise GMTParameterError(at_most_one=["points", "profile"])
 
     if points is None and kwargs.get("E") is None:
-        raise GMTParameterError(at_least_one={"points", "profile"})
+        raise GMTParameterError(at_least_one=["points", "profile"])
 
     if hasattr(points, "columns") and newcolname is None:
         raise GMTParameterError(
diff --git a/pygmt/src/logo.py b/pygmt/src/logo.py
@@ -104,7 +104,7 @@ def logo(  # noqa: PLR0913
     )
 
     if width is not None and height is not None:
-        raise GMTParameterError(at_most_one={"width", "height"})
+        raise GMTParameterError(at_most_one=["width", "height"])
 
     aliasdict = AliasSystem(
         D=[
diff --git a/pygmt/src/makecpt.py b/pygmt/src/makecpt.py
@@ -169,7 +169,7 @@ def makecpt(
         ``categorical=True``.
     """
     if kwargs.get("W") is not None and kwargs.get("Ww") is not None:
-        raise GMTParameterError(at_most_one={"categorical", "cyclic"})
+        raise GMTParameterError(at_most_one=["categorical", "cyclic"])
 
     if (output := kwargs.pop("H", None)) is not None:
         kwargs["H"] = True
diff --git a/pygmt/src/plot.py b/pygmt/src/plot.py
@@ -272,7 +272,7 @@ def plot(  # noqa: PLR0912, PLR0913
             data["symbol"] = symbol
     else:
         if any(v is not None for v in (x, y)):
-            raise GMTParameterError(at_most_one={"data", "x/y/z"})
+            raise GMTParameterError(at_most_one=["data", "x/y/z"])
         for name, value in [
             ("direction", direction),
             ("fill", kwargs.get("G")),
diff --git a/pygmt/src/plot3d.py b/pygmt/src/plot3d.py
@@ -252,7 +252,7 @@ def plot3d(  # noqa: PLR0912, PLR0913
             data["symbol"] = symbol
     else:
         if any(v is not None for v in (x, y, z)):
-            raise GMTParameterError(at_most_one={"data", "x/y/z"})
+            raise GMTParameterError(at_most_one=["data", "x/y/z"])
 
         for name, value in [
             ("direction", direction),
diff --git a/pygmt/src/project.py b/pygmt/src/project.py
@@ -227,7 +227,7 @@ def project(  # noqa: PLR0913
             required="data", reason="Required unless 'generate' is set."
         )
     if kwargs.get("G") is not None and kwargs.get("F") is not None:
-        raise GMTParameterError(at_most_one={"convention", "generate"})
+        raise GMTParameterError(at_most_one=["convention", "generate"])
 
     output_type = validate_output_table_type(output_type, outfile=outfile)
 
diff --git a/pygmt/src/sphdistance.py b/pygmt/src/sphdistance.py
@@ -123,7 +123,7 @@ def sphdistance(
     ... )
     """
     if kwargs.get("I", spacing) is None or kwargs.get("R", region) is None:
-        raise GMTParameterError(required={"region", "spacing"})
+        raise GMTParameterError(required=["region", "spacing"])
 
     aliasdict = AliasSystem(
         I=Alias(spacing, name="spacing", sep="/", size=2),
diff --git a/pygmt/src/subplot.py b/pygmt/src/subplot.py
@@ -166,7 +166,7 @@ def subplot(
         )
 
     if kwargs.get("Ff") and kwargs.get("Fs"):
-        raise GMTParameterError(at_most_one={"figsize", "subsize"})
+        raise GMTParameterError(at_most_one=["figsize", "subsize"])
 
     aliasdict = AliasSystem(
         M=Alias(margins, name="margins", sep="/", size=(2, 4)),
diff --git a/pygmt/src/text.py b/pygmt/src/text.py
@@ -191,7 +191,7 @@ def text_(  # noqa: PLR0912, PLR0913
         + (position is not None)
         + (x is not None or y is not None)
     ) != 1:
-        raise GMTParameterError(at_most_one={"textfiles", "position/text", "x/y/text"})
+        raise GMTParameterError(at_most_one=["textfiles", "position/text", "x/y/text"])
 
     data_is_required = position is None
     kind = data_kind(textfiles, required=data_is_required)
@@ -208,7 +208,7 @@ def text_(  # noqa: PLR0912, PLR0913
             )
 
     if textfiles is not None and text is not None:
-        raise GMTParameterError(at_most_one={"text", "textfiles"})
+        raise GMTParameterError(at_most_one=["text", "textfiles"])
     if kind == "empty" and text is None:
         raise GMTParameterError(
             required="text", reason="Required when 'x' and 'y' are set."
diff --git a/pygmt/src/xyz2grd.py b/pygmt/src/xyz2grd.py
@@ -159,7 +159,7 @@ def xyz2grd(
     ... )
     """
     if kwargs.get("I", spacing) is None or kwargs.get("R", region) is None:
-        raise GMTParameterError(required={"region", "spacing"})
+        raise GMTParameterError(required=["region", "spacing"])
 
     aliasdict = AliasSystem(
         I=Alias(spacing, name="spacing", sep="/", size=2),
