Avoid using inspect

Author: seisman

pygmt/alias.py

@@ -3,7 +3,6 @@
 """
 
 import dataclasses
-import inspect
 from collections import defaultdict
 from collections.abc import Mapping, Sequence
 from typing import Any, Literal
@@ -210,14 +209,14 @@ class AliasSystem:
     ... ):
     ...     alias = AliasSystem(
     ...         A=[
-    ...             Alias("par1"),
-    ...             Alias("par2", prefix="+j"),
-    ...             Alias("par3", prefix="+o", separator="/"),
+    ...             Alias("par1", value=par1),
+    ...             Alias("par2", prefix="+j", value=par2),
+    ...             Alias("par3", prefix="+o", separator="/", value=par3),
     ...         ],
-    ...         B=Alias("frame"),
-    ...         c=Alias("panel", separator=","),
+    ...         B=Alias("frame", value=frame),
+    ...         c=Alias("panel", separator=",", value=panel),
     ...     )
-    ...     return build_arg_list(alias.kwdict)
+    ...     return build_arg_list(alias.kwdict | kwargs)
     >>> func(
     ...     "infile",
     ...     par1="mytext",
@@ -235,33 +234,26 @@ def __init__(self, **kwargs):
         """
         self.options = {}
         for option, aliases in kwargs.items():
-            if isinstance(aliases, list):
-                self.options[option] = aliases
-            elif isinstance(aliases, str):  # Support shorthand like 'J="projection"'
-                self.options[option] = [Alias(aliases)]
-            else:
-                self.options[option] = [aliases]
+            match aliases:
+                case list():
+                    self.options[option] = aliases
+                case str():  # Support shorthand like 'J="projection"'
+                    self.options[option] = [Alias(aliases)]
+                case _:
+                    self.options[option] = [aliases]
 
     @property
     def kwdict(self):
         """
         A keyword dictionary that stores the current parameter values.
         """
-        # Get the local variables from the calling function.
-        p_locals = inspect.currentframe().f_back.f_locals
-        # Get parameters/arguments from **kwargs of the calling function.
-        p_kwargs = p_locals.get("kwargs", {})
-
-        params = p_locals | p_kwargs
         # Default value is an empty string to simplify code logic.
         kwdict = defaultdict(str)
         for option, aliases in self.options.items():
             for alias in aliases:
-                alias.value = params.get(alias.name)
                 # value can be a string, a sequence of strings or None.
                 if alias.value is None:
                     continue
-
                 # Special handing of repeatable parameter like -B/frame.
                 if is_nonstr_iter(alias.value):
                     kwdict[option] = alias.value
@@ -270,24 +262,24 @@ def kwdict(self):
 
                 kwdict[option] += alias.value
 
-        # Support short-form parameter names specified in kwargs.
-        # Short-form parameters can be either one-letter (e.g., '-B'), or two-letters
-        # (e.g., '-Td').
-        for option, value in p_kwargs.items():
-            # Here, we assume that long-form parameters specified in kwargs are longer
-            # than two characters. Sometimes, we may use parameter like 'az', but it's
-            # not specified in kwargs. So, the assumption is still valid.
-            if len(option) > 2:
-                continue
-
-            # Two cases for short-form parameters:
-            #
-            # If it has an alias and the long-form parameter is also specified, (e.g.,
-            # 'projection="X10c", J="X10c"'), then we silently ignore the short-form
-            # parameter.
-            #
-            # If it has an alias but the long-form parameter is not specified, or it
-            # doesn't has an alias, then we use the value of the short-form parameter.
-            if option not in self.options or option not in kwdict:
-                kwdict[option] = value
+        # # Support short-form parameter names specified in kwargs.
+        # # Short-form parameters can be either one-letter (e.g., '-B'), or two-letters
+        # # (e.g., '-Td').
+        # for option, value in self.options.items():
+        #     # Here, we assume that long-form parameters specified in kwargs are longer
+        #     # than two characters. Sometimes, we may use parameter like 'az', but it's
+        #     # not specified in kwargs. So, the assumption is still valid.
+        #     if len(option) > 2:
+        #         continue
+
+        #     # Two cases for short-form parameters:
+        #     #
+        #     # If it has an alias and the long-form parameter is also specified, (e.g.,
+        #     # 'projection="X10c", J="X10c"'), then we silently ignore the short-form
+        #     # parameter.
+        #     #
+        #     # If it has an alias but the long-form parameter is not specified, or it
+        #     # doesn't has an alias, then we use the value of the short-form parameter.
+        #     if option not in self.options or option not in kwdict:
+        #         kwdict[option] = value
         return kwdict

pygmt/src/basemap.py

@@ -2,7 +2,7 @@
 basemap - Plot base maps and frames.
 """
 
-from pygmt.alias import AliasSystem
+from pygmt.alias import Alias, AliasSystem
 from pygmt.clib import Session
 from pygmt.helpers import build_arg_list, fmt_docstring, kwargs_to_strings, use_alias
 
@@ -24,7 +24,7 @@
     t="transparency",
 )
 @kwargs_to_strings(R="sequence", c="sequence_comma", p="sequence")
-def basemap(self, **kwargs):
+def basemap(self, frame=None, **kwargs):
     r"""
     Plot base maps and frames.
 
@@ -83,8 +83,8 @@ def basemap(self, **kwargs):
     {transparency}
     """
     alias = AliasSystem(
-        B="frame",
+        B=Alias("frame", value=frame),
     )
     kwargs = self._preprocess(**kwargs)
     with Session() as lib:
-        lib.call_module(module="basemap", args=build_arg_list(alias.kwdict))
+        lib.call_module(module="basemap", args=build_arg_list(alias.kwdict | kwargs))

pygmt/src/binstats.py

@@ -29,7 +29,7 @@ def binstats(
     outgrid: str | None = None,
     statistic=None,
     quantile_value=50,
-    **kwargs,  # noqa: ARG001
+    **kwargs,
 ) -> xr.DataArray | None:
     r"""
     Bin spatial data and determine statistics per bin.
@@ -130,13 +130,14 @@ def binstats(
                 "maxneg": "U",
                 "sum": "z",
             },
+            value=statistic,
         ),
-        G="outgrid",
+        G=Alias("outgrid", value=outgrid),
     )
     if statistic == "quantile":
         statistic += str(quantile_value)
 
-    kwdict = alias.kwdict
+    kwdict = alias.kwdict | kwargs
     with Session() as lib:
         with (
             lib.virtualfile_in(check_kind="vector", data=data) as vintbl,

pygmt/src/coast.py

@@ -221,4 +221,4 @@ def coast(
         )
         raise GMTInvalidInput(msg)
     with Session() as lib:
-        lib.call_module(module="coast", args=build_arg_list(alias.kwdict))
+        lib.call_module(module="coast", args=build_arg_list(alias.kwdict | kwargs))

pygmt/src/dimfilter.py

@@ -12,7 +12,17 @@
 
 
 @fmt_docstring
-def dimfilter(grid, outgrid: str | None = None, **kwargs) -> xr.DataArray | None:
+def dimfilter(
+    grid,
+    outgrid: str | None = None,
+    distance: int | str | None = None,
+    filter: str | None = None,
+    sectors: str | None = None,
+    spacing: str | list | None = None,
+    region: str | list | None = None,
+    verbose: bool | None = None,
+    **kwargs,
+) -> xr.DataArray | None:
     r"""
     Directional filtering of grids in the space domain.
 
@@ -125,25 +135,25 @@ def dimfilter(grid, outgrid: str | None = None, **kwargs) -> xr.DataArray | None
     ... )
     """
     alias = AliasSystem(
-        D=Alias("distance"),
-        G=Alias("outgrid"),
-        F=Alias("filter"),
-        I=Alias("spacing", separator="/"),
-        N=Alias("sectors"),
-        R=Alias("region", separator="/"),
-        V=Alias("verbose"),
+        D=Alias("distance", value=distance),
+        G=Alias("outgrid", value=outgrid),
+        F=Alias("filter", value=filter),
+        I=Alias("spacing", separator="/", value=spacing),
+        N=Alias("sectors", value=sectors),
+        R=Alias("region", separator="/", value=region),
+        V=Alias("verbose", value=verbose),
     )
 
     if (
-        not all(arg in kwargs for arg in ["distance", "filter", "sectors"])
+        not all(v is not None for v in [distance, filter, sectors])
         and "Q" not in kwargs
     ):
         msg = (
             "At least one of the following parameters must be specified: "
             "distance, filters, or sectors."
         )
         raise GMTInvalidInput(msg)
-    kwdict = alias.kwdict
+    kwdict = alias.kwdict | kwargs
     with Session() as lib:
         with (
             lib.virtualfile_in(check_kind="raster", data=grid) as vingrd,

pygmt/src/image.py

@@ -8,7 +8,21 @@
 
 
 @fmt_docstring
-def image(self, imagefile, **kwargs):
+def image(
+    self,
+    imagefile,
+    region=None,
+    projection=None,
+    position=None,
+    box=None,
+    bitcolor=None,
+    monochrome=None,
+    verbose=None,
+    panel=None,
+    perspective=None,
+    transparency=None,
+    **kwargs,
+):
     r"""
     Plot raster or EPS images.
 
@@ -54,20 +68,20 @@ def image(self, imagefile, **kwargs):
     {transparency}
     """
     alias = AliasSystem(
-        R=Alias("region", separator="/"),
-        J="projection",
-        D="position",
-        F="box",
-        G="bitcolor",
-        M="monochrome",
-        V="verbose",
+        R=Alias("region", separator="/", value=region),
+        J=Alias("projection", value=projection),
+        D=Alias("position", value=position),
+        F=Alias("box", value=box),
+        G=Alias("bitcolor", value=bitcolor),
+        M=Alias("monochrome", value=monochrome),
+        V=Alias("verbose", value=verbose),
         c=Alias("panel", separator=","),
         p=Alias("perspective", separator="/"),
-        t="transparency",
+        t=Alias("transparency", value=transparency),
     )
 
     kwargs = self._preprocess(**kwargs)
     with Session() as lib:
         lib.call_module(
-            module="image", args=build_arg_list(alias.kwdict, infile=imagefile)
+            module="image", args=build_arg_list(alias.kwdict | kwargs, infile=imagefile)
         )

pygmt/src/logo.py

@@ -59,4 +59,4 @@ def logo(self, **kwargs):
     )
     kwargs = self._preprocess(**kwargs)
     with Session() as lib:
-        lib.call_module(module="logo", args=build_arg_list(alias.kwdict))
+        lib.call_module(module="logo", args=build_arg_list(alias.kwdict | kwargs))

pygmt/src/timestamp.py

@@ -77,14 +77,6 @@ def timestamp(
     >>> fig.timestamp(label="Powered by PyGMT")
     >>> fig.show()
     """
-    alias = AliasSystem(
-        U=[
-            Alias("label"),
-            Alias("justify", prefix="+j"),
-            Alias("offset", prefix="+o", separator="/"),
-            Alias("text", prefix="+t"),
-        ]
-    )
 
     self._preprocess()
 
@@ -109,7 +101,16 @@ def timestamp(
         warnings.warn(message=msg, category=RuntimeWarning, stacklevel=2)
         text = text[:64]
 
-    kwdict: dict = {"T": True, "U": True} | alias.kwdict
+    alias = AliasSystem(
+        U=[
+            Alias("label", value=label),
+            Alias("justify", prefix="+j", value=justify),
+            Alias("offset", prefix="+o", separator="/", value=offset),
+            Alias("text", prefix="+t", value=text),
+        ]
+    )
+
+    kwdict = {"T": True} | alias.kwdict
     with Session() as lib:
         lib.call_module(
             module="plot",