Fix tests for urllib3 v2.0.1+ #1822
Merged
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
pquentin reviewed May 2, 2023
Comment on lines +64 to +69
| from urllib3._version import __version__ as urllib3_version | ||
| | ||
| if urllib3_version.startswith("2") and len(args) >= 5 and args[4]: | ||
| headers = args[4].copy() | ||
| args = tuple(itertools.chain((args[:4]), (headers,), args[5:])) | ||
| elif len(args) >= 4 and args[3]: |
There was a problem hiding this comment.
I was initially surprised to see version dependent code here since urllib3 2.0 is supposed to be mostly compatible with urllib3 1.26. Looking more closely, I understand now that you need to set trace headers irrelevant of the way they were set by the caller (arg, kwarg, instance parameter). Since urllib3 2.0 added a body field, it moved headers from 4th positional parameter to 5th positional parameter, and you have to detect this. cc @sethmlarson
Is my understanding right? Should you update the docstring to mention urllib3 2.0?
There was a problem hiding this comment.
Yes, you understood correctly. I probably should throw a comment in there for better documentation.
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.
What does this pull request do?
urllib3 v2.0+ introduced a change to args ordering that broke some tests. This fixes those tests (plus a stack frame test that was failing under a new version of VSCode's python extension).
The hangs that were breaking test runs for urllib3 v2.0.0 were due to a regression that has been fixed in v2.0.1. Big thanks to @pquentin, @sethmlarson, and @graingert for help with this!
Related issues
Closes #1816