You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "allisonwang-db (via GitHub)" <gi...@apache.org> on 2023/07/25 20:58:19 UTC
[GitHub] [spark] allisonwang-db opened a new pull request, #42157: [SPARK-43968][PYTHON] Improve error messages for Python UDTFs with wrong number of outputs
allisonwang-db opened a new pull request, #42157:
URL: https://github.com/apache/spark/pull/42157
<!--
Thanks for sending a pull request! Here are some tips for you:
1. If this is your first time, please read our contributor guidelines: https://spark.apache.org/contributing.html
2. Ensure you have added or run the appropriate tests for your PR: https://spark.apache.org/developer-tools.html
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][SPARK-XXXX] Your PR title ...'.
4. Be sure to keep the PR description updated to reflect all changes.
5. Please write your PR title to summarize what this PR proposes.
6. If possible, provide a concise example to reproduce the issue for a faster review.
7. If you want to add a new configuration, please read the guideline first for naming configurations in
'core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'.
8. If you want to add or modify an error type or message, please read the guideline first in
'core/src/main/resources/error/README.md'.
-->
### What changes were proposed in this pull request?
<!--
Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue.
If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
2. If you fix some SQL features, you can provide some references of other DBMSes.
3. If there is design documentation, please add the link.
4. If there is a discussion in the mailing list, please add the link.
-->
This PR improves the error messages for Python UDTFs when the number of outputs mismatches the number of outputs specified in the return type of the UDTFs.
### Why are the changes needed?
<!--
Please clarify why the changes are needed. For instance,
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, you can clarify why it is a bug.
-->
To make Python UDTFs more user-friendly.
### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such as the documentation fix.
If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
If possible, please also clarify if this is a user-facing change compared to the released Spark versions or within the unreleased branches such as master.
If no, write 'No'.
-->
Yes. This PR improves the error messages.
Before this change, the error thrown by Spark will be a java IllegalStateException:
```
java.lang.IllegalStateException: Input row doesn't have expected number of values required by the schema
```
After this PR, it will throw a clearer error message with an error class:
```
[UDTF_RETURN_SCHEMA_MISMATCH] The number of columns in the result does not match the specified schema
```
### How was this patch tested?
<!--
If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
If tests were not added, please describe why they were not added and/or why it was difficult to add.
If benchmark tests were added, please run the benchmarks in GitHub Actions for the consistent environment, and the instructions could accord to: https://spark.apache.org/developer-tools.html#github-workflow-benchmarks.
-->
Existing tests and new unit tests.
--
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
[GitHub] [spark] ueshin commented on a diff in pull request #42157: [SPARK-43968][PYTHON] Improve error messages for Python UDTFs with wrong number of outputs
Posted by "ueshin (via GitHub)" <gi...@apache.org>.
ueshin commented on code in PR #42157:
URL: https://github.com/apache/spark/pull/42157#discussion_r1276759271
##########
python/pyspark/worker.py:
##########
@@ -654,6 +657,19 @@ def wrap_udtf(f, return_type):
assert return_type.needConversion()
toInternal = return_type.toInternal
+ def verify_and_convert_result(result):
+ # TODO(SPARK-44005): support returning non-tuple values
+ if result is not None and hasattr(result, "__len__"):
+ if len(result) != len(return_type):
Review Comment:
nit: ditto.
##########
python/pyspark/worker.py:
##########
@@ -604,8 +604,11 @@ def verify_result(result):
},
)
- # Check when the dataframe has both rows and columns.
- if not result.empty or len(result.columns) != 0:
+ # Validate the output schema when the result dataframe has either output
+ # rows or columns. Note that we avoid using `df.empty` here because the
+ # result dataframe may contain an empty row. For example, when a UDTF is
+ # defined as follows: def eval(self): yield tuple().
+ if len(result) > 0 or len(result.columns) > 0:
if len(result.columns) != len(return_type):
Review Comment:
nit: We might want to have an variable for `len(return_type)` outside of `verify_result` to avoid any potential overhead.
--
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
[GitHub] [spark] ueshin commented on pull request #42157: [SPARK-43968][PYTHON] Improve error messages for Python UDTFs with wrong number of outputs
Posted by "ueshin (via GitHub)" <gi...@apache.org>.
ueshin commented on PR #42157:
URL: https://github.com/apache/spark/pull/42157#issuecomment-1654514682
@allisonwang-db There was a conflict with `branch-3.5`.
Could you submit another PR to backport this?
Thanks.
--
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
[GitHub] [spark] dtenedor commented on a diff in pull request #42157: [SPARK-43968][PYTHON] Improve error messages for Python UDTFs with wrong number of outputs
Posted by "dtenedor (via GitHub)" <gi...@apache.org>.
dtenedor commented on code in PR #42157:
URL: https://github.com/apache/spark/pull/42157#discussion_r1275350920
##########
python/pyspark/sql/tests/test_udtf.py:
##########
@@ -256,29 +254,76 @@ def eval(self, a: int):
):
TestUDTF(lit(1), lit(2)).collect()
+ def test_udtf_init_with_additional_args(self):
+ @udtf(returnType="x int")
+ class TestUDTF:
+ def __init__(self, a: int):
+ ...
+
+ def eval(self, a: int):
+ yield a,
+
+ with self.assertRaisesRegex(
+ PythonException, r"__init__\(\) missing 1 required positional argument: 'a'"
Review Comment:
I mentioned this in @ueshin's previous PR, it would be helpful to include the UDTF name in the error message. Is it possible to add that now, or should we separate that work to a later PR?
--
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
[GitHub] [spark] allisonwang-db commented on pull request #42157: [SPARK-43968][PYTHON] Improve error messages for Python UDTFs with wrong number of outputs
Posted by "allisonwang-db (via GitHub)" <gi...@apache.org>.
allisonwang-db commented on PR #42157:
URL: https://github.com/apache/spark/pull/42157#issuecomment-1650953383
cc @ueshin @HyukjinKwon
--
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
[GitHub] [spark] allisonwang-db commented on a diff in pull request #42157: [SPARK-43968][PYTHON] Improve error messages for Python UDTFs with wrong number of outputs
Posted by "allisonwang-db (via GitHub)" <gi...@apache.org>.
allisonwang-db commented on code in PR #42157:
URL: https://github.com/apache/spark/pull/42157#discussion_r1276577525
##########
python/pyspark/sql/tests/test_udtf.py:
##########
@@ -256,29 +254,76 @@ def eval(self, a: int):
):
TestUDTF(lit(1), lit(2)).collect()
+ def test_udtf_init_with_additional_args(self):
+ @udtf(returnType="x int")
+ class TestUDTF:
+ def __init__(self, a: int):
+ ...
+
+ def eval(self, a: int):
+ yield a,
+
+ with self.assertRaisesRegex(
+ PythonException, r"__init__\(\) missing 1 required positional argument: 'a'"
Review Comment:
Yup here is the Jira ticket to add UDTF name in the error message: https://issues.apache.org/jira/browse/SPARK-44008
--
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
[GitHub] [spark] allisonwang-db commented on pull request #42157: [SPARK-43968][PYTHON] Improve error messages for Python UDTFs with wrong number of outputs
Posted by "allisonwang-db (via GitHub)" <gi...@apache.org>.
allisonwang-db commented on PR #42157:
URL: https://github.com/apache/spark/pull/42157#issuecomment-1654613795
Created https://github.com/apache/spark/pull/42192 for branch-3.5.
--
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
[GitHub] [spark] ueshin closed pull request #42157: [SPARK-43968][PYTHON] Improve error messages for Python UDTFs with wrong number of outputs
Posted by "ueshin (via GitHub)" <gi...@apache.org>.
ueshin closed pull request #42157: [SPARK-43968][PYTHON] Improve error messages for Python UDTFs with wrong number of outputs
URL: https://github.com/apache/spark/pull/42157
--
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
[GitHub] [spark] ueshin commented on pull request #42157: [SPARK-43968][PYTHON] Improve error messages for Python UDTFs with wrong number of outputs
Posted by "ueshin (via GitHub)" <gi...@apache.org>.
ueshin commented on PR #42157:
URL: https://github.com/apache/spark/pull/42157#issuecomment-1654507067
Thanks! merging to master/3.5.
--
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