Added type stub for keyboard #8666

Avasam · 2022-09-02T03:03:57Z

No description provided.

…yboard

This is also according to docs

JelleZijlstra

Thanks, left some feedback

JelleZijlstra · 2022-09-03T21:10:30Z

stubs/keyboard/keyboard/__init__.pyi

+
+class _KeyboardListener(_GenericListener):
+    transition_table: dict[
+        tuple[Literal["free"], Literal["up"], Literal["modifier"]]


This is a little excessive. How do we help users by duplicating this whole table at the type level?

JelleZijlstra · 2022-09-03T21:13:51Z

stubs/keyboard/keyboard/__init__.pyi

+# is_pressed cannot check multi-step hotkeys, so not using _ParseableHotkey
+
+def is_pressed(hotkey: _Key | _ScanCodeList) -> bool: ...
+def call_later(fn: Callable[..., None], args: _P = ..., delay: float = ...) -> None: ...


This should be expressible with PEP 646's TypeVarTuple, though we can't use that yet because mypy doesn't support it.

Good to know. I hadn't looked into 3.11's variadic generics yet. That's cool. So this would be dependant on python/mypy#12280

JelleZijlstra · 2022-09-03T21:19:02Z

stubs/keyboard/keyboard/__init__.pyi

+def start_recording(
+    recorded_events_queue: Queue[KeyboardEvent] | None = ...,
+) -> tuple[Queue[KeyboardEvent], Callable[[], None]]: ...
+def stop_recording() -> list[deque[KeyboardEvent]]: ...


I think it's just a list of KeyboardEvents.

You're right, I got confused into thinking it was a list of deque, but it's just converting

JelleZijlstra · 2022-09-03T21:20:57Z

stubs/keyboard/keyboard/_canonical_names.pyi

@@ -0,0 +1,6 @@
+basestring = str


I would remove this, it's clearly not meant as a part of the API.

JelleZijlstra · 2022-09-03T21:21:56Z

stubs/keyboard/keyboard/_generic.pyi

+_Event: TypeAlias = KeyboardEvent | _MouseEvent
+
+class GenericListener:
+    lock: Lock


Suggested change

lock: Lock

lock: ClassVar[Lock]

JelleZijlstra · 2022-09-03T21:26:29Z

stubs/keyboard/keyboard/mouse.pyi

+def double_click(button: _MouseButton = ...) -> None: ...
+def right_click() -> None: ...
+def wheel(delta: int = ...) -> None: ...
+def move(x: int | c_long, y: int | c_long, absolute: bool = ..., duration: float = ...) -> None: ...


Suggested change

def move(x: int | c_long, y: int | c_long, absolute: bool = ..., duration: float = ...) -> None: ...

def move(x: SupportsInt, y: SupportsInt, absolute: bool = ..., duration: float = ...) -> None: ...

It calls int() on x and y. Strictly a few more types are allowed:

typeshed/stdlib/builtins.pyi

Line 200 in 8e4b89a

def __new__(cls: type[Self], __x: str | ReadableBuffer | SupportsInt | SupportsIndex | SupportsTrunc = ...) -> Self: ...

Didn't know about that one. Thanks!

JelleZijlstra · 2022-09-03T21:28:18Z

stubs/keyboard/keyboard/mouse.pyi

+else:
+    def get_position() -> tuple[int, int]: ...
+
+def hook(callback: _Callback) -> _Callback: ...


Could use a bound TypeVar to signify that the exact same type is returned.

github-actions · 2022-09-05T00:00:54Z

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

Avasam and others added 2 commits September 1, 2022 22:55

Added type stub for keyboard

72c7ec4

[pre-commit.ci] auto fixes from pre-commit.com hooks

8f9a3ff