<img src="http://mypy-lang.org/static/mypy_light.svg" alt="mypy logo" width="100px"/> [](https://github.com/python-qt-tools/PySide6-stubs/actions/workflows/ci.yml)
# Mypy stubs for the PySide6 (Qt6 for Python)
*Author :* Philippe Fremy
This package provides improved typing stubs for [Qt6 for Python/PySide6](https://pypi.org/project/PySide6/). The
official stubs delivered along with PySide6 are insufficent
for proper typing verification with `mypy`.
### Notable improvements:
* add all missing signals to the stubs (many were missing)
* add conversion from `QByteArray` to `bytes`
* add construction of `QByteArray` from length and string
* fix `QFileDialog.getOpen*()` methods to accept `None` as parent argument
* fix `QLineEdit.setText()` to accept `None`
* fix `QTreeWidget.setItemWidget()` and `QListWidget.setItemWidget()` to accept `None` as a widget argument
* fix `QProgressDialog.setCancelButton()` accepting `None`
* support all `QSize` and `QSizeF` operations
* fix `QTabBar.setButtonWidget()` to accept `None` as a widget argument
* fix `QTreeWidget.topLevelItem()` returning possibly `None`
* fix `QTreeWidgetItem` comparison with `<`
* fix `QMessageBox.warning`, `information`, `critical`, `question`, `about`, `aboutQt` to accept `None` as parent argument
* fix `qVersion()` returns string, not bytes
* fix `qDebug()`, `qWarning()`, `qCritical()`, `qFatal()`, `SIGNAL()`, `SLOT()` to accept string, not bytes
* fix `Signal.connect()`, `Signal.disconnect()`, `QObject.connect()` and `QObject.disconnect()` to accept `str` instead
of `bool`, and to return `bool` on disconnect.
* fix incorrect signature of `QCoreApplication.translate()`
* improve signature of operations on `QPolygon`
See [CHANGELOG.md](CHANGELOG.md) for full details.
This effort was inspired by the PyQt5-stubs and PySide2-stubs project.
Please note that this work is far from complete. Don't hesitate to report problems or propose improvements.
# Licensing
As a derived work from PySide6, the stubs are delivered under the LGPL v2.1 . See file LICENSE for more details.
# Installation
Today, this work exists only inside the Git repository. So the installation command is:
$ pip install git+https://github.com/python-qt-tools/PySide6-stubs
As soon as a Python pip package is created, this will be reflected in the recommendations here.
# Help improve the stubs
If you notice incorrect or missing typing information (mypy reports errors eventhough your code is correct), please report it
here with the following steps:
* create an issue showing your problem
* even better, create a PR to fix the problem. See CONTRIBUTING.md for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/python-qt-tools/PySide6-stubs",
"name": "PySide6-stubs",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Philippe Fremy",
"author_email": "phil.fremy@free.fr",
"download_url": "https://files.pythonhosted.org/packages/71/85/1c504346a5da5b69ba59a235a897430dc302b9d3c12c4d41a849e4b5aff4/PySide6-stubs-6.4.2.0.tar.gz",
"platform": null,
"description": "<img src=\"http://mypy-lang.org/static/mypy_light.svg\" alt=\"mypy logo\" width=\"100px\"/> [](https://github.com/python-qt-tools/PySide6-stubs/actions/workflows/ci.yml)\r\n\r\n\r\n# Mypy stubs for the PySide6 (Qt6 for Python)\r\n\r\n*Author :* Philippe Fremy\r\n\r\nThis package provides improved typing stubs for [Qt6 for Python/PySide6](https://pypi.org/project/PySide6/). The \r\nofficial stubs delivered along with PySide6 are insufficent \r\nfor proper typing verification with `mypy`.\r\n\r\n### Notable improvements:\r\n* add all missing signals to the stubs (many were missing)\r\n* add conversion from `QByteArray` to `bytes`\r\n* add construction of `QByteArray` from length and string\r\n* fix `QFileDialog.getOpen*()` methods to accept `None` as parent argument\r\n* fix `QLineEdit.setText()` to accept `None`\r\n* fix `QTreeWidget.setItemWidget()` and `QListWidget.setItemWidget()` to accept `None` as a widget argument\r\n* fix `QProgressDialog.setCancelButton()` accepting `None`\r\n* support all `QSize` and `QSizeF` operations\r\n* fix `QTabBar.setButtonWidget()` to accept `None` as a widget argument\r\n* fix `QTreeWidget.topLevelItem()` returning possibly `None`\r\n* fix `QTreeWidgetItem` comparison with `<`\r\n* fix `QMessageBox.warning`, `information`, `critical`, `question`, `about`, `aboutQt` to accept `None` as parent argument\r\n* fix `qVersion()` returns string, not bytes\r\n* fix `qDebug()`, `qWarning()`, `qCritical()`, `qFatal()`, `SIGNAL()`, `SLOT()` to accept string, not bytes\r\n* fix `Signal.connect()`, `Signal.disconnect()`, `QObject.connect()` and `QObject.disconnect()` to accept `str` instead\r\n of `bool`, and to return `bool` on disconnect.\r\n* fix incorrect signature of `QCoreApplication.translate()`\r\n* improve signature of operations on `QPolygon`\r\n\r\n\r\nSee [CHANGELOG.md](CHANGELOG.md) for full details.\r\n\r\nThis effort was inspired by the PyQt5-stubs and PySide2-stubs project.\r\n\r\nPlease note that this work is far from complete. Don't hesitate to report problems or propose improvements.\r\n\r\n\r\n# Licensing\r\nAs a derived work from PySide6, the stubs are delivered under the LGPL v2.1 . See file LICENSE for more details.\r\n\r\n\r\n# Installation\r\n\r\nToday, this work exists only inside the Git repository. So the installation command is:\r\n\r\n $ pip install git+https://github.com/python-qt-tools/PySide6-stubs\r\n\r\nAs soon as a Python pip package is created, this will be reflected in the recommendations here.\r\n\r\n\r\n# Help improve the stubs\r\n\r\nIf you notice incorrect or missing typing information (mypy reports errors eventhough your code is correct), please report it\r\nhere with the following steps:\r\n\r\n* create an issue showing your problem\r\n* even better, create a PR to fix the problem. See CONTRIBUTING.md for details.\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "LGPL v2.1",
"summary": "PEP561 stub files for the *Qt for Python/PySide6* framework",
"version": "6.4.2.0",
"project_urls": {
"Bug Tracker": "https://github.com/python-qt-tool/pyside6-stubs/issues",
"Homepage": "https://github.com/python-qt-tools/PySide6-stubs"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "44752e5f1bab9445805971d52563684a14fccf2a835b101f8f392db32cf631c5",
"md5": "eda35e1c22f20a4e2c76915da898a852",
"sha256": "e825ded4b3555d540f297f405e3a9dc0943c032a96c53184cf644a8e4c4a6b0b"
},
"downloads": -1,
"filename": "PySide6_stubs-6.4.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eda35e1c22f20a4e2c76915da898a852",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 469627,
"upload_time": "2023-07-27T07:33:27",
"upload_time_iso_8601": "2023-07-27T07:33:27.578853Z",
"url": "https://files.pythonhosted.org/packages/44/75/2e5f1bab9445805971d52563684a14fccf2a835b101f8f392db32cf631c5/PySide6_stubs-6.4.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "71851c504346a5da5b69ba59a235a897430dc302b9d3c12c4d41a849e4b5aff4",
"md5": "7ca47972b3eb28924fc7a9cc5886f49d",
"sha256": "d5578eb1597d1c07831c899b35636410b08915a4695ce6e41cceb6707c400fcf"
},
"downloads": -1,
"filename": "PySide6-stubs-6.4.2.0.tar.gz",
"has_sig": false,
"md5_digest": "7ca47972b3eb28924fc7a9cc5886f49d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 433881,
"upload_time": "2023-07-27T07:33:40",
"upload_time_iso_8601": "2023-07-27T07:33:40.698364Z",
"url": "https://files.pythonhosted.org/packages/71/85/1c504346a5da5b69ba59a235a897430dc302b9d3c12c4d41a849e4b5aff4/PySide6-stubs-6.4.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-27 07:33:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "python-qt-tools",
"github_project": "PySide6-stubs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pyside6-stubs"
}
JSON
