Migrate the transparency parameter to the new alias system (#4066)

Author: seisman

pygmt/alias.py

@@ -303,6 +303,8 @@ def add_common(self, **kwargs):
                     alias = Alias(value, name="projection")
                 case "c":
                     alias = Alias(value, name="panel", sep=",", size=2)
+                case "t":
+                    alias = Alias(value, name="transparency")
                 case _:
                     raise GMTValueError(key, description="common parameter")
             self.aliasdict[key] = alias

pygmt/src/basemap.py

@@ -21,7 +21,6 @@
     Tm="compass",
     f="coltypes",
     p="perspective",
-    t="transparency",
 )
 @kwargs_to_strings(R="sequence", p="sequence")
 def basemap(
@@ -30,6 +29,7 @@ def basemap(
     verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
     | bool = False,
     panel: int | tuple[int, int] | bool = False,
+    transparency: float | None = None,
     **kwargs,
 ):
     r"""
@@ -49,6 +49,7 @@ def basemap(
        - J = projection
        - V = verbose
        - c = panel
+       - t = transparency
 
     Parameters
     ----------
@@ -98,6 +99,7 @@ def basemap(
         J=projection,
         V=verbose,
         c=panel,
+        t=transparency,
     )
     aliasdict.merge(kwargs)
 

pygmt/src/coast.py

@@ -33,7 +33,6 @@
     S="water",
     W="shorelines",
     p="perspective",
-    t="transparency",
 )
 @kwargs_to_strings(R="sequence", p="sequence")
 def coast(
@@ -45,6 +44,7 @@ def coast(
     verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
     | bool = False,
     panel: int | tuple[int, int] | bool = False,
+    transparency: float | None = None,
     **kwargs,
 ):
     r"""
@@ -71,6 +71,7 @@ def coast(
        - J = projection
        - V = verbose
        - c = panel
+       - t = transparency
 
     Parameters
     ----------
@@ -233,6 +234,7 @@ def coast(
         J=projection,
         V=verbose,
         c=panel,
+        t=transparency,
     )
     aliasdict.merge(kwargs)
 

pygmt/src/colorbar.py

@@ -25,7 +25,6 @@
     W="scale",
     Z="zfile",
     p="perspective",
-    t="transparency",
 )
 @kwargs_to_strings(R="sequence", G="sequence", I="sequence", p="sequence")
 def colorbar(
@@ -34,6 +33,7 @@ def colorbar(
     verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
     | bool = False,
     panel: int | tuple[int, int] | bool = False,
+    transparency: float | None = None,
     **kwargs,
 ):
     r"""
@@ -53,6 +53,7 @@ def colorbar(
        - J = projection
        - V = verbose
        - c = panel
+       - t = transparency
 
     Parameters
     ----------
@@ -158,6 +159,7 @@ def colorbar(
         J=projection,
         V=verbose,
         c=panel,
+        t=transparency,
     )
     aliasdict.merge(kwargs)
 

pygmt/src/contour.py

@@ -35,7 +35,6 @@
     i="incols",
     l="label",
     p="perspective",
-    t="transparency",
 )
 @kwargs_to_strings(R="sequence", i="sequence_comma", p="sequence")
 def contour(
@@ -48,6 +47,7 @@ def contour(
     verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
     | bool = False,
     panel: int | tuple[int, int] | bool = False,
+    transparency: float | None = None,
     **kwargs,
 ):
     r"""
@@ -64,6 +64,7 @@ def contour(
        - J = projection
        - V = verbose
        - c = panel
+       - t = transparency
 
     Parameters
     ----------
@@ -162,6 +163,7 @@ def contour(
         J=projection,
         V=verbose,
         c=panel,
+        t=transparency,
     )
     aliasdict.merge(kwargs)
 

pygmt/src/grdcontour.py

@@ -35,7 +35,6 @@
     l="label",
     f="coltypes",
     p="perspective",
-    t="transparency",
 )
 @kwargs_to_strings(R="sequence", L="sequence", p="sequence")
 def grdcontour(
@@ -45,6 +44,7 @@ def grdcontour(
     verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
     | bool = False,
     panel: int | tuple[int, int] | bool = False,
+    transparency: float | None = None,
     **kwargs,
 ):
     r"""
@@ -58,6 +58,7 @@ def grdcontour(
        - J = projection
        - V = verbose
        - c = panel
+       - t = transparency
 
     Parameters
     ----------
@@ -166,6 +167,7 @@ def grdcontour(
         J=projection,
         V=verbose,
         c=panel,
+        t=transparency,
     )
     aliasdict.merge(kwargs)
 

pygmt/src/grdimage.py

@@ -28,7 +28,6 @@
     n="interpolation",
     f="coltypes",
     p="perspective",
-    t="transparency",
     x="cores",
 )
 @kwargs_to_strings(R="sequence", p="sequence")
@@ -39,6 +38,7 @@ def grdimage(
     verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
     | bool = False,
     panel: int | tuple[int, int] | bool = False,
+    transparency: float | None = None,
     **kwargs,
 ):
     r"""
@@ -78,6 +78,7 @@ def grdimage(
        - J = projection
        - V = verbose
        - c = panel
+       - t = transparency
 
     Parameters
     ----------
@@ -175,6 +176,7 @@ def grdimage(
         J=projection,
         V=verbose,
         c=panel,
+        t=transparency,
     )
     aliasdict.merge(kwargs)
 

pygmt/src/grdview.py

@@ -30,7 +30,6 @@
     f="coltypes",
     n="interpolation",
     p="perspective",
-    t="transparency",
 )
 @kwargs_to_strings(R="sequence", p="sequence")
 def grdview(
@@ -40,6 +39,7 @@ def grdview(
     verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
     | bool = False,
     panel: int | tuple[int, int] | bool = False,
+    transparency: float | None = None,
     **kwargs,
 ):
     r"""
@@ -57,6 +57,7 @@ def grdview(
        - J = projection
        - V = verbose
        - c = panel
+       - t = transparency
 
     Parameters
     ----------
@@ -157,6 +158,7 @@ def grdview(
         J=projection,
         V=verbose,
         c=panel,
+        t=transparency,
     )
     aliasdict.merge(kwargs)
 

pygmt/src/histogram.py

@@ -34,7 +34,6 @@
     i="incols",
     l="label",
     p="perspective",
-    t="transparency",
     w="wrap",
 )
 @kwargs_to_strings(R="sequence", T="sequence", i="sequence_comma", p="sequence")
@@ -45,6 +44,7 @@ def histogram(
     verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
     | bool = False,
     panel: int | tuple[int, int] | bool = False,
+    transparency: float | None = None,
     **kwargs,
 ):
     r"""
@@ -56,6 +56,7 @@ def histogram(
        - J = projection
        - V = verbose
        - c = panel
+       - t = transparency
 
     Parameters
     ----------
@@ -150,6 +151,7 @@ def histogram(
         J=projection,
         V=verbose,
         c=panel,
+        t=transparency,
     )
     aliasdict.merge(kwargs)
 

pygmt/src/image.py

@@ -18,7 +18,6 @@
     M="monochrome",
     R="region",
     p="perspective",
-    t="transparency",
 )
 @kwargs_to_strings(R="sequence", p="sequence")
 def image(
@@ -28,6 +27,7 @@ def image(
     verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
     | bool = False,
     panel: int | tuple[int, int] | bool = False,
+    transparency: float | None = None,
     **kwargs,
 ):
     r"""
@@ -42,6 +42,7 @@ def image(
        - J = projection
        - V = verbose
        - c = panel
+       - t = transparency
 
     Parameters
     ----------
@@ -85,6 +86,7 @@ def image(
         J=projection,
         V=verbose,
         c=panel,
+        t=transparency,
     )
     aliasdict.merge(kwargs)