Skip to content

Allow tagged types in with_exception_handling.#37590

Draft
claudevdm wants to merge 2 commits intoapache:masterfrom
claudevdm:ex-handle-typehints
Draft

Allow tagged types in with_exception_handling.#37590
claudevdm wants to merge 2 commits intoapache:masterfrom
claudevdm:ex-handle-typehints

Conversation

@claudevdm
Copy link
Collaborator

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.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit 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
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @claudevdm, I'm Gemini Code Assist1! 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 addresses a limitation in Apache Beam's exception handling mechanism where type hints for tagged outputs were not correctly propagated. The changes ensure that when with_exception_handling is applied to a ParDo that produces tagged outputs, the resulting PCollections retain their inferred or explicitly provided type information. This improves the robustness and type safety of pipelines that combine these features, while also providing backward compatibility for older deployments.

Highlights

  • Enhanced Type Hint Propagation: The with_exception_handling transform now correctly propagates type hints for both main and tagged outputs, ensuring that PCollection types are preserved when using with_outputs in conjunction with exception handling.
  • Refactored Exception Handling Logic: The internal _ExceptionHandlingWrapper has been refactored to explicitly manage and apply type hints to its outputs, utilizing with_output_types for better type inference.
  • Backward Compatibility: A compatibility check has been introduced to maintain the previous behavior for pipelines running on Beam versions prior to 2.72.0, preventing breaking changes for existing users.
  • New Test Cases: Comprehensive unit tests have been added to validate the correct interaction between with_exception_handling and with_outputs in various configurations, including custom dead letter tags and different chaining orders.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • sdks/python/apache_beam/transforms/core.py
    • Modified ParDo.with_exception_handling to pass type hints to the exception handling wrapper.
    • Added a new with_exception_handling method to _NamedPTransform to correctly manage and propagate output tags.
    • Updated _ExceptionHandlingWrapper.__init__ to accept pardo_type_hints and store _extra_tags.
    • Introduced with_outputs method in _ExceptionHandlingWrapper to handle output tag configuration.
    • Refactored the _ExceptionHandlingWrapper.expand method into _build_pardo and _post_process_result for clarity and modularity.
    • Implemented logic within _ExceptionHandlingWrapper.expand to apply type hints to main and tagged outputs using with_output_types.
    • Added a version compatibility check (is_compat_version_prior_to("2.72.0")) to preserve the old expand behavior for older pipelines.
  • sdks/python/apache_beam/transforms/core_test.py
    • Added new imports for Iterable, Literal, and PipelineOptions.
    • Introduced ExceptionHandlingWithOutputsTest class to test the integration of with_exception_handling and with_outputs.
    • Included test cases for chaining with_exception_handling before and after with_outputs.
    • Added tests to verify correct type hint propagation for main, tagged, and dead letter outputs.
    • Created tests for custom dead letter tags and their impact on type inference.
    • Implemented tests to confirm backward compatibility for pipelines running on Beam versions prior to 2.72.0.
    • Added test cases for Map transforms and ParDo with chained with_output_types to ensure consistent behavior.
Activity
  • No specific human activity (comments, reviews, or progress updates) has been recorded for this pull request beyond its initial creation.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

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.

Customization

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.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 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.

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.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant