Enable pyright for all Python 3 stubs #5597

srittau · 2021-06-09T08:05:31Z

Disable rules reportUnknownParameterType, reportUnknownVariableType, and reportUnknownMemberType.

Unknown parameter types are preferred over Any annotations for
incomplete stubs. Especially larger stubs are expected to be
incomplete for some time and it would be a shame to lose the
other pyright warnings for those stubs.

Cc @jakebailey

Unknown parameter types are preferred over Any annotations for incomplete stubs. Especially larger stubs are expected to be incomplete for some time and it would be a shame to lose the other pyright warnings for those stubs.

Fix problems with tkinter

srittau · 2021-06-09T09:11:35Z

I'll have a huge patch incoming that fixes all problems in the currently disabled stubs.

Fix pyright problems

Akuli · 2021-06-09T09:30:42Z

stubs/paramiko/paramiko/kex_ecdh_nist.pyi

@@ -2,7 +2,11 @@ import sys
 from _typeshed import ReadableBuffer
 from typing import Callable, Optional, Union

-from cryptography.hazmat.primitives.asymmetric.ec2 import EllipticCurve, EllipticCurvePrivateKey, EllipticCurvePublicKey
+from cryptography.hazmat.primitives.asymmetric.ec2 import (  # type: ignore


Why does this need # type: ignore?

Because pyright doesn't find this import (probably because it's "hidden" in stubs/cryptography). This is something we should look into, but I ignored it for this PR.

Akuli · 2021-06-09T09:34:51Z

stubs/cryptography/cryptography/hazmat/primitives/serialization/__init__.pyi

-from cryptography.hazmat.primitives.asymmetric.dsa import DSAPrivateKey, DSAPublicKey
-from cryptography.hazmat.primitives.asymmetric.ec import EllipticCurvePrivateKey, EllipticCurvePublicKey
-from cryptography.hazmat.primitives.asymmetric.ed25519 import Ed25519PublicKey
-from cryptography.hazmat.primitives.asymmetric.rsa import RSAPrivateKey, RSAPublicKey



I'm a bit confused about why these were here in the first place, since this doesn't seem to be re-exporting.

github-actions · 2021-06-09T09:51:35Z

According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉

JelleZijlstra · 2021-06-09T14:08:48Z

stubs/protobuf/google/protobuf/any_pb2.pyi

@@ -40,8 +40,8 @@ class Any(google___protobuf___message___Message, google___protobuf___internal___

    def __init__(self,
        *,
-        type_url : typing___Optional[typing___Text] = None,
-        value : typing___Optional[builtin___bytes] = None,
+        type_url : typing___Optional[typing___Text] = ...,


Aren't these stubs autogenerated? We'll need to update the generation script.

IIRC, they originally were, but since then there have been manual updates.

OK, then ideally we should blacken them too. I'll merge this now and we can deal with the fallout if we try to update the generated stubs.

They have been blackened back during the Great Blackening. (Great Blackout?) I don't know how they are generated, maybe the script is part of the protobuf repository?

Looks like it's scripts/generate_proto_stubs.sh.

jakebailey · 2021-06-09T15:55:43Z

@erictraut

I'm not so sure it's a good idea to be disabling every unknown rule... These filter into other users and mean that strict users are going to start seeing errors in their code due to missing types in typeshed.

srittau · 2021-06-09T16:00:13Z

But wouldn't that be a problem anyway when users start using these stubs? I am not sure what mypy does, but it seems not to apply the same strictness rules to stubs as it does to user code.

erictraut · 2021-06-09T16:05:10Z

I agree with Jake that these rules should not be disabled. I would prefer to leave a library in the "exclude" section until it fully meets these requirements. Otherwise we're lowering the bar for all stubs, which is heading in the wrong direction.

jakebailey · 2021-06-09T16:06:40Z

I'm not sure what you mean. Not having users see unknown when they use stubs from places like the standard lib is the goal; now we have no way to prevent this like we did before the CI checks (which meant Eric would only find them when he pulled and ran against his team's codebase).

srittau · 2021-06-09T16:20:54Z

Partly-annotated stubs are a large part of typeshed and will remain this way for the foreseeable future. We want to lower the bar to stubs submission and don't expect users to fully annotate stubs that gets submitted. In fact, we very much prefer only partly annotated stubs over no stubs and I expect the number of partly annotated stubs to grow as typeshed grows. For example, as far as I understand, @JukkaL plans to submit a huge bunch of auto-generated stubs at some point.

Re-enabling these options would mean that pyright would not check the majority of the stubs in typeshed in the future.

srittau · 2021-06-09T16:23:31Z

One thing I can see, though, is enabling these option for the stdlib and "known-complete" third-party stubs. This would be useful to avoid regressions.

erictraut · 2021-06-09T16:24:27Z

Ensuring that the most commonly-used stubs (especially the stdlib stubs) are complete and usable in the strictest type checking modes is way more important than checking the less-frequently used stubs.

It sounds like we might want to consider ways to enable specific rules for specific subdirectories. That would be a pretty significant feature to implement, but it's something we could consider.

erictraut · 2021-06-09T16:26:52Z

Here's an idea. Pyright allows you to specify a config file by path. By default it looks for a config file called "pyrightconfig.json" in the root directory, but you can specify a different config file. We could define two separate config files and run two separate passes. The first pass would use stricter settings and would exclude libraries that are not complete, the second pass would use laxer settings and would include all libraries. Thoughts?

srittau · 2021-06-09T17:06:59Z

Using two configs for "known-good" and other stubs sounds like the best solution. But we should probably move this discussion out of this PR into a separate issue.

srittau added 2 commits June 9, 2021 10:03

pyright: disable reportUnknownParameterType

3f65e72

Unknown parameter types are preferred over Any annotations for incomplete stubs. Especially larger stubs are expected to be incomplete for some time and it would be a shame to lose the other pyright warnings for those stubs.

Also disable reportUnknownVariableType

b69bbed

Fix problems with tkinter

This comment has been minimized.

Sign in to view

Akuli approved these changes Jun 9, 2021

View reviewed changes

Disable reportUnknownMemberType

b47697d

Fix pyright problems

srittau changed the title ~~pyright: disable reportUnknownParameterType~~ Enable pyright for all Python 3 stubs Jun 9, 2021

srittau added 2 commits June 9, 2021 11:23

Fix imports in windows-only stubs

5c3b5ef

blacken

5b89893

Akuli reviewed Jun 9, 2021

View reviewed changes

srittau added 2 commits June 9, 2021 11:38

Use List in py2/py3 stub

ba145d9

Restore invariant protocol and ignore

14ff99b

This comment has been minimized.

Sign in to view

JelleZijlstra reviewed Jun 9, 2021

View reviewed changes

JelleZijlstra merged commit 7115807 into python:master Jun 9, 2021

srittau deleted the pyright branch June 9, 2021 14:15

srittau mentioned this pull request Jun 9, 2021

Run pyright with stricter options for "known-good" stubs #5607

Closed

nipunn1313 mentioned this pull request Jul 10, 2021

Update proto stubs with latest mypy-protobuf 2.6 #5753

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable pyright for all Python 3 stubs #5597

Enable pyright for all Python 3 stubs #5597

srittau commented Jun 9, 2021 •

edited

Loading

This comment has been minimized.

srittau commented Jun 9, 2021

Akuli Jun 9, 2021

srittau Jun 9, 2021

srittau Jun 9, 2021

Akuli Jun 9, 2021

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

github-actions bot commented Jun 9, 2021

JelleZijlstra Jun 9, 2021

srittau Jun 9, 2021

JelleZijlstra Jun 9, 2021

srittau Jun 9, 2021

JelleZijlstra Jun 9, 2021

srittau Jun 9, 2021

jakebailey commented Jun 9, 2021

srittau commented Jun 9, 2021

erictraut commented Jun 9, 2021

jakebailey commented Jun 9, 2021

srittau commented Jun 9, 2021

srittau commented Jun 9, 2021

erictraut commented Jun 9, 2021

erictraut commented Jun 9, 2021

srittau commented Jun 9, 2021

Enable pyright for all Python 3 stubs #5597

Enable pyright for all Python 3 stubs #5597

Conversation

srittau commented Jun 9, 2021 • edited Loading

This comment has been minimized.

srittau commented Jun 9, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

github-actions bot commented Jun 9, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jakebailey commented Jun 9, 2021

srittau commented Jun 9, 2021

erictraut commented Jun 9, 2021

jakebailey commented Jun 9, 2021

srittau commented Jun 9, 2021

srittau commented Jun 9, 2021

erictraut commented Jun 9, 2021

erictraut commented Jun 9, 2021

srittau commented Jun 9, 2021

srittau commented Jun 9, 2021 •

edited

Loading