You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "itholic (via GitHub)" <gi...@apache.org> on 2023/01/21 17:49:51 UTC
[GitHub] [spark] itholic opened a new pull request, #39693: [SPARK-41712][PYTHON][CONNECT] Migrate the Spark Connect errors into PySpark error framework.
itholic opened a new pull request, #39693:
URL: https://github.com/apache/spark/pull/39693
<!--
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 proposes to migrate the Spark Connect errors into PySpark error framework.
Also introducing 5 exceptions to handle the errors generated by Spark Connect as below:
- SparkConnectException
- SparkConnectGrpcException
- SparkConnectAnalysisException
- SparkConnectParseException
- SparkConnectTempTableAlreadyExistsException
### 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.
-->
All errors are generated from Python side should be integrated into `pyspark.errors`.
### 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'.
-->
No.
### 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.
-->
Fix UTs, also existing CI should pass.
--
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] HyukjinKwon closed pull request #39693: [SPARK-41712][PYTHON][CONNECT] Migrate the Spark Connect errors into PySpark error framework.
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon closed pull request #39693: [SPARK-41712][PYTHON][CONNECT] Migrate the Spark Connect errors into PySpark error framework.
URL: https://github.com/apache/spark/pull/39693
--
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] itholic commented on a diff in pull request #39693: [SPARK-41712][PYTHON][CONNECT] Migrate the Spark Connect errors into PySpark error framework.
Posted by "itholic (via GitHub)" <gi...@apache.org>.
itholic commented on code in PR #39693:
URL: https://github.com/apache/spark/pull/39693#discussion_r1083316715
##########
python/pyspark/errors/exceptions.py:
##########
@@ -288,7 +291,57 @@ class UnknownException(CapturedException):
class SparkUpgradeException(CapturedException):
"""
- Exception thrown because of Spark upgrade
+ Exception thrown because of Spark upgrade.
+ """
+
+
+class SparkConnectException(PySparkException):
+ """
+ Exception thrown from Spark Connect.
+ """
+
+
+class SparkConnectGrpcException(SparkConnectException):
+ """
+ Base class to handle the errors from GRPC.
+ """
+
+ def __init__(
+ self,
+ message: Optional[str] = None,
+ error_class: Optional[str] = None,
+ message_parameters: Optional[Dict[str, str]] = None,
+ plan: Optional[str] = None,
+ reason: Optional[str] = None,
Review Comment:
`SparkConnectGrpcException` is a specialized `SparkConnectException` to handle errors that occur in GRPC.
And `plan` and `reason` come from `grpc.RpcError`, so I moved them from `SparkConnectException`.
##########
python/pyspark/sql/connect/client.py:
##########
@@ -628,21 +612,33 @@ def _handle_error(self, rpc_error: grpc.RpcError) -> NoReturn:
if d.Is(error_details_pb2.ErrorInfo.DESCRIPTOR):
info = error_details_pb2.ErrorInfo()
d.Unpack(info)
- if info.reason == "org.apache.spark.sql.AnalysisException":
+ reason = info.reason
+ if reason == "org.apache.spark.sql.AnalysisException":
raise SparkConnectAnalysisException(
- info.reason, info.metadata["message"], info.metadata["plan"]
Review Comment:
I don't use `reason` from `SparkConnectAnalysisException` and other specified Exceptions (e.g. `SparkConnectParseException`, `SparkConnectTempTableAlreadyExistsException`), since I believe the name of exception sounds self-explanatory.
--
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] itholic commented on a diff in pull request #39693: [SPARK-41712][PYTHON][CONNECT] Migrate the Spark Connect errors into PySpark error framework.
Posted by "itholic (via GitHub)" <gi...@apache.org>.
itholic commented on code in PR #39693:
URL: https://github.com/apache/spark/pull/39693#discussion_r1083528302
##########
python/pyspark/errors/exceptions.py:
##########
@@ -288,7 +291,57 @@ class UnknownException(CapturedException):
class SparkUpgradeException(CapturedException):
"""
- Exception thrown because of Spark upgrade
+ Exception thrown because of Spark upgrade.
+ """
+
+
+class SparkConnectException(PySparkException):
+ """
+ Exception thrown from Spark Connect.
+ """
+
+
+class SparkConnectGrpcException(SparkConnectException):
+ """
+ Base class to handle the errors from GRPC.
+ """
+
+ def __init__(
+ self,
+ message: Optional[str] = None,
+ error_class: Optional[str] = None,
+ message_parameters: Optional[Dict[str, str]] = None,
+ plan: Optional[str] = None,
+ reason: Optional[str] = None,
Review Comment:
Thanks for the detail!
Just moved `plan` into `SparkConnectAnalysisException`.
--
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] HyukjinKwon commented on pull request #39693: [SPARK-41712][PYTHON][CONNECT] Migrate the Spark Connect errors into PySpark error framework.
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #39693:
URL: https://github.com/apache/spark/pull/39693#issuecomment-1399947990
Merged to master.
--
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] itholic commented on a diff in pull request #39693: [SPARK-41712][PYTHON][CONNECT] Migrate the Spark Connect errors into PySpark error framework.
Posted by "itholic (via GitHub)" <gi...@apache.org>.
itholic commented on code in PR #39693:
URL: https://github.com/apache/spark/pull/39693#discussion_r1083429604
##########
python/pyspark/errors/__init__.py:
##########
@@ -45,4 +50,11 @@
"SparkUpgradeException",
"PySparkTypeError",
"PySparkValueError",
+ "SparkConnectException",
+ "SparkConnectGrpcException",
+ "SparkConnectAnalysisException",
+ "SparkConnectParseException",
+ "SparkConnectTempTableAlreadyExistsException",
+ "PySparkTypeError",
+ "PySparkValueError",
Review Comment:
Oops. Thanks for the correction!
--
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] itholic commented on pull request #39693: [SPARK-41712][PYTHON][CONNECT] Migrate the Spark Connect errors into PySpark error framework.
Posted by "itholic (via GitHub)" <gi...@apache.org>.
itholic commented on PR #39693:
URL: https://github.com/apache/spark/pull/39693#issuecomment-1399452695
> not related to this PR, but we may also need to add tests to check the messages in these exceptions.
For sure! I'm planning to improve the tests for new error framework as follow up tasks.
I think that's going to be quite a big task, I plan to create JIRA sub-tasks a per-file basis.
--
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] HyukjinKwon commented on pull request #39693: [SPARK-41712][PYTHON][CONNECT] Migrate the Spark Connect errors into PySpark error framework.
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #39693:
URL: https://github.com/apache/spark/pull/39693#issuecomment-1399949205
Merged to master.
--
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] zhengruifeng commented on a diff in pull request #39693: [SPARK-41712][PYTHON][CONNECT] Migrate the Spark Connect errors into PySpark error framework.
Posted by "zhengruifeng (via GitHub)" <gi...@apache.org>.
zhengruifeng commented on code in PR #39693:
URL: https://github.com/apache/spark/pull/39693#discussion_r1083425383
##########
python/pyspark/sql/connect/client.py:
##########
@@ -628,21 +612,33 @@ def _handle_error(self, rpc_error: grpc.RpcError) -> NoReturn:
if d.Is(error_details_pb2.ErrorInfo.DESCRIPTOR):
info = error_details_pb2.ErrorInfo()
d.Unpack(info)
- if info.reason == "org.apache.spark.sql.AnalysisException":
+ reason = info.reason
+ if reason == "org.apache.spark.sql.AnalysisException":
raise SparkConnectAnalysisException(
- info.reason, info.metadata["message"], info.metadata["plan"]
Review Comment:
sounds good, I just check the scala side also throw `org.apache.spark.sql.catalyst.analysis.TempTableAlreadyExistsException` which inherit `AnalysisException`
##########
python/pyspark/errors/__init__.py:
##########
@@ -45,4 +50,11 @@
"SparkUpgradeException",
"PySparkTypeError",
"PySparkValueError",
+ "SparkConnectException",
+ "SparkConnectGrpcException",
+ "SparkConnectAnalysisException",
+ "SparkConnectParseException",
+ "SparkConnectTempTableAlreadyExistsException",
+ "PySparkTypeError",
+ "PySparkValueError",
Review Comment:
```suggestion
```
`PySparkTypeError` and `PySparkValueError` are duplicated here
--
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] grundprinzip commented on a diff in pull request #39693: [SPARK-41712][PYTHON][CONNECT] Migrate the Spark Connect errors into PySpark error framework.
Posted by "grundprinzip (via GitHub)" <gi...@apache.org>.
grundprinzip commented on code in PR #39693:
URL: https://github.com/apache/spark/pull/39693#discussion_r1083516891
##########
python/pyspark/errors/exceptions.py:
##########
@@ -288,7 +291,57 @@ class UnknownException(CapturedException):
class SparkUpgradeException(CapturedException):
"""
- Exception thrown because of Spark upgrade
+ Exception thrown because of Spark upgrade.
+ """
+
+
+class SparkConnectException(PySparkException):
+ """
+ Exception thrown from Spark Connect.
+ """
+
+
+class SparkConnectGrpcException(SparkConnectException):
+ """
+ Base class to handle the errors from GRPC.
+ """
+
+ def __init__(
+ self,
+ message: Optional[str] = None,
+ error_class: Optional[str] = None,
+ message_parameters: Optional[Dict[str, str]] = None,
+ plan: Optional[str] = None,
+ reason: Optional[str] = None,
Review Comment:
plan is actually only present in `SparkConnectAnalysisException` because it's a special property submitted as part of the error details.
--
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] HyukjinKwon commented on pull request #39693: [SPARK-41712][PYTHON][CONNECT] Migrate the Spark Connect errors into PySpark error framework.
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #39693:
URL: https://github.com/apache/spark/pull/39693#issuecomment-1399951037
Spark Connect errors are factored out now. We can fix the tests now in https://github.com/apache/spark/pull/39693 and https://github.com/apache/spark/pull/39492 cc @beliefer and @techaddict
--
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