Skip to content

AliasSystem: Migrate the region parameter to the new alias system #4099

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Sep 29, 2025
Merged

AliasSystem: Migrate the region parameter to the new alias system #4099

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
9a55d0e
Add region to the common parameter
seisman Sep 17, 2025
da4027a
Update basemap
seisman Sep 17, 2025
bb1b137
Update other wrappers
seisman Sep 17, 2025
8e72f1d
Fix xyz2grd
seisman Sep 17, 2025
605bfa8
Improve type hints for region
seisman Sep 17, 2025
1944b41
Add to docstring
seisman Sep 17, 2025
061f1a1
Fix pygmt/src/triangulate.py
seisman Sep 23, 2025
5b71235
Fixes
seisman Sep 23, 2025
07ff608
Improve the type hints for Figure.tilemap
seisman Sep 23, 2025
d9f3f6f
Merge branch 'main' into AliasSystem/region
seisman Sep 23, 2025
03dd598
Merge branch 'main' into AliasSystem/region
seisman Sep 23, 2025
2195f88
Merge branch 'main' into AliasSystem/region
seisman Sep 24, 2025
45360cc
Merge branch 'main' into AliasSystem/region
seisman Sep 25, 2025
2d18172
Fix tilemap
seisman Sep 25, 2025
9202a8c
Merge branch 'main' into AliasSystem/region
seisman Sep 26, 2025
53f5273
Merge branch 'main' into AliasSystem/region
seisman Sep 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions pygmt/alias.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,10 @@ def add_common(self, **kwargs):
"""
for key, value in kwargs.items():
match key:
case "J":
alias = Alias(value, name="projection")
case "R":
alias = Alias(value, name="region", sep="/", size=(4, 6))
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The size is usually 4, but can be 6 for 3-D plots.

case "V":
alias = Alias(
value,
Expand All @@ -314,8 +318,6 @@ def add_common(self, **kwargs):
"debug": "d",
},
)
case "J":
alias = Alias(value, name="projection")
case "c":
alias = Alias(value, name="panel", sep=",", size=2)
case "t":
Expand Down
7 changes: 5 additions & 2 deletions pygmt/src/basemap.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
basemap - Plot base maps and frames.
"""

from collections.abc import Sequence
from typing import Literal

from pygmt.alias import AliasSystem
Expand All @@ -11,7 +12,6 @@

@fmt_docstring
@use_alias(
R="region",
Jz="zscale",
JZ="zsize",
B="frame",
Expand All @@ -22,10 +22,11 @@
f="coltypes",
p="perspective",
)
@kwargs_to_strings(R="sequence", p="sequence")
@kwargs_to_strings(p="sequence")
def basemap(
self,
projection: str | None = None,
region: Sequence[float | str] | str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
panel: int | tuple[int, int] | bool = False,
Expand All @@ -47,6 +48,7 @@ def basemap(

{aliases}
- J = projection
- R = region
- V = verbose
- c = panel
- t = transparency
Expand Down Expand Up @@ -97,6 +99,7 @@ def basemap(

aliasdict = AliasSystem().add_common(
J=projection,
R=region,
V=verbose,
c=panel,
t=transparency,
Expand Down
7 changes: 5 additions & 2 deletions pygmt/src/binstats.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
binstats - Bin spatial data and determine statistics per bin.
"""

from collections.abc import Sequence
from typing import Literal

import xarray as xr
Expand All @@ -16,7 +17,6 @@
E="empty",
I="spacing",
N="normalize",
R="region",
S="search_radius",
W="weight",
a="aspatial",
Expand All @@ -25,7 +25,7 @@
i="incols",
r="registration",
)
@kwargs_to_strings(I="sequence", R="sequence", i="sequence_comma")
@kwargs_to_strings(I="sequence", i="sequence_comma")
def binstats(
data: PathLike | TableLike,
outgrid: PathLike | None = None,
Expand All @@ -48,6 +48,7 @@ def binstats(
"sum",
] = "number",
quantile_value: float = 50,
region: Sequence[float | str] | str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
**kwargs,
Expand All @@ -67,6 +68,7 @@ def binstats(

{aliases}
- C = statistic
- R = region
- V = verbose

Parameters
Expand Down Expand Up @@ -154,6 +156,7 @@ def binstats(
},
),
).add_common(
R=region,
V=verbose,
)
aliasdict.merge(kwargs)
Expand Down
19 changes: 13 additions & 6 deletions pygmt/src/blockm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
blockm - Block average (x, y, z) data tables by mean, median, or mode estimation.
"""

from collections.abc import Sequence
from typing import Literal

import numpy as np
Expand Down Expand Up @@ -73,7 +74,6 @@ def _blockm(
@fmt_docstring
@use_alias(
I="spacing",
R="region",
S="summary",
a="aspatial",
b="binary",
Expand All @@ -86,14 +86,15 @@ def _blockm(
r="registration",
w="wrap",
)
@kwargs_to_strings(I="sequence", R="sequence", i="sequence_comma", o="sequence_comma")
@kwargs_to_strings(I="sequence", i="sequence_comma", o="sequence_comma")
def blockmean(
data: PathLike | TableLike | None = None,
x=None,
y=None,
z=None,
output_type: Literal["pandas", "numpy", "file"] = "pandas",
outfile: PathLike | None = None,
region: Sequence[float | str] | str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
**kwargs,
Expand All @@ -113,6 +114,7 @@ def blockmean(
Full GMT docs at :gmt-docs:`blockmean.html`.

{aliases}
- R = region
- V = verbose

Parameters
Expand Down Expand Up @@ -166,6 +168,7 @@ def blockmean(
>>> data_bmean = pygmt.blockmean(data=data, region=[245, 255, 20, 30], spacing="5m")
"""
aliasdict = AliasSystem().add_common(
R=region,
V=verbose,
)
aliasdict.merge(kwargs)
Expand All @@ -185,7 +188,6 @@ def blockmean(
@fmt_docstring
@use_alias(
I="spacing",
R="region",
a="aspatial",
b="binary",
d="nodata",
Expand All @@ -197,14 +199,15 @@ def blockmean(
r="registration",
w="wrap",
)
@kwargs_to_strings(I="sequence", R="sequence", i="sequence_comma", o="sequence_comma")
@kwargs_to_strings(I="sequence", i="sequence_comma", o="sequence_comma")
def blockmedian(
data: PathLike | TableLike | None = None,
x=None,
y=None,
z=None,
output_type: Literal["pandas", "numpy", "file"] = "pandas",
outfile: PathLike | None = None,
region: Sequence[float | str] | str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
**kwargs,
Expand All @@ -224,6 +227,7 @@ def blockmedian(
Full GMT docs at :gmt-docs:`blockmedian.html`.

{aliases}
- R = region
- V = verbose

Parameters
Expand Down Expand Up @@ -271,6 +275,7 @@ def blockmedian(
... )
"""
aliasdict = AliasSystem().add_common(
R=region,
V=verbose,
)
aliasdict.merge(kwargs)
Expand All @@ -290,7 +295,6 @@ def blockmedian(
@fmt_docstring
@use_alias(
I="spacing",
R="region",
a="aspatial",
b="binary",
d="nodata",
Expand All @@ -302,14 +306,15 @@ def blockmedian(
r="registration",
w="wrap",
)
@kwargs_to_strings(I="sequence", R="sequence", i="sequence_comma", o="sequence_comma")
@kwargs_to_strings(I="sequence", i="sequence_comma", o="sequence_comma")
def blockmode(
data: PathLike | TableLike | None = None,
x=None,
y=None,
z=None,
output_type: Literal["pandas", "numpy", "file"] = "pandas",
outfile: PathLike | None = None,
region: Sequence[float | str] | str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
**kwargs,
Expand All @@ -329,6 +334,7 @@ def blockmode(
Full GMT docs at :gmt-docs:`blockmode.html`.

{aliases}
- R = region
- V = verbose

Parameters
Expand Down Expand Up @@ -374,6 +380,7 @@ def blockmode(
>>> data_bmode = pygmt.blockmode(data=data, region=[245, 255, 20, 30], spacing="5m")
"""
aliasdict = AliasSystem().add_common(
R=region,
V=verbose,
)
aliasdict.merge(kwargs)
Expand Down
7 changes: 5 additions & 2 deletions pygmt/src/coast.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
coast - Plot continents, countries, shorelines, rivers, and borders.
"""

from collections.abc import Sequence
from typing import Literal

from pygmt.alias import Alias, AliasSystem
Expand Down Expand Up @@ -29,19 +30,19 @@
I="rivers",
L="map_scale",
N="borders",
R="region",
S="water",
W="shorelines",
p="perspective",
)
@kwargs_to_strings(R="sequence", p="sequence")
@kwargs_to_strings(p="sequence")
def coast(
self,
projection: str | None = None,
resolution: Literal[
"auto", "full", "high", "intermediate", "low", "crude", None
] = None,
box: Box | bool = False,
region: Sequence[float | str] | str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
panel: int | tuple[int, int] | bool = False,
Expand Down Expand Up @@ -71,6 +72,7 @@ def coast(
- D = resolution
- F = box
- J = projection
- R = region
- V = verbose
- c = panel
- t = transparency
Expand Down Expand Up @@ -222,6 +224,7 @@ def coast(
F=Alias(box, name="box"),
).add_common(
J=projection,
R=region,
V=verbose,
c=panel,
t=transparency,
Expand Down
7 changes: 5 additions & 2 deletions pygmt/src/colorbar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
colorbar - Plot gray scale or color scale bar.
"""

from collections.abc import Sequence
from typing import Literal

from pygmt.alias import Alias, AliasSystem
Expand All @@ -21,16 +22,16 @@
I="shading",
L="equalsize",
Q="log",
R="region",
W="scale",
Z="zfile",
p="perspective",
)
@kwargs_to_strings(R="sequence", G="sequence", I="sequence", p="sequence")
@kwargs_to_strings(G="sequence", I="sequence", p="sequence")
def colorbar(
self,
projection: str | None = None,
box: Box | bool = False,
region: Sequence[float | str] | str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
panel: int | tuple[int, int] | bool = False,
Expand All @@ -53,6 +54,7 @@ def colorbar(
{aliases}
- F = box
- J = projection
- R = region
- V = verbose
- c = panel
- t = transparency
Expand Down Expand Up @@ -151,6 +153,7 @@ def colorbar(
F=Alias(box, name="box"),
).add_common(
J=projection,
R=region,
V=verbose,
c=panel,
t=transparency,
Expand Down
9 changes: 6 additions & 3 deletions pygmt/src/contour.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
contour - Contour table data by direct triangulation.
"""

from collections.abc import Sequence
from typing import Literal

from pygmt._typing import PathLike, TableLike
Expand All @@ -23,7 +24,6 @@
C="levels",
G="label_placement",
L="triangular_mesh_pen",
R="region",
S="skip",
W="pen",
b="binary",
Expand All @@ -35,15 +35,16 @@
l="label",
p="perspective",
)
@kwargs_to_strings(R="sequence", i="sequence_comma", p="sequence")
def contour(
@kwargs_to_strings(i="sequence_comma", p="sequence")
def contour( # noqa: PLR0913
self,
data: PathLike | TableLike | None = None,
x=None,
y=None,
z=None,
no_clip: bool = False,
projection: str | None = None,
region: Sequence[float | str] | str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
panel: int | tuple[int, int] | bool = False,
Expand All @@ -63,6 +64,7 @@ def contour(
{aliases}
- J = projection
- N = no_clip
- R = region
- V = verbose
- c = panel
- t = transparency
Expand Down Expand Up @@ -164,6 +166,7 @@ def contour(
N=Alias(no_clip, name="no_clip"),
).add_common(
J=projection,
R=region,
V=verbose,
c=panel,
t=transparency,
Expand Down
Loading
Loading