Implement a general BaseParams class for complex options

Author: seisman

pygmt/params.py

@@ -0,0 +1,54 @@
+from __future__ import annotations
+
+from collections.abc import Iterable, Sequence
+from dataclasses import dataclass
+from typing import NamedTuple
+
+
+class Alias(NamedTuple):
+    name: str
+    modifier: str
+    separator: str | None = None
+
+
+class BaseParams:
+    def __str__(self):
+        values = []
+        for alias in self.aliases:
+            value = getattr(self, alias.name)
+            if value in (None, False):
+                continue
+            if value is True:
+                value = ""
+            if isinstance(value, Iterable) and not isinstance(value, str):
+                value = alias.separator.join(map(str, value))
+            values.append(f"{alias.modifier}{value}")
+        return "".join(values)
+
+    def __repr__(self):
+        string = []
+        for alias in self.aliases:
+            value = getattr(self, alias.name)
+            if value is None or value is False:
+                continue
+            string.append(f"{alias.name}={value!r}")
+        return f"{self.__class__.__name__}({', '.join(string)})"
+
+
+@dataclass(repr=False)
+class Box(BaseParams):
+    clearance: float | str | Sequence[float | str] | None = None
+    fill: str | None = None
+    innerborder: str | Sequence | None = None
+    pen: str | None = None
+    radius: float | bool | None = False
+    shading: str | Sequence | None = None
+
+    aliases = [
+        Alias("clearance", "+c", "/"),
+        Alias("fill", "+g"),
+        Alias("innerborder", "+i", "/"),
+        Alias("pen", "+p"),
+        Alias("radius", "+r"),
+        Alias("shading", "+s", "/"),
+    ]

pygmt/src/logo.py

@@ -1,6 +1,12 @@
 """
 logo - Plot the GMT logo
 """
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from pygmt.params import Box
 
 from pygmt.clib import Session
 from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias
@@ -18,7 +24,7 @@
     t="transparency",
 )
 @kwargs_to_strings(R="sequence", c="sequence_comma", p="sequence")
-def logo(self, **kwargs):
+def logo(self, box: bool | Box = False, **kwargs):
     r"""
     Plot the GMT logo.
 
@@ -39,7 +45,7 @@ def logo(self, **kwargs):
         [**g**\|\ **j**\|\ **J**\|\ **n**\|\ **x**]\ *refpoint*\
         **+w**\ *width*\ [**+j**\ *justify*]\ [**+o**\ *dx*\ [/*dy*]].
         Set reference point on the map for the image.
-    box : bool or str
+    box
         If set to ``True``, draw a rectangular border around the
         GMT logo.
     style : str