Skip to content

pygmt.dataset.load_*: Add type hints for the 'region' parameter #3272

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 5 commits into from
May 27, 2024
Merged

pygmt.dataset.load_*: Add type hints for the 'region' parameter #3272

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d7c5f15
pygmt.dataset.load_*: Add type hints for the 'region' parameter
seisman May 25, 2024
4ddf1f9
Make changes to all load functions
seisman May 27, 2024
6767d2c
Minor fix
seisman May 27, 2024
7369cba
Merge branch 'main' into datasets/region
seisman May 27, 2024
9c2ac53
region can be a string type
seisman May 27, 2024
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
16 changes: 6 additions & 10 deletions pygmt/datasets/earth_age.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,19 @@
The grids are available in various resolutions.
"""

from collections.abc import Sequence
from typing import Literal

from pygmt.datasets.load_remote_dataset import _load_remote_dataset
from pygmt.helpers import kwargs_to_strings

__doctest_skip__ = ["load_earth_age"]


@kwargs_to_strings(region="sequence")
Copy link
Member Author

@seisman seisman May 25, 2024

Choose a reason for hiding this comment

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

This line can be removed because region is passed to _load_remote_dataset and in that function region can be a sequence.

def load_earth_age(
resolution: Literal[
"01d", "30m", "20m", "15m", "10m", "06m", "05m", "04m", "03m", "02m", "01m"
] = "01d",
region=None,
region: Sequence[float] | None = None,
registration: Literal["gridline", "pixel"] = "gridline",
):
r"""
Expand Down Expand Up @@ -56,13 +55,10 @@ def load_earth_age(
resolution
The grid resolution. The suffix ``d`` and ``m`` stand for arc-degrees and
arc-minutes.

region : str or list
The subregion of the grid to load, in the form of a list
[*xmin*, *xmax*, *ymin*, *ymax*] or a string *xmin/xmax/ymin/ymax*.
Required for grids with resolutions higher than 5
arc-minutes (i.e., ``"05m"``).

region
The subregion of the grid to load, in the form of a sequence [*xmin*, *xmax*,
*ymin*, *ymax*]. Required for grids with resolutions higher than 5 arc-minutes
(i.e., ``"05m"``).
registration
Grid registration type. Either ``"pixel"`` for pixel registration or
``"gridline"`` for gridline registration.
Expand Down