[SPARK-48938][PYTHON] Improve error messages when registering Python UDTFs #47408
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
cc @ueshin |
ueshin
approved these changes
Jul 18, 2024
HyukjinKwon
approved these changes
Jul 19, 2024
zhengruifeng
approved these changes
Jul 19, 2024
|
Merged to master. |
jingz-db
pushed a commit
to jingz-db/spark
that referenced
this pull request
Jul 22, 2024
…UDTFs
### What changes were proposed in this pull request?
This PR improves the error messages when registering Python UDTFs.
Before this PR:
```python
class TestUDTF:
...
spark.udtf.register("test_udtf", TestUDTF)
```
This fails with
```
AttributeError: type object "TestUDTF" has no attribute "evalType"
```
After this PR:
```python
spark.udtf.register("test_udtf", TestUDTF)
```
Now we have a nicer error:
```
[CANNOT_REGISTER_UDTF] Cannot register the UDTF 'test_udtf': expected a 'UserDefinedTableFunction'. Please make sure the UDTF is correctly defined as a class, and then either wrap it in the `udtf()` function or annotate it with `udtf(...)`.`
```
### Why are the changes needed?
To improve usability.
### Does this PR introduce _any_ user-facing change?
No
### How was this patch tested?
Existing and new unit tests.
### Was this patch authored or co-authored using generative AI tooling?
No
Closes apache#47408 from allisonwang-db/spark-48938-udtf-register-err-msg.
Authored-by: allisonwang-db <[email protected]>
Signed-off-by: Hyukjin Kwon <[email protected]>
attilapiros
pushed a commit
to attilapiros/spark
that referenced
this pull request
Oct 4, 2024
…UDTFs
### What changes were proposed in this pull request?
This PR improves the error messages when registering Python UDTFs.
Before this PR:
```python
class TestUDTF:
...
spark.udtf.register("test_udtf", TestUDTF)
```
This fails with
```
AttributeError: type object "TestUDTF" has no attribute "evalType"
```
After this PR:
```python
spark.udtf.register("test_udtf", TestUDTF)
```
Now we have a nicer error:
```
[CANNOT_REGISTER_UDTF] Cannot register the UDTF 'test_udtf': expected a 'UserDefinedTableFunction'. Please make sure the UDTF is correctly defined as a class, and then either wrap it in the `udtf()` function or annotate it with `udtf(...)`.`
```
### Why are the changes needed?
To improve usability.
### Does this PR introduce _any_ user-facing change?
No
### How was this patch tested?
Existing and new unit tests.
### Was this patch authored or co-authored using generative AI tooling?
No
Closes apache#47408 from allisonwang-db/spark-48938-udtf-register-err-msg.
Authored-by: allisonwang-db <[email protected]>
Signed-off-by: Hyukjin Kwon <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
This PR improves the error messages when registering Python UDTFs.
Before this PR:
This fails with
After this PR:
Now we have a nicer error:
Why are the changes needed?
To improve usability.
Does this PR introduce any user-facing change?
No
How was this patch tested?
Existing and new unit tests.
Was this patch authored or co-authored using generative AI tooling?
No