Skip to content

TYP: Adjust type hint of Norm.__call__ to return masked array #26434

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
QuLogic merged 2 commits into from
Aug 3, 2023
Merged

TYP: Adjust type hint of Norm.__call__ to return masked array #26434

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
47d155d
Adjust type hint of Norm.__call__ to return masked array
ksunden Aug 2, 2023
6385edc
Use overloads for Normalize.__call__ and inverse, ensure NoNorm retur…
ksunden Aug 2, 2023
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
Next Next commit
Adjust type hint of Norm.__call__ to return masked array 
xref pydata/xarray#8030

We were perhaps overly permissive in the return type, I'm pretty sure we always return Masked Array, so may as well say so, so that downstream can rely on that (which they already are, to be clear...)
  • Loading branch information
@ksunden
ksunden committed Aug 2, 2023
commit 47d155d7100bb0eb6e0c5eacd75f8e1ac1e0c3b5
10 changes: 5 additions & 5 deletions lib/matplotlib/colors.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ class Normalize:
def clip(self, value: bool) -> None: ...
@staticmethod
def process_value(value: ArrayLike) -> tuple[np.ma.MaskedArray, bool]: ...
def __call__(self, value: ArrayLike, clip: bool | None = ...) -> ArrayLike: ...
def __call__(self, value: ArrayLike, clip: bool | None = ...) -> np.ma.MaskedArray: ...
def inverse(self, value: ArrayLike) -> ArrayLike: ...
def autoscale(self, A: ArrayLike) -> None: ...
def autoscale_None(self, A: ArrayLike) -> None: ...
Expand All @@ -161,7 +161,7 @@ class TwoSlopeNorm(Normalize):
@vcenter.setter
def vcenter(self, value: float) -> None: ...
def autoscale_None(self, A: ArrayLike) -> None: ...
def __call__(self, value: ArrayLike, clip: bool | None = ...) -> ArrayLike: ...
def __call__(self, value: ArrayLike, clip: bool | None = ...) -> np.ma.MaskedArray: ...
def inverse(self, value: ArrayLike) -> ArrayLike: ...

class CenteredNorm(Normalize):
Expand Down Expand Up @@ -240,7 +240,7 @@ class PowerNorm(Normalize):
vmax: float | None = ...,
clip: bool = ...,
) -> None: ...
def __call__(self, value: ArrayLike, clip: bool | None = ...) -> ArrayLike: ...
def __call__(self, value: ArrayLike, clip: bool | None = ...) -> np.ma.MaskedArray: ...
def inverse(self, value: ArrayLike) -> ArrayLike: ...

class BoundaryNorm(Normalize):
Expand All @@ -256,11 +256,11 @@ class BoundaryNorm(Normalize):
*,
extend: Literal["neither", "both", "min", "max"] = ...
) -> None: ...
def __call__(self, value: ArrayLike, clip: bool | None = ...) -> ArrayLike: ...
def __call__(self, value: ArrayLike, clip: bool | None = ...) -> np.ma.MaskedArray: ...
def inverse(self, value: ArrayLike) -> ArrayLike: ...

class NoNorm(Normalize):
def __call__(self, value: ArrayLike, clip: bool | None = ...) -> ArrayLike: ...
def __call__(self, value: ArrayLike, clip: bool | None = ...) -> np.ma.MaskedArray: ...
def inverse(self, value: ArrayLike) -> ArrayLike: ...

def rgb_to_hsv(arr: ArrayLike) -> np.ndarray: ...
Expand Down