googleapis/google-cloud-python

add underlying cause for `TransportError`

Closed

#15,181 opened on Dec 15, 2023

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)Python (1,481 forks)batch import
help wantedpriority: p3type: feature request

Repository metrics

Stars
 (4,304 stars)
PR merge metrics
 (Avg merge 4d) (158 merged PRs in 30d)

Description

Is it possible to save a reference to the last exception thrown at:

https://github.com/googleapis/google-auth-library-python/blob/0afc61a3a9c3d5035c913ad4a7568e8a888e2ec9/google/auth/compute_engine/_metadata.py#L204

and use it to build a more meaningful error message? at:

https://github.com/googleapis/google-auth-library-python/blob/0afc61a3a9c3d5035c913ad4a7568e8a888e2ec9/google/auth/compute_engine/_metadata.py#L217-L220

that way the underlying reason for the TransportError would be available even if DEBUG logging level is not enabled.

Contributor guide

Research direction
The issue suggests modifying the TransportError to include the underlying cause. The relevant code is in google/auth/compute engine/ metadata.py around line 204 and 217-220. A contributor should capture the last exception before raising TransportError and use Python's exception chaining (e.g., `raise ... from exc`) to preserve it. The change is small and localized.
Tech stack
python
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80