monkeypatch: annotate the path parameter of syspath_prepend - #14988
Open
adamtheturtle wants to merge 2 commits into
Open
monkeypatch: annotate the path parameter of syspath_prepend#14988adamtheturtle wants to merge 2 commits into
adamtheturtle wants to merge 2 commits into
Conversation
The parameter had no annotation, so a strict type checker such as pyright reports every call as having a partially unknown type. The method accepts anything str() can turn into a path, and it is documented alongside chdir, which already takes str | os.PathLike[str]. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
psf-chronographer
Bot
added
the
bot:chronographer:provided
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
MonkeyPatch.syspath_prependhad no annotation on itspathparameter. Under a strict type checker such as pyright, every call in a user's test suite is then reported asreportUnknownMemberType, so each call needs an ignore comment.This annotates it as
str | os.PathLike[str], matchingMonkeyPatch.chdirnext to it. The method already converts the argument withstr(), so behaviour is unchanged.AUTHORSchangelog/<PR number>.improvement.rstonce the number was known)