Added complete Xlib stubs #9279

Avasam · 2022-11-25T21:17:33Z

These are the complete type stubs for https://github.com/python-xlib/python-xlib/ to the best of my ability. I typed this stub for use in https://github.com/Kalmat/PyWinCtl and https://github.com/Avasam/Auto-Split. So I know it's at least good enough for those projects.

Due to how Struct, GetAttrData, and ValueList dynamically generate and get their values, every subclass and instance would have to specify their __init__ and attributes. I didn't go that far but at least still typed the base classes with an attribute getter and/or setter so that their dynamic nature is accurately represented.

Any special case should be documented properly with comments (or I'll add more if there's still questions 😃 )

JelleZijlstra · 2022-11-25T23:03:37Z

pytype is quite unhappy. I see some complaint involving collections.abc.Callable; it's possible using typing.Callable will work better.

Avasam · 2022-11-25T23:14:14Z

pytype is quite unhappy. I see some complaint involving collections.abc.Callable; it's possible using typing.Callable will work better.

pytype.load_pytd.BadDependencyError: Unresolved class: 'collections.abc.Callable', referenced from 'Xlib.xobject.fontable'

Callable isn't even referenced directly in Xlib.xobject.fontable. ~~Maybe because it's using the TypeAlias ErrorHandler from _typing.pyi?~~ Nope
And other similar issues.

I think that you're right that google/pytype#1096 is relevant. But that's not all here:

stubs/python-xlib/Xlib/xobject/drawable.pyi (3.8): pytype.pytd.visitors.SymbolLookupError: Function(name='map', signatures=(Signature(params=(Parameter(name='self', type=AnythingType(), kind=<ParameterKind.REGULAR: 'regular'>, optional=False, mutated_type=None), Parameter(name='onerror', type=UnionType(type_list=(CallableType(base_type=ClassType(typing.Callable), parameters=(ClassType(Xlib.error.XError), UnionType(type_list=(ClassType(Xlib.protocol.rq.Request), ClassType(builtins.NoneType))), ClassType(builtins.object))),
ClassType(builtins.NoneType))), kind=<ParameterKind.REGULAR: 'regular'>, optional=True,
mutated_type=None)), starargs=None, starstarargs=None, return_type=ClassType(builtins.NoneType), exceptions=(), template=()),), kind=<MethodKind.METHOD: 'method'>, flags=<MethodFlag.NONE: 1>) is not a type

stubs/python-xlib/Xlib/xobject/fontable.pyi (3.8): pytype.load_pytd.BadDependencyError:
No display._BaseDisplay in module Xlib, referenced from 'Xlib.xobject.resource'

Avasam · 2022-11-27T19:02:47Z

I think I managed to work around pytype and mypy errors
Refs:
google/pytype#1324
python/mypy#14205

AlexWaygood · 2022-11-27T19:05:49Z

You have a talent for finding packages that break our CI in strange and unexpected ways 😀

AlexWaygood · 2022-11-28T12:38:30Z

@Avasam, do you fancy adding https://github.com/Avasam/Auto-Split (and other repos you're working on, if you like!) to mypy_primer, so that we can get some more coverage for some of the stubs packages you're contributing? :)

AlexWaygood

Thanks! I skimmed, a few comments below :)

stubs/python-xlib/Xlib/_typing.pyi

stubs/python-xlib/Xlib/display.pyi

stubs/python-xlib/Xlib/rdb.pyi

stubs/python-xlib/Xlib/support/unix_connect.pyi

stubs/python-xlib/Xlib/threaded.pyi

stubs/python-xlib/Xlib/xobject/drawable.pyi

Avasam · 2022-11-29T01:51:57Z

stubs/python-xlib/Xlib/_typing.pyi

+
+_T = TypeVar("_T")
+ErrorHandler: TypeAlias = Callable[[XError, Optional[Request]], _T]
+Unused: TypeAlias = object


Do you think there's value in making this an alias in typeshed? I've used such an alias in D3dShot and pyscreeze as well.

It's a much less complicated type; but Incomplete is also a pretty simple alias, and that's certainly shown its worth. Sure, why not :)

Note though that aliases added to _typeshed can only be used in third-party stubs after mypy/pyright cut releases that update their vendored copy of _typeshed. Otherwise we run into the same problem we had in #9145, where a third-party stub starts using a type from _typeshed that, from the type checker's point of view, "doesn't exist yet".

Indeed the value doesn't come from the type behind the alias, but the name of the alias itself (like FileDescriptor, Incomplete, etc.). Since you're not against it, I'll open a PR as a suggestion, and if accepted I'll update object --> Unused separately. I do remember that problem we had >.<

Avasam · 2022-11-29T06:38:33Z

@Avasam, do you fancy adding https://github.com/Avasam/Auto-Split (and other repos you're working on, if you like!) to mypy_primer, so that we can get some more coverage for some of the stubs packages you're contributing? :)

Sure thing! Probably later this week. For instance I've been looking at the most popular projects (thousands of stars) using both pywin32 and mypy. Completing pywin32 stubs for 'em, and planning to suggest them to the primer.

stubs/python-xlib/Xlib/_typing.pyi

stubs/python-xlib/Xlib/protocol/rq.pyi

stubs/python-xlib/Xlib/rdb.pyi

Co-authored-by: Alex Waygood <[email protected]>

github-actions · 2022-11-30T16:08:08Z

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

AlexWaygood · 2022-11-30T16:10:43Z

Thanks @Avasam!

Removals from `stubinfo.py`: - `atomicwrites` is archived and deprecated at runtime; stubs were removed from typeshed in python/typeshed#8925 - `attrs` has had inline types for a very long time now - `chardet` recently cut a release with inline types; typeshed's stubs were marked obsolete in python/typeshed#9318 - `cryptography` has had inline types for a very long time now; the only reason why it's still in typeshed is because other typeshed packages need `types-cryptography` as a dependency, and our testing infrastructure therefore can't currently cope with it being removed from typeshed. - `emoji` recently cut a release bundling stubs with the runtime package; typeshed's stubs were marked obsolete in python/typeshed#9051 - `termcolor` recently cut a release with inline types; typeshed's stubs were marked obsolete in python/typeshed#8746 - `prettytable` recently cut a release with inline types; typeshed's stubs were marked obsolete in python/typeshed#9023 Additions: - Stubs for `Xlib` were added in python/typeshed#9279 - Stubs for `consolemenu` were added in python/typeshed#8820 - Stubs for `dockerfile_parse` were added in python/typeshed#9305 - Stubs for `flask_migrate` were added in python/typeshed#8967 - Stubs for `paho.mqtt` were added in python/typeshed#8853 - Stubs for `pycocotools` were added in python/typeshed#9086 - Stubs for many `pywin32` modules were added in python/typeshed#8825, and multiple follow-up PRs - Stubs for `pyscreeze` were added in python/typeshed#8823

Avasam added 3 commits November 24, 2022 19:45

Added Xlib stubs

6bb4892

Revert not yet implemented

b306d70

Merge branch 'main' of https://github.com/python/typeshed into Xlib

d97795d

This comment has been minimized.

Sign in to view

Avasam added 3 commits November 25, 2022 19:25

map comment

638a81a

Merge branch 'main' of https://github.com/python/typeshed into Xlib

375b30c

workaround typing issues

a27f384

Avasam added 2 commits November 27, 2022 14:07

Forgot a _map

1531a6e

revert leftover change in builtins

6a2a94a

This comment has been minimized.

Sign in to view

Use SliceableBuffer from _typeshed

7259c37

This comment has been minimized.

Sign in to view

AlexWaygood reviewed Nov 28, 2022

View reviewed changes

Avasam added 4 commits November 28, 2022 14:39

Merge branch 'main' of https://github.com/python/typeshed into Xlib

710443a

wip PR comments

f37020d

Updates from comments

834be96

Alias tuples that can be Iterabl/Sequence

4ca75a9

Avasam requested a review from AlexWaygood November 29, 2022 01:14

This comment has been minimized.

Sign in to view

Avasam added 2 commits November 28, 2022 20:37

Remove bad comparisons from stub

4c85a11

Fix flake8

2621889

This comment has been minimized.

Sign in to view

Avasam commented Nov 29, 2022

View reviewed changes

Avasam mentioned this pull request Nov 29, 2022

StrOrBytesPath | FileDescriptor alias #9297

Closed

This comment has been minimized.

Sign in to view

AlexWaygood reviewed Nov 30, 2022

View reviewed changes

stubs/python-xlib/Xlib/_typing.pyi Outdated Show resolved Hide resolved

stubs/python-xlib/Xlib/protocol/rq.pyi Outdated Show resolved Hide resolved

stubs/python-xlib/Xlib/rdb.pyi Outdated Show resolved Hide resolved

Avasam and others added 4 commits November 30, 2022 10:48

Update stubs/python-xlib/Xlib/rdb.pyi

a5163c0

Co-authored-by: Alex Waygood <[email protected]>

Update stubs/python-xlib/Xlib/protocol/rq.pyi

2b3eb62

Co-authored-by: Alex Waygood <[email protected]>

PR comments

2cb50e7

Merge branch 'Xlib' of https://github.com/Avasam/typeshed into Xlib

b416836

AlexWaygood approved these changes Nov 30, 2022

View reviewed changes

AlexWaygood merged commit ee69f60 into python:main Nov 30, 2022

Avasam deleted the Xlib branch November 30, 2022 16:16

AlexWaygood mentioned this pull request Dec 8, 2022

Update stubinfo.py for recent typeshed changes python/mypy#14265

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added complete Xlib stubs #9279

Added complete Xlib stubs #9279

Avasam commented Nov 25, 2022

This comment has been minimized.

JelleZijlstra commented Nov 25, 2022

Avasam commented Nov 25, 2022 •

edited

Loading

Avasam commented Nov 27, 2022

AlexWaygood commented Nov 27, 2022 •

edited

Loading

This comment has been minimized.

This comment has been minimized.

AlexWaygood commented Nov 28, 2022

AlexWaygood left a comment

This comment has been minimized.

This comment has been minimized.

Avasam Nov 29, 2022 •

edited

Loading

AlexWaygood Nov 30, 2022

Avasam Nov 30, 2022 •

edited

Loading

This comment has been minimized.

Avasam commented Nov 29, 2022

github-actions bot commented Nov 30, 2022

AlexWaygood commented Nov 30, 2022

Added complete Xlib stubs #9279

Added complete Xlib stubs #9279

Conversation

Avasam commented Nov 25, 2022

This comment has been minimized.

JelleZijlstra commented Nov 25, 2022

Avasam commented Nov 25, 2022 • edited Loading

Avasam commented Nov 27, 2022

AlexWaygood commented Nov 27, 2022 • edited Loading

This comment has been minimized.

This comment has been minimized.

AlexWaygood commented Nov 28, 2022

AlexWaygood left a comment

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

Avasam Nov 29, 2022 • edited Loading

Choose a reason for hiding this comment

AlexWaygood Nov 30, 2022

Choose a reason for hiding this comment

Avasam Nov 30, 2022 • edited Loading

Choose a reason for hiding this comment

This comment has been minimized.

Avasam commented Nov 29, 2022

github-actions bot commented Nov 30, 2022

AlexWaygood commented Nov 30, 2022

Avasam commented Nov 25, 2022 •

edited

Loading

AlexWaygood commented Nov 27, 2022 •

edited

Loading

Avasam Nov 29, 2022 •

edited

Loading

Avasam Nov 30, 2022 •

edited

Loading