31a16fbb40
### What changes were proposed in this pull request? This PR proposes migration of [`pyspark-stubs`](https://github.com/zero323/pyspark-stubs) into Spark codebase. ### Why are the changes needed? ### Does this PR introduce _any_ user-facing change? Yes. This PR adds type annotations directly to Spark source. This can impact interaction with development tools for users, which haven't used `pyspark-stubs`. ### How was this patch tested? - [x] MyPy tests of the PySpark source ``` mypy --no-incremental --config python/mypy.ini python/pyspark ``` - [x] MyPy tests of Spark examples ``` MYPYPATH=python/ mypy --no-incremental --config python/mypy.ini examples/src/main/python/ml examples/src/main/python/sql examples/src/main/python/sql/streaming ``` - [x] Existing Flake8 linter - [x] Existing unit tests Tested against: - `mypy==0.790+dev.e959952d9001e9713d329a2f9b196705b028f894` - `mypy==0.782` Closes #29591 from zero323/SPARK-32681. Authored-by: zero323 <mszymkiewicz@gmail.com> Signed-off-by: HyukjinKwon <gurwls223@apache.org>
177 lines
7 KiB
Python
177 lines
7 KiB
Python
#
|
|
# Licensed to the Apache Software Foundation (ASF) under one
|
|
# or more contributor license agreements. See the NOTICE file
|
|
# distributed with this work for additional information
|
|
# regarding copyright ownership. The ASF licenses this file
|
|
# to you under the Apache License, Version 2.0 (the
|
|
# "License"); you may not use this file except in compliance
|
|
# with the License. You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing,
|
|
# software distributed under the License is distributed on an
|
|
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
# KIND, either express or implied. See the License for the
|
|
# specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
from typing import overload
|
|
from typing import Union, Callable
|
|
|
|
from pyspark.sql._typing import (
|
|
AtomicDataTypeOrString,
|
|
UserDefinedFunctionLike,
|
|
)
|
|
from pyspark.sql.pandas._typing import (
|
|
GroupedMapPandasUserDefinedFunction,
|
|
MapIterPandasUserDefinedFunction,
|
|
CogroupedMapPandasUserDefinedFunction,
|
|
PandasCogroupedMapFunction,
|
|
PandasCogroupedMapUDFType,
|
|
PandasGroupedAggFunction,
|
|
PandasGroupedAggUDFType,
|
|
PandasGroupedMapFunction,
|
|
PandasGroupedMapUDFType,
|
|
PandasMapIterFunction,
|
|
PandasMapIterUDFType,
|
|
PandasScalarIterFunction,
|
|
PandasScalarIterUDFType,
|
|
PandasScalarToScalarFunction,
|
|
PandasScalarToStructFunction,
|
|
PandasScalarUDFType,
|
|
)
|
|
|
|
from pyspark import since as since # noqa: F401
|
|
from pyspark.rdd import PythonEvalType as PythonEvalType # noqa: F401
|
|
from pyspark.sql.types import ArrayType, StructType
|
|
|
|
class PandasUDFType:
|
|
SCALAR: PandasScalarUDFType
|
|
SCALAR_ITER: PandasScalarIterUDFType
|
|
GROUPED_MAP: PandasGroupedMapUDFType
|
|
GROUPED_AGG: PandasGroupedAggUDFType
|
|
|
|
@overload
|
|
def pandas_udf(
|
|
f: PandasScalarToScalarFunction,
|
|
returnType: Union[AtomicDataTypeOrString, ArrayType],
|
|
functionType: PandasScalarUDFType,
|
|
) -> UserDefinedFunctionLike: ...
|
|
@overload
|
|
def pandas_udf(f: Union[AtomicDataTypeOrString, ArrayType], returnType: PandasScalarUDFType) -> Callable[[PandasScalarToScalarFunction], UserDefinedFunctionLike]: ... # type: ignore[misc]
|
|
@overload
|
|
def pandas_udf(f: Union[AtomicDataTypeOrString, ArrayType], *, functionType: PandasScalarUDFType) -> Callable[[PandasScalarToScalarFunction], UserDefinedFunctionLike]: ... # type: ignore[misc]
|
|
@overload
|
|
def pandas_udf(*, returnType: Union[AtomicDataTypeOrString, ArrayType], functionType: PandasScalarUDFType) -> Callable[[PandasScalarToScalarFunction], UserDefinedFunctionLike]: ... # type: ignore[misc]
|
|
@overload
|
|
def pandas_udf(
|
|
f: PandasScalarToStructFunction,
|
|
returnType: Union[StructType, str],
|
|
functionType: PandasScalarUDFType,
|
|
) -> UserDefinedFunctionLike: ...
|
|
@overload
|
|
def pandas_udf(f: Union[StructType, str], returnType: PandasScalarUDFType) -> Callable[[PandasScalarToStructFunction], UserDefinedFunctionLike]: ... # type: ignore[misc]
|
|
@overload
|
|
def pandas_udf(f: Union[StructType, str], *, functionType: PandasScalarUDFType) -> Callable[[PandasScalarToStructFunction], UserDefinedFunctionLike]: ... # type: ignore[misc]
|
|
@overload
|
|
def pandas_udf(*, returnType: Union[StructType, str], functionType: PandasScalarUDFType) -> Callable[[PandasScalarToStructFunction], UserDefinedFunctionLike]: ... # type: ignore[misc]
|
|
@overload
|
|
def pandas_udf(
|
|
f: PandasScalarIterFunction,
|
|
returnType: Union[AtomicDataTypeOrString, ArrayType],
|
|
functionType: PandasScalarIterUDFType,
|
|
) -> UserDefinedFunctionLike: ...
|
|
@overload
|
|
def pandas_udf(
|
|
f: Union[AtomicDataTypeOrString, ArrayType], returnType: PandasScalarIterUDFType
|
|
) -> Callable[[PandasScalarIterFunction], UserDefinedFunctionLike]: ...
|
|
@overload
|
|
def pandas_udf(
|
|
*,
|
|
returnType: Union[AtomicDataTypeOrString, ArrayType],
|
|
functionType: PandasScalarIterUDFType
|
|
) -> Callable[[PandasScalarIterFunction], UserDefinedFunctionLike]: ...
|
|
@overload
|
|
def pandas_udf(
|
|
f: Union[AtomicDataTypeOrString, ArrayType],
|
|
*,
|
|
functionType: PandasScalarIterUDFType
|
|
) -> Callable[[PandasScalarIterFunction], UserDefinedFunctionLike]: ...
|
|
@overload
|
|
def pandas_udf(
|
|
f: PandasGroupedMapFunction,
|
|
returnType: Union[StructType, str],
|
|
functionType: PandasGroupedMapUDFType,
|
|
) -> GroupedMapPandasUserDefinedFunction: ...
|
|
@overload
|
|
def pandas_udf(
|
|
f: Union[StructType, str], returnType: PandasGroupedMapUDFType
|
|
) -> Callable[[PandasGroupedMapFunction], GroupedMapPandasUserDefinedFunction]: ...
|
|
@overload
|
|
def pandas_udf(
|
|
*, returnType: Union[StructType, str], functionType: PandasGroupedMapUDFType
|
|
) -> Callable[[PandasGroupedMapFunction], GroupedMapPandasUserDefinedFunction]: ...
|
|
@overload
|
|
def pandas_udf(
|
|
f: Union[StructType, str], *, functionType: PandasGroupedMapUDFType
|
|
) -> Callable[[PandasGroupedMapFunction], GroupedMapPandasUserDefinedFunction]: ...
|
|
@overload
|
|
def pandas_udf(
|
|
f: PandasGroupedAggFunction,
|
|
returnType: Union[AtomicDataTypeOrString, ArrayType],
|
|
functionType: PandasGroupedAggUDFType,
|
|
) -> UserDefinedFunctionLike: ...
|
|
@overload
|
|
def pandas_udf(
|
|
f: Union[AtomicDataTypeOrString, ArrayType], returnType: PandasGroupedAggUDFType
|
|
) -> Callable[[PandasGroupedAggFunction], UserDefinedFunctionLike]: ...
|
|
@overload
|
|
def pandas_udf(
|
|
*,
|
|
returnType: Union[AtomicDataTypeOrString, ArrayType],
|
|
functionType: PandasGroupedAggUDFType
|
|
) -> Callable[[PandasGroupedAggFunction], UserDefinedFunctionLike]: ...
|
|
@overload
|
|
def pandas_udf(
|
|
f: Union[AtomicDataTypeOrString, ArrayType],
|
|
*,
|
|
functionType: PandasGroupedAggUDFType
|
|
) -> Callable[[PandasGroupedAggFunction], UserDefinedFunctionLike]: ...
|
|
@overload
|
|
def pandas_udf(
|
|
f: PandasMapIterFunction,
|
|
returnType: Union[StructType, str],
|
|
functionType: PandasMapIterUDFType,
|
|
) -> MapIterPandasUserDefinedFunction: ...
|
|
@overload
|
|
def pandas_udf(
|
|
f: Union[StructType, str], returnType: PandasMapIterUDFType
|
|
) -> Callable[[PandasMapIterFunction], MapIterPandasUserDefinedFunction]: ...
|
|
@overload
|
|
def pandas_udf(
|
|
*, returnType: Union[StructType, str], functionType: PandasMapIterUDFType
|
|
) -> Callable[[PandasMapIterFunction], MapIterPandasUserDefinedFunction]: ...
|
|
@overload
|
|
def pandas_udf(
|
|
f: Union[StructType, str], *, functionType: PandasMapIterUDFType
|
|
) -> Callable[[PandasMapIterFunction], MapIterPandasUserDefinedFunction]: ...
|
|
@overload
|
|
def pandas_udf(
|
|
f: PandasCogroupedMapFunction,
|
|
returnType: Union[StructType, str],
|
|
functionType: PandasCogroupedMapUDFType,
|
|
) -> CogroupedMapPandasUserDefinedFunction: ...
|
|
@overload
|
|
def pandas_udf(
|
|
f: Union[StructType, str], returnType: PandasCogroupedMapUDFType
|
|
) -> Callable[[PandasCogroupedMapFunction], CogroupedMapPandasUserDefinedFunction]: ...
|
|
@overload
|
|
def pandas_udf(
|
|
*, returnType: Union[StructType, str], functionType: PandasCogroupedMapUDFType
|
|
) -> Callable[[PandasCogroupedMapFunction], CogroupedMapPandasUserDefinedFunction]: ...
|
|
@overload
|
|
def pandas_udf(
|
|
f: Union[StructType, str], *, functionType: PandasCogroupedMapUDFType
|
|
) -> Callable[[PandasCogroupedMapFunction], CogroupedMapPandasUserDefinedFunction]: ...
|