Add support for kw_only dataclasses (addresses #36978)
Add support for dataclasses with kw_only=True, and for dataclasses with init=False fields.
This change encode the dataclass field names as well as their values in order to pass them to the dataclass __init__ function by-keyword on decoding.
fixes #36978
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, commentfixes #<ISSUE NUMBER>instead. - [ ] Update
CHANGES.mdwith 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)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.
Summary of Changes
Hello @assaf127, I'm Gemini Code Assist[^1]! 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 Apache Beam Python SDK's coding capabilities to support modern Python dataclass features, specifically kw_only=True and fields with init=False. By modifying how dataclass fields are encoded and decoded, the system can now correctly serialize and deserialize these more complex dataclass structures, ensuring data integrity and compatibility across Beam pipelines.
Highlights
- Dataclass Encoding: The encoding mechanism for dataclasses has been updated to explicitly encode field names along with their values. This change specifically targets fields where
init=True, ensuring that only relevant fields are serialized. - Dataclass Decoding: The decoding process for dataclasses now reconstructs instances using keyword arguments. This allows for proper deserialization of dataclasses defined with
kw_only=True, as well as handling fields withinit=Falseby only considering fields that were part of the initialization. - Test Coverage: New test cases have been introduced to validate the encoding and decoding of
kw_onlydataclasses. This includes a newFrozenKwOnlyDataClassand checks within both deterministic and cross-process encoding tests.
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 :thumbsup: and :thumbsdown: 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.
[^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.
Codecov Report
:x: Patch coverage is 31.57895% with 13 lines in your changes missing coverage. Please review.
:white_check_mark: Project coverage is 40.36%. Comparing base (0f7a189) to head (b9ad291).
:warning: Report is 93 commits behind head on master.
| Files with missing lines | Patch % | Lines |
|---|---|---|
| sdks/python/apache_beam/coders/coder_impl.py | 14.28% | 12 Missing :warning: |
| ...ks/python/apache_beam/coders/coders_test_common.py | 80.00% | 1 Missing :warning: |
Additional details and impacted files
@@ Coverage Diff @@
## master #36979 +/- ##
============================================
- Coverage 40.38% 40.36% -0.02%
Complexity 3470 3470
============================================
Files 1226 1226
Lines 188337 188418 +81
Branches 3603 3603
============================================
+ Hits 76053 76063 +10
- Misses 108883 108954 +71
Partials 3401 3401
| Flag | Coverage Δ | |
|---|---|---|
| python | 40.62% <31.57%> (-0.03%) |
:arrow_down: |
Flags with carried forward coverage won't be shown. Click here to find out more.
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
:rocket: New features to boost your workflow:
- :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
- :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers
The failing checks seem irrelevant for this PR. Also, the coverage report doesn't seems right - I specifically added tests that run over the lines that appear uncovered. Perhaps it doesn't count lines that are run in a subprocess?
assign set of reviewers
Assigning reviewers:
R: @damccorm 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 toolingremind me after tests pass- tag the comment author after tests passwaiting 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).