Skip to content

Pass pipeline options to all call sites.#37509

Closed
claudevdm wants to merge 1 commit intoapache:masterfrom
claudevdm:pipelineoptions-compat
Closed

Pass pipeline options to all call sites.#37509
claudevdm wants to merge 1 commit intoapache:masterfrom
claudevdm:pipelineoptions-compat

Conversation

@claudevdm
Copy link
Collaborator

Please add a meaningful description for your change here


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.

@gemini-code-assist
Copy link
Contributor

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 significantly refactors how Apache Beam's Python SDK handles version compatibility within its coding mechanisms. By introducing a dedicated method in PipelineOptions and explicitly passing these options to coder-related functions, the change centralizes compatibility checks and reduces reliance on global state. This improves the clarity and maintainability of the codebase, ensuring that pipeline behaviors are consistently governed by their configured options, especially concerning deterministic coders and serialization strategies.

Highlights

  • Centralized Compatibility Checks: Introduced a new method is_compat_version_prior_to within PipelineOptions to centralize version compatibility checks, moving this logic away from global registry attributes and utility functions.
  • Explicit PipelineOptions Passing: Modified numerous as_deterministic_coder methods across various coders and related functions to explicitly accept and pass PipelineOptions, ensuring that compatibility logic is consistently applied based on pipeline configuration.
  • Refactored Coder Compatibility Logic: Updated internal functions like _should_force_use_dill and _update_compatible_deterministic_fast_primitives_coder to receive PipelineOptions directly, streamlining how deterministic coders handle version-specific behaviors.
  • Removed Global State and Utility Functions: Eliminated the update_compatibility_version attribute from typecoders.registry and removed redundant is_v1_prior_to_v2 and is_compat_version_prior_to utility functions from apache_beam.transforms.util, reducing global state and consolidating logic.
  • Updated Test Infrastructure: Adjusted test cases to reflect the new approach, creating PipelineOptions instances and passing them to relevant methods, and removing outdated direct manipulations of global registry settings.

🧠 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
  • .github/trigger_files/beam_PreCommit_Python_Dill.json
    • Updated revision number to trigger CI.
  • sdks/python/apache_beam/coders/coders.py
    • Modified as_deterministic_coder methods across various coder classes to accept an optional options argument.
    • Updated DeterministicFastPrimitivesCoderV2 constructor to take options instead of update_compatibility_version.
    • Refactored _should_force_use_dill and _update_compatible_deterministic_fast_primitives_coder to use options for compatibility checks.
  • sdks/python/apache_beam/coders/coders_test_common.py
    • Imported PipelineOptions.
    • Removed typecoders.registry.update_compatibility_version assignment in tearDown.
    • Updated test methods to create and pass PipelineOptions to as_deterministic_coder calls.
  • sdks/python/apache_beam/coders/row_coder.py
    • Added options parameter to as_deterministic_coder method.
  • sdks/python/apache_beam/coders/typecoders.py
    • Removed update_compatibility_version attribute from TypeCoderRegistry initialization.
    • Added options parameter to verify_deterministic and passed it to as_deterministic_coder.
  • sdks/python/apache_beam/io/gcp/bigquery_file_loads.py
    • Replaced util.is_compat_version_prior_to with p.options.is_compat_version_prior_to for compatibility checks.
  • sdks/python/apache_beam/io/gcp/bigquery_file_loads_test.py
    • Removed direct manipulation of typecoders.registry.force_dill_deterministic_coders.
    • Updated tests to set force_dill_deterministic_coders directly on PipelineOptions using object.__setattr__.
    • Removed force_cloudpickle_deterministic_coders from PipelineOptions initialization.
  • sdks/python/apache_beam/options/pipeline_options.py
    • Added is_compat_version_prior_to method to PipelineOptions for robust version comparison.
    • Removed the --force_cloudpickle_deterministic_coders argument from StandardOptions.
  • sdks/python/apache_beam/options/pipeline_options_test.py
    • Added CompatVersionTest class to thoroughly test the new is_compat_version_prior_to method.
    • Updated test_dir to reflect the addition of is_compat_version_prior_to.
  • sdks/python/apache_beam/pipeline.py
    • Removed import of StreamingOptions and direct assignment to typecoders.registry.update_compatibility_version.
    • Modified PipelineContext constructor to accept and store options.
  • sdks/python/apache_beam/pipeline_test.py
    • Updated test_dir to include is_compat_version_prior_to in the expected options lists.
  • sdks/python/apache_beam/runners/dataflow/dataflow_runner.py
    • Passed pcoll.pipeline.options to coders.registry.verify_deterministic.
  • sdks/python/apache_beam/runners/direct/direct_runner.py
    • Passed pcoll.pipeline.options to typecoders.registry.verify_deterministic in GroupByKey expansion.
  • sdks/python/apache_beam/runners/pipeline_context.py
    • Imported pipeline_options and added options to PipelineContext initialization and storage.
    • Updated deterministic_coder to pass self.options to coder.as_deterministic_coder.
  • sdks/python/apache_beam/transforms/external.py
    • Removed import of is_compat_version_prior_to and directly used pcolls.pipeline._options.is_compat_version_prior_to.
  • sdks/python/apache_beam/transforms/ptransform.py
    • Removed import of is_compat_version_prior_to and directly used options.is_compat_version_prior_to in set_options.
  • sdks/python/apache_beam/transforms/stats.py
    • Modified ApproximateUniqueCombineFn constructor to accept options and pass it to verify_deterministic.
    • Updated CountGlobally and CountPerKey to pass pcoll.pipeline.options to ApproximateUniqueCombineFn.
  • sdks/python/apache_beam/transforms/util.py
    • Removed pipeline_options import and deleted is_v1_prior_to_v2 and is_compat_version_prior_to utility functions.
    • Updated GroupByEncryptedKey, Reshuffle, and ReshufflePerKey to use pcoll.pipeline.options.is_compat_version_prior_to.
  • sdks/python/apache_beam/transforms/util_test.py
    • Removed direct manipulation of typecoders.registry.force_dill_deterministic_coders.
    • Updated tests to set force_dill_deterministic_coders directly on PipelineOptions.
    • Removed CompatCheckTest class and its associated tests.
Activity
  • The pull request description is generic and does not contain specific details about comments, reviews, or progress. The changes primarily involve code refactoring and updates.
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.

@claudevdm
Copy link
Collaborator Author

/gemini review

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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 refactors how pipeline options, particularly for version compatibility, are handled throughout the coder and transform components. A new method PipelineOptions.is_compat_version_prior_to is introduced to centralize version checking, and the options object is now passed explicitly through various method calls (like as_deterministic_coder) instead of relying on global state. This is a significant improvement for maintainability and correctness. My review focuses on ensuring the options parameter is propagated correctly everywhere. I've found a few places where this seems to have been missed.

@claudevdm claudevdm force-pushed the pipelineoptions-compat branch from a17f3dd to 86726f9 Compare February 4, 2026 23:25
@claudevdm claudevdm force-pushed the pipelineoptions-compat branch from 86726f9 to 3f45657 Compare February 5, 2026 02:31
@claudevdm
Copy link
Collaborator Author

/gemini review

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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 is a significant and well-executed refactoring to pass PipelineOptions to various coder-related functions, instead of relying on a global state in typecoders.registry. This greatly improves the design by making dependency on pipeline options explicit, which enhances maintainability and prevents potential issues in multi-pipeline scenarios.

Key changes include:

  • Adding an options parameter to as_deterministic_coder methods and other related functions.
  • Introducing a new PipelineOptions.is_compat_version_prior_to method to centralize version compatibility checks, and removing the old utility functions.
  • Updating PipelineContext to hold and propagate PipelineOptions.
  • Thoroughly updating call sites and tests to use the new pattern.

The changes are consistent and well-tested, with new tests added for the new logic. This is a high-quality contribution. I have one suggestion to improve the test code by formally adding a test-only option instead of using object.__setattr__.

Comment on lines +514 to +515
options = PipelineOptions(update_compatibility_version=compat_version)
object.__setattr__(options, 'force_dill_deterministic_coders', True)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Using object.__setattr__ to set a test-only option can be a bit opaque. To make this cleaner and more explicit, consider adding force_dill_deterministic_coders as a formal option to TestingOptions in sdks/python/apache_beam/options/pipeline_options.py.

You would add this to TestingOptions._add_argparse_args:

parser.add_argument(
    '--force_dill_deterministic_coders',
    default=False,
    action='store_true',
    help='(INTERNAL) For testing purposes. Force the use of dill-based '
    'deterministic coders for backward compatibility testing.')

This would allow you to set the option directly in the PipelineOptions constructor as suggested, making the test setup more readable and maintainable. This change should be applied to other tests using this pattern as well.

Suggested change
options = PipelineOptions(update_compatibility_version=compat_version)
object.__setattr__(options, 'force_dill_deterministic_coders', True)
options = PipelineOptions(
update_compatibility_version=compat_version,
force_dill_deterministic_coders=True)

@claudevdm claudevdm closed this Feb 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant