allisonwang-db commented on code in PR #41316: URL: https://github.com/apache/spark/pull/41316#discussion_r1217545886
########## python/pyspark/sql/udtf.py: ########## @@ -0,0 +1,209 @@ +# +# 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. +# +""" +User-defined table function related classes and functions +""" +import sys +from typing import Type, TYPE_CHECKING, Optional, Union + +from py4j.java_gateway import JavaObject + +from pyspark.sql.column import _to_java_column, _to_seq +from pyspark.sql.types import StructType, _parse_datatype_string +from pyspark.sql.udf import _wrap_function + +if TYPE_CHECKING: + from pyspark.sql._typing import ColumnOrName + from pyspark.sql.dataframe import DataFrame + from pyspark.sql.session import SparkSession + +__all__ = ["UDTFRegistration"] + + +def _create_udtf( + f: Type, + returnType: Union[StructType, str], + name: Optional[str] = None, + deterministic: bool = True, +) -> "UserDefinedTableFunction": + """Create a Python UDTF.""" + udtf_obj = UserDefinedTableFunction( + f, returnType=returnType, name=name, deterministic=deterministic + ) + return udtf_obj + + +class UserDefinedTableFunction: + """ + User-defined table function in Python + + .. versionadded:: 3.5 + + Notes + ----- + The constructor of this class is not supposed to be directly called. + Use :meth:`pyspark.sql.functions.udtf` to create this instance. + + This API is evolving. + """ + + def __init__( + self, + func: Type, + returnType: Union[StructType, str], + name: Optional[str] = None, + deterministic: bool = True, + ): + if not isinstance(func, type): + raise TypeError( + f"Invalid user-defined table function: the function handler " + f"must be a class, but got {type(func)}." + ) + + # TODO: add more checks for invalid user-defined table functions. Review Comment: Create a follow-up ticket to add more compile-time checks: SPARK-43968 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
