Add more tests (#195)

Author: bluebird75

CHANGELOG.md

@@ -5,11 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## To be released
-
 ### Added
 * [#192](https://github.com./python-qt-tools/PyQt5-stubs/pull/192) Add missing platform specific stubs:
   * Windows specific: QAxContainer.pyi QtWinExtras.pyi QtCore.QWinEventNotifier
   * MacOs X specific: QtMacExtras.pyi QtWidgets.QMacCocoaViewContainer
+* [#195](https://github.com./python-qt-tools/PyQt5-stubs/pull/195) Add more tests based on the historical PR and issues:
+  * check that QTest methods are static
+  * check all pyqtSlot() usage
+  * check sip.voidptr behavior
+  * check sip.array[int] type
+  * check comparison operators for QModelIndex, QTableWidgetItem, QListWidgetItem, QTreeWidgetItem
+  * check QProgressDialog.setCancelButton() accepts optional None
+  * check signal connect() call returns a QMetaObject.Connection
+  * check argument for disconnect() is optional
+  * check QCoreApplication.instance() may return None
+
 
 ### Changed
 * [#198](https://github.com./python-qt-tools/PyQt5-stubs/pull/198) Corrected `QTableWidget.cellWidget()` to return an an optional `QWidget` instead of a list of `QWidgets`.

PyQt5-stubs/QtCore.pyi

@@ -3503,6 +3503,12 @@ class QModelIndex(sip.simplewrapper):
     def row(self) -> int: ...
     def child(self, arow: int, acolumn: int) -> 'QModelIndex': ...
 
+    def __eq__(self, other: object) -> bool: ...
+    def __ne__(self, other: object) -> bool: ...
+    def __ge__(self, other: 'QModelIndex') -> bool: ...
+    def __gt__(self, other: 'QModelIndex') -> bool: ...
+    def __le__(self, other: 'QModelIndex') -> bool: ...
+    def __lt__(self, other: 'QModelIndex') -> bool: ...
 
 class QPersistentModelIndex(sip.simplewrapper):
 

PyQt5-stubs/QtWidgets.pyi

@@ -7352,6 +7352,12 @@ class QListWidgetItem(sip.wrapper):
     def flags(self) -> QtCore.Qt.ItemFlags: ...
     def listWidget(self) -> 'QListWidget': ...
     def clone(self) -> 'QListWidgetItem': ...
+    def __eq__(self, other: object) -> bool: ...
+    def __ne__(self, other: object) -> bool: ...
+    def __ge__(self, other: 'QListWidgetItem') -> bool: ...
+    def __gt__(self, other: 'QListWidgetItem') -> bool: ...
+    def __le__(self, other: 'QListWidgetItem') -> bool: ...
+    def __lt__(self, other: 'QListWidgetItem') -> bool: ...
 
 
 class QListWidget(QListView):
@@ -10576,11 +10582,11 @@ class QTableWidgetItem(sip.wrapper):
     def tableWidget(self) -> 'QTableWidget': ...
     def clone(self) -> 'QTableWidgetItem': ...
     def __eq__(self, other: object) -> bool: ...
-    def __ge__(self, other: object) -> bool: ...
-    def __gt__(self, other: object) -> bool: ...
-    def __le__(self, other: object) -> bool: ...
-    def __lt__(self, other: object) -> bool: ...
     def __ne__(self, other: object) -> bool: ...
+    def __ge__(self, other: 'QTableWidgetItem') -> bool: ...
+    def __gt__(self, other: 'QTableWidgetItem') -> bool: ...
+    def __le__(self, other: 'QTableWidgetItem') -> bool: ...
+    def __lt__(self, other: 'QTableWidgetItem') -> bool: ...
 
 
 class QTableWidget(QTableView):
@@ -11320,6 +11326,11 @@ class QTreeWidgetItem(sip.wrapper):
     @typing.overload
     def __init__(self, other: 'QTreeWidgetItem') -> None: ...
 
+    def __eq__(self, other: object) -> bool: ...
+    def __ne__(self, other: object) -> bool: ...
+    def __ge__(self, other: 'QTreeWidgetItem') -> bool: ...
+    def __gt__(self, other: 'QTreeWidgetItem') -> bool: ...
+    def __le__(self, other: 'QTreeWidgetItem') -> bool: ...
     def __lt__(self, other: 'QTreeWidgetItem') -> bool: ...
 
     def emitDataChanged(self) -> None: ...

tests/pyqtsignal.py

@@ -5,11 +5,26 @@
 class Class(QtCore.QObject):
     signal = QtCore.pyqtSignal([str])  # type: typing.ClassVar[QtCore.pyqtSignal]
 
+    def __init__(self) -> None:
+        super().__init__()
 
+    def my_slot(self) -> None:
+        pass
+
+# check that method exists
 Class.signal.__get__
 
 instance = Class()
 instance.signal.emit
 instance.signal.connect
 instance.signal.disconnect
 instance.signal[str].emit
+
+# use some of them
+connection = QtCore.QMetaObject.Connection()
+
+connection = instance.signal.connect(instance.my_slot)
+instance.signal.disconnect()
+connection = instance.signal.connect(instance.my_slot)
+instance.signal.disconnect(connection)
+

tests/pyqtslot.py

@@ -1,4 +1,6 @@
-from PyQt5.QtCore import pyqtSlot
+from typing import Union
+
+from PyQt5.QtCore import pyqtSlot, QObject
 
 @pyqtSlot(str)
 def func_none(s: str) -> None:
@@ -8,9 +10,84 @@ def func_none(s: str) -> None:
 def func_int(s: str) -> int:
     return 42
 
-@pyqtSlot(str, result='int')
+@pyqtSlot(str, result='int')    # this means int here
 def func_str(s: str) -> str:
     return '42'
 
-func_none("test")
-x = func_int("test")  # type: int
+@pyqtSlot(str, name='toto', revision=33, result=int)
+def func_toto(s: str) -> int:
+    return 33
+
+n = None
+n = func_none("test")
+
+i = 0
+i = func_int("test")
+
+s = ''
+s = func_str('test')
+
+print( func_toto('123') )
+
+### Other example extracted from pyqtSlot documentation
+
+class Foo(QObject):
+
+    @pyqtSlot()
+    def foo_noarg(self) -> None:
+        """ C++: void foo() """
+        pass
+
+    @pyqtSlot(int, str)
+    def foo_int_str(self, arg1: int, arg2: str) -> None:
+        """ C++: void foo(int, QString) """
+        pass
+
+    @pyqtSlot(int, name='bar')
+    def foo_int(self, arg1: int) -> None:
+        """ C++: void bar(int) """
+        pass
+
+    @pyqtSlot(int, result=int)
+    def foo_int2(self, arg1: int) -> int:
+        """ C++: int foo(int) """
+        pass
+
+    # make sure that the return type is type-checked
+    @pyqtSlot(int, result=int)  # type: ignore[arg-type]
+    def foo_int_with_return_arg_error(self, arg1: int) -> str:
+        """ C++: int foo(int) """
+        pass
+
+    # mypy can not typecheck the pyqtSlot() arguments vs method arguments
+    @pyqtSlot(int, result=int)
+    def foo_int_with_arg_error(self, arg1: str) -> int:
+        """ C++: int foo(int) """
+        pass
+
+    @pyqtSlot(int, QObject)
+    def foo_qobject(self, arg1: QObject) -> None:
+        """ C++: int foo(int, QObject *) """
+        pass
+
+    @pyqtSlot(int)
+    @pyqtSlot('QString')
+    def valueChanged(self, value: Union[int, str]) -> None:
+        """ Two slots will be defined in the QMetaObject. """
+        pass
+
+
+f = Foo()
+
+n = f.foo_noarg()
+
+n = f.foo_int_str(33, 'abc')
+
+n = f.foo_int(33)
+
+i = f.foo_int2(33)
+
+n = f.foo_qobject(QObject())
+
+n = f.valueChanged(33)
+n = f.valueChanged('abc')

tests/qapplication.py

@@ -0,0 +1,9 @@
+from typing import Optional
+
+from PyQt5.QtCore import QCoreApplication
+
+# let the default type propagate to app
+app = QCoreApplication.instance()
+
+# ensure that QCoreApplication.instance() may also return None
+app = None

tests/qmodelindex.py

@@ -0,0 +1,13 @@
+from PyQt5.QtCore import QModelIndex
+
+qmi = QModelIndex()
+qmi = qmi.siblingAtRow(33)
+qmi = qmi.siblingAtColumn(45)
+
+result = True
+result = (qmi == qmi)
+result = (qmi != qmi)
+result = (qmi <= qmi)
+result = (qmi >= qmi)
+result = (qmi < qmi)
+result = (qmi > qmi)

tests/qprogressdialog.py

@@ -0,0 +1,10 @@
+from typing import Optional
+from PyQt5.QtWidgets import QProgressDialog, QPushButton
+
+qpd = QProgressDialog()
+button1 = None   # type: Optional[QPushButton]
+button2 = None
+button3 = QPushButton()
+qpd.setCancelButton(button1)
+qpd.setCancelButton(button2)
+qpd.setCancelButton(button3)

tests/qtest.py

@@ -0,0 +1,5 @@
+from PyQt5.QtTest import QTest
+
+# check that this is a static method
+QTest.qWait(33)
+

tests/qtreewidgetitem.py

@@ -0,0 +1,15 @@
+from PyQt5.QtDataVisualization import QCustom3DVolume
+from PyQt5 import sip
+
+v = sip.voidptr(0)
+a = v.asarray(1)
+
+volume = QCustom3DVolume()
+volume.setTextureData(a)
+a = volume.textureData()
+
+# more voidptr tests
+v = sip.voidptr(None)
+v = sip.voidptr(b'123', 0)
+v = sip.voidptr(bytearray(b'123'), 0, False)
+v = sip.voidptr(v)

tests/siparray.py

@@ -0,0 +1,60 @@
+from PyQt5.QtWidgets import QTableWidgetItem, QListWidgetItem, QTreeWidgetItem
+
+
+qti = QTableWidgetItem('')
+
+# Check all comparison informtaion
+result = True
+result = (qti == qti)
+result = (qti != qti)
+result = (qti <= qti)
+result = (qti >= qti)
+result = (qti < qti)
+result = (qti > qti)
+
+try:
+    # comparison does not work, there should be also a type error
+    result = qti < object() # type: ignore[operator]
+except TypeError:
+    pass
+
+class MyTableWidgetItem(QTableWidgetItem):
+
+    # add comparison indicator to allow custom sorting of items
+    def __lt__(self, other: QTableWidgetItem) -> bool:
+        return super().__lt__(other)
+
+
+qli = QListWidgetItem()
+result = True
+result = (qli == qli)
+result = (qli != qli)
+result = (qli <= qli)
+result = (qli >= qli)
+result = (qli < qli)
+result = (qli > qli)
+
+class MyListWidgetItem(QListWidgetItem):
+
+    # add comparison indicator to allow custom sorting of items
+    def __lt__(self, other: QListWidgetItem) -> bool:
+        return super().__lt__(other)
+
+
+qtwi = QTreeWidgetItem([])
+result = True
+result = (qtwi == qtwi)
+result = (qtwi != qtwi)
+result = (qtwi <= qtwi)
+result = (qtwi >= qtwi)
+result = (qtwi < qtwi)
+result = (qtwi > qtwi)
+
+
+class MyTreeWidgetItem(QTreeWidgetItem):
+
+    # add comparison indicator to allow custom sorting of items
+    def __lt__(self, other: QTreeWidgetItem) -> bool:
+        return super().__lt__(other)
+
+