Update text

Author: seisman

Makefile

@@ -61,8 +61,8 @@ test_no_images: _runtest
 
 format:
 	docformatter --in-place $(FORMAT_FILES)
-	ruff check --fix $(FORMAT_FILES)
 	ruff format $(FORMAT_FILES)
+	ruff check --fix $(FORMAT_FILES)
 
 check:
 	docformatter --check $(FORMAT_FILES)

pygmt/alias.py

@@ -30,11 +30,14 @@ def convert_aliases():
     options = defaultdict(lambda: "")
     for alias in p_locals.get("_aliases"):
         value = params.get(alias.name)
-        if value in (None, False):  # None or False are skipped
+        if is_nonstr_iter(value):
+            if alias.separator != "":
+                value = sequence_to_str(value, alias.separator)
+            else:
+                value = ""
+        elif value in (None, False):  # None or False are skipped
             continue
-        if value is True:  # Convert True to an empty string
+        elif value is True:  # Convert True to an empty string
             value = ""
-        if alias.separator is not None and is_nonstr_iter(value):
-            value = sequence_to_str(value, alias.separator)
         options[alias.flag] += f"{alias.modifier}{value}"
     return dict(options)

pygmt/src/legend.py

@@ -61,7 +61,7 @@ def legend(self, spec=None, position="JTR+jTR+o0.2c", box="+gwhite+p1p", **kwarg
         Alias("verbose", "v", "", ""),
         Alias("panel", "c", "", ","),
         Alias("perspective", "p", "", "/"),
-        Alias("transparency", "t", "", "")
+        Alias("transparency", "t", "", ""),
     ]
 
     kwargs = self._preprocess(**kwargs)
@@ -74,4 +74,6 @@ def legend(self, spec=None, position="JTR+jTR+o0.2c", box="+gwhite+p1p", **kwarg
             specfile = spec
         else:
             raise GMTInvalidInput(f"Unrecognized data type: {type(spec)}")
-        lib.call_module(module="legend", args=build_arg_string(options, infile=specfile))
+        lib.call_module(
+            module="legend", args=build_arg_string(options, infile=specfile)
+        )

pygmt/src/text.py

@@ -2,6 +2,7 @@
 text - Plot text on a figure.
 """
 import numpy as np
+from pygmt.alias import Alias, convert_aliases
 from pygmt.clib import Session
 from pygmt.exceptions import GMTInvalidInput
 from pygmt.helpers import (
@@ -11,38 +12,12 @@
     is_nonstr_iter,
     kwargs_to_strings,
     non_ascii_to_octal,
-    use_alias,
 )
 
 
 @fmt_docstring
-@use_alias(
-    R="region",
-    J="projection",
-    B="frame",
-    C="clearance",
-    D="offset",
-    G="fill",
-    N="no_clip",
-    V="verbose",
-    W="pen",
-    a="aspatial",
-    c="panel",
-    e="find",
-    f="coltypes",
-    h="header",
-    it="use_word",
-    p="perspective",
-    t="transparency",
-    w="wrap",
-)
-@kwargs_to_strings(
-    R="sequence",
-    textfiles="sequence_space",
-    c="sequence_comma",
-    p="sequence",
-)
-def text_(  # noqa: PLR0912
+@kwargs_to_strings(textfiles="sequence_space")
+def text_(
     self,
     textfiles=None,
     x=None,
@@ -52,6 +27,9 @@ def text_(  # noqa: PLR0912
     angle=None,
     font=None,
     justify=None,
+    projection=None,
+    region=None,
+    transparency=None,
     **kwargs,
 ):
     r"""
@@ -71,8 +49,6 @@ def text_(  # noqa: PLR0912
 
     Full option list at :gmt-docs:`text.html`
 
-    {aliases}
-
     Parameters
     ----------
     textfiles : str or list
@@ -182,6 +158,31 @@ def text_(  # noqa: PLR0912
     """
     kwargs = self._preprocess(**kwargs)
 
+    _aliases = [
+        Alias("position", "F", "+c", ""),
+        Alias("angle", "F", "+a", ""),
+        Alias("font", "F", "+f", ""),
+        Alias("justify", "F", "+j", ""),
+        Alias("region", "R", "", "/"),
+        Alias("projection", "J", "", ""),
+        Alias("transparency", "t", "", ""),
+        Alias("frame", "B", "", ""),
+        Alias("clearance", "C", "", ""),
+        Alias("offset", "D", "", ""),
+        Alias("fill", "G", "", ""),
+        Alias("no_clip", "N", "", ""),
+        Alias("verbose", "V", "", ""),
+        Alias("pen", "W", "", ""),
+        Alias("aspatial", "a", "", ""),
+        Alias("panel", "c", "", ","),
+        Alias("find", "e", "", ""),
+        Alias("coltypes", "f", "", ""),
+        Alias("header", "h", "", ""),
+        Alias("use_word", "it", "", ""),
+        Alias("perspective", "p", "", "/"),
+        Alias("wrap", "w", "", ""),
+    ]
+
     # Ensure inputs are either textfiles, x/y/text, or position/text
     if position is None:
         if (x is not None or y is not None) and textfiles is not None:
@@ -201,33 +202,22 @@ def text_(  # noqa: PLR0912
         kind = None
         textfiles = ""
 
-    # Build the -F option in gmt text.
-    if kwargs.get("F") is None and any(
-        v is not None for v in (position, angle, font, justify)
-    ):
-        kwargs.update({"F": ""})
+    # special handling with the position parameter
+    if position is not None:
+        position += f"+t{text}"
 
     extra_arrays = []
-    for arg, flag in [(angle, "+a"), (font, "+f"), (justify, "+j")]:
-        if arg is True:
-            kwargs["F"] += flag
-        elif is_nonstr_iter(arg):
-            kwargs["F"] += flag
-            if flag == "+a":  # angle is numeric type
-                extra_arrays.append(np.atleast_1d(arg))
-            else:  # font or justify is str type
-                extra_arrays.append(np.atleast_1d(arg).astype(str))
-        elif isinstance(arg, (int, float, str)):
-            kwargs["F"] += f"{flag}{arg}"
-
-    if isinstance(position, str):
-        kwargs["F"] += f"+c{position}+t{text}"
-
+    # angle is numeric type
+    if is_nonstr_iter(angle):
+        extra_arrays.append(np.atleast_1d(angle))
+    # font or justify is str type
+    for arg in (font, justify):
+        if is_nonstr_iter(arg):
+            extra_arrays.append(np.atleast_1d(arg).astype(str))
     # If an array of transparency is given, GMT will read it from
     # the last numerical column per data record.
-    if is_nonstr_iter(kwargs.get("t")):
-        extra_arrays.append(kwargs["t"])
-        kwargs["t"] = ""
+    if is_nonstr_iter(transparency):
+        extra_arrays.append(transparency)
 
     # Append text at last column. Text must be passed in as str type.
     if kind == "vectors":
@@ -239,5 +229,6 @@ def text_(  # noqa: PLR0912
         file_context = lib.virtualfile_from_data(
             check_kind="vector", data=textfiles, x=x, y=y, extra_arrays=extra_arrays
         )
+        options = convert_aliases()
         with file_context as fname:
-            lib.call_module(module="text", args=build_arg_string(kwargs, infile=fname))
+            lib.call_module(module="text", args=build_arg_string(options, infile=fname))

pygmt/src/xyz2grd.py

@@ -35,7 +35,7 @@ def xyz2grd(
     incols=None,
     registration=None,
     wrap=None,
-    **kwargs
+    **kwargs,
 ):
     r"""
     Create a grid file from table data.