Skip to content

[Python] Deprecate native SpannerIO implementation (#35860)#37609

Open
Kaustubh1204 wants to merge 1 commit intoapache:masterfrom
Kaustubh1204:deprecate-spannerio-35860
Open

[Python] Deprecate native SpannerIO implementation (#35860)#37609
Kaustubh1204 wants to merge 1 commit intoapache:masterfrom
Kaustubh1204:deprecate-spannerio-35860

Conversation

@Kaustubh1204
Copy link

Summary

Deprecates the native SpannerIO implementation in the Python SDK as discussed in #35860.

Changes

  • Marked native SpannerIO as deprecated.
  • Updated related references and documentation (if applicable).
  • Ensured existing tests pass without regression.

Testing

  • Ran Python SDK tests:
    ./gradlew :sdks:python:test --rerun-tasks
  • Build completed successfully.

Fixes #35860

The native Python SpannerIO implementation in apache_beam/io/gcp/experimental has been marked as experimental and less maintained. It is being deprecated in favor of the cross-language SpannerIO implementation in apache_beam/io/gcp/spanner.

This change adds module-level and class-level deprecation warnings to clear state that the native implementation will be removed in Beam 3.0.

Migration Guidance: For reads, migrate to apache_beam.io.gcp.spanner.ReadFromSpanner. For writes, migrate to apache_beam.io.gcp.spanner.SpannerInsert, SpannerUpdate, etc.
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @Kaustubh1204, 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 formally deprecates the native Python SpannerIO implementation within the SDK. The changes introduce explicit deprecation warnings and decorators across the relevant classes and functions, guiding users towards the recommended cross-language SpannerIO module. This move ensures a consistent and future-proof approach to Spanner integration within the Apache Beam ecosystem.

Highlights

  • Native SpannerIO Deprecation: The native Python SpannerIO implementation has been marked as deprecated in version 2.68 and is scheduled for removal in Beam 3.0. Users are now directed to use the cross-language SpannerIO available in apache_beam.io.gcp.spanner.

🧠 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/io/gcp/experimental/spannerio.py
    • Added a module-level deprecation notice at the top of the file.
    • Imported the warnings module to enable deprecation warnings.
    • Defined a global _DEPRECATION_MESSAGE constant for consistent messaging.
    • Applied @deprecated decorators to ReadOperation.__new__, create_transaction, ReadFromSpanner, WriteToSpanner, MutationGroup.__init__, and WriteMutation.__init__.
    • Updated the current argument in the @deprecated decorator for WriteToSpanner to reflect the correct cross-language SpannerIO path.
Activity
  • The native SpannerIO implementation was marked as deprecated.
  • Related references and documentation were updated to reflect the deprecation.
  • Existing Python SDK tests were executed and passed successfully.
  • The build process completed without any issues.
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
Copy link
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

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.

[Task]: Deprecate Python native SpannerIO

1 participant