viirya commented on a change in pull request #26861: [SPARK-30231][SQL][PYTHON]
Support explain mode in PySpark df.explain
URL: https://github.com/apache/spark/pull/26861#discussion_r357726827
##########
File path: python/pyspark/sql/dataframe.py
##########
@@ -271,11 +279,47 @@ def explain(self, extended=False):
...
== Physical Plan ==
...
+
+ >>> df.explain(mode="formatted")
+ == Physical Plan ==
+ * Scan ExistingRDD (1)
+ (1) Scan ExistingRDD [codegen id : 1]
+ Output: [age#0, name#1]
+
+ .. versionchanged:: 3.0.0
+ Added optional argument `mode` to specify the expected output
format of plans.
"""
- if extended:
- print(self._jdf.queryExecution().toString())
- else:
- print(self._jdf.queryExecution().simpleString())
+
+ if extended is not None and mode is not None:
+ raise Exception("extended and mode can not be specified
simultaneously")
+
+ # For the no argument case: df.explain()
+ is_no_argument = extended is None and mode is None
+
+ # For the cases below:
+ # explain(True)
+ # explain(extended=False)
+ is_extended_case = extended is not None and isinstance(extended, bool)
+
+ # For the mode specified: df.explain(mode="formatted")
+ is_mode_case = mode is not None and isinstance(mode, basestring)
+
+ if not is_no_argument and not (is_extended_case or is_mode_case):
+ argtypes = [
+ str(type(arg)) for arg in [extended, mode] if arg is not None]
+ raise TypeError(
+ "extended (optional) and mode (optional) should be a bool and
str; "
+ "however, got [%s]." % ", ".join(argtypes))
Review comment:
If only a wrong mode is given, this will print like:
```
extended (optional) and mode (optional) should be a bool and str; however,
got wrong_type_for_mode.
```
Not big deal, but maybe only print out corresponding arg name if it is given
wrong type.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
