Skip to content

refactor(retry): migrate from backoff to tenacity#1000

Open
Kevin James (TheKevJames) wants to merge 3 commits intomasterfrom
kjames/migrate-to-tenacity
Open

refactor(retry): migrate from backoff to tenacity#1000
Kevin James (TheKevJames) wants to merge 3 commits intomasterfrom
kjames/migrate-to-tenacity

Conversation

@TheKevJames
Copy link
Member

Summary

backoff is now abandoned and starting to throw errors in newer Python
versions (see #999), so we need to consider an alternative. After playing with
tenacity and stamina, and evaluating a few others, it seems like tenacity is
a pretty nice fit it terms of useability vs simplicity and slotting into our
system.

@gemini-code-assist
Copy link

Summary of Changes

Hello, 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 retry mechanism across the codebase, replacing the backoff library with tenacity. This change addresses the abandonment of backoff and its compatibility issues with newer Python versions, ensuring a more robust and maintainable retry strategy. The migration involved updating dependency configurations, modifying code to use tenacity's decorator-based retry patterns, and updating relevant documentation.

Highlights

  • Retry Library Migration: The backoff library, which is no longer maintained and causes issues with newer Python versions, has been replaced with the tenacity library for implementing retry logic across the codebase.
  • Dependency Updates: Project dependencies and lock files (.pre-commit-config.yaml, poetry.lock, pyproject.toml) have been updated to remove backoff and include tenacity.
  • Code Refactoring: Existing retry implementations using backoff.on_exception and backoff.on_predicate have been refactored to use tenacity's @retry decorator, ensuring equivalent retry behavior.
  • Documentation Refresh: Documentation examples in pubsub and storage modules have been updated to demonstrate retry policy configuration using tenacity.

🧠 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
  • .pre-commit-config.yaml
    • Updated pre-commit hook dependencies to replace 'backoff' with 'tenacity'.
  • auth/gcloud/aio/auth/token.py
    • Removed 'backoff' imports.
    • Added 'tenacity' imports for 'retry', 'retry_if_exception_type', 'stop_after_attempt', and 'wait_random_exponential'.
    • Replaced '@backoff.on_exception' decorator with 'Retry' for 'acquire_access_token' method, configuring it with equivalent retry logic.
  • auth/poetry.lock
    • Removed 'backoff' package entry.
    • Added 'tenacity' package entry with version '9.1.4'.
    • Updated 'gcloud-aio-auth' version to '5.4.4'.
    • Updated 'chardet' version to '>= 2.0, < 7.0'.
    • Updated poetry lock file header to '2.3.2'.
    • Updated content hash.
  • auth/pyproject.rest.toml
    • Replaced 'backoff' dependency with 'tenacity'.
  • auth/pyproject.toml
    • Replaced 'backoff' dependency with 'tenacity'.
  • bigquery/poetry.lock
    • Updated poetry lock file header to '2.3.2'.
    • Removed 'backoff' package entry.
    • Updated 'gcloud-aio-auth' version to '5.4.4'.
    • Updated 'chardet' version to '>= 2.0, < 7.0'.
    • Added 'tenacity' package entry with version '9.1.4'.
  • bigquery/tests/integration/smoke_test.py
    • Removed 'backoff' imports.
    • Added 'tenacity' imports for various retry components.
    • Refactored 'backoff.on_predicate' and 'backoff.on_exception' calls into 'Retry' decorated async helper functions for 'get_datastore_operation', 'get_source_table', and 'get_copy_table'.
  • datastore/poetry.lock
    • Updated poetry lock file header to '2.3.2'.
    • Removed 'backoff' package entry.
    • Updated 'gcloud-aio-auth' version to '5.4.4'.
    • Updated 'chardet' version to '>= 2.0, < 7.0'.
    • Added 'tenacity' package entry with version '9.1.4'.
  • kms/poetry.lock
    • Updated poetry lock file header to '2.3.2'.
    • Removed 'backoff' package entry.
    • Updated 'gcloud-aio-auth' version to '5.4.4'.
    • Updated 'chardet' version to '>= 2.0, < 7.0'.
    • Added 'tenacity' package entry with version '9.1.4'.
  • pubsub/gcloud/aio/pubsub/init.py
    • Updated documentation example for retry policies to use 'tenacity' instead of 'backoff'.
    • Changed class name in example from 'SubscriberClientWithBackoff' to 'SubscriberClientWithRetry'.
    • Updated 'backoff' reference link to 'tenacity'.
  • pubsub/poetry.lock
    • Updated poetry lock file header to '2.3.2'.
    • Removed 'backoff' package entry.
    • Updated 'gcloud-aio-auth' version to '5.4.4'.
    • Updated 'chardet' version to '>= 2.0, < 7.0'.
    • Added 'tenacity' package entry with version '9.1.4'.
  • storage/gcloud/aio/storage/init.py
    • Updated documentation examples for retry policies to use 'tenacity' instead of 'backoff'.
    • Changed class name in example from 'StorageWithBackoff' to 'StorageWithRetry'.
    • Updated 'backoff' reference link to 'tenacity'.
  • storage/poetry.lock
    • Removed 'backoff' package entry.
    • Updated 'chardet' version to '>= 2.0, < 7.0'.
    • Added 'tenacity' package entry with version '9.1.4'.
  • taskqueue/poetry.lock
    • Updated poetry lock file header to '2.3.2'.
    • Removed 'backoff' package entry.
    • Updated 'gcloud-aio-auth' version to '5.4.4'.
    • Updated 'chardet' version to '>= 2.0, < 7.0'.
    • Added 'tenacity' package entry with version '9.1.4'.
Activity
  • No human activity (comments, reviews, etc.) has been recorded on this pull request 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 (@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 (@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.

Copy link

@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 successfully migrates the project's retry logic from the abandoned backoff library to tenacity. The changes span across dependency configurations, application code, test files, and documentation, ensuring a consistent and necessary update. The migration to tenacity is well-executed, with retry policies correctly translated. I've included a couple of suggestions to refactor duplicated retry logic in a test file for improved maintainability and conciseness.

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@TheKevJames Kevin James (TheKevJames) marked this pull request as ready for review February 27, 2026 19:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant