Skip to content

Conversation

@liferoad
Copy link
Contributor

@liferoad liferoad commented Nov 3, 2025

Fixes #32858

Handle Python 3.12's new type alias statements by unwrapping TypeAliasType to its underlying value in type conversion and pickling. This ensures compatibility with Beam's type checking and serialization for Python 3.12+.

Tested with Python 3.12:

pytest -v apache_beam/transforms/ptransform_test.py::PTransformTypeAliasTest::test_type_alias_statement_supported_in_with_output_types apache_beam/transforms/ptransform_test.py::PTransformTypeAliasTest::test_type_alias_supported_in_ptransform_with_output_types

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.

Handle Python 3.12's new type alias statements by unwrapping TypeAliasType to its underlying value in type conversion and pickling. This ensures compatibility with Beam's type checking and serialization for Python 3.12+.
@github-actions github-actions bot added the python label Nov 3, 2025
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @liferoad, 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 introduces essential compatibility for Python 3.12's new type alias statements, represented by TypeAliasType. By ensuring that both Apache Beam's internal type conversion and its cloudpickle serialization correctly unwrap these new type aliases to their underlying values, the change guarantees seamless functionality and prevents potential type-related errors for users adopting Python 3.12. This update is crucial for maintaining robust type checking and serialization across different Python versions.

Highlights

  • Python 3.12 TypeAliasType Support: Introduced compatibility for Python 3.12's new type alias statements (TypeAliasType) within Apache Beam's type conversion and pickling mechanisms. This ensures that type aliases defined using the new type syntax are correctly recognized and processed.
  • Cloudpickle Integration: Modified cloudpickle to correctly handle TypeAliasType instances by unwrapping them to their underlying value during serialization, preventing issues when pickling objects that use these new type aliases.
  • Beam Type Hint Compatibility: Updated Beam's native type compatibility layer to recognize and unwrap TypeAliasType objects, ensuring that Beam's type checking and processing logic correctly interprets the actual types behind these aliases.
  • New Test Cases: Added new unit tests specifically for Python 3.12 to verify that type alias statements are properly supported when used with with_output_types and in type hints for beam.Map transforms.
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.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 3, 2025

Assigning reviewers:

R: @shunping 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).

@liferoad liferoad requested a review from claudevdm November 4, 2025 00:09
sys.version_info.minor >= 10) and (isinstance(typ, types.UnionType)):
typ = typing.Union[typ]

# Unwrap Python 3.12 `type` aliases (TypeAliasType) to their underlying value.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd like one or two unit test cases for this just to cover us. Nothing fancy, just alias a simple built-in type and make sure that the type gets converted as expected

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sounds good. Added one unit test test_type_alias_type_unwrapped in sdks/python/apache_beam/typehints/native_type_compatibility_test.py

@liferoad liferoad requested a review from jrmccluskey November 5, 2025 18:02
Copy link
Contributor

@jrmccluskey jrmccluskey left a comment

Choose a reason for hiding this comment

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

LGTM

@liferoad liferoad merged commit ff1d6bb into apache:master Nov 5, 2025
102 of 103 checks passed
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.

[Bug]: Python type statement unsupported

3 participants