Skip to content

Commit bc6a844

Browse files
committed
Remove ArrayLike import and define _ArrayLike
1 parent 5ce3deb commit bc6a844

2 files changed

Lines changed: 37 additions & 20 deletions

File tree

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,16 @@ def test_array_functions() -> None:
182182
check(pc.round([1.5, 2.5]), pa.Array)
183183
check(pc.binary_join_element_wise(["a", "b"], ["c", "d"], "-"), pa.Array)
184184

185+
import numpy as np
186+
check(pc.variance([1, 2, 3]), pa.DoubleScalar)
187+
check(pc.variance((1, 2, 3)), pa.DoubleScalar)
188+
check(pc.variance(np.array([1.0, 2.0, 3.0])), pa.DoubleScalar)
189+
190+
selected = pc.if_else([True, False], [1, 2], [3, 4])
191+
check(assert_type(selected, pa.Scalar | pa.Array | pa.ChunkedArray | pc.Expression),
192+
pa.Array)
193+
check(pc.if_else(pc.field("a") > 1, 1, 2), pc.Expression)
194+
185195
# Python literals are accepted next to arrays.
186196
check(pc.power(arr, 2), pa.Array)
187197
check(pc.divide(arr, 2.0), pa.Array)
@@ -193,3 +203,4 @@ def test_array_functions() -> None:
193203
if TYPE_CHECKING:
194204
pc.top_k_unstable(arr, "2") # type: ignore[arg-type]
195205
pc.sort_indices(table, [("a", "up")]) # type: ignore[list-item]
206+
pc.cumulative_sum(range(3)) # type: ignore[arg-type]

‎python/pyarrow-stubs/compute.pyi‎

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
from collections.abc import Callable, Hashable, Iterable, Sequence
1919
from typing import Any, ParamSpec, TypeAlias, TypeVar
2020

21+
from numpy.typing import NDArray
22+
2123
# Placeholders (Any) until scalar.pyi is annotated; mypy rejects them as
2224
# types when imported through pyarrow.lib.
2325
from pyarrow.__lib.scalar import (
@@ -157,7 +159,6 @@ from pyarrow._compute import (
157159
_UnexpectedKeyBehavior,
158160
)
159161
from pyarrow._stubs_typing import (
160-
ArrayLike,
161162
Indices,
162163
Mask,
163164
NullEncoding,
@@ -259,6 +260,9 @@ _NumericOrTemporalScalar: TypeAlias = _NumericScalar | _TemporalScalar
259260
# chunked input is the same for every kind.
260261
_ArrayOrChunkedArray: TypeAlias = Array | ChunkedArray
261262
_ScalarOrArray: TypeAlias = Scalar | Array | ChunkedArray
263+
_ArrayLike: TypeAlias = (
264+
list[Any] | tuple[Any, ...] | NDArray[Any] | Array | ChunkedArray
265+
)
262266
_DecimalArray: TypeAlias = (
263267
Decimal32Array | Decimal64Array | Decimal128Array | Decimal256Array
264268
)
@@ -436,7 +440,7 @@ def tdigest(
436440
memory_pool: MemoryPool | None = None,
437441
) -> DoubleArray | Expression: ...
438442
def variance(
439-
array: _NumericScalar | _ArrayOrChunkedArray | ArrayLike | Expression,
443+
array: _NumericScalar | _ArrayOrChunkedArray | _ArrayLike | Expression,
440444
/,
441445
*,
442446
ddof: int = 0,
@@ -446,7 +450,7 @@ def variance(
446450
memory_pool: MemoryPool | None = None,
447451
) -> DoubleScalar | Expression: ...
448452
def skew(
449-
array: _NumericScalar | _ArrayOrChunkedArray | ArrayLike | Expression,
453+
array: _NumericScalar | _ArrayOrChunkedArray | _ArrayLike | Expression,
450454
/,
451455
*,
452456
skip_nulls: bool = True,
@@ -456,7 +460,7 @@ def skew(
456460
memory_pool: MemoryPool | None = None,
457461
) -> DoubleScalar | Expression: ...
458462
def kurtosis(
459-
array: _NumericScalar | _ArrayOrChunkedArray | ArrayLike | Expression,
463+
array: _NumericScalar | _ArrayOrChunkedArray | _ArrayLike | Expression,
460464
/,
461465
*,
462466
skip_nulls: bool = True,
@@ -489,8 +493,10 @@ def abs(
489493
abs_checked = _clone_signature(abs)
490494

491495
def add(
492-
x: _NumericOrTemporalScalar | _ArrayOrChunkedArray | ArrayLike | int | Expression,
493-
y: (_NumericOrTemporalScalar | _ArrayOrChunkedArray | ArrayLike | int | Expression),
496+
x: _NumericOrTemporalScalar | _ArrayOrChunkedArray | _ArrayLike | int | Expression,
497+
y: (
498+
_NumericOrTemporalScalar | _ArrayOrChunkedArray | _ArrayLike | int | Expression
499+
),
494500
/,
495501
*,
496502
memory_pool: MemoryPool | None = None,
@@ -717,7 +723,7 @@ less_equal = _clone_signature(equal)
717723
not_equal = _clone_signature(equal)
718724

719725
def max_element_wise(
720-
*args: _ScalarOrArray | Expression | ScalarLike | ArrayLike,
726+
*args: _ScalarOrArray | Expression | ScalarLike | _ArrayLike,
721727
skip_nulls: bool = True,
722728
options: ElementWiseAggregateOptions | None = None,
723729
memory_pool: MemoryPool | None = None,
@@ -1100,7 +1106,7 @@ def is_null(
11001106
memory_pool: MemoryPool | None = None,
11011107
) -> BooleanScalar | _BooleanArray | Expression: ...
11021108
def is_valid(
1103-
values: _ScalarOrArray | Expression | ArrayLike,
1109+
values: _ScalarOrArray | Expression | _ArrayLike,
11041110
/,
11051111
*,
11061112
memory_pool: MemoryPool | None = None,
@@ -1113,29 +1119,29 @@ true_unless_null = _clone_signature(is_valid)
11131119
def case_when(
11141120
cond: StructScalar | _ArrayOrChunkedArray | Expression,
11151121
/,
1116-
*cases: _ScalarOrArray | ArrayLike,
1122+
*cases: _ScalarOrArray | _ArrayLike,
11171123
memory_pool: MemoryPool | None = None,
11181124
) -> _ScalarOrArray | Array | Expression: ...
11191125
def choose(
1120-
indices: ArrayLike | ScalarLike,
1126+
indices: _ArrayLike | ScalarLike | Expression,
11211127
/,
1122-
*values: ArrayLike | ScalarLike,
1128+
*values: _ArrayLike | ScalarLike,
11231129
memory_pool: MemoryPool | None = None,
1124-
) -> ArrayLike | ScalarLike: ...
1130+
) -> _ScalarOrArray | Expression: ...
11251131
def coalesce(
11261132
*values: _ScalarOrArray | Expression, memory_pool: MemoryPool | None = None
11271133
) -> _ScalarOrArray | Expression: ...
11281134
def fill_null(
1129-
values: _ScalarOrArray | ScalarLike, fill_value: ArrayLike | ScalarLike
1135+
values: _ScalarOrArray | ScalarLike, fill_value: _ArrayLike | ScalarLike
11301136
) -> _ScalarOrArray | ScalarLike: ...
11311137
def if_else(
1132-
cond: ArrayLike | ScalarLike,
1133-
left: ArrayLike | ScalarLike,
1134-
right: ArrayLike | ScalarLike,
1138+
cond: _ArrayLike | ScalarLike | Expression,
1139+
left: _ArrayLike | ScalarLike,
1140+
right: _ArrayLike | ScalarLike,
11351141
/,
11361142
*,
11371143
memory_pool: MemoryPool | None = None,
1138-
) -> ArrayLike | ScalarLike: ...
1144+
) -> _ScalarOrArray | Expression: ...
11391145

11401146
# ========================= Structural transforms =========================
11411147

@@ -1148,7 +1154,7 @@ def list_value_length(
11481154
Int32Scalar | Int64Scalar | Int32Array | Int64Array | ChunkedArray | Expression
11491155
): ...
11501156
def make_struct(
1151-
*args: _ScalarOrArray | Expression | ArrayLike,
1157+
*args: _ScalarOrArray | Expression | _ArrayLike,
11521158
field_names: Sequence[str] = (),
11531159
field_nullability: bool | None = None,
11541160
field_metadata: Sequence[KeyValueMetadata] | None = None,
@@ -1387,7 +1393,7 @@ def random(
13871393

13881394
# ========================= Cumulative Functions =========================
13891395
def cumulative_sum(
1390-
values: _ArrayOrChunkedArray | ArrayLike | Expression,
1396+
values: _ArrayOrChunkedArray | _ArrayLike | Expression,
13911397
/,
13921398
start: float | Scalar | None = None,
13931399
*,
@@ -1671,7 +1677,7 @@ def fill_null_forward(
16711677
def replace_with_mask(
16721678
values: _ScalarOrArray | Expression,
16731679
mask: Mask,
1674-
replacements: ArrayLike,
1680+
replacements: _ArrayLike,
16751681
/,
16761682
*,
16771683
memory_pool: MemoryPool | None = None,

0 commit comments

Comments
 (0)