Move the projection parameter to the AliasSystem.add_common method (#4063)

seisman · web-flow · commit 12daf4ad1ed0 · 2025-08-23T17:40:38.000+08:00
diff --git a/pygmt/alias.py b/pygmt/alias.py
@@ -276,6 +276,8 @@ def add_common(self, **kwargs):
         """
         for key, value in kwargs.items():
             match key:
+                case "J":
+                    alias = Alias(value, name="projection")
                 case "c":
                     alias = Alias(value, name="panel", sep=",", size=2)
                 case _:
diff --git a/pygmt/src/basemap.py b/pygmt/src/basemap.py
@@ -2,7 +2,7 @@
 basemap - Plot base maps and frames.
 """
 
-from pygmt.alias import Alias, AliasSystem
+from pygmt.alias import AliasSystem
 from pygmt.clib import Session
 from pygmt.helpers import build_arg_list, fmt_docstring, kwargs_to_strings, use_alias
 
@@ -87,9 +87,8 @@ def basemap(
     """
     self._activate_figure()
 
-    aliasdict = AliasSystem(
-        J=Alias(projection, name="projection"),
-    ).add_common(
+    aliasdict = AliasSystem().add_common(
+        J=projection,
         c=panel,
     )
     aliasdict.merge(kwargs)
diff --git a/pygmt/src/coast.py b/pygmt/src/coast.py
@@ -227,8 +227,8 @@ def coast(
                 "crude": "c",
             },
         ),
-        J=Alias(projection, name="projection"),
     ).add_common(
+        J=projection,
         c=panel,
     )
     aliasdict.merge(kwargs)
diff --git a/pygmt/src/colorbar.py b/pygmt/src/colorbar.py
@@ -2,7 +2,7 @@
 colorbar - Plot gray scale or color scale bar.
 """
 
-from pygmt.alias import Alias, AliasSystem
+from pygmt.alias import AliasSystem
 from pygmt.clib import Session
 from pygmt.helpers import build_arg_list, fmt_docstring, kwargs_to_strings, use_alias
 
@@ -147,9 +147,8 @@ def colorbar(
     """
     self._activate_figure()
 
-    aliasdict = AliasSystem(
-        J=Alias(projection, name="projection"),
-    ).add_common(
+    aliasdict = AliasSystem().add_common(
+        J=projection,
         c=panel,
     )
     aliasdict.merge(kwargs)
diff --git a/pygmt/src/contour.py b/pygmt/src/contour.py
@@ -3,7 +3,7 @@
 """
 
 from pygmt._typing import PathLike, TableLike
-from pygmt.alias import Alias, AliasSystem
+from pygmt.alias import AliasSystem
 from pygmt.clib import Session
 from pygmt.helpers import (
     build_arg_list,
@@ -154,9 +154,8 @@ def contour(
             else:  # Multiple levels
                 kwargs[arg] = ",".join(f"{item}" for item in kwargs[arg])
 
-    aliasdict = AliasSystem(
-        J=Alias(projection, name="projection"),
-    ).add_common(
+    aliasdict = AliasSystem().add_common(
+        J=projection,
         c=panel,
     )
     aliasdict.merge(kwargs)
diff --git a/pygmt/src/grdcontour.py b/pygmt/src/grdcontour.py
@@ -4,7 +4,7 @@
 
 import xarray as xr
 from pygmt._typing import PathLike
-from pygmt.alias import Alias, AliasSystem
+from pygmt.alias import AliasSystem
 from pygmt.clib import Session
 from pygmt.helpers import (
     build_arg_list,
@@ -158,9 +158,8 @@ def grdcontour(
             else:  # Multiple levels
                 kwargs[arg] = ",".join(f"{item}" for item in kwargs[arg])
 
-    aliasdict = AliasSystem(
-        J=Alias(projection, name="projection"),
-    ).add_common(
+    aliasdict = AliasSystem().add_common(
+        J=projection,
         c=panel,
     )
     aliasdict.merge(kwargs)
diff --git a/pygmt/src/grdcut.py b/pygmt/src/grdcut.py
@@ -6,7 +6,7 @@
 
 import xarray as xr
 from pygmt._typing import PathLike
-from pygmt.alias import Alias, AliasSystem
+from pygmt.alias import AliasSystem
 from pygmt.clib import Session
 from pygmt.exceptions import GMTTypeError, GMTValueError
 from pygmt.helpers import (
@@ -126,9 +126,10 @@ def grdcut(
         case _:
             raise GMTTypeError(type(grid))
 
-    aliasdict = AliasSystem(
-        J=Alias(projection, name="projection"),
-    ).merge(kwargs)
+    aliasdict = AliasSystem().add_common(
+        J=projection,
+    )
+    aliasdict.merge(kwargs)
 
     with Session() as lib:
         with (
diff --git a/pygmt/src/grdimage.py b/pygmt/src/grdimage.py
@@ -4,7 +4,7 @@
 
 import xarray as xr
 from pygmt._typing import PathLike
-from pygmt.alias import Alias, AliasSystem
+from pygmt.alias import AliasSystem
 from pygmt.clib import Session
 from pygmt.helpers import build_arg_list, fmt_docstring, kwargs_to_strings, use_alias
 
@@ -167,9 +167,8 @@ def grdimage(
         )
         raise NotImplementedError(msg)
 
-    aliasdict = AliasSystem(
-        J=Alias(projection, name="projection"),
-    ).add_common(
+    aliasdict = AliasSystem().add_common(
+        J=projection,
         c=panel,
     )
     aliasdict.merge(kwargs)
diff --git a/pygmt/src/grdproject.py b/pygmt/src/grdproject.py
@@ -4,7 +4,7 @@
 
 import xarray as xr
 from pygmt._typing import PathLike
-from pygmt.alias import Alias, AliasSystem
+from pygmt.alias import 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
@@ -113,9 +113,10 @@ def grdproject(
         msg = "The projection must be specified."
         raise GMTInvalidInput(msg)
 
-    aliasdict = AliasSystem(
-        J=Alias(projection, name="projection"),
-    ).merge(kwargs)
+    aliasdict = AliasSystem().add_common(
+        J=projection,
+    )
+    aliasdict.merge(kwargs)
 
     with Session() as lib:
         with (
diff --git a/pygmt/src/grdview.py b/pygmt/src/grdview.py
@@ -4,7 +4,7 @@
 
 import xarray as xr
 from pygmt._typing import PathLike
-from pygmt.alias import Alias, AliasSystem
+from pygmt.alias import AliasSystem
 from pygmt.clib import Session
 from pygmt.helpers import build_arg_list, fmt_docstring, kwargs_to_strings, use_alias
 
@@ -149,9 +149,8 @@ def grdview(
     """
     self._activate_figure()
 
-    aliasdict = AliasSystem(
-        J=Alias(projection, name="projection"),
-    ).add_common(
+    aliasdict = AliasSystem().add_common(
+        J=projection,
         c=panel,
     )
     aliasdict.merge(kwargs)
diff --git a/pygmt/src/histogram.py b/pygmt/src/histogram.py
@@ -3,7 +3,7 @@
 """
 
 from pygmt._typing import PathLike, TableLike
-from pygmt.alias import Alias, AliasSystem
+from pygmt.alias import AliasSystem
 from pygmt.clib import Session
 from pygmt.helpers import build_arg_list, fmt_docstring, kwargs_to_strings, use_alias
 
@@ -142,9 +142,8 @@ def histogram(
     """
     self._activate_figure()
 
-    aliasdict = AliasSystem(
-        J=Alias(projection, name="projection"),
-    ).add_common(
+    aliasdict = AliasSystem().add_common(
+        J=projection,
         c=panel,
     )
     aliasdict.merge(kwargs)
diff --git a/pygmt/src/image.py b/pygmt/src/image.py
@@ -3,7 +3,7 @@
 """
 
 from pygmt._typing import PathLike
-from pygmt.alias import Alias, AliasSystem
+from pygmt.alias import AliasSystem
 from pygmt.clib import Session
 from pygmt.helpers import build_arg_list, fmt_docstring, kwargs_to_strings, use_alias
 
@@ -77,9 +77,8 @@ def image(
     """
     self._activate_figure()
 
-    aliasdict = AliasSystem(
-        J=Alias(projection, name="projection"),
-    ).add_common(
+    aliasdict = AliasSystem().add_common(
+        J=projection,
         c=panel,
     )
     aliasdict.merge(kwargs)
diff --git a/pygmt/src/inset.py b/pygmt/src/inset.py
@@ -4,7 +4,7 @@
 
 import contextlib
 
-from pygmt.alias import Alias, AliasSystem
+from pygmt.alias import AliasSystem
 from pygmt.clib import Session
 from pygmt.helpers import build_arg_list, fmt_docstring, kwargs_to_strings, use_alias
 
@@ -137,9 +137,10 @@ def inset(self, projection=None, **kwargs):
     """
     self._activate_figure()
 
-    aliasdict = AliasSystem(
-        J=Alias(projection, name="projection"),
-    ).merge(kwargs)
+    aliasdict = AliasSystem().add_common(
+        J=projection,
+    )
+    aliasdict.merge(kwargs)
 
     with Session() as lib:
         try:
diff --git a/pygmt/src/legend.py b/pygmt/src/legend.py
@@ -5,7 +5,7 @@
 import io
 
 from pygmt._typing import PathLike
-from pygmt.alias import Alias, AliasSystem
+from pygmt.alias import AliasSystem
 from pygmt.clib import Session
 from pygmt.exceptions import GMTTypeError
 from pygmt.helpers import (
@@ -100,9 +100,8 @@ def legend(
             type(spec), reason="Only one legend specification file is allowed."
         )
 
-    aliasdict = AliasSystem(
-        J=Alias(projection, name="projection"),
-    ).add_common(
+    aliasdict = AliasSystem().add_common(
+        J=projection,
         c=panel,
     )
     aliasdict.merge(kwargs)
diff --git a/pygmt/src/logo.py b/pygmt/src/logo.py
@@ -2,7 +2,7 @@
 logo - Plot the GMT logo.
 """
 
-from pygmt.alias import Alias, AliasSystem
+from pygmt.alias import AliasSystem
 from pygmt.clib import Session
 from pygmt.helpers import build_arg_list, fmt_docstring, kwargs_to_strings, use_alias
 
@@ -57,9 +57,8 @@ def logo(self, projection=None, panel: int | tuple[int, int] | bool = False, **k
     """
     self._activate_figure()
 
-    aliasdict = AliasSystem(
-        J=Alias(projection, name="projection"),
-    ).add_common(
+    aliasdict = AliasSystem().add_common(
+        J=projection,
         c=panel,
     )
     aliasdict.merge(kwargs)
diff --git a/pygmt/src/meca.py b/pygmt/src/meca.py
@@ -8,7 +8,7 @@
 import numpy as np
 import pandas as pd
 from pygmt._typing import PathLike, TableLike
-from pygmt.alias import Alias, AliasSystem
+from pygmt.alias import AliasSystem
 from pygmt.clib import Session
 from pygmt.exceptions import GMTInvalidInput, GMTValueError
 from pygmt.helpers import (
@@ -366,9 +366,8 @@ def meca(  # noqa: PLR0913
         kwargs["A"] = _auto_offset(spec)
     kwargs["S"] = f"{_convention.code}{scale}"
 
-    aliasdict = AliasSystem(
-        J=Alias(projection, name="projection"),
-    ).add_common(
+    aliasdict = AliasSystem().add_common(
+        J=projection,
         c=panel,
     )
     aliasdict.merge(kwargs)
diff --git a/pygmt/src/plot.py b/pygmt/src/plot.py
@@ -5,7 +5,7 @@
 from typing import Literal
 
 from pygmt._typing import PathLike, TableLike
-from pygmt.alias import Alias, AliasSystem
+from pygmt.alias import AliasSystem
 from pygmt.clib import Session
 from pygmt.exceptions import GMTInvalidInput, GMTTypeError
 from pygmt.helpers import (
@@ -284,9 +284,8 @@ def plot(  # noqa: PLR0912
     if kwargs.get("S") is None and _data_geometry_is_point(data, kind):
         kwargs["S"] = "s0.2c"
 
-    aliasdict = AliasSystem(
-        J=Alias(projection, name="projection"),
-    ).add_common(
+    aliasdict = AliasSystem().add_common(
+        J=projection,
         c=panel,
     )
     aliasdict.merge(kwargs)
diff --git a/pygmt/src/plot3d.py b/pygmt/src/plot3d.py
@@ -5,7 +5,7 @@
 from typing import Literal
 
 from pygmt._typing import PathLike, TableLike
-from pygmt.alias import Alias, AliasSystem
+from pygmt.alias import AliasSystem
 from pygmt.clib import Session
 from pygmt.exceptions import GMTInvalidInput, GMTTypeError
 from pygmt.helpers import (
@@ -263,9 +263,8 @@ def plot3d(  # noqa: PLR0912, PLR0913
     if kwargs.get("S") is None and _data_geometry_is_point(data, kind):
         kwargs["S"] = "u0.2c"
 
-    aliasdict = AliasSystem(
-        J=Alias(projection, name="projection"),
-    ).add_common(
+    aliasdict = AliasSystem().add_common(
+        J=projection,
         c=panel,
     )
     aliasdict.merge(kwargs)
diff --git a/pygmt/src/select.py b/pygmt/src/select.py
@@ -229,8 +229,10 @@ def select(
                 "crude": "c",
             },
         ),
-        J=Alias(projection, name="projection"),
-    ).merge(kwargs)
+    ).add_common(
+        J=projection,
+    )
+    aliasdict.merge(kwargs)
 
     with Session() as lib:
         with (
diff --git a/pygmt/src/solar.py b/pygmt/src/solar.py
@@ -111,7 +111,6 @@ def solar(
             raise GMTValueError(terminator_datetime, description="datetime") from verr
 
     aliasdict = AliasSystem(
-        J=Alias(projection, name="projection"),
         T=[
             Alias(
                 terminator,
@@ -126,6 +125,7 @@ def solar(
             Alias(datetime_string, name="terminator_datetime", prefix="+d"),
         ],
     ).add_common(
+        J=projection,
         c=panel,
     )
     aliasdict.merge(kwargs)
diff --git a/pygmt/src/subplot.py b/pygmt/src/subplot.py
diff --git a/pygmt/src/text.py b/pygmt/src/text.py
diff --git a/pygmt/src/tilemap.py b/pygmt/src/tilemap.py
diff --git a/pygmt/src/triangulate.py b/pygmt/src/triangulate.py
diff --git a/pygmt/src/velo.py b/pygmt/src/velo.py
diff --git a/pygmt/src/wiggle.py b/pygmt/src/wiggle.py
diff --git a/pygmt/src/xyz2grd.py b/pygmt/src/xyz2grd.py
diff --git a/pygmt/tests/test_alias_system.py b/pygmt/tests/test_alias_system.py
