[GitHub] [spark] allisonwang-db commented on a diff in pull request #41864: [SPARK-44059] Add analyzer support of named arguments for built-in functions

["allisonwang-db (via GitHub)" <gi...@apache.org>]

allisonwang-db commented on code in PR #41864:
URL: https://github.com/apache/spark/pull/41864#discussion_r1256488444


##########
sql/catalyst/src/test/scala/org/apache/spark/sql/catalyst/analysis/NamedArgumentFunctionSuite.scala:
##########
@@ -0,0 +1,193 @@
+/*
+ * 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.
+ */
+package org.apache.spark.sql.catalyst.analysis
+
+import scala.reflect.ClassTag
+
+import org.apache.spark.SparkThrowable
+import org.apache.spark.sql.catalyst.InternalRow
+import org.apache.spark.sql.catalyst.expressions.{Expression, Literal, NamedArgumentExpression}
+import org.apache.spark.sql.catalyst.expressions.codegen.{CodegenContext, ExprCode}
+import org.apache.spark.sql.catalyst.plans.logical.{FixedArgumentType, FunctionSignature, NamedArgument, SupportsNamedArguments}
+import org.apache.spark.sql.catalyst.util.TypeUtils.toSQLId
+import org.apache.spark.sql.types.{DataType, StringType}
+
+
+case class DummyExpression() extends Expression {
+  override def nullable: Boolean = false
+  override def eval(input: InternalRow): Any = None
+  override protected def doGenCode(ctx: CodegenContext, ev: ExprCode): ExprCode = null
+  override def dataType: DataType = null
+  override def children: Seq[Expression] = Nil
+  override protected def withNewChildrenInternal(
+    newChildren: IndexedSeq[Expression]): Expression = null
+}
+
+object DummyExpression extends SupportsNamedArguments {
+  def defaultFunctionSignature: FunctionSignature = {
+    FunctionSignature(Seq(NamedArgument("k1", FixedArgumentType(StringType)),
+      NamedArgument("k2", FixedArgumentType(StringType)),
+      NamedArgument("k3", FixedArgumentType(StringType)),
+      NamedArgument("k4", FixedArgumentType(StringType))))
+  }
+  override def functionSignatures: Seq[FunctionSignature] = {
+    Seq(defaultFunctionSignature)
+  }
+}
+
+case class SignaturesExpression() extends Expression {
+  override def nullable: Boolean = false
+  override def eval(input: InternalRow): Any = None
+  override protected def doGenCode(ctx: CodegenContext, ev: ExprCode): ExprCode = null
+  override def dataType: DataType = null
+  override def children: Seq[Expression] = Nil
+  override protected def withNewChildrenInternal(
+    newChildren: IndexedSeq[Expression]): Expression = null
+}
+
+object SignaturesExpression extends SupportsNamedArguments {
+  override def functionSignatures: Seq[FunctionSignature] = Seq(null, null)
+}
+
+case class NoNamedArgumentsExpression() extends Expression {
+  override def nullable: Boolean = false
+  override def eval(input: InternalRow): Any = None
+  override protected def doGenCode(ctx: CodegenContext, ev: ExprCode): ExprCode = null
+  override def dataType: DataType = null
+  override def children: Seq[Expression] = Nil
+  override protected def withNewChildrenInternal(
+    newChildren: IndexedSeq[Expression]): Expression = null
+}
+
+class NamedArgumentFunctionSuite extends AnalysisTest {
+
+  final val k1Arg = Literal("v1")
+  final val k2Arg = NamedArgumentExpression("k2", Literal("v2"))
+  final val k3Arg = NamedArgumentExpression("k3", Literal("v3"))
+  final val k4Arg = NamedArgumentExpression("k4", Literal("v4"))
+  final val args = Seq(k1Arg, k4Arg, k2Arg, k3Arg)
+  final val expectedSeq = Seq(Literal("v1"), Literal("v2"), Literal("v3"), Literal("v4"))
+
+  def rearrangeExpressions[T <: Expression : ClassTag](
+        expressions: Seq[Expression], functionName: String = "function"): Seq[Expression] = {
+    SupportsNamedArguments.getRearrangedExpressions[T](expressions, functionName)
+  }
+
+  test("Check rearrangement of expressions") {
+    val rearrangedArgs = SupportsNamedArguments.defaultRearrange(
+      DummyExpression.defaultFunctionSignature, args, "function")
+    for ((returnedArg, expectedArg) <- rearrangedArgs.zip(expectedSeq)) {
+      assert(returnedArg == expectedArg)
+    }
+  }
+
+  test("Check inheritance restrictions are enforced.") {
+    val rearrangedArgs = rearrangeExpressions[DummyExpression](args)
+    for ((returnedArg, expectedArg) <- rearrangedArgs.zip(expectedSeq)) {
+      assert(returnedArg == expectedArg)
+    }
+  }
+
+  private def parseRearrangeException(functionSignature: FunctionSignature,
+                                      expressions: Seq[Expression],
+                                      functionName: String = "function"): SparkThrowable = {

Review Comment:
   nit: space



##########
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/generators.scala:
##########
@@ -431,6 +432,11 @@ case class Explode(child: Expression) extends ExplodeBase {
     copy(child = newChild)
 }
 
+object Explode extends SupportsNamedArguments {

Review Comment:
   Also, for a table function like `stack(n, expr1, ..., exprk)`, how would you add named arguments for it?



##########
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/generators.scala:
##########
@@ -431,6 +432,11 @@ case class Explode(child: Expression) extends ExplodeBase {
     copy(child = newChild)
 }
 
+object Explode extends SupportsNamedArguments {

Review Comment:
   Why should the 'explode' function support named arguments if it only has one argument?
   ```
   explode(expr)
   ```



-- 
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: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org