You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by "Abacn (via GitHub)" <gi...@apache.org> on 2025/12/12 21:57:02 UTC

[PR] Pass options in DaskOptions inheritance hierarchy only for Dask runner [beam]

Abacn opened a new pull request, #37101:
URL: https://github.com/apache/beam/pull/37101

   Fix  #30528
   
   There is a pre-exisitng bug such that Dask runner passing all (non-default) pipeline options to dask client. Whenever there is a pipeline option added that is not part of DaskOptions, pipeline run will crash.
   
   #36271 made `save_main_session` gets resolved before pipeline submission time and introduced a "non-default" option. It has to be resolved early (unlike other worker options can leave to None and get resolved on worker side) because it is needed as early as staging a pipeline.
   
   **Please** add a meaningful description for your change here
   
   ------------------------
   
   Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
   
    - [ ] Mention the appropriate issue in your description (for example: `addresses #123`), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment `fixes #<ISSUE NUMBER>` instead.
    - [ ] Update `CHANGES.md` with noteworthy changes.
    - [ ] If this contribution is large, please file an Apache [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
   
   See the [Contributor Guide](https://beam.apache.org/contribute) for more tips on [how to make review process smoother](https://github.com/apache/beam/blob/master/CONTRIBUTING.md#make-the-reviewers-job-easier).
   
   To check the build health, please visit [https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md](https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md)
   
   GitHub Actions Tests Status (on master branch)
   ------------------------------------------------------------------------------------------------
   [![Build python source distribution and wheels](https://github.com/apache/beam/actions/workflows/build_wheels.yml/badge.svg?event=schedule&&?branch=master)](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
   [![Python tests](https://github.com/apache/beam/actions/workflows/python_tests.yml/badge.svg?event=schedule&&?branch=master)](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
   [![Java tests](https://github.com/apache/beam/actions/workflows/java_tests.yml/badge.svg?event=schedule&&?branch=master)](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
   [![Go tests](https://github.com/apache/beam/actions/workflows/go_tests.yml/badge.svg?event=schedule&&?branch=master)](https://github.com/apache/beam/actions?query=workflow%3A%22Go+tests%22+branch%3Amaster+event%3Aschedule)
   
   See [CI.md](https://github.com/apache/beam/blob/master/CI.md) for more information about GitHub Actions CI or the [workflows README](https://github.com/apache/beam/blob/master/.github/workflows/README.md) to see a list of phrases to trigger workflows.
   


-- 
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: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Pass options in DaskOptions inheritance hierarchy only for Dask runner [beam]

Posted by "Abacn (via GitHub)" <gi...@apache.org>.
Abacn commented on code in PR #37101:
URL: https://github.com/apache/beam/pull/37101#discussion_r2616059153


##########
sdks/python/apache_beam/options/pipeline_options.py:
##########
@@ -500,6 +501,9 @@ def get_all_options(
       retain_unknown_options: If set to true, options not recognized by any
         known pipeline options class will still be included in the result. If
         set to false, they will be discarded.
+      hierarchy_only: If set to true, only returns options defined in this class
+        and its super classes only. Otherwise, arguments that are defined in

Review Comment:
   Yeah for current one (DaskOptions) it is sufficient. Simplified.



-- 
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: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Pass options in DaskOptions inheritance hierarchy only for Dask runner [beam]

Posted by "gemini-code-assist[bot] (via GitHub)" <gi...@apache.org>.
gemini-code-assist[bot] commented on PR #37101:
URL: https://github.com/apache/beam/pull/37101#issuecomment-3648275051

   ## Summary of Changes
   
   Hello @Abacn, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
   
   This pull request resolves a critical issue in the Dask runner where it would incorrectly attempt to process all available pipeline options, leading to runtime errors when encountering options not recognized by the Dask client. The solution involves enhancing the `PipelineOptions` mechanism to allow for hierarchical filtering of options, ensuring that the Dask runner only receives and processes options directly relevant to its configuration. This change significantly improves the robustness and compatibility of the Dask runner with diverse pipeline configurations.
   
   ### Highlights
   
   * **Bug Fix**: Addresses a bug where the Dask runner would crash if non-Dask-specific pipeline options were passed to the Dask client, as it was attempting to process all options.
   * **New `hierarchy_only` Parameter**: Introduced a new `hierarchy_only` boolean parameter to the `get_all_options` method in `PipelineOptions`. When `True`, this parameter restricts the returned options to only those defined within the current class and its superclasses, rather than all known `PipelineOptions` subclasses.
   * **Dask Runner Integration**: The Dask runner now utilizes the `hierarchy_only=True` parameter when calling `get_all_options` for `DaskOptions`. This ensures that only relevant Dask-specific options are passed to the Dask client, preventing crashes caused by unrecognized options.
   * **Improved Option Filtering**: Updated the logic for discarding unparseable or invalid options to respect the `hierarchy_only` flag, providing more precise control over option processing.
   * **New Test Cases**: Added new test cases to `pipeline_options_test.py` to validate the functionality of the `hierarchy_only` parameter, specifically demonstrating how options are filtered based on the inheritance hierarchy.
   
   
   
   
   
   
   
   <details>
   <summary><b>Using Gemini Code Assist</b></summary>
   <br>
   
   The full guide for Gemini Code Assist can be found on our [documentation page](https://developers.google.com/gemini-code-assist/docs/review-github-code), here are some quick tips.
   
   <b>Invoking Gemini</b>
   
   You can request assistance from Gemini at any point by creating a comment using either `/gemini <command>` or `@gemini-code-assist <command>`. Below is a summary of the supported commands on the current page.
   
   Feature | Command | Description
   --- | --- | ---
   Code Review | `/gemini review` | Performs a code review for the current pull request in its current state.
   Pull Request Summary | `/gemini summary` | Provides a summary of the current pull request in its current state.
   Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments.
   Help | `/gemini help` | Displays a list of available commands.
   
   <b>Customization</b>
   
   To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a `.gemini/` folder in the base of the repository. Detailed instructions can be found [here](https://developers.google.com/gemini-code-assist/docs/customize-gemini-behavior-github).
   
   <b>Limitations & Feedback</b>
   
   Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up [here](https://google.qualtrics.com/jfe/form/SV_2cyuGuTWsEw84yG).
   
   <b>You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the [Gemini Code Assist IDE Extension](https://cloud.google.com/products/gemini/code-assist).</b>
   </details>
   
   
   
   
   [^1]: Review the [Privacy Notices](https://policies.google.com/privacy), [Generative AI Prohibited Use Policy](https://policies.google.com/terms/generative-ai/use-policy), [Terms of Service](https://policies.google.com/terms), and learn how to configure Gemini Code Assist in GitHub [here](https://developers.google.com/gemini-code-assist/docs/customize-gemini-behavior-github). Gemini can make mistakes, so double check it and [use code with caution](https://support.google.com/legal/answer/13505487).
   


-- 
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: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Pass options in DaskOptions inheritance hierarchy only for Dask runner [beam]

Posted by "Abacn (via GitHub)" <gi...@apache.org>.
Abacn commented on PR #37101:
URL: https://github.com/apache/beam/pull/37101#issuecomment-3648324651

   R: @tvalentyn @Amar3tto 


-- 
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: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Pass options in DaskOptions inheritance hierarchy only for Dask runner [beam]

Posted by "Abacn (via GitHub)" <gi...@apache.org>.
Abacn merged PR #37101:
URL: https://github.com/apache/beam/pull/37101


-- 
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: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Pass options in DaskOptions inheritance hierarchy only for Dask runner [beam]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #37101:
URL: https://github.com/apache/beam/pull/37101#issuecomment-3648327258

   Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment `assign set of reviewers`


-- 
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: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Pass options in DaskOptions inheritance hierarchy only for Dask runner [beam]

Posted by "Abacn (via GitHub)" <gi...@apache.org>.
Abacn commented on code in PR #37101:
URL: https://github.com/apache/beam/pull/37101#discussion_r2616058299


##########
sdks/python/apache_beam/options/pipeline_options.py:
##########
@@ -510,8 +514,13 @@ def get_all_options(
     # instance of each subclass to avoid conflicts.
     subset = {}
     parser = _BeamArgumentParser(allow_abbrev=False)
-    for cls in PipelineOptions.__subclasses__():
-      subset.setdefault(str(cls), cls)
+    if not hierarchy_only:

Review Comment:
   changed



-- 
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: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Pass options in DaskOptions inheritance hierarchy only for Dask runner [beam]

Posted by "tvalentyn (via GitHub)" <gi...@apache.org>.
tvalentyn commented on code in PR #37101:
URL: https://github.com/apache/beam/pull/37101#discussion_r2615944434


##########
sdks/python/apache_beam/options/pipeline_options.py:
##########
@@ -510,8 +514,13 @@ def get_all_options(
     # instance of each subclass to avoid conflicts.
     subset = {}
     parser = _BeamArgumentParser(allow_abbrev=False)
-    for cls in PipelineOptions.__subclasses__():
-      subset.setdefault(str(cls), cls)
+    if not hierarchy_only:

Review Comment:
   i think it would read easier if we reverse the order of conditions (`if hierarchy_only: ...`)



##########
sdks/python/apache_beam/options/pipeline_options.py:
##########
@@ -500,6 +501,9 @@ def get_all_options(
       retain_unknown_options: If set to true, options not recognized by any
         known pipeline options class will still be included in the result. If
         set to false, they will be discarded.
+      hierarchy_only: If set to true, only returns options defined in this class
+        and its super classes only. Otherwise, arguments that are defined in

Review Comment:
   Do we have use-cases for is returning options from superclasses? would it be sufficient to return only options defined in the current class?



-- 
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: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org