Added pyautogui stubs

[Avasam]

No description provided.

[Avasam]

I don't understand the 1 failing test

[Akuli]

stubtest is a tool that tries to import pyautogui in CI, to check whether your stubs match what is available with importing. It fails, because the CI environment doesn't have a screen attached to it (which is needed for using pyautogui; the way this works on Linux is that a screen name is stored in the $DISPLAY environment variable that it fails to find).

To silence the CI errors, you need to create a folder stubs/PyAutoGUI/@tests and add a file stubtest_allowlist.txt into it. There's an example of what to put into it at the end of the CI output. Many other stubs also have a @tests directory.

[AlexWaygood]

Thank you! Here's a partial review -- I've got up to line 75 in __init__.pyi, will carry on later if somebody else doesn't beat me to it :)

[AlexWaygood]

Nit: can we keep this list alphabetised? :)

[Akuli]

We could edit the stub generating script to keep it alphabetized. Alphabetizing would also help prevent merge conflicts: if two new items are added to the end, they will conflict, but if they are added to a random-ish place depending on the name of the project, they won't.

[AlexWaygood]

We could edit the stub generating script to keep it alphabetized.

I like that idea :)

[AlexWaygood]

(Actually, it looks like the stub-generating script already has logic in it to keep the list alphabetised. I'm guessing the only reason it wasn't initially alphabetised here is because of the path-separator issue being discussed in #8653, which screwed up the alphabetisation logic. So I think this issue will be fixed when #8653 is merged.)

[Avasam]

I ran stubtest locally so it could tell me about missing class members without the display error. However, just like with my D3DShot PR, I'm not sure how to deal with pointer types. ie dwExtraInfo: ctypes.POINTER(ctypes.wintypes.ULONG)

Edit: I found the pointer types in ctypes.wintypes

[AlexWaygood]

Here's a review for the rest of the PR!

As well as the remarks inline here: we usually only add stubs for a package's public API, unless there's a good reason to add stubs for implementation details. That means we usually omit stubs for private modules like _pyautogui_osx.pyi, _pyautogui_java.pyi, _pyautogui_win.pyi and _pyautogui_x11.pyi. Would you mind removing those? (Add an allowlist entry if stubtest complains!)

The remarks I made in relation to the mouseDown() signature also apply to mouseUp(), click(), leftClick(), rightClick(), middleClick(), doubleClick(), tripleClick(), scroll(), hscroll(), vscroll(), moveTo(), moveRel(), dragTo() and dragRel().

The remarks I made in relation to press() also apply to hold() and typewrite().

[AlexWaygood]

Thank you!

[github-actions]

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