Avoid importing a non-vendored version of Tornado #10029
Conversation
news/10020.bugfix.rst
Outdated
| @@ -0,0 +1 @@ | |||
| The presence of an old version of Tornado (before 4.1) in the environment no longer breaks pip. No newline at end of file | |||
There was a problem hiding this comment.
Describe the problem in past tense, and the fix in present tense (because that's what makes sense after the release is made). So maybe something like
Remove unused optional
tornadoimport in vendoredtenacityto avoid an old version ortornadoinstallation from breaking pip.
src/pip/_vendor/tenacity/__init__.py
Outdated
| import tornado | ||
| # Pip does not currently vendor Tornado, so this will take the | ||
| # ImportError path. | ||
| from pip._vendor import tornado |
There was a problem hiding this comment.
I think it would be better to patch the entire block to tornado = None. If the import always fails, we don't need to try that.
There was a problem hiding this comment.
I'm happy to make that change. It was my original plan, but I decided to use from pip._vendor import tornado so that in the (unlikely) event pip adds Tornado to its vendored dependencies things will just work and you won't be left with a copy of tenacity that mostly works but breaks if it interacts with tornado.
| except ImportError: | ||
| tornado = None | ||
|
|
||
|
No newline at end of file |
There was a problem hiding this comment.
Need to fix this lack of trailing newline.
bdarnell
force-pushed
the
develop
branch
2 times, most recently
from
17f2f7e to
3b655ef
Compare
|
Branch is updated with all requested changes. |
src/pip/_vendor/tenacity/__init__.py
Outdated
| except ImportError: | ||
| tornado = None | ||
| # Pip does not currently vendor Tornado, so don't import it even if it | ||
| # happens to be installed in the environment. |
There was a problem hiding this comment.
If I read this comment for the first time, I’d think to myself “OK but that works without the patch as well, so is this unnecessary”?
I’d mention why the patch is needed instead to avoid this confusion.
Code depending on this conditional import could break if an old version of Tornado is present in the environment, rendering pip unusable.
|
Thank you @bdarnell! ^>^ |
5 participants
Code depending on this conditional import could break if an old
version of Tornado is present in the environment, rendering pip
unusable.
Fixes #10020