Fix Pyright unknown types for YAML.load / YAML.dump (SF #564) - #2
Open
adamtheturtle wants to merge 1 commit into
Open
Fix Pyright unknown types for YAML.load / YAML.dump (SF #564)#2adamtheturtle wants to merge 1 commit into
adamtheturtle wants to merge 1 commit into
Conversation
Pyright does not treat `if False` blocks as type-checker-only, so imports of Path and Stream* aliases were undefined and parameters became Unknown under strict reportUnknownMemberType. - Use typing.TYPE_CHECKING in compat.py and main.py for MYPY-only imports. - Type YAML.dump data as Any (the serialized object); stream as Optional[Union[Path, StreamType]]. Made-with: Cursor
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.
Summary
Fixes SourceForge #564: under Pyright strict mode,
YAML.loadandYAML.dumpreportedreportUnknownMemberTypebecausestream/dataresolved toUnknown.Cause
Imports for
Path,StreamType, andStreamTextTypelived underif False: # MYPY. Pyright does not treat that as a type-checking-only branch (unliketyping.TYPE_CHECKING), so those names were undefined and annotation resolution failed.Changes
compat.py,main.py: useTYPE_CHECKINGinstead ofif Falsefor MYPY-only imports.YAML.dump: typedataasAny(the object to serialize). The previousUnion[Path, StreamType]was incorrect fordata.streamisOptional[Union[Path, StreamType]].Verification
Strict Pyright on a small consumer that calls
YAML().load(...)andYAML().dump(..., ...)reports 0 errors.Made with Cursor