refactor: remove redundant str casts for canonicalize_name #2295
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
The type NormalizedName is just a NewType of str so it's compatible with return-type str. This means casting it to a str is never required.
Contributor
Author
|
Heya Initially I did not understand why the mypy check was failing because However, when upgrading the pre-commit config to use the first pip version where canonicalize_name is typed v21.2, I opened a can of worms and Then I decided to give it a go on the latest pip-supported (25.3) -> So my question now is: Why was mypy's pip version pinned at 20.3.4? An easy fix for this PR is to just add a Any suggestions/ideas? To be complete, here is the log when using pre-commit with the newest pip |
Contributor
Author
Ok, checking the commit history on the file actually revealed that this was introduced initially to silence mypy going to v21. 1efce5f I am not sure what is the preferred way forward. |
Member
|
Thanks for getting this moving! Our mypy situation right now is poor -- we're currently stuck on the version in pre-commit and, as you note, there's some work to be done to un-wedge it (we have some other issues about that, like #2200). However, I think we should be able to land this even without fixing the mypy setup yet. I think the right approach is to wrap # _packaging_compat.py
import typing as _t
if _t.TYPE_CHECKING:
def canonicalize_name(name: str) -> str: ...
else:
from pip._vendor.packaging.utils import canonicalize_nameThat way, the rest of the codebase can grab |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The type NormalizedName is just a NewType of str so it's compatible with return-type str. This means casting it to a str is never required.
no changelog needed
Contributor checklist
changelog.d/(seechangelog.d/README.mdfor instructions) or the PR text says "no changelog needed".Maintainer checklist
bot:chronographer:skiplabel.