Add stubs for pynput package

[faresbakhit]

Fixes #4328

[srittau]

Why are all of those on the stubtest allowlist?

[faresbakhit]

stubtest fails to import pynput since there's no display server running (e.g. x11)

[srittau]

I see. We should probably re-introduce the flag to disable stubtest in METADATA.toml we had for a short time. I will send a PR tomorrow.

[Akuli]

We could run stubtest under xvfb, which emulates an x11 display. For example: https://github.com/Akuli/porcupine/blob/1ad0d5fa8d944ef66a0dbb7e0100da3a13aebfda/.github/workflows/check.yml#L60-L62

[hauntsaninja]

Am I missing something? stubtest does not appear to fail to import pynput in CI. In fact, if it was failing, you wouldn't see any errors.

[faresbakhit]

@hauntsaninja Here is the failing CI test in the first commit:

https://github.com/python/typeshed/runs/5163416378

error: pynput failed to import: this platform is not supported: ('failed to acquire X connection: Bad display name ""', DisplayNameError(''))

I added the allowlist in the commit after it.

[hauntsaninja]

Oh, I see how I confused myself. Sorry about that, thanks!

[srittau]

@rchen152 Could you have a look at the pytype failure? I don't see anything obvious wrong.

[srittau]

Depends on #7351. This adds support for the stubtest = false key back to METADATA.toml.

[rchen152]

Looking into the pytype error.

[rchen152]

This change seems to get rid of the pytype_test failure:

--- a/stubs/pynput/pynput/keyboard/_base.pyi
+++ b/stubs/pynput/pynput/keyboard/_base.pyi
@@ -101,8 +101,7 @@ class Controller:
     def pressed(self, *args: str | Key | KeyCode) -> Iterator[None]: ...
     def type(self, string: str) -> None: ...
     @property  # type: ignore[misc]
-    @contextlib.contextmanager
-    def modifiers(self) -> Iterator[set[Key]]: ...
+    def modifiers(self) -> contextlib.AbstractContextManager[Iterator[set[Key]]]: ...
     @property
     def alt_pressed(self) -> bool: ...
     @property

[faresbakhit]

Thanks! Just added the change in the last commit. 😄

[srittau]

Thanks, looks good to me, although I didn't compare it to the implementation. A few nits below.