You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by GitBox <gi...@apache.org> on 2022/03/15 15:56:10 UTC

[GitHub] [spark] heyihong opened a new pull request #35861: [SPARK-38556][PYTHON] Disable Pandas usage logging for calls inside @contextmanager functions

heyihong opened a new pull request #35861:
URL: https://github.com/apache/spark/pull/35861


   <!--
   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.
   -->
   
   
   ### 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.
   -->
   
   
   ### 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.
   -->
   - Existing 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 pull request #35861: [SPARK-38556][PYTHON] Disable Pandas usage logging for method calls inside @contextmanager functions

Posted by GitBox <gi...@apache.org>.
ueshin commented on pull request #35861:
URL: https://github.com/apache/spark/pull/35861#issuecomment-1068522635


   cc @HyukjinKwon @itholic @xinrong-databricks Could you take another look? 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] ueshin commented on a change in pull request #35861: [SPARK-38556][PYTHON] Disable Pandas usage logging for method calls inside @contextmanager functions

Posted by GitBox <gi...@apache.org>.
ueshin commented on a change in pull request #35861:
URL: https://github.com/apache/spark/pull/35861#discussion_r827460697



##########
File path: python/pyspark/instrumentation_utils.py
##########
@@ -30,6 +31,24 @@
 _local = threading.local()
 
 
+class _WrappedAbstractContextManager(AbstractContextManager):
+    def __init__(
+        self, gcm: AbstractContextManager, class_name: str, function_name: str, logger: Any

Review comment:
       nit: maybe `acm` instead of `gcm`?




-- 
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 #35861: [SPARK-38556][PYTHON] Disable Pandas usage logging for method calls inside @contextmanager functions

Posted by GitBox <gi...@apache.org>.
ueshin commented on pull request #35861:
URL: https://github.com/apache/spark/pull/35861#issuecomment-1068276249


   @heyihong Could you fix the conflicts? 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] heyihong commented on pull request #35861: [SPARK-38556][PYTHON] Disable Pandas usage logging for method calls inside @contextmanager functions

Posted by GitBox <gi...@apache.org>.
heyihong commented on pull request #35861:
URL: https://github.com/apache/spark/pull/35861#issuecomment-1068295690


   > @heyihong Could you fix the conflicts? Thanks.
   
   Done


-- 
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 edited a comment on pull request #35861: [SPARK-38556][PYTHON] Disable Pandas usage logging for method calls inside @contextmanager functions

Posted by GitBox <gi...@apache.org>.
HyukjinKwon edited a comment on pull request #35861:
URL: https://github.com/apache/spark/pull/35861#issuecomment-1069796744


   Merged to master and branch-3.3.


-- 
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 #35861: [SPARK-38556][PYTHON] Disable Pandas usage logging for method calls inside @contextmanager functions

Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on pull request #35861:
URL: https://github.com/apache/spark/pull/35861#issuecomment-1069796744


   Merged to master, branch-3.3 and branch-3.2.


-- 
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 #35861: [SPARK-38556][PYTHON] Disable Pandas usage logging for method calls inside @contextmanager functions

Posted by GitBox <gi...@apache.org>.
HyukjinKwon closed pull request #35861:
URL: https://github.com/apache/spark/pull/35861


   


-- 
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 change in pull request #35861: [SPARK-38556][PYTHON] Disable Pandas usage logging for method calls inside @contextmanager functions

Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on a change in pull request #35861:
URL: https://github.com/apache/spark/pull/35861#discussion_r830716928



##########
File path: python/pyspark/instrumentation_utils.py
##########
@@ -44,6 +63,17 @@ def wrapper(*args: Any, **kwargs: Any) -> Any:
             start = time.perf_counter()
             try:
                 res = func(*args, **kwargs)
+                if isinstance(res, AbstractContextManager):
+                    # Wrap AbstractContextManager's subclasses returned by @contextmanager decorator
+                    # function so that wrapped function calls inside __enter__ and __exit__
+                    # are not recorded by usage logger.
+                    #
+                    # The reason to add a wrapped class after function calls instead of
+                    # wrapping __enter__ and __exit__ methods of _GeneratorContextManager class is
+                    # because usage logging should be disabled for functions with @contextmanager
+                    # decorator in PySpark only.
+                    res = _WrappedAbstractContextManager(res, class_name, function_name, logger)

Review comment:
       Oops, sorry I missed this. This breaks few things: `pyspark.pandas.frame.CachedDataFrame` with `__enter__` and `__exit__` (and potentially `pyspark.SparkContext` and `pyspark.sql.SparkSession`). Note that `isinstance(obj, AbstractContextManager)` works for the classes that do not inherit `AbstractContextManager` (see also https://docs.python.org/3/glossary.html#term-abstract-base-class).
   
   For example, if a notebook has a feature to automatically represent these instances above:
   
   ```bash
   KOALAS_USAGE_LOGGER=pyspark.pandas.usage_logger ./bin/pyspark
   ```
   
   This does not work anymore because:
   
   ```python
   >>> import pyspark.pandas as ps
   >>> type(ps.range(1).spark.cache())
   <class 'pyspark.instrumentation_utils._WrappedAbstractContextManager'>
   ```
   
   and ,`_WrappedAbstractContextManager` is not the instance of `DataFrame` which `CachedDataFrame` inherits.
   
   We would probably have to monkey-patch each method of `__enter__` and `__exit__`. Since the release is getting close, I will revert this one first to be more conservative.




-- 
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 change in pull request #35861: [SPARK-38556][PYTHON] Disable Pandas usage logging for method calls inside @contextmanager functions

Posted by GitBox <gi...@apache.org>.
itholic commented on a change in pull request #35861:
URL: https://github.com/apache/spark/pull/35861#discussion_r827539466



##########
File path: python/pyspark/instrumentation_utils.py
##########
@@ -44,6 +63,17 @@ def wrapper(*args: Any, **kwargs: Any) -> Any:
             start = time.perf_counter()
             try:
                 res = func(*args, **kwargs)
+                if isinstance(res, AbstractContextManager):
+                    # Wrap AbstractContextManager's subclasses returned by @contexmanager decorator

Review comment:
       nit: @contexmanager -> @contextmanager
   maybe typo ?




-- 
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