Skip to content

Add pickler.roundtrip() shortcut for testing pickle - #36441

Merged
jrmccluskey merged 3 commits into
apache:masterfrom
shoyer:pickle-roundtrip
Oct 16, 2025
Merged

Add pickler.roundtrip() shortcut for testing pickle#36441
jrmccluskey merged 3 commits into
apache:masterfrom
shoyer:pickle-roundtrip

Conversation

@shoyer

@shoyer shoyer commented Oct 8, 2025

Copy link
Copy Markdown
Contributor

pickler.roundtrip(...)`` is equivalent to pickler.loads(pickler.dumps(...))`, but avoids the overhead of compression. For pipelines that serialize large objects, this can significantly reduce the overhead of pipeline creation.

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.

@shoyer
Add pickler.roundtrip() shortcut for testing pickle
140afdc 
`pickler.roundtrip(...)`` is equivalent to `pickler.loads(pickler.dumps(...))`,
but avoids the overhead of compression. For pipelines that serialize large
objects, this can significantly reduce the overhead of pipeline creation.
@gemini-code-assist

gemini-code-assist Bot commented Oct 8, 2025

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @shoyer, 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 introduces a new utility function pickler.roundtrip() that performs a serialization and deserialization cycle without applying compression. This is intended to optimize internal testing and pipeline creation processes by reducing the overhead associated with compression when a full dumps and loads operation is needed for object cloning or verification. The change involves refactoring the underlying dumps and loads implementations in both cloudpickle_pickler.py and dill_pickler.py to expose non-compressing internal versions, and then updating several call sites across the codebase to leverage this new, faster roundtrip mechanism.

Highlights

  • New Feature: Introduced pickler.roundtrip() as a shortcut for pickler.loads(pickler.dumps(...)) without compression.
  • Performance Improvement: The new roundtrip function avoids compression overhead, which can significantly speed up pipeline creation when serializing large objects.
  • Code Refactoring: Refactored internal dumps and loads functions in cloudpickle_pickler.py and dill_pickler.py to separate core pickling/unpickling logic from compression/decompression.
  • Usage Update: Updated existing code in filebasedsource.py, transform_evaluator.py, core.py, and ptransform.py to use the new pickler.roundtrip() function where appropriate.
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. ↩

@github-actions

github-actions Bot commented Oct 8, 2025

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

@shoyer

shoyer commented Oct 10, 2025

Copy link
Copy Markdown
Contributor Author

assign set of reviewers

@github-actions

github-actions Bot commented Oct 10, 2025

Copy link
Copy Markdown
Contributor

Assigning reviewers:

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

@jrmccluskey

jrmccluskey commented Oct 15, 2025

Copy link
Copy Markdown
Contributor

Gonna route this to @claudevdm since it's pickling related

@jrmccluskey
jrmccluskey requested a review from claudevdm October 15, 2025 14:15
@claudevdm

claudevdm commented Oct 16, 2025

Copy link
Copy Markdown
Collaborator

@jrmccluskey can you merge please?

@jrmccluskey
jrmccluskey merged commit 5d420c5 into apache:master Oct 16, 2025
127 of 130 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@claudevdm claudevdm claudevdm approved these changes
@jrmccluskey jrmccluskey jrmccluskey approved these changes

Assignees

No one assigned

Labels

io Next Action: Reviewers python runners

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@shoyer @jrmccluskey @claudevdm