Skip to content

Handle some cases during infer schema from dataclass#37855

Open
Abacn wants to merge 1 commit intoapache:masterfrom
Abacn:fix-dataclass-cases
Open

Handle some cases during infer schema from dataclass#37855
Abacn wants to merge 1 commit intoapache:masterfrom
Abacn:fix-dataclass-cases

Conversation

@Abacn
Copy link
Contributor

@Abacn Abacn commented Mar 13, 2026

After #37728 added support for inferring schema from dataclasses

If dataclass is inherited, the subclass assumes Beam Schema ID from base class, which isn't correct. Also, the change exposed another issue (previously could also happen for named tuple) for user types defined __iter__ but does not have a typehint for element type.

This change

  • Make sure Beam schema ID does not inherit

  • Fix IndexOutofBoundError trying to infer type from custom Iterable without type hint

internal tracker b/492300593

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, 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 robustness and correctness of schema inference within Apache Beam's type hinting system. It specifically refines how schemas are generated for dataclasses by preventing unintended inheritance of schema IDs from base classes, thereby ensuring type-specific schema generation. Additionally, it introduces a defensive check during type inference for generic collections like Iterable and Sequence to prevent errors when type arguments are missing, improving the stability of the schema generation process.

Highlights

  • Beam Schema ID Inheritance: Implemented logic to prevent _BEAM_SCHEMA_ID from inheriting from base classes when inferring schemas for derived dataclasses, ensuring each type has a unique and correct schema identifier.
  • IndexOutOfBoundsError Fix: Addressed a potential IndexOutOfBoundsError when inferring types from custom Iterable or Sequence types that might not have explicit type hints, by safely checking for the presence of type arguments.

🧠 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/row_type.py
    • Modified RowTypeConstraint initialization to unset _schema_id if it was inherited from a base class, ensuring it's only set if explicitly defined on the current type.
  • sdks/python/apache_beam/typehints/row_type_test.py
    • Added a new test case test_derived_dataclass_schema_id to verify that _BEAM_SCHEMA_ID is not inherited by derived dataclasses.
    • Imported the schemas module for use in the new test.
  • sdks/python/apache_beam/typehints/schemas.py
    • Updated typing_to_runner_api to check the length of _get_args(type_) before accessing its elements for Sequence and Iterable types, preventing IndexOutOfBoundsError.
    • Changed the condition for checking _BEAM_SCHEMA_ID in schema_from_element_type from hasattr to _BEAM_SCHEMA_ID in element_type.__dict__ to explicitly prevent inheritance from base classes.
Activity
  • Abacn created this pull request to address issues with schema inference from dataclasses.
  • The pull request description outlines two main objectives: preventing Beam schema ID inheritance and fixing an IndexOutOfBoundsError.
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.

@Abacn Abacn force-pushed the fix-dataclass-cases branch from 701c97d to 0129b49 Compare March 13, 2026 21:31
@github-actions
Copy link
Contributor

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

* Make sure Beam schema ID does not inherit

* Fix IndexOutofBoundError trying to infer type from custom Iterable
  without type hint
@Abacn Abacn force-pushed the fix-dataclass-cases branch from 0129b49 to dc89818 Compare March 13, 2026 22:30
@github-actions
Copy link
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).

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