Skip to content

TaggedOutput function annotations update compat.#37593

Closed
claudevdm wants to merge 2 commits intoapache:masterfrom
claudevdm:tagged-typehints-updatecompat
Closed

TaggedOutput function annotations update compat.#37593
claudevdm wants to merge 2 commits intoapache:masterfrom
claudevdm:tagged-typehints-updatecompat

Conversation

@claudevdm
Copy link
Collaborator

  • For annotations like -> int | TaggedOutput map main: int and TaggedOutput[*]: Any
  • Add update compat flag so annotation behavior is update compatible

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 enhances the handling of TaggedOutput type annotations within Apache Beam's type hinting system. The primary goal is to introduce update compatibility, ensuring that existing pipelines using TaggedOutput annotations continue to function as expected when upgrading to newer Beam versions. This is achieved by conditionally applying new type extraction logic based on the pipeline's compatibility version, preventing breaking changes while allowing for more precise type inference in modern contexts.

Highlights

  • Update Compatibility for TaggedOutput Annotations: Introduced logic to ensure that TaggedOutput type annotations behave consistently across different Apache Beam compatibility versions, specifically for versions prior to 2.72.0.
  • Refined TaggedOutput Extraction: Modified the extract_tagged_outputs method to correctly handle cases where TaggedOutput is used in a union type (e.g., int | TaggedOutput) without explicit tags, while also respecting existing explicit tag definitions.
  • New Test Coverage: Added a parameterized test case to validate the update compatibility behavior of TaggedOutput annotations in DoFn process methods, confirming the expected type inference for both older and newer compatibility settings.

🧠 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/typehints/decorators.py
    • Imported get_pipeline_options to enable compatibility version checks.
    • Added a compatibility check within extract_tagged_outputs to preserve old behavior for versions prior to 2.72.0.
    • Modified the extract_tagged_outputs logic to correctly identify and handle bare TaggedOutput types in unions and to avoid re-extracting tags that are already explicitly defined.
  • sdks/python/apache_beam/typehints/tagged_output_typehints_test.py
    • Added imports for param, parameterized, PipelineOptions, and Any to support new test cases.
    • Implemented a new parameterized test test_pardo_annotation_process_method_update_compatible to verify TaggedOutput annotation behavior under different update compatibility settings.
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.

@claudevdm
Copy link
Collaborator Author

/gemini review

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a compatibility flag to handle TaggedOutput in function annotations, ensuring backward compatibility for pipeline updates. The changes correctly check for a compatibility version and adjust behavior accordingly. A new test case validates this for both old and new versions. The core logic is sound, and I have one minor suggestion to improve a comment for better maintainability.

@claudevdm claudevdm marked this pull request as ready for review February 13, 2026 18:17
@github-actions
Copy link
Contributor

Assigning reviewers:

R: @tvalentyn for label python.

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

  • stop reviewer notifications - opt out of the automated review tooling
  • remind me after tests pass - tag the comment author after tests pass
  • waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

@claudevdm
Copy link
Collaborator Author

Actually this is more of a breaking change than I thought. If user typehints are not accurate, this will break pipelines. I will abandon for now.

@claudevdm claudevdm closed this Feb 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants