Skip to content

Support inferring schemas from Python dataclasses#37728

Draft
Abacn wants to merge 1 commit intoapache:masterfrom
Abacn:dataclass-schema
Draft

Support inferring schemas from Python dataclasses#37728
Abacn wants to merge 1 commit intoapache:masterfrom
Abacn:dataclass-schema

Conversation

@Abacn
Copy link
Contributor

@Abacn Abacn commented Feb 28, 2026

Fix #22085

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 Apache Beam's type hinting capabilities by introducing comprehensive support for Python dataclasses. It enables the system to recognize, convert, and infer schemas from dataclasses, integrating them seamlessly into Beam's data processing model, similar to how NamedTuples are handled.

Highlights

  • Dataclass Recognition: A new utility function, match_is_dataclass, was added to accurately identify Python dataclass types within the type hinting system.
  • Type Conversion Integration: The convert_to_beam_type mechanism was updated to include dataclass recognition, allowing Beam to properly process and convert dataclass types.
  • RowType Constraint Generation: The RowTypeConstraint.from_user_type method was extended to correctly extract fields and their types from dataclasses, facilitating the generation of Beam schemas.
  • Schema Inference Update: The schema_from_element_type function was modified to infer schemas directly from dataclasses, providing consistent behavior with existing NamedTuple support.
  • Comprehensive Testing: New unit tests were introduced to validate the roundtrip conversion of dataclasses to Beam schemas and to ensure their correct schema inference.

🧠 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/native_type_compatibility.py
    • Imported the dataclasses module.
    • Added a new function match_is_dataclass to check if a type is a dataclass.
    • Updated convert_to_beam_type to include a _TypeMapEntry for dataclasses.
  • sdks/python/apache_beam/typehints/row_type.py
    • Imported match_is_dataclass from native_type_compatibility.
    • Extended the from_user_type static method to handle dataclass types, extracting their fields and types to construct RowTypeConstraint instances.
  • sdks/python/apache_beam/typehints/schemas.py
    • Imported match_is_dataclass from native_type_compatibility.
    • Modified schema_from_element_type to infer schemas from dataclasses, alongside named tuples.
  • sdks/python/apache_beam/typehints/schemas_test.py
    • Imported the dataclasses module.
    • Added test_dataclass_roundtrip to verify the conversion of dataclasses to RowTypeConstraint and schema generation.
    • Added test_trivial_example_dataclass to test the schema inference for a basic dataclass structure.
Activity
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.

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.

[Feature Request]: Support for inferring schemas from Python dataclasses

1 participant