Figure.logo: Refactor using the AliasSystem class

Author: seisman

pygmt/src/logo.py

@@ -2,23 +2,37 @@
 logo - Plot the GMT logo.
 """
 
+from typing import Literal
+
+from pygmt.alias import Alias, 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
 
 
 @fmt_docstring
 @use_alias(
     R="region",
     J="projection",
-    D="position",
     F="box",
     S="style",
     V="verbose",
     c="panel",
     t="transparency",
 )
 @kwargs_to_strings(R="sequence", c="sequence_comma", p="sequence")
-def logo(self, **kwargs):
+def logo(
+    self,
+    position_type: Literal[
+        "user", "justify", "mirror", "normalize", "plot", None
+    ] = None,
+    position=None,
+    height=None,
+    width=None,
+    justify=None,
+    offset=None,
+    **kwargs,
+):
     r"""
     Plot the GMT logo.
 
@@ -39,6 +53,9 @@ 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.
+    positon_type
+    width/height
+        Width or height of the GMT logo.
     box : bool or str
         If set to ``True``, draw a rectangular border around the
         GMT logo.
@@ -55,5 +72,30 @@ def logo(self, **kwargs):
     {transparency}
     """
     self._activate_figure()
+    if width is not None and height is not None:
+        msg = "Cannot specify both width and height."
+        raise GMTInvalidInput(msg)
+
+    aliasdict = AliasSystem(
+        D=[
+            Alias(
+                position_type,
+                name="position_type",
+                mapping={
+                    "user": "g",
+                    "justify": "j",
+                    "mirror": "J",
+                    "normalize": "n",
+                    "plot": "x",
+                },
+            ),
+            Alias(position, name="position", separator="/"),
+            Alias(height, name="height", prefix="+h"),
+            Alias(width, name="width", prefix="+w"),
+            Alias(justify, name="justify", prefix="+j"),
+            Alias(offset, name="offset", prefix="+o", separator="/", size=2),
+        ]
+    ).merge(kwargs)
+
     with Session() as lib:
-        lib.call_module(module="logo", args=build_arg_list(kwargs))
+        lib.call_module(module="logo", args=build_arg_list(aliasdict))

pygmt/tests/test_logo.py

@@ -24,5 +24,11 @@ def test_logo_on_a_map():
     """
     fig = Figure()
     fig.basemap(region=[-90, -70, 0, 20], projection="M15c", frame=True)
-    fig.logo(position="jTR+o0.25c/0.25c+w7.5c", box=True)
+    fig.logo(
+        position_type="justify",
+        position="TR",
+        offset=(0.25, 0.25),
+        width="7.5c",
+        box=True,
+    )
     return fig