Skip to content

Use TypeVar to help with QObject.findChild[ren]() #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
altendky merged 9 commits into from
Oct 2, 2020
Merged

Use TypeVar to help with QObject.findChild[ren]() #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
2b070c1
Use TypeVar to help with QObject.findChild[ren]()
altendky Sep 12, 2020
8cc9e41
At least type the inputs to multi-type findChild[ren]
altendky Sep 13, 2020
1b196b3
Merge branch 'master' into patch-4
altendky Sep 22, 2020
2a3ea2e
Merge branch 'master' into patch-4
altendky Sep 28, 2020
9f27a2b
Correct to allow multiple types in the tuples
altendky Oct 1, 2020
1060dd5
Add minimal tests for findChildren updates
altendky Oct 1, 2020
72d9bf3
Merge branch 'master' into patch-4
altendky Oct 1, 2020
42d75d0
Update CHANGELOG.md
altendky Oct 2, 2020
9eb7b8e
Make QObject.findChild() return optional
altendky Oct 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
### Added

### Changed
* [#58](https://github.com/stlehmann/PyQt5-stubs/pull/50) improves QObject.findChild and findChildren
* [#50](https://github.com/stlehmann/PyQt5-stubs/pull/50) fixes QTest QAbstractItemModelTester.FailureReportingMode attributes
* [#46](https://github.com/stlehmann/PyQt5-stubs/pull/46) fixes QCoreApplication and QObject signals
* [#48](https://github.com/stlehmann/PyQt5-stubs/pull/48) fixes some signals for QClipBoard, QWindows, QQuickView and QQml{Application,}Engine
Expand Down
19 changes: 11 additions & 8 deletions PyQt5-stubs/QtCore.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@ class pyqtSignal:
PYQT_SLOT = typing.Union[typing.Callable[..., object], pyqtBoundSignal]


QObjectT = typing.TypeVar("QObjectT", bound="QObject")


class QtMsgType(int): ...
QtDebugMsg = ... # type: QtMsgType
QtWarningMsg = ... # type: QtMsgType
Expand Down Expand Up @@ -1801,21 +1804,21 @@ class QObject(sip.wrapper):
def setObjectName(self, name: str) -> None: ...
def objectName(self) -> str: ...
@typing.overload
def findChildren(self, type: type, name: str = ..., options: typing.Union[Qt.FindChildOptions, Qt.FindChildOption] = ...) -> typing.List['QObject']: ...
def findChildren(self, type: typing.Type[QObjectT], name: str = ..., options: typing.Union[Qt.FindChildOptions, Qt.FindChildOption] = ...) -> typing.List[QObjectT]: ...
@typing.overload
def findChildren(self, types: typing.Tuple, name: str = ..., options: typing.Union[Qt.FindChildOptions, Qt.FindChildOption] = ...) -> typing.List['QObject']: ...
def findChildren(self, types: typing.Tuple[typing.Type[QObject], ...], name: str = ..., options: typing.Union[Qt.FindChildOptions, Qt.FindChildOption] = ...) -> typing.List['QObject']: ...
@typing.overload
def findChildren(self, type: type, regExp: 'QRegExp', options: typing.Union[Qt.FindChildOptions, Qt.FindChildOption] = ...) -> typing.List['QObject']: ...
def findChildren(self, type: typing.Type[QObjectT], regExp: 'QRegExp', options: typing.Union[Qt.FindChildOptions, Qt.FindChildOption] = ...) -> typing.List[QObjectT]: ...
@typing.overload
def findChildren(self, types: typing.Tuple, regExp: 'QRegExp', options: typing.Union[Qt.FindChildOptions, Qt.FindChildOption] = ...) -> typing.List['QObject']: ...
def findChildren(self, types: typing.Tuple[typing.Type[QObject], ...], regExp: 'QRegExp', options: typing.Union[Qt.FindChildOptions, Qt.FindChildOption] = ...) -> typing.List['QObject']: ...
@typing.overload
def findChildren(self, type: type, re: 'QRegularExpression', options: typing.Union[Qt.FindChildOptions, Qt.FindChildOption] = ...) -> typing.List['QObject']: ...
def findChildren(self, type: typing.Type[QObjectT], re: 'QRegularExpression', options: typing.Union[Qt.FindChildOptions, Qt.FindChildOption] = ...) -> typing.List[QObjectT]: ...
@typing.overload
def findChildren(self, types: typing.Tuple, re: 'QRegularExpression', options: typing.Union[Qt.FindChildOptions, Qt.FindChildOption] = ...) -> typing.List['QObject']: ...
def findChildren(self, types: typing.Tuple[typing.Type[QObject], ...], re: 'QRegularExpression', options: typing.Union[Qt.FindChildOptions, Qt.FindChildOption] = ...) -> typing.List['QObject']: ...
@typing.overload
def findChild(self, type: type, name: str = ..., options: typing.Union[Qt.FindChildOptions, Qt.FindChildOption] = ...) -> 'QObject': ...
def findChild(self, type: typing.Type[QObjectT], name: str = ..., options: typing.Union[Qt.FindChildOptions, Qt.FindChildOption] = ...) -> typing.Optional[QObjectT]: ...
@typing.overload
def findChild(self, types: typing.Tuple, name: str = ..., options: typing.Union[Qt.FindChildOptions, Qt.FindChildOption] = ...) -> 'QObject': ...
def findChild(self, types: typing.Tuple[typing.Type[QObject], ...], name: str = ..., options: typing.Union[Qt.FindChildOptions, Qt.FindChildOption] = ...) -> 'typing.Optional[QObject]': ...
def tr(self, sourceText: str, disambiguation: typing.Optional[str] = ..., n: int = ...) -> str: ...
def eventFilter(self, a0: 'QObject', a1: 'QEvent') -> bool: ...
def event(self, a0: 'QEvent') -> bool: ...
Expand Down
15 changes: 15 additions & 0 deletions tests/qobject.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import typing

from PyQt5 import QtCore
from PyQt5 import QtWidgets


q = QtCore.QObject()

a = q.findChildren(QtCore.QObject) # type: typing.List[QtCore.QObject]
b = q.findChildren(QtWidgets.QWidget) # type: typing.List[QtWidgets.QWidget]
c = q.findChildren((QtCore.QObject,)) # type: typing.List[QtCore.QObject]
d = q.findChildren((QtWidgets.QWidget,)) # type: typing.List[QtCore.QObject]
# desired error
# Incompatible types in assignment (expression has type "List[QObject]", variable has type "List[QWidget]")
# e = q.findChildren((QtWidgets.QWidget,)) # type: typing.List[QtWidgets.QWidget]