Skip to content

Support infer types involving dataclass fields#38548

Open
Abacn wants to merge 1 commit into
apache:masterfrom
Abacn:support-dataclass-infer
Open

Support infer types involving dataclass fields#38548
Abacn wants to merge 1 commit into
apache:masterfrom
Abacn:support-dataclass-infer

Conversation

@Abacn
Copy link
Copy Markdown
Contributor

@Abacn Abacn commented May 19, 2026

After #22085, dataclass is a supported type for Beam Row. However the original stackoverflow example in #20738 still missing one part from working that is dataclass's typehints do not survive lambda. We get all fields as "any".

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
Copy Markdown
Contributor

Summary of Changes

Hello, 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 Apache Beam's type inference system to correctly handle fields within Python dataclasses, particularly when they are accessed within lambda functions. This addresses a limitation where dataclass type hints were not preserved during type inference, leading to fields being typed as Any. The changes ensure that Beam can accurately infer the types of dataclass fields, improving type safety and consistency for Beam Row operations.

Highlights

  • Dataclass Field Type Inference: Implemented logic within the type inference opcode handler to correctly determine the type of a dataclass field when accessed, addressing a previous limitation where type hints were lost.
  • Expanded Dataclass Support: Ensured that dataclass type hints are preserved and correctly inferred when dataclasses are used in beam.Map transformations, improving type safety for Beam Row operations.
  • New Test Cases: Added comprehensive unit tests to validate the accurate inference of dataclass field types in various scenarios, including within beam.Map and when accessed via lambdas.
New Features

🧠 You can now enable Memory (public preview) 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.

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 the 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 counterproductive. 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.

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.

Copy link
Copy Markdown
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 enhances the Apache Beam type inference system by adding support for Python dataclasses. The changes include updating the _getattr opcode handler to resolve field types from dataclass definitions and adding unit tests to verify type inference for dataclass fields and row mappings. A review comment identifies an improvement opportunity in opcodes.py to remove an unnecessarily restrictive class check, allowing the inference engine to correctly handle both dataclass classes and instances.

return Const(BoundMethod(func, o))
elif isinstance(o, row_type.RowTypeConstraint):
return o.get_type_for(name)
elif inspect.isclass(o) and dataclasses.is_dataclass(o):
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The inspect.isclass(o) check is unnecessarily restrictive. dataclasses.is_dataclass(o) returns True for both dataclass classes and instances. Removing the class check allows the type inference engine to correctly resolve fields when it encounters a dataclass instance (for example, when an instance is wrapped in a Const object during the inference process).

Suggested change
elif inspect.isclass(o) and dataclasses.is_dataclass(o):
elif dataclasses.is_dataclass(o):

@github-actions
Copy link
Copy Markdown
Contributor

Assigning reviewers:

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

@Abacn
Copy link
Copy Markdown
Contributor Author

Abacn commented May 20, 2026

R: @jrmccluskey (Python typehinting)

@github-actions
Copy link
Copy Markdown
Contributor

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

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.

1 participant