Skip to content

Commit a1d168d

Browse files
eendebakpteendebakpt
authored
Update type annotation for center argument of dataaray_plot methods (#8261)
* Update type annotation for center argument of dataaray_plot methods * address review comments
1 parent 26b5fe2 commit a1d168d

File tree

2 files changed

+19
-17
lines changed

2 files changed

+19
-17
lines changed

‎doc/whats-new.rst

+2
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,8 @@ Bug fixes
139139
- Static typing of dunder ops methods (like :py:meth:`DataArray.__eq__`) has been fixed.
140140
Remaining issues are upstream problems (:issue:`7780`, :pull:`8204`).
141141
By `Michael Niklas <https://github.com/headtr1ck>`_.
142+
- Fix type annotation for ``center`` argument of plotting methods (like :py:meth:`xarray.plot.dataarray_plot.pcolormesh`) (:pull:`8261`).
143+
By `Pieter Eendebak <https://github.com/eendebakpt>`_.
142144

143145
Documentation
144146
~~~~~~~~~~~~~

‎xarray/plot/dataarray_plot.py

+17-17
Original file line numberDiff line numberDiff line change
@@ -1348,7 +1348,7 @@ def _plot2d(plotfunc):
13481348
`seaborn color palette <https://seaborn.pydata.org/tutorial/color_palettes.html>`_.
13491349
Note: if ``cmap`` is a seaborn color palette and the plot type
13501350
is not ``'contour'`` or ``'contourf'``, ``levels`` must also be specified.
1351-
center : float, optional
1351+
center : float or False, optional
13521352
The value at which to center the colormap. Passing this value implies
13531353
use of a diverging colormap. Setting it to ``False`` prevents use of a
13541354
diverging colormap.
@@ -1432,7 +1432,7 @@ def newplotfunc(
14321432
vmin: float | None = None,
14331433
vmax: float | None = None,
14341434
cmap: str | Colormap | None = None,
1435-
center: float | None = None,
1435+
center: float | Literal[False] | None = None,
14361436
robust: bool = False,
14371437
extend: ExtendOptions = None,
14381438
levels: ArrayLike | None = None,
@@ -1692,7 +1692,7 @@ def imshow( # type: ignore[misc,unused-ignore] # None is hashable :(
16921692
vmin: float | None = None,
16931693
vmax: float | None = None,
16941694
cmap: str | Colormap | None = None,
1695-
center: float | None = None,
1695+
center: float | Literal[False] | None = None,
16961696
robust: bool = False,
16971697
extend: ExtendOptions = None,
16981698
levels: ArrayLike | None = None,
@@ -1733,7 +1733,7 @@ def imshow(
17331733
vmin: float | None = None,
17341734
vmax: float | None = None,
17351735
cmap: str | Colormap | None = None,
1736-
center: float | None = None,
1736+
center: float | Literal[False] | None = None,
17371737
robust: bool = False,
17381738
extend: ExtendOptions = None,
17391739
levels: ArrayLike | None = None,
@@ -1774,7 +1774,7 @@ def imshow(
17741774
vmin: float | None = None,
17751775
vmax: float | None = None,
17761776
cmap: str | Colormap | None = None,
1777-
center: float | None = None,
1777+
center: float | Literal[False] | None = None,
17781778
robust: bool = False,
17791779
extend: ExtendOptions = None,
17801780
levels: ArrayLike | None = None,
@@ -1911,7 +1911,7 @@ def contour( # type: ignore[misc,unused-ignore] # None is hashable :(
19111911
vmin: float | None = None,
19121912
vmax: float | None = None,
19131913
cmap: str | Colormap | None = None,
1914-
center: float | None = None,
1914+
center: float | Literal[False] | None = None,
19151915
robust: bool = False,
19161916
extend: ExtendOptions = None,
19171917
levels: ArrayLike | None = None,
@@ -1952,7 +1952,7 @@ def contour(
19521952
vmin: float | None = None,
19531953
vmax: float | None = None,
19541954
cmap: str | Colormap | None = None,
1955-
center: float | None = None,
1955+
center: float | Literal[False] | None = None,
19561956
robust: bool = False,
19571957
extend: ExtendOptions = None,
19581958
levels: ArrayLike | None = None,
@@ -1993,7 +1993,7 @@ def contour(
19931993
vmin: float | None = None,
19941994
vmax: float | None = None,
19951995
cmap: str | Colormap | None = None,
1996-
center: float | None = None,
1996+
center: float | Literal[False] | None = None,
19971997
robust: bool = False,
19981998
extend: ExtendOptions = None,
19991999
levels: ArrayLike | None = None,
@@ -2047,7 +2047,7 @@ def contourf( # type: ignore[misc,unused-ignore] # None is hashable :(
20472047
vmin: float | None = None,
20482048
vmax: float | None = None,
20492049
cmap: str | Colormap | None = None,
2050-
center: float | None = None,
2050+
center: float | Literal[False] | None = None,
20512051
robust: bool = False,
20522052
extend: ExtendOptions = None,
20532053
levels: ArrayLike | None = None,
@@ -2088,7 +2088,7 @@ def contourf(
20882088
vmin: float | None = None,
20892089
vmax: float | None = None,
20902090
cmap: str | Colormap | None = None,
2091-
center: float | None = None,
2091+
center: float | Literal[False] | None = None,
20922092
robust: bool = False,
20932093
extend: ExtendOptions = None,
20942094
levels: ArrayLike | None = None,
@@ -2129,7 +2129,7 @@ def contourf(
21292129
vmin: float | None = None,
21302130
vmax: float | None = None,
21312131
cmap: str | Colormap | None = None,
2132-
center: float | None = None,
2132+
center: float | Literal[False] | None = None,
21332133
robust: bool = False,
21342134
extend: ExtendOptions = None,
21352135
levels: ArrayLike | None = None,
@@ -2183,7 +2183,7 @@ def pcolormesh( # type: ignore[misc,unused-ignore] # None is hashable :(
21832183
vmin: float | None = None,
21842184
vmax: float | None = None,
21852185
cmap: str | Colormap | None = None,
2186-
center: float | None = None,
2186+
center: float | Literal[False] | None = None,
21872187
robust: bool = False,
21882188
extend: ExtendOptions = None,
21892189
levels: ArrayLike | None = None,
@@ -2224,7 +2224,7 @@ def pcolormesh(
22242224
vmin: float | None = None,
22252225
vmax: float | None = None,
22262226
cmap: str | Colormap | None = None,
2227-
center: float | None = None,
2227+
center: float | Literal[False] | None = None,
22282228
robust: bool = False,
22292229
extend: ExtendOptions = None,
22302230
levels: ArrayLike | None = None,
@@ -2265,7 +2265,7 @@ def pcolormesh(
22652265
vmin: float | None = None,
22662266
vmax: float | None = None,
22672267
cmap: str | Colormap | None = None,
2268-
center: float | None = None,
2268+
center: float | Literal[False] | None = None,
22692269
robust: bool = False,
22702270
extend: ExtendOptions = None,
22712271
levels: ArrayLike | None = None,
@@ -2370,7 +2370,7 @@ def surface(
23702370
vmin: float | None = None,
23712371
vmax: float | None = None,
23722372
cmap: str | Colormap | None = None,
2373-
center: float | None = None,
2373+
center: float | Literal[False] | None = None,
23742374
robust: bool = False,
23752375
extend: ExtendOptions = None,
23762376
levels: ArrayLike | None = None,
@@ -2411,7 +2411,7 @@ def surface(
24112411
vmin: float | None = None,
24122412
vmax: float | None = None,
24132413
cmap: str | Colormap | None = None,
2414-
center: float | None = None,
2414+
center: float | Literal[False] | None = None,
24152415
robust: bool = False,
24162416
extend: ExtendOptions = None,
24172417
levels: ArrayLike | None = None,
@@ -2452,7 +2452,7 @@ def surface(
24522452
vmin: float | None = None,
24532453
vmax: float | None = None,
24542454
cmap: str | Colormap | None = None,
2455-
center: float | None = None,
2455+
center: float | Literal[False] | None = None,
24562456
robust: bool = False,
24572457
extend: ExtendOptions = None,
24582458
levels: ArrayLike | None = None,

0 commit comments

Comments
 (0)