Skip to content

chore: improve typing in api_core.exceptions#16115

Open
daniel-sanche wants to merge 2 commits intomainfrom
api_core_typing_patch
Open

chore: improve typing in api_core.exceptions#16115
daniel-sanche wants to merge 2 commits intomainfrom
api_core_typing_patch

Conversation

@daniel-sanche
Copy link
Contributor

GoogleApiCallError.grpc_status_code had no typing, so mypy will assume the value is always None

This PR adds the proper type annotation

GoogleApiCallError.grpc_status_code had no typing, so mypy will assume the value is always None
@daniel-sanche daniel-sanche requested review from a team as code owners March 17, 2026 17:55
@gemini-code-assist
Copy link
Contributor

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 focuses on enhancing the type annotations within the google.api_core.exceptions module, specifically for the GoogleAPICallError class. The changes provide explicit type hints for error-related attributes, which improves static analysis capabilities and overall code clarity for error handling within the library.

Highlights

  • Improved Type Annotation for grpc_status_code: Added an explicit type annotation of Optional[grpc.StatusCode] to the grpc_status_code attribute within the GoogleAPICallError class, addressing a previous lack of typing that could lead MyPy to incorrectly infer its value as always None.
  • Refined Type Annotation for code: Updated the type annotation for the code attribute in GoogleAPICallError from Union[int, None] to the more concise Optional[int] for consistency and clarity.
Changelog
  • packages/google-api-core/google/api_core/exceptions.py
    • Added a type annotation for the grpc_status_code attribute.
    • Updated the type annotation for the code attribute.
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.

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 updates type annotations in google.api_core.exceptions.GoogleAPICallError. It replaces Union[int, None] with Optional[int] and adds a type hint for grpc_status_code. The suggestion to use a forward reference for grpc.StatusCode and guard the grpc import with TYPE_CHECKING is retained as it correctly addresses how to maintain grpc as an optional dependency for type hinting purposes, aligning with best practices for optional dependencies.

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Copy link
Contributor

@gkevinzheng gkevinzheng left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants