Skip to content

TYP: Add type hints for the 'projection' parameter #4123

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
seisman merged 2 commits into from
Sep 29, 2025
Merged

TYP: Add type hints for the 'projection' parameter #4123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ea0e6c
TYP: Add type hints for the 'projection' parameter
seisman Sep 26, 2025
f0fea46
Update projection type hint in decorators
seisman Sep 26, 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
4 changes: 2 additions & 2 deletions pygmt/helpers/decorators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@
the viewpoint [Default is ``[180, 90]``]. Full documentation is at
:gmt-docs:`gmt.html#perspective-full`.""",
"projection": r"""
projection : str
projection
*projcode*\[*projparams*/]\ *width*\|\ *scale*.
Select map :doc:`projection </projections/index>`.""",
"region": r"""
Expand Down Expand Up @@ -415,7 +415,7 @@ def fmt_docstring(module_func):
region : str or list
*xmin/xmax/ymin/ymax*\ [**+r**][**+u**\ *unit*].
Specify the :doc:`region </tutorials/basics/regions>` of interest.
projection : str
projection
*projcode*\[*projparams*/]\ *width*\|\ *scale*.
Select map :doc:`projection </projections/index>`.
<BLANKLINE>
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/basemap.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
@kwargs_to_strings(R="sequence", p="sequence")
def basemap(
self,
projection=None,
projection: str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
panel: int | tuple[int, int] | bool = False,
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/coast.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
@kwargs_to_strings(R="sequence", p="sequence")
def coast(
self,
projection=None,
projection: str | None = None,
resolution: Literal[
"auto", "full", "high", "intermediate", "low", "crude", None
] = None,
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/colorbar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
@kwargs_to_strings(R="sequence", G="sequence", I="sequence", p="sequence")
def colorbar(
self,
projection=None,
projection: str | None = None,
box: Box | bool = False,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/contour.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ def contour(
y=None,
z=None,
no_clip: bool = False,
projection=None,
projection: str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
panel: int | tuple[int, int] | bool = False,
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/grdcontour.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
def grdcontour(
self,
grid: PathLike | xr.DataArray,
projection=None,
projection: str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
panel: int | tuple[int, int] | bool = False,
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/grdcut.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ def grdcut(
grid: PathLike | xr.DataArray,
kind: Literal["grid", "image"] = "grid",
outgrid: PathLike | None = None,
projection=None,
projection: str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
**kwargs,
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/grdimage.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ def grdimage(
grid: PathLike | xr.DataArray,
monochrome: bool = False,
no_clip: bool = False,
projection=None,
projection: str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
panel: int | tuple[int, int] | bool = False,
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/grdproject.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
def grdproject(
grid: PathLike | xr.DataArray,
outgrid: PathLike | None = None,
projection=None,
projection: str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
**kwargs,
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/grdview.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
def grdview(
self,
grid: PathLike | xr.DataArray,
projection=None,
projection: str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
panel: int | tuple[int, int] | bool = False,
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/histogram.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
def histogram(
self,
data: PathLike | TableLike,
projection=None,
projection: str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
panel: int | tuple[int, int] | bool = False,
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/image.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
def image(
self,
imagefile: PathLike,
projection=None,
projection: str | None = None,
box: Box | bool = False,
monochrome: bool = False,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/inset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
@kwargs_to_strings(D="sequence", M="sequence", R="sequence")
def inset(
self,
projection=None,
projection: str | None = None,
box: Box | bool = False,
no_clip: bool = False,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/legend.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
def legend(
self,
spec: PathLike | io.StringIO | None = None,
projection=None,
projection: str | None = None,
position="JTR+jTR+o0.2c",
box: Box | bool = False,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/logo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
@kwargs_to_strings(R="sequence", p="sequence")
def logo(
self,
projection=None,
projection: str | None = None,
style: Literal["standard", "url", "no_label"] = "standard",
box: Box | bool = False,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/meca.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ def meca( # noqa: PLR0913
plot_latitude: float | Sequence[float] | None = None,
event_name: str | Sequence[str] | None = None,
no_clip: bool = False,
projection=None,
projection: str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
panel: int | tuple[int, int] | bool = False,
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/plot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ def plot( # noqa: PLR0912, PLR0913
symbol=None,
direction=None,
straight_line: bool | Literal["x", "y"] = False,
projection=None,
projection: str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
panel: int | tuple[int, int] | bool = False,
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/plot3d.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ def plot3d( # noqa: PLR0912, PLR0913
symbol=None,
direction=None,
straight_line: bool | Literal["x", "y"] = False,
projection=None,
projection: str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
panel: int | tuple[int, int] | bool = False,
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/select.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ def select(
resolution: Literal[
"auto", "full", "high", "intermediate", "low", "crude", None
] = None,
projection=None,
projection: str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
**kwargs,
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/solar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ def solar(
terminator_datetime=None,
fill: str | None = None,
pen: str | None = None,
projection=None,
projection: str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
panel: int | tuple[int, int] | bool = False,
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/subplot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ def subplot(
self,
nrows=1,
ncols=1,
projection=None,
projection: str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
**kwargs,
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/text.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ def text_( # noqa: PLR0912, PLR0913, PLR0915
font=None,
justify: bool | None | AnchorCode | Sequence[AnchorCode] = None,
no_clip: bool = False,
projection=None,
projection: str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
panel: int | tuple[int, int] | bool = False,
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/tilemap.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ def tilemap( # noqa: PLR0913
zoom_adjust: int | None = None,
monochrome: bool = False,
no_clip: bool = False,
projection=None,
projection: str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
panel: int | tuple[int, int] | bool = False,
Expand Down
4 changes: 2 additions & 2 deletions pygmt/src/triangulate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ def regular_grid(
y=None,
z=None,
outgrid: PathLike | None = None,
projection=None,
projection: str | None = None,
verbose: Literal[
"quiet", "error", "warning", "timing", "info", "compat", "debug"
]
Expand Down Expand Up @@ -190,7 +190,7 @@ def delaunay_triples(
*,
output_type: Literal["pandas", "numpy", "file"] = "pandas",
outfile: PathLike | None = None,
projection=None,
projection: str | None = None,
verbose: Literal[
"quiet", "error", "warning", "timing", "info", "compat", "debug"
]
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/velo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ def velo(
self,
data: PathLike | TableLike | None = None,
no_clip: bool = False,
projection=None,
projection: str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
panel: int | tuple[int, int] | bool = False,
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/wiggle.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ def wiggle( # noqa: PLR0913
z=None,
fillpositive=None,
fillnegative=None,
projection=None,
projection: str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
panel: int | tuple[int, int] | bool = False,
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/xyz2grd.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ def xyz2grd(
y=None,
z=None,
outgrid: PathLike | None = None,
projection=None,
projection: str | None = None,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
**kwargs,
Expand Down
Loading