Skip to content

Normalize types in dataclass field type resolving#38797

Open
Abacn wants to merge 1 commit into
apache:masterfrom
Abacn:fix-normalize
Open

Normalize types in dataclass field type resolving#38797
Abacn wants to merge 1 commit into
apache:masterfrom
Abacn:fix-normalize

Conversation

@Abacn
Copy link
Copy Markdown
Contributor

@Abacn Abacn commented Jun 3, 2026

Please add a meaningful description for your change here

internal tracker: b/518498022


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.

@github-actions github-actions Bot added the python label Jun 3, 2026
@Abacn Abacn force-pushed the fix-normalize branch 6 times, most recently from 166eb24 to 6aa5459 Compare June 4, 2026 00:01
@Abacn Abacn marked this pull request as ready for review June 4, 2026 02:10
@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 Python type inference by correctly resolving dataclass field types instead of defaulting to 'Any'. To ensure backward compatibility and mitigate potential breaking changes for existing pipelines, a new configuration flag has been added, providing users with a mechanism to opt-out of this stricter type inference.

Highlights

  • Dataclass Type Inference: Updated the type inference mechanism to honor dataclass field typehints, improving type safety and accuracy in Apache Beam pipelines.
  • Backward Compatibility: Introduced a new pipeline option, --exclude_infer_dataclass_field_type, allowing users to revert to the previous 'fallback-to-any' behavior if necessary.
  • Testing: Added comprehensive test cases to verify both the new type inference behavior and the backward compatibility flag.
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.

@Abacn
Copy link
Copy Markdown
Contributor Author

Abacn commented Jun 4, 2026

R: @chamikaramj @jrmccluskey

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 enables honoring dataclass field typehints during type inference in the Python SDK, while introducing a --exclude_infer_dataclass_field_type pipeline option for backward compatibility. The review feedback highlights a critical circular import risk in opcodes.py that should be resolved by importing resolve_dataclass_field_type locally. Additionally, the reviewer recommends replacing a print() statement with standard logging in trivial_inference.py and correcting a typo in the pipeline option's help text.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread sdks/python/apache_beam/typehints/opcodes.py
Comment thread sdks/python/apache_beam/typehints/opcodes.py
Comment on lines +796 to +798
except AttributeError:
print(options.view_as(TypeOptions)._visible_option_list())
raise
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

Avoid using print() in library code as it writes directly to standard output, which can interfere with user logs or stdout-based tooling. Use the standard logging module instead.

Suggested change
except AttributeError:
print(options.view_as(TypeOptions)._visible_option_list())
raise
except AttributeError:
import logging
logging.warning(
"Failed to retrieve exclude_infer_dataclass_field_type option. "
"Visible options: %s",
options.view_as(TypeOptions)._visible_option_list())
raise

Comment on lines +895 to +899
help='Exclude certain typehint inference involving dataclass fields '
'and resolve to Any (as in beam<=2.74.0). NOTE: this option is '
'for backward compatibility only and the exclusion senario is subject '
'to change, until removing in a future version. For details see: '
'https://beam.apache.org/releases/pydoc/current/apache_beam.typehints.trivial_inference.html#apache_beam.typehints.trivial_inference.resolve_dataclass_field_type') # pylint: disable=line-too-long
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

Fix typo: 'senario' should be 'scenario'.

Suggested change
help='Exclude certain typehint inference involving dataclass fields '
'and resolve to Any (as in beam<=2.74.0). NOTE: this option is '
'for backward compatibility only and the exclusion senario is subject '
'to change, until removing in a future version. For details see: '
'https://beam.apache.org/releases/pydoc/current/apache_beam.typehints.trivial_inference.html#apache_beam.typehints.trivial_inference.resolve_dataclass_field_type') # pylint: disable=line-too-long
help='Exclude certain typehint inference involving dataclass fields '
'and resolve to Any (as in beam<=2.74.0). NOTE: this option is '
'for backward compatibility only and the exclusion scenario is subject '
'to change, until removing in a future version. For details see: '
'https://beam.apache.org/releases/pydoc/current/apache_beam.typehints.trivial_inference.html#apache_beam.typehints.trivial_inference.resolve_dataclass_field_type') # pylint: disable=line-too-long

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 4, 2026

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

Add a pipeline option to allow fallback to Any
@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 56.67%. Comparing base (bec756f) to head (b0b27c8).
⚠️ Report is 4 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff              @@
##             master   #38797      +/-   ##
============================================
- Coverage     56.68%   56.67%   -0.01%     
  Complexity     3637     3637              
============================================
  Files          1183     1183              
  Lines        187908   187923      +15     
  Branches       3751     3751              
============================================
+ Hits         106509   106511       +2     
- Misses        77933    77946      +13     
  Partials       3466     3466              
Flag Coverage Δ
python 79.37% <100.00%> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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