Add option to pickle relative filepaths in cloudpickle.

[claudevdm]

This PR reflects the state of cloudpickle at claudevdm/cloudpickle#1

---

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.

[claudevdm]

R: @tvalentyn

[gemini-code-assist]

Summary of Changes

Hello @claudevdm, 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 library by introducing an option to serialize file paths as relative paths. This change addresses potential issues with portability and reproducibility when code containing absolute file paths is pickled and unpickled across different environments or machines. By normalizing paths to be relative to sys.path, the serialization becomes more robust and less dependent on the specific file system layout of the origin environment.

Highlights

• Relative Filepath Option: Introduced a new configuration option use_relative_filepaths in cloudpickle to allow pickling file paths as relative paths, enhancing portability.
• Path Normalization Utility: Added a helper function _get_relative_path that converts an absolute file path to a path relative to the longest matching directory in sys.path.
• Code Object Serialization: Modified the _code_reduce function to apply relative path conversion to the co_filename attribute of code objects when the new configuration option is enabled.
• Function Global __file__ Handling: Ensured that the __file__ attribute within function globals is also normalized to a relative path during pickling if use_relative_filepaths is active.
• Deterministic Coder Configuration: Updated the DETERMINISTIC_CODER_CONFIG in apache_beam.internal.cloudpickle_pickler to enable the use_relative_filepaths option, improving determinism for type encoding in Beam.

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]

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

[claudevdm]

This is a change from cloudpickle lib

[codecov]

Codecov Report

❌ Patch coverage is 62.50000% with 15 lines in your changes missing coverage. Please review.
✅ Project coverage is 56.84%. Comparing base (bbf3613) to head (88f7bb7).
⚠️ Report is 6 commits behind head on master.

Files with missing lines	Patch %	Lines
...on/apache_beam/internal/cloudpickle/cloudpickle.py	62.50%	15 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##             master   #36300      +/-   ##
============================================
- Coverage     56.84%   56.84%   -0.01%     
  Complexity     3386     3386              
============================================
  Files          1220     1220              
  Lines        185898   185921      +23     
  Branches       3523     3523              
============================================
+ Hits         105672   105678       +6     
- Misses        76885    76902      +17     
  Partials       3341     3341              

Flag	Coverage Δ
python	80.91% <62.50%> (-0.02%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[claudevdm]

#21298