Check for unused pyright: ignore and differentiate from mypy ignores
#9397
Conversation
Prevent type: ignore[*] comments from supressing all pyright errors Added more comments to pyright config
pyright: ignore and differentiate from mypy ignores
| @@ -1188,7 +1188,7 @@ class property: | |||
| class _NotImplementedType(Any): # type: ignore[misc] | |||
| # A little weird, but typing the __call__ as NotImplemented makes the error message | |||
There was a problem hiding this comment.
Unrelated to your PR but we should probably revisit this and see if it actually makes things better for all type checkers.
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
This looks great to me. You've uncovered several cases where it looks like we were accidentally ignoring several pyright errors that we didn't really want to, and I think that shows the value of the change.
I left a few comments below. As well as those: maybe we should add a note to CONTRIBUTING.md somewhere. It might be surprising for new contributors to find out that type: ignore comments don't silence errors emitted by pyright. It might go well in the "Conventions" section, where we already talk about using mypy error codes for type: ignore comments wherever possible.
| @@ -328,15 +328,15 @@ class _OrderedDictValuesView(ValuesView[_VT_co], Reversible[_VT_co]): | |||
| # (At runtime, these are called `odict_keys`, `odict_items` and `odict_values`, | |||
| # but they are not exposed anywhere) | |||
| @final | |||
| class _odict_keys(dict_keys[_KT_co, _VT_co], Reversible[_KT_co]): # type: ignore[misc] | |||
| class _odict_keys(dict_keys[_KT_co, _VT_co], Reversible[_KT_co]): # type: ignore[misc] # pyright: ignore | |||
There was a problem hiding this comment.
Are we able to add the pyright error codes for these pyright: ignores?
There was a problem hiding this comment.
There is no code!
Base class "dict_keys[_KT_co@_odict_keys, _VT_co@_odict_keys]" is marked final and cannot be subclassed
Pylance
E:\Users\Avasam\Documents\Git\typeshed\stdlib\collections_init_.pyi
E:\Users\Avasam\Documents\Git\typeshed\stdlib\collections_init_.pyi:331:19 - error: Base class "dict_keys[_KT_co@_odict_keys, _VT_co@_odict_keys]" is marked final and cannot be subclassed
There was a problem hiding this comment.
Oh, strange! In that case, can we leave a comment to that effect? (Same below for the other one)
| class _odict_keys(dict_keys[_KT_co, _VT_co], Reversible[_KT_co]): # type: ignore[misc] # pyright: ignore | |
| # pyright doesn't have a specific error code for this error! | |
| class _odict_keys(dict_keys[_KT_co, _VT_co], Reversible[_KT_co]): # type: ignore[misc] # pyright: ignore |
| @@ -14,7 +14,7 @@ class DebugDocumentProvider(gateways.DebugDocumentProvider): | |||
| def GetDocument(self): ... | |||
|
|
|||
| # error: Cannot determine consistent method resolution order (MRO) for "DebugDocumentText" | |||
| class DebugDocumentText(gateways.DebugDocumentInfo, gateways.DebugDocumentText, gateways.DebugDocument): # type: ignore[misc] | |||
| class DebugDocumentText(gateways.DebugDocumentInfo, gateways.DebugDocumentText, gateways.DebugDocument): # type: ignore[misc] # pyright: ignore | |||
There was a problem hiding this comment.
Which pyright error are we ignoring here? Can we add the error code?
There was a problem hiding this comment.
Same as above, no code, and if iirc, this does fail at runtime. I had already added a comment to explain the ignore.
Cannot create consistent method ordering
Pylance
I could create a feature request with pyright to add a code for "will fail at runtime". But this should rather be fixed upstream (and pywin32 already has accepted a couple fixes I found through type-checking).
And for the other case above, it's kindof a niche type-stub use-case, and is totally fixable by splitting off into another private/internal protocol (which I didn't do to keep changes minimal)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
…ithub.com/Avasam/typeshed into pyright-no-unused-pyright-ignore-comments
…t-no-unused-pyright-ignore-comments
This comment has been minimized.
This comment has been minimized.
|
According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉 |
|
|
This is possible since pyright 1.1.283. I had to bump from 1.1.284 because of a regression with comments.
Prevent
type: ignore[*]comments from also blanket suppressing all pyright errors.Added more comments to pyright config.
Fixed new pyright errors