Skip to content

Commit 66d8661

Browse files
committed
Limit list from_arrays/from_pandas masks, align with runtime
1 parent bc94a18 commit 66d8661

2 files changed

Lines changed: 17 additions & 7 deletions

File tree

‎python/pyarrow-stubs-tests/test_array.py‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,16 @@ def test_list_arrays() -> None:
165165
pa.FixedSizeListArray),
166166
pa.FixedSizeListArray)
167167

168+
# mask must be a boolean pyarrow Array (no lists or ndarrays)
169+
mask = pa.array([False, True])
170+
check(assert_type(pa.ListArray.from_arrays([0, 1, 2], [1, 2], mask=mask),
171+
pa.ListArray),
172+
pa.ListArray)
173+
if TYPE_CHECKING:
174+
pa.ListArray.from_arrays(
175+
[0, 1, 2], [1, 2], mask=[False, True] # type: ignore[arg-type]
176+
)
177+
168178
# MapArray is a ListArray (of key-item structs) at runtime.
169179
map_arr = pa.MapArray.from_arrays([0, 2], [1, 2], ["a", "b"])
170180
check(assert_type(map_arr, pa.MapArray), pa.ListArray)

‎python/pyarrow-stubs/__lib/array.pyi‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ class Array(_PandasConvertible):
158158
@staticmethod
159159
def from_pandas(
160160
obj: pd.Series | np.ndarray | ArrayLike,
161-
mask: Mask | None = None,
161+
mask: Array | Iterable[bool] | NDArray[np.bool_] | None = None,
162162
type: DataType | str | None = None,
163163
safe: bool = True,
164164
memory_pool: MemoryPool | None = None,
@@ -321,7 +321,7 @@ class ListArray(BaseListArray):
321321
values: Array | Iterable[Any],
322322
type: DataType | None = None,
323323
pool: MemoryPool | None = None,
324-
mask: Mask | None = None,
324+
mask: Array | None = None,
325325
) -> ListArray: ...
326326
@property
327327
def values(self) -> Array: ...
@@ -336,7 +336,7 @@ class LargeListArray(BaseListArray):
336336
values: Array | Iterable[Any],
337337
type: DataType | None = None,
338338
pool: MemoryPool | None = None,
339-
mask: Mask | None = None,
339+
mask: Array | None = None,
340340
) -> LargeListArray: ...
341341
@property
342342
def values(self) -> Array: ...
@@ -352,7 +352,7 @@ class ListViewArray(BaseListArray):
352352
values: Array | Iterable[Any],
353353
type: DataType | None = None,
354354
pool: MemoryPool | None = None,
355-
mask: Mask | None = None,
355+
mask: Array | None = None,
356356
) -> ListViewArray: ...
357357
@property
358358
def values(self) -> Array: ...
@@ -370,7 +370,7 @@ class LargeListViewArray(BaseListArray):
370370
values: Array | Iterable[Any],
371371
type: DataType | None = None,
372372
pool: MemoryPool | None = None,
373-
mask: Mask | None = None,
373+
mask: Array | None = None,
374374
) -> LargeListViewArray: ...
375375
@property
376376
def values(self) -> Array: ...
@@ -386,7 +386,7 @@ class FixedSizeListArray(BaseListArray):
386386
values: Array | Iterable[Any],
387387
list_size: int | None = None,
388388
type: DataType | None = None,
389-
mask: Mask | None = None,
389+
mask: Array | None = None,
390390
) -> FixedSizeListArray: ...
391391
@property
392392
def values(self) -> Array: ...
@@ -400,7 +400,7 @@ class MapArray(ListArray):
400400
items: Array | Iterable[Any],
401401
type: DataType | None = None,
402402
pool: MemoryPool | None = None,
403-
mask: Mask | None = None,
403+
mask: Array | None = None,
404404
) -> MapArray: ...
405405
@property
406406
def keys(self) -> Array: ...

0 commit comments

Comments
 (0)