Type Stubs for Google Auth

0.3.0 · active · verified Sun Apr 12

google-auth-stubs provides type stubs for the `google-auth` library, enabling static type checking (e.g., with MyPy) for Google authentication code. It helps catch type-related errors at development time without affecting runtime behavior. The current version is 0.3.0, with releases occurring as needed to support new `google-auth` versions or add type elaborations.

Warnings

gotcha This library provides type stubs only. You must also install the actual `google-auth` library for your application to run at runtime. `google-auth-stubs` is a development-time dependency for type checking.
Fix: Ensure `google-auth` is included in your project's runtime dependencies (`pip install google-auth`).
gotcha Type stubs may not perfectly align with every minor version of the `google-auth` library. Mismatched versions can lead to incorrect type checking results or false positives from your type checker.
Fix: Try to keep `google-auth-stubs` and `google-auth` versions as close as possible. Check the `google-auth-stubs` changelog for specific `google-auth` versions it targets.
gotcha The library explicitly requires Python versions >=3.6.2 and <4.0.0. Using it with unsupported Python versions may lead to installation failures or unexpected behavior.
Fix: Ensure your development environment uses a compatible Python version (e.g., Python 3.8, 3.9, 3.10, 3.11).

Install

pip install google-auth-stubs Install latest version

Imports

Credentials

from google.auth.credentials import Credentials

default
```
import google.auth.default
```

Request

from google.auth.transport.requests import Request

service_account_credentials

from google.oauth2 import service_account

Quickstart

This quickstart demonstrates a basic `google-auth` flow. The `google-auth-stubs` library provides type hints for all components used here, enhancing static analysis when this code is run through a type checker like MyPy.

import google.auth
from google.auth.transport.requests import Request

# This code demonstrates typical google-auth usage, which google-auth-stubs provides types for.
# In a real application, credentials would be obtained from environment variables,
# a service account file, or other configuration.
# For example, to use default credentials:

try:
    credentials, project = google.auth.default()

    # If credentials are refreshable and expired, try to refresh them.
    if credentials and credentials.expired and credentials.refresh_token:
        credentials.refresh(Request())

    print(f"Successfully obtained credentials for project: {project}")
    print(f"Credentials scope(s): {credentials.scopes}")
except Exception as e:
    print(f"Failed to obtain Google Cloud credentials: {e}")
    print("Ensure 'google-auth' is installed and credentials are configured (e.g., GOOGLE_APPLICATION_CREDENTIALS).")

view raw JSON →