You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "alexanderwu-db (via GitHub)" <gi...@apache.org> on 2023/04/21 23:08:55 UTC
[GitHub] [spark] alexanderwu-db opened a new pull request, #40907: [PYTHON] Implement `__dir__()` in `pyspark.sql.dataframe.DataFrame` to include columns
alexanderwu-db opened a new pull request, #40907:
URL: https://github.com/apache/spark/pull/40907
<!--
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.
-->
Override the parent `__dir__()` method on Python `DataFrame` class to include column names. Main benefit of this is that any autocomplete engine that uses `dir()` to generate autocomplete suggestions (e.g. IPython kernel, Databricks Notebooks) will suggest column names on the completion `df.|`.
### 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 keep `__dir__()` consistent with `__getattr__()`. So this is arguably a bug fix. Increases productivity for anyone who uses an autocomplete engine on pyspark code.
Example of column attribute completion coming for free after this change:
https://user-images.githubusercontent.com/84545946/233747057-56b2589d-d075-4d13-8349-ac5142c38c62.mov
### 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'.
-->
Will change the output of `dir(df)`. If the user chooses to use the private method `df.__dir__()`, they will also notice an output and docstring difference there.
### 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.
-->
New doctest with three assertions. Output where I only ran this test:
To test it in a notebook:
```python
from pyspark.sql.dataframe import DataFrame
class DataFrameWithColAttrs(DataFrame):
def __init__(self, df):
super().__init__(df._jdf, df._sql_ctx if df._sql_ctx else df._session)
def __dir__(self):
attrs = super().__dir__()
attrs.extend(attr for attr in self.columns if attr not in attrs)
return attrs
```
--
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 #40907: [SPARK-43270][PYTHON] Implement `__dir__()` in `pyspark.sql.dataframe.DataFrame` to include columns
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #40907:
URL: https://github.com/apache/spark/pull/40907#issuecomment-1528560625
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] BeishaoCao-db commented on a diff in pull request #40907: [SPARK-43270][PYTHON] Implement `__dir__()` in `pyspark.sql.dataframe.DataFrame` to include columns
Posted by "BeishaoCao-db (via GitHub)" <gi...@apache.org>.
BeishaoCao-db commented on code in PR #40907:
URL: https://github.com/apache/spark/pull/40907#discussion_r1179547179
##########
python/pyspark/sql/dataframe.py:
##########
@@ -3008,6 +3008,34 @@ def __getattr__(self, name: str) -> Column:
jc = self._jdf.apply(name)
return Column(jc)
+ def __dir__(self) -> List[str]:
+ """
+ Examples
+ --------
+ >>> from pyspark.sql.functions import lit
+
+ Create a dataframe with a column named 'id'.
+
+ >>> df = spark.range(3)
+ >>> [attr for attr in dir(df) if attr[0] == 'i'][:7] # Includes column id
+ ['id', 'inputFiles', 'intersect', 'intersectAll', 'isEmpty', 'isLocal', 'isStreaming']
+
+ Add a column named 'i_like_pancakes'.
+
+ >>> df = df.withColumn('i_like_pancakes', lit(1))
+ >>> [attr for attr in dir(df) if attr[0] == 'i'][:7] # Includes columns i_like_pancakes, id
+ ['i_like_pancakes', 'id', 'inputFiles', 'intersect', 'intersectAll', 'isEmpty', 'isLocal']
+
+ Try to add an existed column 'inputFiles'.
+
+ >>> df = df.withColumn('inputFiles', lit(2))
+ >>> [attr for attr in dir(df) if attr[0] == 'i'][:7] # Doesn't duplicate inputFiles
+ ['i_like_pancakes', 'id', 'inputFiles', 'intersect', 'intersectAll', 'isEmpty', 'isLocal']
+ """
+ attrs = list(super().__dir__())
+ attrs.extend(attr for attr in self.columns if attr not in attrs)
Review Comment:
I don't see the point of using hasattr: our implementation about `__getattr__ `check the columns exist or not and we still need to check that `attr not in attrs`
Also, I change to use set and we don't need to check if the column already there or not
--
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 a diff in pull request #40907: [SPARK-43270][PYTHON] Implement `__dir__()` in `pyspark.sql.dataframe.DataFrame` to include columns
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on code in PR #40907:
URL: https://github.com/apache/spark/pull/40907#discussion_r1178214495
##########
python/pyspark/sql/dataframe.py:
##########
@@ -3008,6 +3008,34 @@ def __getattr__(self, name: str) -> Column:
jc = self._jdf.apply(name)
return Column(jc)
+ def __dir__(self) -> List[str]:
+ """
+ Examples
+ --------
+ >>> from pyspark.sql.functions import lit
+
+ Create a dataframe with a column named 'id'.
+
+ >>> df = spark.range(3)
+ >>> [attr for attr in dir(df) if attr[0] == 'i'][:7] # Includes column id
+ ['id', 'inputFiles', 'intersect', 'intersectAll', 'isEmpty', 'isLocal', 'isStreaming']
+
+ Add a column named 'i_like_pancakes'.
+
+ >>> df = df.withColumn('i_like_pancakes', lit(1))
+ >>> [attr for attr in dir(df) if attr[0] == 'i'][:7] # Includes columns i_like_pancakes, id
+ ['i_like_pancakes', 'id', 'inputFiles', 'intersect', 'intersectAll', 'isEmpty', 'isLocal']
+
+ Try to add an existed column 'inputFiles'.
+
+ >>> df = df.withColumn('inputFiles', lit(2))
+ >>> [attr for attr in dir(df) if attr[0] == 'i'][:7] # Doesn't duplicate inputFiles
+ ['i_like_pancakes', 'id', 'inputFiles', 'intersect', 'intersectAll', 'isEmpty', 'isLocal']
+ """
+ attrs = list(super().__dir__())
+ attrs.extend(attr for attr in self.columns if attr not in attrs)
Review Comment:
can we use `hasattr` instead? That will use `getattr`, and invoke `__getattr__` in the dataframe.
--
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] viirya commented on pull request #40907: [SPARK-43270][PYTHON] Implement `__dir__()` in `pyspark.sql.dataframe.DataFrame` to include columns
Posted by "viirya (via GitHub)" <gi...@apache.org>.
viirya commented on PR #40907:
URL: https://github.com/apache/spark/pull/40907#issuecomment-1526269975
Looks okay to me.
--
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] BeishaoCao-db commented on pull request #40907: [SPARK-43270][PYTHON] Implement `__dir__()` in `pyspark.sql.dataframe.DataFrame` to include columns
Posted by "BeishaoCao-db (via GitHub)" <gi...@apache.org>.
BeishaoCao-db commented on PR #40907:
URL: https://github.com/apache/spark/pull/40907#issuecomment-1522387106
Have to mention, this solution is not perfect solution:
dir won't return private method, so if a column start with an _, it would be ignored in the suggestion
--
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] BeishaoCao-db commented on a diff in pull request #40907: [SPARK-43270][PYTHON] Implement `__dir__()` in `pyspark.sql.dataframe.DataFrame` to include columns
Posted by "BeishaoCao-db (via GitHub)" <gi...@apache.org>.
BeishaoCao-db commented on code in PR #40907:
URL: https://github.com/apache/spark/pull/40907#discussion_r1179547179
##########
python/pyspark/sql/dataframe.py:
##########
@@ -3008,6 +3008,34 @@ def __getattr__(self, name: str) -> Column:
jc = self._jdf.apply(name)
return Column(jc)
+ def __dir__(self) -> List[str]:
+ """
+ Examples
+ --------
+ >>> from pyspark.sql.functions import lit
+
+ Create a dataframe with a column named 'id'.
+
+ >>> df = spark.range(3)
+ >>> [attr for attr in dir(df) if attr[0] == 'i'][:7] # Includes column id
+ ['id', 'inputFiles', 'intersect', 'intersectAll', 'isEmpty', 'isLocal', 'isStreaming']
+
+ Add a column named 'i_like_pancakes'.
+
+ >>> df = df.withColumn('i_like_pancakes', lit(1))
+ >>> [attr for attr in dir(df) if attr[0] == 'i'][:7] # Includes columns i_like_pancakes, id
+ ['i_like_pancakes', 'id', 'inputFiles', 'intersect', 'intersectAll', 'isEmpty', 'isLocal']
+
+ Try to add an existed column 'inputFiles'.
+
+ >>> df = df.withColumn('inputFiles', lit(2))
+ >>> [attr for attr in dir(df) if attr[0] == 'i'][:7] # Doesn't duplicate inputFiles
+ ['i_like_pancakes', 'id', 'inputFiles', 'intersect', 'intersectAll', 'isEmpty', 'isLocal']
+ """
+ attrs = list(super().__dir__())
+ attrs.extend(attr for attr in self.columns if attr not in attrs)
Review Comment:
I don't see the point of using hasattr: our implementation about `__getattr__ `check the columns exist or not and we still need to check that `attr not in attrs`
##########
python/pyspark/sql/dataframe.py:
##########
@@ -3008,6 +3008,34 @@ def __getattr__(self, name: str) -> Column:
jc = self._jdf.apply(name)
return Column(jc)
+ def __dir__(self) -> List[str]:
+ """
+ Examples
+ --------
+ >>> from pyspark.sql.functions import lit
+
+ Create a dataframe with a column named 'id'.
+
+ >>> df = spark.range(3)
+ >>> [attr for attr in dir(df) if attr[0] == 'i'][:7] # Includes column id
+ ['id', 'inputFiles', 'intersect', 'intersectAll', 'isEmpty', 'isLocal', 'isStreaming']
+
+ Add a column named 'i_like_pancakes'.
+
+ >>> df = df.withColumn('i_like_pancakes', lit(1))
+ >>> [attr for attr in dir(df) if attr[0] == 'i'][:7] # Includes columns i_like_pancakes, id
+ ['i_like_pancakes', 'id', 'inputFiles', 'intersect', 'intersectAll', 'isEmpty', 'isLocal']
+
+ Try to add an existed column 'inputFiles'.
+
+ >>> df = df.withColumn('inputFiles', lit(2))
+ >>> [attr for attr in dir(df) if attr[0] == 'i'][:7] # Doesn't duplicate inputFiles
+ ['i_like_pancakes', 'id', 'inputFiles', 'intersect', 'intersectAll', 'isEmpty', 'isLocal']
+ """
+ attrs = list(super().__dir__())
Review Comment:
1. we use set and remove the check, return sorted list
2. still use the list, return sorted list
I submit 2 commits for each of them, which one do you prefer?
--
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 a diff in pull request #40907: [PYTHON] Implement `__dir__()` in `pyspark.sql.dataframe.DataFrame` to include columns
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on code in PR #40907:
URL: https://github.com/apache/spark/pull/40907#discussion_r1174235481
##########
python/pyspark/sql/dataframe.py:
##########
@@ -3008,6 +3008,25 @@ def __getattr__(self, name: str) -> Column:
jc = self._jdf.apply(name)
return Column(jc)
+ def __dir__(self):
+ """
+ Examples
+ --------
Review Comment:
Should better have some explanation for the example 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] BeishaoCao-db commented on a diff in pull request #40907: [SPARK-43270][PYTHON] Implement `__dir__()` in `pyspark.sql.dataframe.DataFrame` to include columns
Posted by "BeishaoCao-db (via GitHub)" <gi...@apache.org>.
BeishaoCao-db commented on code in PR #40907:
URL: https://github.com/apache/spark/pull/40907#discussion_r1179547314
##########
python/pyspark/sql/dataframe.py:
##########
@@ -3008,6 +3008,34 @@ def __getattr__(self, name: str) -> Column:
jc = self._jdf.apply(name)
return Column(jc)
+ def __dir__(self) -> List[str]:
+ """
+ Examples
+ --------
+ >>> from pyspark.sql.functions import lit
+
+ Create a dataframe with a column named 'id'.
+
+ >>> df = spark.range(3)
+ >>> [attr for attr in dir(df) if attr[0] == 'i'][:7] # Includes column id
+ ['id', 'inputFiles', 'intersect', 'intersectAll', 'isEmpty', 'isLocal', 'isStreaming']
+
+ Add a column named 'i_like_pancakes'.
+
+ >>> df = df.withColumn('i_like_pancakes', lit(1))
+ >>> [attr for attr in dir(df) if attr[0] == 'i'][:7] # Includes columns i_like_pancakes, id
+ ['i_like_pancakes', 'id', 'inputFiles', 'intersect', 'intersectAll', 'isEmpty', 'isLocal']
+
+ Try to add an existed column 'inputFiles'.
+
+ >>> df = df.withColumn('inputFiles', lit(2))
+ >>> [attr for attr in dir(df) if attr[0] == 'i'][:7] # Doesn't duplicate inputFiles
+ ['i_like_pancakes', 'id', 'inputFiles', 'intersect', 'intersectAll', 'isEmpty', 'isLocal']
+ """
+ attrs = list(super().__dir__())
Review Comment:
change to use set and remove the check.
--
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 #40907: [PYTHON] Implement `__dir__()` in `pyspark.sql.dataframe.DataFrame` to include columns
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #40907:
URL: https://github.com/apache/spark/pull/40907#issuecomment-1518441484
Mind filing a JIRA please?
--
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 a diff in pull request #40907: [SPARK-43270][PYTHON] Implement `__dir__()` in `pyspark.sql.dataframe.DataFrame` to include columns
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on code in PR #40907:
URL: https://github.com/apache/spark/pull/40907#discussion_r1178214107
##########
python/pyspark/sql/dataframe.py:
##########
@@ -3008,6 +3008,34 @@ def __getattr__(self, name: str) -> Column:
jc = self._jdf.apply(name)
return Column(jc)
+ def __dir__(self) -> List[str]:
+ """
+ Examples
+ --------
+ >>> from pyspark.sql.functions import lit
+
+ Create a dataframe with a column named 'id'.
+
+ >>> df = spark.range(3)
+ >>> [attr for attr in dir(df) if attr[0] == 'i'][:7] # Includes column id
+ ['id', 'inputFiles', 'intersect', 'intersectAll', 'isEmpty', 'isLocal', 'isStreaming']
+
+ Add a column named 'i_like_pancakes'.
+
+ >>> df = df.withColumn('i_like_pancakes', lit(1))
+ >>> [attr for attr in dir(df) if attr[0] == 'i'][:7] # Includes columns i_like_pancakes, id
+ ['i_like_pancakes', 'id', 'inputFiles', 'intersect', 'intersectAll', 'isEmpty', 'isLocal']
+
+ Try to add an existed column 'inputFiles'.
+
+ >>> df = df.withColumn('inputFiles', lit(2))
+ >>> [attr for attr in dir(df) if attr[0] == 'i'][:7] # Doesn't duplicate inputFiles
+ ['i_like_pancakes', 'id', 'inputFiles', 'intersect', 'intersectAll', 'isEmpty', 'isLocal']
+ """
+ attrs = list(super().__dir__())
Review Comment:
Can we use `set` and return the sorted list to make it consistent with built-in Python behaviour?
--
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] BeishaoCao-db commented on pull request #40907: [PYTHON] Implement `__dir__()` in `pyspark.sql.dataframe.DataFrame` to include columns
Posted by "BeishaoCao-db (via GitHub)" <gi...@apache.org>.
BeishaoCao-db commented on PR #40907:
URL: https://github.com/apache/spark/pull/40907#issuecomment-1520825250
> engine that uses `dir()` to generate autocomplete suggestions (e.g. IPython kernel, Databricks Notebooks) will suggest column names on the completion `df.|`
Sure, create one ASF JIRA: https://issues.apache.org/jira/browse/SPARK-43270
--
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 #40907: [PYTHON] Implement `__dir__()` in `pyspark.sql.dataframe.DataFrame` to include columns
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #40907:
URL: https://github.com/apache/spark/pull/40907#issuecomment-1519352303
Please file a JIRA in ASF JIRA (at here https://issues.apache.org/jira/projects/SPARK/issues). See also https://spark.apache.org/contributing.html
--
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 #40907: [SPARK-43270][PYTHON] Implement `__dir__()` in `pyspark.sql.dataframe.DataFrame` to include columns
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon closed pull request #40907: [SPARK-43270][PYTHON] Implement `__dir__()` in `pyspark.sql.dataframe.DataFrame` to include columns
URL: https://github.com/apache/spark/pull/40907
--
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] BeishaoCao-db commented on a diff in pull request #40907: [PYTHON] Implement `__dir__()` in `pyspark.sql.dataframe.DataFrame` to include columns
Posted by "BeishaoCao-db (via GitHub)" <gi...@apache.org>.
BeishaoCao-db commented on code in PR #40907:
URL: https://github.com/apache/spark/pull/40907#discussion_r1175813851
##########
python/pyspark/sql/dataframe.py:
##########
@@ -3008,6 +3008,25 @@ def __getattr__(self, name: str) -> Column:
jc = self._jdf.apply(name)
return Column(jc)
+ def __dir__(self):
+ """
+ Examples
+ --------
Review Comment:
added
--
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 #40907: [SPARK-43270][PYTHON] Implement `__dir__()` in `pyspark.sql.dataframe.DataFrame` to include columns
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #40907:
URL: https://github.com/apache/spark/pull/40907#issuecomment-1530768477
Made a followup to implement this in Spark Connect: https://github.com/apache/spark/pull/41009
--
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 #40907: [SPARK-43270][PYTHON] Implement `__dir__()` in `pyspark.sql.dataframe.DataFrame` to include columns
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #40907:
URL: https://github.com/apache/spark/pull/40907#issuecomment-1523824585
Looks fine to me.
--
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] BeishaoCao-db commented on pull request #40907: [PYTHON] Implement `__dir__()` in `pyspark.sql.dataframe.DataFrame` to include columns
Posted by "BeishaoCao-db (via GitHub)" <gi...@apache.org>.
BeishaoCao-db commented on PR #40907:
URL: https://github.com/apache/spark/pull/40907#issuecomment-1519269891
> Mind filing a JIRA please?
Thanks for the reply! I add a JIRA ticket for this case. If any ambiguous, please let me know.
--
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 #40907: [SPARK-43270][PYTHON] Implement `__dir__()` in `pyspark.sql.dataframe.DataFrame` to include columns
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #40907:
URL: https://github.com/apache/spark/pull/40907#issuecomment-1526169832
cc @viirya @ueshin @holdenk
--
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 a diff in pull request #40907: [SPARK-43270][PYTHON] Implement `__dir__()` in `pyspark.sql.dataframe.DataFrame` to include columns
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on code in PR #40907:
URL: https://github.com/apache/spark/pull/40907#discussion_r1179653102
##########
python/pyspark/sql/dataframe.py:
##########
@@ -3008,6 +3008,34 @@ def __getattr__(self, name: str) -> Column:
jc = self._jdf.apply(name)
return Column(jc)
+ def __dir__(self) -> List[str]:
+ """
+ Examples
+ --------
+ >>> from pyspark.sql.functions import lit
+
+ Create a dataframe with a column named 'id'.
+
+ >>> df = spark.range(3)
+ >>> [attr for attr in dir(df) if attr[0] == 'i'][:7] # Includes column id
+ ['id', 'inputFiles', 'intersect', 'intersectAll', 'isEmpty', 'isLocal', 'isStreaming']
+
+ Add a column named 'i_like_pancakes'.
+
+ >>> df = df.withColumn('i_like_pancakes', lit(1))
+ >>> [attr for attr in dir(df) if attr[0] == 'i'][:7] # Includes columns i_like_pancakes, id
+ ['i_like_pancakes', 'id', 'inputFiles', 'intersect', 'intersectAll', 'isEmpty', 'isLocal']
+
+ Try to add an existed column 'inputFiles'.
+
+ >>> df = df.withColumn('inputFiles', lit(2))
+ >>> [attr for attr in dir(df) if attr[0] == 'i'][:7] # Doesn't duplicate inputFiles
+ ['i_like_pancakes', 'id', 'inputFiles', 'intersect', 'intersectAll', 'isEmpty', 'isLocal']
+ """
+ attrs = list(super().__dir__())
+ attrs.extend(attr for attr in self.columns if attr not in attrs)
Review Comment:
I wanted to make sure that we share the same logic when we get the attributes. e.g., this would matter in the maintenance and it's future proof - we won't have to deduplicately fix both places. But this is pretty simple logic so I am fine as is.
--
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