You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "kasztp (via GitHub)" <gi...@apache.org> on 2023/09/30 15:38:19 UTC

[GitHub] [spark] kasztp opened a new pull request, #43190: [MINOR][DOCS] Fix Python code sample for StreamingQueryListener: Reporting Metrics programmatically using Asynchronous APIs

kasztp opened a new pull request, #43190:
URL: https://github.com/apache/spark/pull/43190

   Fix python language code sample for StreamingQueryListener:
   Reporting Metrics programmatically using Asynchronous APIs
   
   ### What changes were proposed in this pull request?
   The code sample in the [Reporting Metrics programmatically using Asynchronous APIs](https://spark.apache.org/docs/latest/structured-streaming-programming-guide.html#reporting-metrics-programmatically-using-asynchronous-apis) section was this:
   ```
   spark = ...
   
   class Listener(StreamingQueryListener):
       def onQueryStarted(self, event):
           print("Query started: " + queryStarted.id)
   
       def onQueryProgress(self, event):
           println("Query terminated: " + queryTerminated.id)
   
       def onQueryTerminated(self, event):
           println("Query made progress: " + queryProgress.progress)
   
   
   spark.streams.addListener(Listener())
   ```
   
   Which is not a proper Python code, and has Queryprogress and QueryTerminated prints mixed. Proposed change/fix:
   ```
   spark = ...
   
   class Listener(StreamingQueryListener):
       def onQueryStarted(self, event):
           print("Query started: " + queryStarted.id)
   
       def onQueryProgress(self, event):
           print("Query made progress: " + queryProgress.progress)
   
       def onQueryTerminated(self, event):
           print("Query terminated: " + queryTerminated.id)
   
   
   spark.streams.addListener(Listener())
   ```
   
   ### Why are the changes needed?
   To fix docimentation errors.
   
   
   ### Does this PR introduce _any_ user-facing change?
   Yes. -> Sample python code snippet is fixed in docs (see above).
   
   
   ### How was this patch tested?
   Checked with github's .md preview, and built the docs according to the readme.
   
   
   ### Was this patch authored or co-authored using generative AI tooling?
   No.
   


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


Re: [PR] [MINOR][DOCS] Fix Python code sample for StreamingQueryListener: Reporting Metrics programmatically using Asynchronous APIs [spark]

Posted by "srowen (via GitHub)" <gi...@apache.org>.
srowen closed pull request #43190: [MINOR][DOCS] Fix Python code sample for StreamingQueryListener: Reporting Metrics programmatically using Asynchronous APIs
URL: https://github.com/apache/spark/pull/43190


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


Re: [PR] [MINOR][DOCS] Fix Python code sample for StreamingQueryListener: Reporting Metrics programmatically using Asynchronous APIs [spark]

Posted by "kasztp (via GitHub)" <gi...@apache.org>.
kasztp closed pull request #43190: [MINOR][DOCS] Fix Python code sample for StreamingQueryListener: Reporting Metrics programmatically using Asynchronous APIs
URL: https://github.com/apache/spark/pull/43190


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


Re: [PR] [MINOR][DOCS] Fix Python code sample for StreamingQueryListener: Reporting Metrics programmatically using Asynchronous APIs [spark]

Posted by "kasztp (via GitHub)" <gi...@apache.org>.
kasztp commented on PR #43190:
URL: https://github.com/apache/spark/pull/43190#issuecomment-1742603564

   > Just retrigger tests for completeness
   
   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] srowen commented on pull request #43190: [MINOR][DOCS] Fix Python code sample for StreamingQueryListener: Reporting Metrics programmatically using Asynchronous APIs

Posted by "srowen (via GitHub)" <gi...@apache.org>.
srowen commented on PR #43190:
URL: https://github.com/apache/spark/pull/43190#issuecomment-1742141214

   Just retrigger tests for completeness


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


Re: [PR] [MINOR][DOCS] Fix Python code sample for StreamingQueryListener: Reporting Metrics programmatically using Asynchronous APIs [spark]

Posted by "srowen (via GitHub)" <gi...@apache.org>.
srowen commented on PR #43190:
URL: https://github.com/apache/spark/pull/43190#issuecomment-1742955790

   Merged to master/3.5


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