-
Notifications
You must be signed in to change notification settings - Fork 4.5k
Make dill optional #36093
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Make dill optional #36093
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @claudevdm, 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 refactors the dependency on the 'dill' serialization library, making it optional rather than a core requirement for the Apache Beam Python SDK. This change provides greater flexibility for users who may not need 'dill' in their pipelines, while ensuring that its use is properly validated and supported when explicitly chosen. The update also introduces a mechanism for using potentially unsupported 'dill' versions for advanced users.
Highlights
- Dependency Management: The 'dill' library is no longer a mandatory dependency for the Apache Beam Python SDK. It has been moved to an optional extra, meaning users can install it via
apache-beam[dill]if their pipelines require it. - Dill Usage and Validation: The system now includes runtime checks to ensure 'dill' is installed when a
DillCoderordillpickler is explicitly used. If 'dill' is missing, aRuntimeErrororImportErroris raised with instructions on how to install it. - Pickle Library Options: A new
pickle_libraryoption,dill_unsafe, has been introduced. This allows users to bypass the strict version validation for 'dill' (which typically requiresdill==0.3.1.1), enabling the use of other 'dill' versions at their own risk. - Test Suite Updates: Numerous tests that rely on 'dill' have been updated to conditionally skip if 'dill' is not installed. A new
pytestmarkeruses_dilland a dedicatedtoxenvironment (py{version}-dill) have been added to manage and run these 'dill'-dependent 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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
-
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. ↩
|
Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment |
4dcad56 to
5a2f77e
Compare
|
/gemini review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request effectively makes dill an optional dependency by removing it from the core requirements and adding it as an extra. The changes are comprehensive, touching runtime code to raise errors when dill is needed but absent, and updating numerous tests to skip gracefully. The addition of a dill_unsafe option and validation for the dill version is also a good improvement. My review includes a few suggestions to improve code clarity, fix a redundant check, and correct a docstring.
|
R: @damccorm |
|
Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment |
|
Failing tests look like flakes and unrelated. |
damccorm
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, this LGTM. I re-kicked off some test suites, and will merge once those are green
|
Failing postcommit tests look related to #36027 |
|
I do agree that this PR isn't causing the failures though, so merging |
|
some flaky ones from the logs: |
trying #36140 |
| 'Chooses which pickle library to use. Options are dill, ' | ||
| 'cloudpickle or default.'), | ||
| choices=['cloudpickle', 'default', 'dill']) | ||
| choices=['cloudpickle', 'default', 'dill', 'dill_unsafe']) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
possible other ways to name this concept:
dill_any
dill_untested
dill_any_version
Make dill an optional dependency.
There will be two followup PR's
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
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.CHANGES.mdwith noteworthy changes.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.