fix: add missing packaging dependency for feature requiring urllib3 #1732
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…brary-python into add-dependency
sai-sunder-s
reviewed
Apr 7, 2025
| @@ -34,6 +34,7 @@ | |||
| "reauth": "pyu2f>=0.1.5", | |||
| "enterprise_cert": ["cryptography", "pyopenssl"], | |||
| "pyjwt": ["pyjwt>=2.0", "cryptography>=38.0.3"], | |||
| "urllib3": ["urllib3", "packaging"], | |||
There was a problem hiding this comment.
how does user know to install this extra?
Maybe update the error msg in the try catch and tell users about this extra.
Also move packaging into the try?
There was a problem hiding this comment.
installing dependency like pip install google-auth[urllib3] should install all the dependencies defined for urlllib3. I was thinking about updating error message, however I saw similar error in other modules, but this is definitely confusing. let me update the message to include google-auth[urllib3] command to avoid user installing directly from pip.
sai-sunder-s
reviewed
Apr 7, 2025
google/auth/transport/urllib3.py
Outdated
| except ImportError as caught_exc: # pragma: NO COVER | ||
| raise ImportError( | ||
| "The urllib3 library is not installed from please install the " | ||
| "urllib3 package to use the urllib3 transport." | ||
| "Error: Missing 'urllib3' dependency for 'google-auth'." |
There was a problem hiding this comment.
same error msg for packaging as well.
Does the caught_exc have the name of the missing library?
sai-sunder-s
approved these changes
Apr 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves an
ImportError: No module named 'packaging'encountered when using functionality in the urllib3.py file.The code paths relying on
urllib3transport also have a runtime dependency on thepackaginglibrary. This dependency was introduced in PR #1390.However,
packagingwas not explicitly listed as a requirement for theurllib3insetup.py. This was masked during development becausenoxoften installspackagingtransitively. Users installing the library without havingnoxor its dependencies installed separately would face anImportErrorwhen theurllib3dependent code executes.This PR fixes the issue by explicitly adding
packagingalongsideurllib3in the extras group definition. This ensures that installing the optional feature via the extra correctly pulls in all its necessary runtime dependencies.