diff --git a/pyarrow-stubs/__lib_pxi/scalar.pyi b/pyarrow-stubs/__lib_pxi/scalar.pyi index 11887c0..9a56134 100644 --- a/pyarrow-stubs/__lib_pxi/scalar.pyi +++ b/pyarrow-stubs/__lib_pxi/scalar.pyi @@ -1,4 +1,4 @@ -# mypy: disable-error-code="overload-overlap,misc" +# mypy: disable-error-code="overload-overlap,misc,type-arg" import collections.abc import datetime as dt @@ -281,6 +281,10 @@ def scalar( value: Decimal, *, from_pandas: bool | None = None, memory_pool: MemoryPool | None = None ) -> Decimal128Scalar: ... @overload +def scalar( + value: dt.datetime, *, from_pandas: bool | None = None, memory_pool: MemoryPool | None = None +) -> TimestampScalar: ... +@overload def scalar( value: dt.date, *, from_pandas: bool | None = None, memory_pool: MemoryPool | None = None ) -> Date32Scalar: ... @@ -349,6 +353,13 @@ def scalar( memory_pool: MemoryPool | None = None, ) -> ListScalar[types.ListType[types.Decimal128Type]]: ... @overload +def scalar( + value: CollectionValue[dt.datetime], + *, + from_pandas: bool | None = None, + memory_pool: MemoryPool | None = None, +) -> ListScalar[types.ListType[types.TimestampType]]: ... +@overload def scalar( value: CollectionValue[dt.date], *, diff --git a/pyarrow-stubs/__lib_pxi/table.pyi b/pyarrow-stubs/__lib_pxi/table.pyi index a9ef5ae..a84f4a9 100644 --- a/pyarrow-stubs/__lib_pxi/table.pyi +++ b/pyarrow-stubs/__lib_pxi/table.pyi @@ -1,4 +1,4 @@ -# mypy: disable-error-code="overload-overlap" +# mypy: disable-error-code="overload-overlap,type-arg,misc" import datetime as dt @@ -162,6 +162,11 @@ def chunked_array( type: None = None, ) -> ChunkedArray[scalar.StructScalar]: ... @overload +def chunked_array( + values: NullableIterable[dt.datetime], + type: None = None, +) -> ChunkedArray[scalar.TimestampScalar]: ... +@overload def chunked_array( values: NullableIterable[dt.date], type: None = None, diff --git a/pyarrow-stubs/compute.pyi b/pyarrow-stubs/compute.pyi index 593d9f6..9679e72 100644 --- a/pyarrow-stubs/compute.pyi +++ b/pyarrow-stubs/compute.pyi @@ -1,4 +1,7 @@ -from typing import Literal, Sequence, TypeVar, overload +# mypy: disable-error-code="misc,type-var,var-annotated" +# ruff: noqa: I001 +from typing import Literal, TypeAlias, TypeVar, overload, Any, Iterable, ParamSpec +from collections.abc import Callable # Option classes from pyarrow._compute import ArraySortOptions as ArraySortOptions @@ -79,66 +82,1671 @@ from pyarrow._compute import register_aggregate_function as register_aggregate_f from pyarrow._compute import register_scalar_function as register_scalar_function from pyarrow._compute import register_tabular_function as register_tabular_function from pyarrow._compute import register_vector_function as register_vector_function -from pyarrow._stubs_typing import Indices from . import lib +import typing_extensions -def cast( - arr: lib.Array, - target_type: str | lib.DataType, - safe: bool = True, - options: CastOptions | None = None, +_P = ParamSpec("_P") +_R = TypeVar("_R") + +def field(*name_or_index: str | tuple[str, ...] | int) -> Expression: ... +def scalar(value: bool | float | str) -> Expression: ... +def _clone_signature(f: Callable[_P, _R]) -> Callable[_P, _R]: ... + +# ============= compute functions ============= +_DataTypeT = TypeVar("_DataTypeT", bound=lib.DataType) +NumericScalar: TypeAlias = ( + lib.Scalar[lib.Int8Type] + | lib.Scalar[lib.Int16Type] + | lib.Scalar[lib.Int32Type] + | lib.Scalar[lib.Int64Type] + | lib.Scalar[lib.Uint8Type] + | lib.Scalar[lib.Uint16Type] + | lib.Scalar[lib.Uint32Type] + | lib.Scalar[lib.Uint64Type] + | lib.Scalar[lib.Float16Type] + | lib.Scalar[lib.Float32Type] + | lib.Scalar[lib.Float64Type] + | lib.Scalar[lib.Decimal128Type] + | lib.Scalar[lib.Decimal256Type] +) +BinaryScalar: TypeAlias = ( + lib.Scalar[lib.BinaryType] + | lib.Scalar[lib.LargeBinaryType] + | lib.Scalar[lib.FixedSizeBinaryType] +) +StringScalar: TypeAlias = lib.Scalar[lib.StringType] | lib.Scalar[lib.LargeStringType] +ListScalar: TypeAlias = ( + lib.ListScalar[_DataTypeT] + | lib.LargeListScalar[_DataTypeT] + | lib.ListViewScalar[_DataTypeT] + | lib.LargeListViewScalar[_DataTypeT] + | lib.FixedSizeListScalar[_DataTypeT, Any] +) +TemporalScalar: TypeAlias = ( + lib.Date32Scalar + | lib.Date64Scalar + | lib.Time32Scalar + | lib.Time64Scalar + | lib.TimestampScalar + | lib.DurationScalar + | lib.MonthDayNanoIntervalScalar +) +_NumericScalarT = TypeVar("_NumericScalarT", bound=NumericScalar) +NumericOrDurationScalar: TypeAlias = NumericScalar | lib.DurationScalar +_NumericOrDurationT = TypeVar("_NumericOrDurationT", bound=NumericOrDurationScalar) +NumericOrTemporalScalar: TypeAlias = NumericScalar | TemporalScalar +_NumericOrTemporalT = TypeVar("_NumericOrTemporalT", bound=NumericOrTemporalScalar) +NumericArray: TypeAlias = lib.NumericArray +_NumericArrayT = TypeVar("_NumericArrayT", bound=lib.NumericArray) +NumericOrDurationArray: TypeAlias = lib.NumericArray | lib.Array[lib.DurationScalar] +_NumericOrDurationArrayT = TypeVar("_NumericOrDurationArrayT", bound=NumericOrDurationArray) +NumericOrTemporalArray: TypeAlias = lib.NumericArray | lib.Array[TemporalScalar] +_NumericOrTemporalArrayT = TypeVar("_NumericOrTemporalArrayT", bound=NumericOrTemporalArray) +FloatScalar: typing_extensions.TypeAlias = ( + lib.Scalar[lib.Float32Type] + | lib.Scalar[lib.Float64Type] + | lib.Scalar[lib.Decimal128Type] + | lib.Scalar[lib.Decimal256Type] +) +_FloatScalarT = TypeVar("_FloatScalarT", bound=FloatScalar) +FloatArray: typing_extensions.TypeAlias = ( + lib.NumericArray[lib.FloatScalar] + | lib.NumericArray[lib.DoubleScalar] + | lib.NumericArray[lib.Decimal128Scalar] + | lib.NumericArray[lib.Decimal256Scalar] +) +_FloatArrayT = TypeVar("_FloatArrayT", bound=FloatArray) +_StringScalarT = TypeVar("_StringScalarT", bound=StringScalar) +StringArray: TypeAlias = lib.StringArray | lib.LargeStringArray +_StringArrayT = TypeVar("_StringArrayT", bound=StringArray) +_BinaryScalarT = TypeVar("_BinaryScalarT", bound=BinaryScalar) +BinaryArray: TypeAlias = lib.BinaryArray | lib.LargeBinaryArray +_BinaryArrayT = TypeVar("_BinaryArrayT", bound=BinaryArray) +StringOrBinaryScalar: TypeAlias = StringScalar | BinaryScalar +_StringOrBinaryScalarT = TypeVar("_StringOrBinaryScalarT", bound=StringOrBinaryScalar) +StringOrBinaryArray: TypeAlias = StringArray | BinaryArray +_StringOrBinaryArrayT = TypeVar("_StringOrBinaryArrayT", bound=StringOrBinaryArray) +_TemporalScalarT = TypeVar("_TemporalScalarT", bound=TemporalScalar) +TemporalArray: TypeAlias = ( + lib.Date32Array + | lib.Date64Array + | lib.Time32Array + | lib.Time64Array + | lib.TimestampArray + | lib.DurationArray + | lib.MonthDayNanoIntervalArray +) +_TemporalArrayT = TypeVar("_TemporalArrayT", bound=TemporalArray) +_ScalarT = TypeVar("_ScalarT", bound=lib.Scalar) +_ArrayT = TypeVar("_ArrayT", bound=lib.Array) +_ScalarOrArrayT = TypeVar("_ScalarOrArrayT", bound=lib.Array | lib.Scalar) +# =============================== 1. Aggregation =============================== + +# ========================= 1.1 functions ========================= + +def all( + array: lib.BooleanScalar | lib.BooleanArray, + /, + *, + skip_nulls: bool = True, + min_count: int = 1, + options: ScalarAggregateOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.BooleanScalar: ... + +any = _clone_signature(all) + +def approximate_median( + array: NumericScalar | lib.NumericArray, + /, + *, + skip_nulls: bool = True, + min_count: int = 1, + options: ScalarAggregateOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.DoubleScalar: ... +def count( + array: lib.Array, + /, + mode: Literal["only_valid", "only_null", "all"] = "only_valid", + *, + options: CountOptions | None = None, memory_pool: lib.MemoryPool | None = None, -) -> lib.Array: ... +) -> lib.Int64Scalar: ... +def count_distinct( + array: lib.Array, + /, + mode: Literal["only_valid", "only_null", "all"] = "only_valid", + *, + options: CountOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.Int64Scalar: ... +def first( + array: lib.Array[_ScalarT], + /, + *, + skip_nulls: bool = True, + min_count: int = 1, + options: ScalarAggregateOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _ScalarT: ... +def first_last( + array: lib.Array, + /, + *, + skip_nulls: bool = True, + min_count: int = 1, + options: ScalarAggregateOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.StructScalar: ... def index( data: lib.Array, - value: lib.Scalar, + value, start: int | None = None, end: int | None = None, *, memory_pool: lib.MemoryPool | None = None, -) -> int: ... +) -> lib.Int64Scalar: ... -_DataT = TypeVar("_DataT", bound=lib.Array | lib.ChunkedArray | lib.RecordBatch | lib.Table) +last = _clone_signature(first) +max = _clone_signature(first) +min = _clone_signature(first) +min_max = _clone_signature(first_last) -def take( - data: _DataT, - indices: Indices, +def mean( + array: NumericScalar | lib.NumericArray, + /, *, - boundscheck: bool = True, + skip_nulls: bool = True, + min_count: int = 1, + options: ScalarAggregateOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.DoubleScalar | lib.Decimal128Scalar: ... +def mode( + array: NumericScalar | lib.NumericArray, + /, + n: int = 1, + *, + skip_nulls: bool = True, + min_count: int = 0, + options: ModeOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.StructArray: ... +def product( + array: _ScalarT | lib.NumericArray[_ScalarT], + /, + *, + skip_nulls=True, + min_count=1, + options=None, + memory_pool: lib.MemoryPool | None = None, +) -> _ScalarT: ... +def quantile( + array: NumericScalar | lib.NumericArray, + /, + q: float = 0.5, + *, + interpolation: Literal["linear", "lower", "higher", "nearest", "midpoint"] = "linear", + skip_nulls: bool = True, + min_count: int = 0, + options: QuantileOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.DoubleArray: ... +def stddev( + array: NumericScalar | lib.NumericArray, + /, + *, + ddof: float = 0, + skip_nulls: bool = True, + min_count: int = 0, + options: VarianceOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.DoubleScalar: ... +def sum( + array: _NumericScalarT | lib.NumericArray[_NumericScalarT], + /, + *, + skip_nulls: bool = True, + min_count: int = 1, + options: ScalarAggregateOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _NumericScalarT: ... +def tdigest( + array: NumericScalar | lib.NumericArray, + /, + q: float = 0.5, + *, + delta: int = 100, + buffer_size: int = 500, + skip_nulls: bool = True, + min_count: int = 0, + options: TDigestOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.DoubleArray: ... +def variance( + array: NumericScalar | lib.NumericArray, + /, + *, + ddof: int = 0, + skip_nulls: bool = True, + min_count: int = 0, + options: VarianceOptions | None = None, memory_pool: lib.MemoryPool | None = None, -) -> _DataT: ... -def fill_null(values: _DataT, fill_value: lib.Array | lib.ChunkedArray | lib.Scalar) -> _DataT: ... +) -> lib.DoubleScalar: ... + +# ========================= 2. Element-wise (“scalar”) functions ========================= + +# ========================= 2.1 Arithmetic ========================= @overload -def top_k_unstable( - values: lib.Array | lib.ChunkedArray | lib.RecordBatch, - k: int, +def abs( + x: _NumericOrDurationT, /, *, memory_pool: lib.MemoryPool | None = None +) -> _NumericOrDurationT: ... +@overload +def abs( + x: _NumericOrDurationArrayT, /, *, memory_pool: lib.MemoryPool | None = None +) -> _NumericOrDurationArrayT: ... + +abs_checked = _clone_signature(abs) + +@overload +def add( + x: _NumericOrTemporalT, y: _NumericOrTemporalT, /, *, memory_pool: lib.MemoryPool | None = None +) -> _NumericOrTemporalT: ... +@overload +def add( + x: _NumericOrTemporalArrayT, + y: _NumericOrTemporalArrayT, + /, *, memory_pool: lib.MemoryPool | None = None, -) -> lib.Array: ... +) -> _NumericOrTemporalArrayT: ... @overload -def top_k_unstable( - values: lib.Table, - k: int, - sort_keys: Sequence[str], +def add( + x: NumericScalar, y: NumericScalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> NumericScalar: ... +@overload +def add( + x: TemporalScalar, y: TemporalScalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> TemporalScalar: ... +@overload +def add( + x: NumericOrTemporalArray | NumericOrTemporalScalar, + y: NumericOrTemporalArray | NumericOrTemporalScalar, + /, *, memory_pool: lib.MemoryPool | None = None, -) -> lib.Array: ... +) -> NumericOrTemporalArray: ... + +add_checked = _clone_signature(add) + @overload -def bottom_k_unstable( - values: lib.Array | lib.ChunkedArray | lib.RecordBatch, - k: int, +def divide( + dividend: NumericScalar, + divisor: NumericScalar, + /, *, memory_pool: lib.MemoryPool | None = None, -) -> lib.Array: ... +) -> NumericScalar: ... @overload -def bottom_k_unstable( - values: lib.Table, - k: int, - sort_keys: Sequence[str], +def divide( + dividend: TemporalScalar, + divisor: TemporalScalar, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> TemporalScalar: ... +@overload +def divide( + dividend: NumericOrTemporalArray | NumericOrTemporalScalar, + divisor: NumericOrTemporalArray | NumericOrTemporalScalar, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> NumericArray: ... + +divide_checked = _clone_signature(divide) + +@overload +def exp( + exponent: NumericArray, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.FloatArray | lib.DoubleArray: ... +@overload +def exp( + exponent: NumericScalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.FloatScalar | lib.DoubleScalar: ... + +multiply = _clone_signature(add) +multiply_checked = _clone_signature(multiply) + +@overload +def negate( + x: _NumericOrDurationT, /, *, memory_pool: lib.MemoryPool | None = None +) -> _NumericOrDurationT: ... +@overload +def negate( + x: _NumericOrDurationArrayT, /, *, memory_pool: lib.MemoryPool | None = None +) -> _NumericOrDurationArrayT: ... + +negate_checked = _clone_signature(negate) + +@overload +def power( + base: _NumericScalarT, + exponent: _NumericScalarT, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> _NumericScalarT: ... +@overload +def power( + base: NumericScalar, exponent: NumericScalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> NumericScalar: ... +@overload +def power( + base: _NumericArrayT, + exponent: _NumericArrayT, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> _NumericArrayT: ... +@overload +def power( + base: NumericScalar | NumericArray, + exponent: NumericScalar | NumericArray, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> NumericArray: ... + +power_checked = _clone_signature(power) + +@overload +def sign( + x: NumericOrDurationArray, /, *, memory_pool: lib.MemoryPool | None = None +) -> ( + lib.NumericArray[lib.Int8Scalar] + | lib.NumericArray[lib.FloatScalar] + | lib.NumericArray[lib.DoubleScalar] +): ... +@overload +def sign( + x: NumericOrDurationScalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.Int8Scalar | lib.FloatScalar | lib.DoubleScalar: ... +@overload +def sqrt(x: NumericArray, /, *, memory_pool: lib.MemoryPool | None = None) -> FloatArray: ... +@overload +def sqrt(x: NumericScalar, /, *, memory_pool: lib.MemoryPool | None = None) -> FloatScalar: ... + +sqrt_checked = _clone_signature(sqrt) + +subtract = _clone_signature(add) +subtract_checked = _clone_signature(subtract) + +# ========================= 2.1 Bit-wise functions ========================= +@overload +def bit_wise_and( + x: _NumericScalarT, y: _NumericScalarT, /, *, memory_pool: lib.MemoryPool | None = None +) -> _NumericScalarT: ... +@overload +def bit_wise_and( + x: _NumericArrayT, + y: _NumericArrayT, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> _NumericArrayT: ... +@overload +def bit_wise_and( + x: NumericScalar, y: NumericScalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> NumericScalar: ... +@overload +def bit_wise_and( + x: NumericArray | NumericScalar, + y: NumericArray | NumericScalar, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> NumericArray: ... +@overload +def bit_wise_not( + x: _NumericScalarT, /, *, memory_pool: lib.MemoryPool | None = None +) -> _NumericScalarT: ... +@overload +def bit_wise_not( + x: _NumericArrayT, /, *, memory_pool: lib.MemoryPool | None = None +) -> _NumericArrayT: ... + +bit_wise_or = _clone_signature(bit_wise_and) +bit_wise_xor = _clone_signature(bit_wise_and) +shift_left = _clone_signature(bit_wise_and) +shift_left_checked = _clone_signature(bit_wise_and) +shift_right = _clone_signature(bit_wise_and) +shift_right_checked = _clone_signature(bit_wise_and) + +# ========================= 2.2 Rounding functions ========================= +@overload +def ceil(x: _FloatScalarT, /, *, memory_pool: lib.MemoryPool | None = None) -> _FloatScalarT: ... +@overload +def ceil(x: _FloatArrayT, /, *, memory_pool: lib.MemoryPool | None = None) -> _FloatArrayT: ... + +floor = _clone_signature(ceil) + +@overload +def round( + x: _NumericScalarT, + /, + ndigits: int = 0, + round_mode: Literal[ + "down", + "up", + "towards_zero", + "towards_infinity", + "half_down", + "half_up", + "half_towards_zero", + "half_towards_infinity", + "half_to_even", + "half_to_odd", + ] = "half_to_even", + *, + options: RoundOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _NumericScalarT: ... +@overload +def round( + x: _NumericArrayT, + /, + ndigits: int = 0, + round_mode: Literal[ + "down", + "up", + "towards_zero", + "towards_infinity", + "half_down", + "half_up", + "half_towards_zero", + "half_towards_infinity", + "half_to_even", + "half_to_odd", + ] = "half_to_even", + *, + options: RoundOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _NumericArrayT: ... +@overload +def round_to_multiple( + x: _NumericScalarT, + /, + multiple: int = 0, + round_mode: Literal[ + "down", + "up", + "towards_zero", + "towards_infinity", + "half_down", + "half_up", + "half_towards_zero", + "half_towards_infinity", + "half_to_even", + "half_to_odd", + ] = "half_to_even", + *, + options: RoundToMultipleOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _NumericScalarT: ... +@overload +def round_to_multiple( + x: _NumericArrayT, + /, + multiple: int = 0, + round_mode: Literal[ + "down", + "up", + "towards_zero", + "towards_infinity", + "half_down", + "half_up", + "half_towards_zero", + "half_towards_infinity", + "half_to_even", + "half_to_odd", + ] = "half_to_even", + *, + options: RoundToMultipleOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _NumericArrayT: ... +@overload +def round_binary( + x: _NumericScalarT, + s: int | lib.Int8Scalar | lib.Int16Scalar | lib.Int32Scalar | lib.Int64Scalar, + /, + round_mode: Literal[ + "down", + "up", + "towards_zero", + "towards_infinity", + "half_down", + "half_up", + "half_towards_zero", + "half_towards_infinity", + "half_to_even", + "half_to_odd", + ] = "half_to_even", + *, + options: RoundBinaryOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _NumericScalarT: ... +@overload +def round_binary( + x: _NumericScalarT, + s: Iterable, + /, + round_mode: Literal[ + "down", + "up", + "towards_zero", + "towards_infinity", + "half_down", + "half_up", + "half_towards_zero", + "half_towards_infinity", + "half_to_even", + "half_to_odd", + ] = "half_to_even", + *, + options: RoundBinaryOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.NumericArray[_NumericScalarT]: ... +@overload +def round_binary( + x: _NumericArrayT, + s: int | lib.Int8Scalar | lib.Int16Scalar | lib.Int32Scalar | lib.Int64Scalar | Iterable, + /, + round_mode: Literal[ + "down", + "up", + "towards_zero", + "towards_infinity", + "half_down", + "half_up", + "half_towards_zero", + "half_towards_infinity", + "half_to_even", + "half_to_odd", + ] = "half_to_even", + *, + options: RoundBinaryOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _NumericArrayT: ... + +trunc = _clone_signature(ceil) + +# ========================= 2.3 Logarithmic functions ========================= +@overload +def ln( + x: FloatScalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.FloatScalar | lib.DoubleScalar: ... +@overload +def ln( + x: FloatArray, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.NumericArray[lib.FloatScalar] | lib.NumericArray[lib.DoubleScalar]: ... + +ln_checked = _clone_signature(ln) +log10 = _clone_signature(ln) +log10_checked = _clone_signature(ln) +log1p = _clone_signature(ln) +log1p_checked = _clone_signature(ln) +log2 = _clone_signature(ln) +log2_checked = _clone_signature(ln) + +@overload +def logb( + x: FloatScalar, b: FloatScalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.FloatScalar | lib.DoubleScalar: ... +@overload +def logb( + x: FloatArray, b: FloatArray, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.NumericArray[lib.FloatScalar] | lib.NumericArray[lib.DoubleScalar]: ... +@overload +def logb( + x: FloatScalar | FloatArray, + b: FloatScalar | FloatArray, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> lib.NumericArray[lib.FloatScalar] | lib.NumericArray[lib.DoubleScalar]: ... +def logb( + x: FloatScalar, b: FloatScalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.FloatScalar | lib.DoubleScalar: ... + +logb_checked = _clone_signature(logb) + +# ========================= 2.4 Trigonometric functions ========================= +acos = _clone_signature(ln) +acos_checked = _clone_signature(ln) +asin = _clone_signature(ln) +asin_checked = _clone_signature(ln) +atan = _clone_signature(ln) +cos = _clone_signature(ln) +cos_checked = _clone_signature(ln) +sin = _clone_signature(ln) +sin_checked = _clone_signature(ln) +tan = _clone_signature(ln) +tan_checked = _clone_signature(ln) + +@overload +def atan2( + y: FloatScalar, x: FloatScalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.FloatScalar | lib.DoubleScalar: ... +@overload +def atan2( + y: FloatArray, x: FloatArray, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.NumericArray[lib.FloatScalar] | lib.NumericArray[lib.DoubleScalar]: ... +@overload +def atan2( + y: FloatScalar | FloatArray, + x: FloatScalar | FloatArray, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> lib.NumericArray[lib.FloatScalar] | lib.NumericArray[lib.DoubleScalar]: ... +def atan2( + y: FloatScalar, x: FloatScalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.FloatScalar | lib.DoubleScalar: ... + +# ========================= 2.5 Comparisons functions ========================= +@overload +def equal( + x: lib.Scalar, y: lib.Scalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.BooleanScalar: ... +@overload +def equal( + x: lib.Scalar | lib.Array, + y: lib.Scalar | lib.Array, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> lib.BooleanArray: ... + +greater = _clone_signature(equal) +greater_equal = _clone_signature(equal) +less = _clone_signature(equal) +less_equal = _clone_signature(equal) +not_equal = _clone_signature(equal) + +@overload +def max_element_wise( + *args: _ScalarT, + skip_nulls: bool = True, + options: ElementWiseAggregateOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _ScalarT: ... +@overload +def max_element_wise( + *args: _ArrayT, + skip_nulls: bool = True, + options: ElementWiseAggregateOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _ArrayT: ... + +min_element_wise = _clone_signature(equal) + +# ========================= 2.6 Logical functions ========================= +@overload +def and_( + x: lib.BooleanScalar, y: lib.BooleanScalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.BooleanScalar: ... +@overload +def and_( + x: lib.BooleanScalar | lib.BooleanArray, + y: lib.BooleanScalar | lib.BooleanArray, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> lib.BooleanArray: ... + +and_kleene = _clone_signature(and_) +and_not = _clone_signature(and_) +and_not_kleene = _clone_signature(and_) +or_ = _clone_signature(and_) +or_kleene = _clone_signature(and_) +xor = _clone_signature(and_) + +@overload +def invert( + x: lib.BooleanScalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.BooleanScalar: ... +@overload +def invert( + x: lib.BooleanArray, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> lib.BooleanArray: ... + +# ========================= 2.10 String predicates ========================= +@overload +def ascii_is_alnum( + strings: StringScalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.BooleanScalar: ... +@overload +def ascii_is_alnum( + strings: StringArray, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.BooleanArray: ... + +ascii_is_alpha = _clone_signature(ascii_is_alnum) +ascii_is_decimal = _clone_signature(ascii_is_alnum) +ascii_is_lower = _clone_signature(ascii_is_alnum) +ascii_is_printable = _clone_signature(ascii_is_alnum) +ascii_is_space = _clone_signature(ascii_is_alnum) +ascii_is_upper = _clone_signature(ascii_is_alnum) +utf8_is_alnum = _clone_signature(ascii_is_alnum) +utf8_is_alpha = _clone_signature(ascii_is_alnum) +utf8_is_decimal = _clone_signature(ascii_is_alnum) +utf8_is_digit = _clone_signature(ascii_is_alnum) +utf8_is_lower = _clone_signature(ascii_is_alnum) +utf8_is_numeric = _clone_signature(ascii_is_alnum) +utf8_is_printable = _clone_signature(ascii_is_alnum) +utf8_is_space = _clone_signature(ascii_is_alnum) +utf8_is_upper = _clone_signature(ascii_is_alnum) +ascii_is_title = _clone_signature(ascii_is_alnum) +utf8_is_title = _clone_signature(ascii_is_alnum) +string_is_ascii = _clone_signature(ascii_is_alnum) + +# ========================= 2.11 String transforms ========================= +@overload +def ascii_capitalize( + strings: _StringScalarT, /, *, memory_pool: lib.MemoryPool | None = None +) -> _StringScalarT: ... +@overload +def ascii_capitalize( + strings: _StringArrayT, /, *, memory_pool: lib.MemoryPool | None = None +) -> _StringArrayT: ... + +ascii_lower = _clone_signature(ascii_capitalize) +ascii_reverse = _clone_signature(ascii_capitalize) +ascii_swapcase = _clone_signature(ascii_capitalize) +ascii_title = _clone_signature(ascii_capitalize) +ascii_upper = _clone_signature(ascii_capitalize) + +@overload +def binary_length( + strings: lib.BinaryScalar | lib.StringScalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.Int32Scalar: ... +@overload +def binary_length( + strings: lib.LargeBinaryScalar | lib.LargeStringScalar, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> lib.Int64Scalar: ... +@overload +def binary_length( + strings: lib.BinaryArray | lib.StringArray, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.Int32Array: ... +@overload +def binary_length( + strings: lib.LargeBinaryArray | lib.LargeStringArray, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> lib.Int64Array: ... +@overload +def binary_repeat( + strings: _StringOrBinaryScalarT, + num_repeats: int, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> _StringOrBinaryScalarT: ... +@overload +def binary_repeat( + strings: _StringOrBinaryScalarT, + num_repeats: list[int] | list[int | None], + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> lib.Array[_StringOrBinaryScalarT]: ... +@overload +def binary_repeat( + strings: _StringOrBinaryArrayT, + num_repeats: int | list[int] | list[int | None], + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> _StringOrBinaryArrayT: ... +@overload +def binary_replace_slice( + strings: _StringOrBinaryScalarT, + /, + start: int, + stop: int, + replacement: str | bytes, + *, + options: ReplaceSliceOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _StringOrBinaryScalarT: ... +@overload +def binary_replace_slice( + strings: _StringOrBinaryArrayT, + /, + start: int, + stop: int, + replacement: str | bytes, + *, + options: ReplaceSliceOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _StringOrBinaryArrayT: ... +@overload +def binary_reverse( + strings: _BinaryScalarT, /, *, memory_pool: lib.MemoryPool | None = None +) -> _BinaryScalarT: ... +@overload +def binary_reverse( + strings: _BinaryArrayT, /, *, memory_pool: lib.MemoryPool | None = None +) -> _BinaryArrayT: ... +@overload +def replace_substring( + strings: _StringScalarT, + /, + pattern: str | bytes, + replacement: str | bytes, + *, + max_replacements: int | None = None, + options: ReplaceSubstringOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _StringScalarT: ... +@overload +def replace_substring( + strings: _StringArrayT, + /, + pattern: str | bytes, + replacement: str | bytes, + *, + max_replacements: int | None = None, + options: ReplaceSubstringOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _StringArrayT: ... + +replace_substring_regex = _clone_signature(replace_substring) + +@overload +def utf8_capitalize( + strings: _StringScalarT, /, *, memory_pool: lib.MemoryPool | None = None +) -> _StringScalarT: ... +@overload +def utf8_capitalize( + strings: _StringArrayT, /, *, memory_pool: lib.MemoryPool | None = None +) -> _StringArrayT: ... +@overload +def utf8_length( + strings: lib.StringScalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.Int32Scalar: ... +@overload +def utf8_length( + strings: lib.LargeStringScalar, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> lib.Int64Scalar: ... +@overload +def utf8_length( + strings: lib.StringArray, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.Int32Array: ... +@overload +def utf8_length( + strings: lib.LargeStringArray, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> lib.Int64Array: ... + +utf8_lower = _clone_signature(utf8_capitalize) + +@overload +def utf8_replace_slice( + strings: _StringScalarT, + /, + start: int, + stop: int, + replacement: str | bytes, + *, + options: ReplaceSliceOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _StringScalarT: ... +@overload +def utf8_replace_slice( + strings: _StringArrayT, + /, + start: int, + stop: int, + replacement: str | bytes, + *, + options: ReplaceSliceOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _StringArrayT: ... + +utf8_reverse = _clone_signature(utf8_capitalize) +utf8_swapcase = _clone_signature(utf8_capitalize) +utf8_title = _clone_signature(utf8_capitalize) +utf8_upper = _clone_signature(utf8_capitalize) + +# ========================= 2.12 String padding ========================= +@overload +def ascii_center( + strings: _StringScalarT, + /, + width: int, + padding: str = " ", + lean_left_on_odd_padding: bool = True, + *, + options: PadOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _StringScalarT: ... +@overload +def ascii_center( + strings: _StringArrayT, + /, + width: int, + padding: str = " ", + lean_left_on_odd_padding: bool = True, + *, + options: PadOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _StringArrayT: ... + +ascii_lpad = _clone_signature(ascii_center) +ascii_rpad = _clone_signature(ascii_center) +utf8_center = _clone_signature(ascii_center) +utf8_lpad = _clone_signature(ascii_center) +utf8_rpad = _clone_signature(ascii_center) + +# ========================= 2.13 String trimming ========================= +@overload +def ascii_ltrim( + strings: _StringScalarT, + /, + characters: str, + *, + options: TrimOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _StringScalarT: ... +@overload +def ascii_ltrim( + strings: _StringArrayT, + /, + characters: str, + *, + options: TrimOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _StringArrayT: ... + +ascii_rtrim = _clone_signature(ascii_ltrim) +ascii_trim = _clone_signature(ascii_ltrim) +utf8_ltrim = _clone_signature(ascii_ltrim) +utf8_rtrim = _clone_signature(ascii_ltrim) +utf8_trim = _clone_signature(ascii_ltrim) + +@overload +def ascii_ltrim_whitespace( + strings: _StringScalarT, + /, + *, + options: TrimOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _StringScalarT: ... +@overload +def ascii_ltrim_whitespace( + strings: _StringArrayT, + /, + *, + options: TrimOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _StringArrayT: ... + +ascii_rtrim_whitespace = _clone_signature(ascii_ltrim_whitespace) +ascii_trim_whitespace = _clone_signature(ascii_ltrim_whitespace) +utf8_ltrim_whitespace = _clone_signature(ascii_ltrim_whitespace) +utf8_rtrim_whitespace = _clone_signature(ascii_ltrim_whitespace) +utf8_trim_whitespace = _clone_signature(ascii_ltrim_whitespace) + +# ========================= 2.14 String splitting ========================= +@overload +def ascii_split_whitespace( + strings: _StringScalarT, + /, + *, + max_splits: int | None = None, + reverse: bool = False, + options: SplitOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.ListArray[_StringScalarT]: ... +@overload +def ascii_split_whitespace( + strings: lib.Array[lib.Scalar[_DataTypeT]], + /, + *, + max_splits: int | None = None, + reverse: bool = False, + options: SplitOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.ListArray[lib.ListScalar[_DataTypeT]]: ... +@overload +def split_pattern( + strings: _StringOrBinaryScalarT, + /, + pattern: str, + *, + max_splits: int | None = None, + reverse: bool = False, + options: SplitOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.ListArray[_StringOrBinaryScalarT]: ... +@overload +def split_pattern( + strings: lib.Array[lib.Scalar[_DataTypeT]], + /, + pattern: str, + *, + max_splits: int | None = None, + reverse: bool = False, + options: SplitPatternOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.ListArray[lib.ListScalar[_DataTypeT]]: ... + +split_pattern_regex = _clone_signature(split_pattern) +utf8_split_whitespace = _clone_signature(ascii_split_whitespace) + +# ========================= 2.15 String component extraction ========================= +@overload +def extract_regex( + strings: StringOrBinaryScalar, + /, + pattern: str, + *, + options: ExtractRegexOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.StructScalar: ... +@overload +def extract_regex( + strings: StringOrBinaryArray, + /, + pattern: str, + *, + options: ExtractRegexOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.StructArray: ... + +# ========================= 2.16 String join ========================= +def binary_join( + strings, separator, /, *, memory_pool: lib.MemoryPool | None = None +) -> StringScalar | StringArray: ... +@overload +def binary_join_element_wise( + *strings: _StringOrBinaryScalarT, + null_handling: Literal["emit_null", "skip", "replace"] = "emit_null", + null_replacement: str = "", + options: JoinOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _StringOrBinaryScalarT: ... +@overload +def binary_join_element_wise( + *strings: _StringOrBinaryArrayT, + null_handling: Literal["emit_null", "skip", "replace"] = "emit_null", + null_replacement: str = "", + options: JoinOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _StringOrBinaryArrayT: ... + +# ========================= 2.17 String Slicing ========================= +@overload +def binary_slice( + strings: _BinaryScalarT, + /, + start: int, + stop: int | None = None, + step: int = 1, + *, + options: SliceOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _BinaryScalarT: ... +@overload +def binary_slice( + strings: _BinaryArrayT, + /, + start: int, + stop: int | None = None, + step: int = 1, + *, + options: SliceOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _BinaryArrayT: ... +@overload +def utf8_slice_codeunits( + strings: _StringScalarT, + /, + start: int, + stop: int | None = None, + step: int = 1, + *, + options: SliceOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _StringScalarT: ... +@overload +def utf8_slice_codeunits( + strings: _StringArrayT, + /, + start: int, + stop: int | None = None, + step: int = 1, + *, + options: SliceOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _StringArrayT: ... + +# ========================= 2.18 Containment tests ========================= +@overload +def count_substring( + strings: lib.StringScalar | lib.BinaryScalar, + /, + pattern: str, + *, + ignore_case: bool = False, + options: MatchSubstringOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.Int32Scalar: ... +@overload +def count_substring( + strings: lib.LargeStringScalar | lib.LargeBinaryScalar, + /, + pattern: str, + *, + ignore_case: bool = False, + options: MatchSubstringOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.Int64Scalar: ... +@overload +def count_substring( + strings: lib.StringArray | lib.BinaryArray, + /, + pattern: str, + *, + ignore_case: bool = False, + options: MatchSubstringOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.Int32Array: ... +@overload +def count_substring( + strings: lib.LargeStringArray | lib.LargeBinaryArray, + /, + pattern: str, + *, + ignore_case: bool = False, + options: MatchSubstringOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.Int64Array: ... + +count_substring_regex = _clone_signature(count_substring) + +@overload +def ends_with( + strings: StringScalar | BinaryScalar, + /, + pattern: str, *, + ignore_case: bool = False, + options: MatchSubstringOptions | None = None, memory_pool: lib.MemoryPool | None = None, -) -> lib.Array: ... +) -> lib.BooleanScalar: ... +@overload +def ends_with( + strings: StringArray | BinaryArray, + /, + pattern: str, + *, + ignore_case: bool = False, + options: MatchSubstringOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.BooleanArray: ... + +find_substring = _clone_signature(count_substring) +find_substring_regex = _clone_signature(count_substring) + +@overload +def index_in( + values: lib.Scalar, + /, + value_set: lib.Array, + *, + skip_nulls: bool = False, + options: SetLookupOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.Int32Scalar: ... +@overload +def index_in( + values: lib.Array, + /, + value_set: lib.Array, + *, + skip_nulls: bool = False, + options: SetLookupOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.Int32Array: ... +@overload +def is_in( + values: lib.Scalar, + /, + value_set: lib.Array, + *, + skip_nulls: bool = False, + options: SetLookupOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.BooleanScalar: ... +@overload +def is_in( + values: lib.Array, + /, + value_set: lib.Array, + *, + skip_nulls: bool = False, + options: SetLookupOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.BooleanArray: ... + +match_like = _clone_signature(ends_with) +match_substring = _clone_signature(ends_with) +match_substring_regex = _clone_signature(ends_with) +starts_with = _clone_signature(ends_with) + +# ========================= 2.19 Categorizations ========================= +@overload +def is_finite( + values: NumericScalar | lib.NullScalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.BooleanScalar: ... +@overload +def is_finite( + values: NumericArray | lib.NullArray, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.BooleanArray: ... + +is_inf = _clone_signature(is_finite) +is_nan = _clone_signature(is_finite) + +@overload +def is_null( + values: lib.Scalar, + /, + *, + nan_is_null: bool = False, + options: NullOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.BooleanScalar: ... +@overload +def is_null( + values: lib.Array, + /, + *, + nan_is_null: bool = False, + options: NullOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.BooleanArray: ... +@overload +def is_valid( + values: lib.Scalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.BooleanScalar: ... +@overload +def is_valid( + values: lib.Array, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.BooleanArray: ... + +true_unless_null = _clone_signature(is_valid) + +# ========================= 2.20 Selecting / multiplexing ========================= +def case_when(cond, /, *cases, memory_pool: lib.MemoryPool | None = None): ... +def choose(indices, /, *values, memory_pool: lib.MemoryPool | None = None): ... +def coalesce( + *values: _ScalarOrArrayT, memory_pool: lib.MemoryPool | None = None +) -> _ScalarOrArrayT: ... +def if_else(cond, left, right, /, *, memory_pool: lib.MemoryPool | None = None): ... + +# ========================= 2.21 Structural transforms ========================= + +@overload +def list_value_length( + lists: lib.ListArray | lib.ListViewArray | lib.FixedSizeListArray, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> lib.Int32Array: ... +@overload +def list_value_length( + lists: lib.LargeListArray | lib.LargeListViewArray, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> lib.Int64Array: ... +@overload +def make_struct( + *args: lib.Scalar, + field_names: list[str] | tuple[str, ...] = (), + field_nullability: bool | None = None, + field_metadata: list[lib.KeyValueMetadata] | None = None, + options: MakeStructOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.StructScalar: ... +@overload +def make_struct( + *args: lib.Array, + field_names: list[str] | tuple[str, ...] = (), + field_nullability: bool | None = None, + field_metadata: list[lib.KeyValueMetadata] | None = None, + options: MakeStructOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.StructArray: ... + +# ========================= 2.22 Conversions ========================= +@overload +def ceil_temporal( + timestamps: _TemporalScalarT, + /, + multiple: int = 1, + unit: Literal[ + "year", + "quarter", + "month", + "week", + "day", + "hour", + "minute", + "second", + "millisecond", + "microsecond", + "nanosecond", + ] = "day", + *, + week_starts_monday: bool = True, + ceil_is_strictly_greater: bool = False, + calendar_based_origin: bool = False, + options: RoundTemporalOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _TemporalScalarT: ... +@overload +def ceil_temporal( + timestamps: _TemporalArrayT, + /, + multiple: int = 1, + unit: Literal[ + "year", + "quarter", + "month", + "week", + "day", + "hour", + "minute", + "second", + "millisecond", + "microsecond", + "nanosecond", + ] = "day", + *, + week_starts_monday: bool = True, + ceil_is_strictly_greater: bool = False, + calendar_based_origin: bool = False, + options: RoundTemporalOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _TemporalArrayT: ... + +floor_temporal = _clone_signature(ceil_temporal) +round_temporal = _clone_signature(ceil_temporal) + +@overload +def cast( + arr: lib.Scalar, + target_type: _DataTypeT, + safe: bool | None = None, + options: CastOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.Scalar[_DataTypeT]: ... +@overload +def cast( + arr: lib.Array, + target_type: _DataTypeT, + safe: bool | None = None, + options: CastOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.Array[lib.Scalar[_DataTypeT]]: ... +@overload +def strftime( + timestamps: TemporalScalar, + /, + format: str = "%Y-%m-%dT%H:%M:%S", + locale: str = "C", + *, + options: StrftimeOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.StringScalar: ... +@overload +def strftime( + timestamps: TemporalArray, + /, + format: str = "%Y-%m-%dT%H:%M:%S", + locale: str = "C", + *, + options: StrftimeOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.StringArray: ... +@overload +def strptime( + strings: StringScalar, + /, + format: str, + unit: Literal["s", "ms", "us", "ns"], + error_is_null: bool = False, + *, + options: StrptimeOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.TimestampScalar: ... +@overload +def strptime( + strings: StringArray, + /, + format: str, + unit: Literal["s", "ms", "us", "ns"], + error_is_null: bool = False, + *, + options: StrptimeOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.TimestampArray: ... + +# ========================= 2.23 Temporal component extraction ========================= +@overload +def day( + values: TemporalScalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.Int64Scalar: ... +@overload +def day( + values: TemporalArray, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.Int64Array: ... +@overload +def day_of_week( + values: TemporalScalar, + /, + *, + count_from_zero: bool = True, + week_start: int = 1, + options: DayOfWeekOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.Int64Scalar: ... +@overload +def day_of_week( + values: TemporalArray, + /, + *, + count_from_zero: bool = True, + week_start: int = 1, + options: DayOfWeekOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.Int64Array: ... + +day_of_year = _clone_signature(day) + +@overload +def hour( + values: lib.TimestampScalar | lib.Time32Scalar | lib.Time64Scalar, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> lib.Int64Scalar: ... +@overload +def hour( + values: lib.TimestampArray | lib.Time32Array | lib.Time64Array, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> lib.Int64Array: ... +@overload +def is_dst( + values: lib.TimestampScalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.BooleanScalar: ... +@overload +def is_dst( + values: lib.TimestampArray, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.BooleanArray: ... +@overload +def iso_week( + values: lib.TimestampScalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.Int64Scalar: ... +@overload +def iso_week( + values: lib.TimestampArray, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.Int64Array: ... + +iso_year = _clone_signature(iso_week) + +@overload +def is_leap_year( + values: lib.TimestampScalar | lib.Date32Scalar | lib.Date64Scalar, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> lib.BooleanScalar: ... +@overload +def is_leap_year( + values: lib.TimestampArray | lib.Date32Array | lib.Date64Array, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> lib.BooleanArray: ... + +microsecond = _clone_signature(iso_week) +millisecond = _clone_signature(iso_week) +minute = _clone_signature(iso_week) +month = _clone_signature(day_of_week) +nanosecond = _clone_signature(hour) +quarter = _clone_signature(day_of_week) +second = _clone_signature(hour) +subsecond = _clone_signature(hour) +us_week = _clone_signature(iso_week) +us_year = _clone_signature(iso_week) +year = _clone_signature(iso_week) + +@overload +def week( + values: lib.TimestampScalar, + /, + *, + week_starts_monday: bool = True, + count_from_zero: bool = False, + first_week_is_fully_in_year: bool = False, + options: WeekOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.Int64Scalar: ... +@overload +def week( + values: lib.TimestampArray, + /, + *, + week_starts_monday: bool = True, + count_from_zero: bool = False, + first_week_is_fully_in_year: bool = False, + options: WeekOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.Int64Array: ... +@overload +def year_month_day( + values: TemporalScalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.StructScalar: ... +@overload +def year_month_day( + values: TemporalArray, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.StructArray: ... + +# ========================= 2.24 Temporal difference ========================= +def day_time_interval_between(start, end, /, *, memory_pool: lib.MemoryPool | None = None): ... +def days_between( + start, end, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.Int64Scalar | lib.Int64Array: ... + +hours_between = _clone_signature(days_between) +microseconds_between = _clone_signature(days_between) +milliseconds_between = _clone_signature(days_between) +minutes_between = _clone_signature(days_between) + +def month_day_nano_interval_between( + start, end, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.MonthDayNanoIntervalScalar | lib.MonthDayNanoIntervalArray: ... +def month_interval_between(start, end, /, *, memory_pool: lib.MemoryPool | None = None): ... + +nanoseconds_between = _clone_signature(days_between) +quarters_between = _clone_signature(days_between) +seconds_between = _clone_signature(days_between) + +def weeks_between( + start, + end, + /, + *, + count_from_zero: bool = True, + week_start: int = 1, + options: DayOfWeekOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.Int64Scalar | lib.Int64Array: ... + +years_between = _clone_signature(days_between) + +# ========================= 2.25 Timezone handling ========================= +@overload +def assume_timezone( + timestamps: lib.TimestampScalar, + /, + timezone: str, + *, + ambiguous: Literal["raise", "earliest", "latest"] = "raise", + nonexistent: Literal["raise", "earliest", "latest"] = "raise", + options: AssumeTimezoneOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.TimestampScalar: ... +@overload +def assume_timezone( + timestamps: lib.TimestampArray, + /, + timezone: str, + *, + ambiguous: Literal["raise", "earliest", "latest"] = "raise", + nonexistent: Literal["raise", "earliest", "latest"] = "raise", + options: AssumeTimezoneOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.TimestampArray: ... +@overload +def local_timestamp( + timestamps: lib.TimestampScalar, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.TimestampScalar: ... +@overload +def local_timestamp( + timestamps: lib.TimestampArray, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.TimestampArray: ... + +# ========================= 2.26 Random number generation ========================= def random( n: int, *, @@ -146,5 +1754,191 @@ def random( options: RandomOptions | None = None, memory_pool: lib.MemoryPool | None = None, ) -> lib.DoubleArray: ... -def field(*name_or_index: str | tuple[str, ...] | int) -> Expression: ... -def scalar(value: bool | float | str) -> Expression: ... + +# ========================= 3. Array-wise (“vector”) functions ========================= + +# ========================= 3.1 Cumulative Functions ========================= + +def cumulative_sum( + values: _NumericArrayT, + /, + start: lib.Scalar | None = None, + *, + skip_nulls: bool = False, + options: CumulativeSumOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _NumericArrayT: ... + +cumulative_sum_checked = _clone_signature(cumulative_sum) +cumulative_prod = _clone_signature(cumulative_sum) +cumulative_prod_checked = _clone_signature(cumulative_sum) +cumulative_max = _clone_signature(cumulative_sum) +cumulative_min = _clone_signature(cumulative_sum) +cumulative_mean = _clone_signature(cumulative_sum) + +# ========================= 3.2 Associative transforms ========================= + +def dictionary_encode( + array: _ScalarOrArrayT, + /, + null_encoding: Literal["mask", "encode"] = "mask", + *, + options=None, + memory_pool: lib.MemoryPool | None = None, +) -> _ScalarOrArrayT: ... +def unique(array: _ArrayT, /, *, memory_pool: lib.MemoryPool | None = None) -> _ArrayT: ... +def value_counts( + array: lib.Array, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.StructArray: ... + +# ========================= 3.3 Selections ========================= + +def array_filter( + array: _ArrayT, + selection_filter: list[bool] | list[bool | None] | lib.BooleanArray, + /, + null_selection_behavior: Literal["drop", "emit_null"] = "drop", + *, + options: FilterOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _ArrayT: ... +def array_take( + array: _ArrayT, + indices: list[int] | list[int | None] | lib.Int16Array | lib.Int32Array | lib.Int64Array, + /, + *, + boundscheck: bool = True, + options: TakeOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _ArrayT: ... +def drop_null(input: _ArrayT, /, *, memory_pool: lib.MemoryPool | None = None) -> _ArrayT: ... + +filter = array_filter +take = array_take + +# ========================= 3.4 Containment tests ========================= + +def indices_nonzero( + values: lib.BooleanArray + | lib.NullArray + | NumericArray + | lib.Decimal128Array + | lib.Decimal256Array, + /, + *, + memory_pool: lib.MemoryPool | None = None, +) -> lib.UInt64Array: ... + +# ========================= 3.5 Sorts and partitions ========================= +def array_sort_indices( + array: lib.Array, + /, + order: Literal["ascending", "descending"] = "ascending", + *, + null_placement: Literal["at_start", "at_end"] = "at_end", + options: ArraySortOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.UInt64Array: ... +def partition_nth_indices( + array: lib.Array, + /, + pivot: int, + *, + null_placement: Literal["at_start", "at_end"] = "at_end", + options: PartitionNthOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.UInt64Array: ... +def rank( + input: lib.Array, + /, + sort_keys: Literal["ascending", "descending"] = "ascending", + *, + null_placement: Literal["at_start", "at_end"] = "at_end", + tiebreaker: Literal["min", "max", "first", "dense"] = "first", + options: RankOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.UInt64Array: ... +def select_k_unstable( + input: lib.Array, + /, + k: int, + sort_keys: list[tuple[str, Literal["ascending", "descending"]]], + *, + options: SelectKOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.UInt64Array: ... +def sort_indices( + array: lib.Array | lib.ChunkedArray | lib.RecordBatch | lib.Table, + /, + order: Literal["ascending", "descending"] = "ascending", + *, + null_placement: Literal["at_start", "at_end"] = "at_end", + options: SortOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.UInt64Array: ... + +# ========================= 3.6 Structural transforms ========================= +def list_element( + lists, index, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.ListArray: ... +def list_flatten( + lists, + /, + recursive: bool = False, + *, + options: ListFlattenOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.ListArray: ... +def list_parent_indices( + lists, /, *, memory_pool: lib.MemoryPool | None = None +) -> lib.Int64Array: ... +def list_slice( + lists, + /, + start: int, + stop: int | None = None, + step: int = 1, + return_fixed_size_list: bool | None = None, + *, + options: ListSliceOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> lib.ListArray: ... +def map_lookup( + container, + /, + query_key, + occurrence: str, + *, + options: MapLookupOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +): ... +def struct_field( + values, + /, + indices, + *, + options: StructFieldOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +): ... +def fill_null_backward(values, /, *, memory_pool: lib.MemoryPool | None = None): ... +def fill_null_forward(values, /, *, memory_pool: lib.MemoryPool | None = None): ... +def replace_with_mask( + values, + mask: list[bool] | list[bool | None] | lib.BooleanArray, + replacements, + /, + *, + memory_pool: lib.MemoryPool | None = None, +): ... + +# ========================= 3.7 Pairwise functions ========================= +def pairwise_diff( + input: _NumericOrTemporalArrayT, + /, + period: int = 1, + *, + options: PairwiseOptions | None = None, + memory_pool: lib.MemoryPool | None = None, +) -> _NumericOrTemporalArrayT: ... + +pairwise_diff_checked = _clone_signature(pairwise_diff)