TYP: fix ndarray.tolist() and .item() for unknown dtype
#28644
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Diff from mypy_primer, showing the effect of this PR on type check results on a corpus of open source code: spark (https://github.com/apache/spark)
- python/pyspark/ml/connect/serialize.py:73: error: Argument 1 to "build_int_list" has incompatible type "int | list[int] | list[list[int]] | list[list[list[Any]]]"; expected "list[int]" [arg-type]
- python/pyspark/ml/connect/serialize.py:75: error: Argument 1 to "build_float_list" has incompatible type "float | list[float] | list[list[float]] | list[list[list[Any]]]"; expected "list[float]" [arg-type]
- python/pyspark/ml/connect/serialize.py:88: error: Argument 1 to "build_float_list" has incompatible type "str"; expected "list[float]" [arg-type]
- python/pyspark/ml/connect/serialize.py:101: error: Argument 1 to "build_int_list" has incompatible type "str"; expected "list[int]" [arg-type]
- python/pyspark/ml/connect/serialize.py:103: error: Argument 1 to "build_int_list" has incompatible type "str"; expected "list[int]" [arg-type]
- python/pyspark/ml/connect/serialize.py:105: error: Argument 1 to "build_float_list" has incompatible type "str"; expected "list[float]" [arg-type]
- python/pyspark/ml/connect/serialize.py:124: error: Argument 1 to "build_float_list" has incompatible type "str"; expected "list[float]" [arg-type]
pandas (https://github.com/pandas-dev/pandas)
- pandas/core/arrays/masked.py:518: error: Incompatible return value type (got "str", expected "list[Any]") [return-value]
- pandas/core/base.py:878: error: Incompatible return value type (got "list[Any] | str", expected "list[Any]") [return-value]
- pandas/io/formats/format.py:1498: error: Incompatible return value type (got "Any | list[Any] | list[list[Any]] | list[list[list[Any]]]", expected "list[str]") [return-value]
- pandas/core/groupby/generic.py:2145: error: Incompatible types in assignment (expression has type "str | list[str] | list[list[str]] | list[list[list[Any]]]", variable has type "ndarray[tuple[int, ...], dtype[Any]]") [assignment]
- pandas/plotting/_matplotlib/style.py:276: error: Incompatible return value type (got "float | list[float] | list[list[float]] | list[list[list[Any]]]", expected "list[float]") [return-value]
static-frame (https://github.com/static-frame/static-frame)
- static_frame/core/index.py:1536: error: Incompatible types in assignment (expression has type "str", variable has type "list[TLabel]") [assignment]
- static_frame/core/pivot.py:757: error: Incompatible types in assignment (expression has type "str", variable has type "list[type[IndexBase]]") [assignment]
- static_frame/core/frame.py:4281: error: Incompatible types in assignment (expression has type "str", variable has type "list[Callable[..., IndexBase] | type[Index[Any]] | None]") [assignment]
xarray (https://github.com/pydata/xarray)
- xarray/core/utils.py: note: In function "decode_numpy_dict_values":
- xarray/core/utils.py:754: error: Incompatible types in assignment (expression has type "str", target has type "V") [assignment]
- xarray/plot/utils.py: note: In function "_add_legend":
- xarray/plot/utils.py:1747: error: Incompatible types in assignment (expression has type "str | list[str] | list[list[str]] | list[list[list[Any]]]", variable has type "list[Any]") [assignment]
- xarray/plot/utils.py:1748: error: Incompatible types in assignment (expression has type "str | list[str] | list[list[str]] | list[list[list[Any]]]", variable has type "list[Any]") [assignment]
- xarray/plot/utils.py: note: At top level:
- xarray/tests/test_dataarray.py: note: In member "test_to_and_from_dict" of class "TestDataArray":
- xarray/tests/test_dataarray.py:3611: error: Incompatible types in assignment (expression has type "str", variable has type "ndarray[Any, Any]") [assignment]
- xarray/tests/test_dataarray.py:3612: error: Incompatible types in assignment (expression has type "str | list[str] | list[list[str]] | list[list[list[Any]]]", variable has type "ndarray[tuple[int, ...], dtype[Any]]") [assignment]
|
There was a problem hiding this comment.
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (3)
numpy/init.pyi:2179
- There appears to be a naming inconsistency with 'NDArray' here; if it is intended to refer to the current class 'ndarray', consider using consistent naming to avoid confusion.
def item(self: NDArray[generic[_T]], i0: SupportsIndex | tuple[SupportsIndex, ...] = ..., /, *args: SupportsIndex) -> _T:
numpy/init.pyi:5340
- Using 'pyright: ignore[reportIncompatibleMethodOverride]' may suppress underlying type issues; if possible, consider refining the override signature to avoid relying on ignores.
def tolist(self: matrix[Any, dtype[generic[_T]]]) -> list[list[_T]]: ... # pyright: ignore[reportIncompatibleMethodOverride]
numpy/init.pyi:2197
- The general 'tolist' overload that returns 'Any' might mask type information for arrays with known shapes; verify that this behavior is intentional and does not regress type inference for well-defined cases.
def tolist(self, /) -> Any: ...
|
Thanks Joren. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This fixes #27944 for both mypy and pyright.
I used the new generic
generictype as a more direct alternative to match the.item()type of the underlying scalar-type. This way, we don't have to rely on on pyright's constraint set solving algorithm (recently introduced so not yet in pylance, and slightly incorrect in case of overlap). Mypy doesn't support constraint-sets, and it instead always chooses the first matching overload, causing it to behave incorrectly.