Enable pickling main by reference option within CloudpickleConfig

[praneetnadella]

Please add a meaningful description for your change here

This change mirrors an upstream Cloudpickle PR to support pickling main by reference when configured.

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)

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]

Summary of Changes

Hello @praneetnadella, I'm Gemini Code Assist¹! 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 Cloudpickle configuration by adding an option to control how objects defined in the __main__ module are serialized. By mirroring an upstream Cloudpickle feature, it provides greater flexibility for users to choose between pickling __main__ objects by reference or by value, which can be crucial for optimizing serialization performance and handling specific execution environments.

Highlights

• New Configuration Option: Introduced a new pickle_main_by_ref boolean attribute to CloudPickleConfig, allowing users to specify whether objects from the __main__ module should be pickled by reference.
• Config Propagation: Modified several internal functions (_should_pickle_by_reference, _lookup_module_and_qualname, _typevar_reduce, _module_reduce, _class_reduce, _function_reduce, save_global, save_function) to accept and utilize the CloudPickleConfig object, ensuring the new pickle_main_by_ref setting is respected throughout the pickling process.
• Main Module Pickling Logic: Updated the _lookup_module_and_qualname function to conditionally allow pickling of __main__ module objects by reference, based on the config.pickle_main_by_ref setting.
• Module Pickler Integration: Refactored how types.ModuleType objects are handled during pickling by removing it from the default dispatch table and introducing a new save_module method within the Pickler class, which uses the config-aware _module_reduce function.

🧠 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/internal/cloudpickle/cloudpickle.py
  • Added pickle_main_by_ref: bool = False to the CloudPickleConfig class.
  • Modified _should_pickle_by_reference to accept a config parameter and pass it to _lookup_module_and_qualname.
  • Updated _lookup_module_and_qualname to accept a config parameter and use config.pickle_main_by_ref to determine if __main__ objects should be pickled by reference.
  • Modified _typevar_reduce to pass the config object to _lookup_module_and_qualname.
  • Updated _module_reduce to accept a config parameter and pass it to _should_pickle_by_reference.
  • Modified _class_reduce to pass the config object to _should_pickle_by_reference.
  • Removed _dispatch_table[types.ModuleType] = _module_reduce from the Pickler class initialization.
  • Updated _function_reduce to pass self.config to _should_pickle_by_reference.
  • Added a new elif isinstance(obj, types.ModuleType): return _module_reduce(obj, self.config) branch to reducer_override.
  • Modified save_global to pass self.config to _should_pickle_by_reference.
  • Updated save_function to pass self.config to _should_pickle_by_reference.
  • Introduced a new save_module method within the Pickler class that handles module objects using _module_reduce and self.config, and assigned it to dispatch[types.ModuleType].

Activity

• The pull request was created by praneetnadella.
• No human activity (comments, reviews) has been recorded yet.

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. ↩

[praneetnadella]

R: @claudevdm

[github-actions]

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