Skip to content

Add doctest_skips for xarray<2025.10.1 and update output DataArray repr #4145

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 2 commits into from
Oct 9, 2025
Merged

Add doctest_skips for xarray<2025.10.1 and update output DataArray repr #4145

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
cb0f604
Add doctest_skips for xarray<2025.10.0
weiji14 Oct 8, 2025
627c678
Apply suggestions from code review
weiji14 Oct 8, 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
30 changes: 18 additions & 12 deletions pygmt/datatypes/image.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,14 @@

import numpy as np
import xarray as xr
from packaging.version import Version
from pygmt.datatypes.header import _GMT_GRID_HEADER

# TODO(xarray>=2025.10.1): Remove the __doctest_skip__ on _GMT_IMAGE.to_xarray
__doctest_skip__ = (
["_GMT_IMAGE.to_xarray"] if Version(xr.__version__) < Version("2025.10.1") else []
)


class _GMT_IMAGE(ctp.Structure): # noqa: N801
"""
Expand Down Expand Up @@ -115,8 +121,8 @@ def to_xarray(self) -> xr.DataArray:
... image = lib.read_virtualfile(voutimg, kind="image")
... # Convert to xarray.DataArray and use it later
... da = image.contents.to_xarray()
>>> da # doctest: +NORMALIZE_WHITESPACE, +ELLIPSIS
<xarray.DataArray 'z' (band: 3, y: 180, x: 360)>...
>>> da # doctest: +NORMALIZE_WHITESPACE
<xarray.DataArray 'z' (band: 3, y: 180, x: 360)> Size: 194kB
array([[[ 10, 10, 10, ..., 10, 10, 10],
[ 10, 10, 10, ..., 10, 10, 10],
[ 10, 10, 10, ..., 10, 10, 10],
Expand All @@ -141,26 +147,26 @@ def to_xarray(self) -> xr.DataArray:
[185, 187, 187, ..., 187, 186, 185],
[189, 191, 191, ..., 191, 191, 189]]], dtype=uint8)
Coordinates:
* y (y) float64... 89.5 88.5 87.5 86.5 ... -86.5 -87.5 -88.5 -89.5
* x (x) float64... -179.5 -178.5 -177.5 -176.5 ... 177.5 178.5 179.5
* band (band) uint8... 1 2 3
* band (band) uint8 3B 1 2 3
* y (y) float64 1kB 89.5 88.5 87.5 86.5 ... -86.5 -87.5 -88.5 -89.5
* x (x) float64 3kB -179.5 -178.5 -177.5 -176.5 ... 177.5 178.5 179.5
Attributes:
long_name: z
long_name: z

>>> da.coords["x"] # doctest: +NORMALIZE_WHITESPACE, +ELLIPSIS
<xarray.DataArray 'x' (x: 360)>...
>>> da.coords["x"] # doctest: +NORMALIZE_WHITESPACE
<xarray.DataArray 'x' (x: 360)> Size: 3kB
array([-179.5, -178.5, -177.5, ..., 177.5, 178.5, 179.5])
Coordinates:
* x (x) float64... -179.5 -178.5 -177.5 -176.5 ... 177.5 178.5 179.5
* x (x) float64 3kB -179.5 -178.5 -177.5 -176.5 ... 177.5 178.5 179.5
Attributes:
long_name: x
axis: X
actual_range: [-180. 180.]
>>> da.coords["y"] # doctest: +NORMALIZE_WHITESPACE, +ELLIPSIS
<xarray.DataArray 'y' (y: 180)>...
>>> da.coords["y"] # doctest: +NORMALIZE_WHITESPACE
<xarray.DataArray 'y' (y: 180)> Size: 1kB
array([ 89.5, 88.5, 87.5, 86.5, ..., -87.5, -88.5, -89.5])
Coordinates:
* y (y) float64... 89.5 88.5 87.5 86.5 ... -86.5 -87.5 -88.5 -89.5
* y (y) float64 1kB 89.5 88.5 87.5 86.5 ... -86.5 -87.5 -88.5 -89.5
Attributes:
long_name: y
axis: Y
Expand Down
26 changes: 16 additions & 10 deletions pygmt/xarray/backend.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,19 @@
from typing import Literal

import xarray as xr
from packaging.version import Version
from pygmt._typing import PathLike
from pygmt.clib import Session
from pygmt.exceptions import GMTValueError
from pygmt.helpers import build_arg_list, kwargs_to_strings
from pygmt.src.which import which
from xarray.backends import BackendEntrypoint

# TODO(xarray>=2025.10.1): Remove the __doctest_skip__ on GMTBackendEntrypoint
__doctest_skip__ = (
["GMTBackendEntrypoint"] if Version(xr.__version__) < Version("2025.10.1") else []
)


class GMTBackendEntrypoint(BackendEntrypoint):
"""
Expand Down Expand Up @@ -44,12 +50,12 @@ class GMTBackendEntrypoint(BackendEntrypoint):
>>> da_grid = xr.open_dataarray(
... "@static_earth_relief.nc", engine="gmt", raster_kind="grid"
... )
>>> da_grid # doctest: +NORMALIZE_WHITESPACE, +ELLIPSIS
<xarray.DataArray 'z' (lat: 14, lon: 8)>...
>>> da_grid # doctest: +NORMALIZE_WHITESPACE
<xarray.DataArray 'z' (lat: 14, lon: 8)> Size: 448B
[112 values with dtype=float32]
Coordinates:
* lat (lat) float64... -23.5 -22.5 -21.5 -20.5 ... -12.5 -11.5 -10.5
* lon (lon) float64... -54.5 -53.5 -52.5 -51.5 -50.5 -49.5 -48.5 -47.5
* lat (lat) float64 112B -23.5 -22.5 -21.5 -20.5 ... -12.5 -11.5 -10.5
* lon (lon) float64 64B -54.5 -53.5 -52.5 -51.5 -50.5 -49.5 -48.5 -47.5
Attributes:...
Conventions: CF-1.7
title: Produced by grdcut
Expand All @@ -63,13 +69,13 @@ class GMTBackendEntrypoint(BackendEntrypoint):
>>> da_image = xr.open_dataarray(
... "@earth_night_01d", engine="gmt", raster_kind="image"
... )
>>> da_image # doctest: +NORMALIZE_WHITESPACE, +ELLIPSIS
<xarray.DataArray 'z' (band: 3, y: 180, x: 360)>...
>>> da_image # doctest: +NORMALIZE_WHITESPACE
<xarray.DataArray 'z' (band: 3, y: 180, x: 360)> Size: 194kB
[194400 values with dtype=uint8]
Coordinates:
* band (band) uint8... 1 2 3
* y (y) float64... 89.5 88.5 87.5 86.5 ... -86.5 -87.5 -88.5 -89.5
* x (x) float64... -179.5 -178.5 -177.5 -176.5 ... 177.5 178.5 179.5
* band (band) uint8... 1 2 3
Attributes:...
long_name: z

Expand All @@ -80,15 +86,15 @@ class GMTBackendEntrypoint(BackendEntrypoint):
... "@tut_bathy.nc", engine="gmt", raster_kind="grid", region=[-64, -62, 32, 33]
... )
>>> da_grid
<xarray.DataArray 'z' (lat: 13, lon: 25)>...
<xarray.DataArray 'z' (lat: 13, lon: 25)> Size: 1kB
array([[-4369., -4587., -4469., -4409., -4587., -4505., -4403., -4405.,
-4466., -4595., -4609., -4608., -4606., -4607., -4607., -4597.,
...
-4667., -4642., -4677., -4795., -4797., -4800., -4803., -4818.,
-4820.]], dtype=float32)
Coordinates:
* lat (lat) float64... 32.0 32.08 32.17 32.25 ... 32.83 32.92 33.0
* lon (lon) float64... -64.0 -63.92 -63.83 ... -62.17 -62.08 -62.0
* lat (lat) float64 104B 32.0 32.08 32.17 32.25 ... 32.83 32.92 33.0
* lon (lon) float64 200B -64.0 -63.92 -63.83 ... -62.17 -62.08 -62.0
Attributes:...
Conventions: CF-1.7
title: ETOPO5 global topography
Expand Down
Loading