193 lines
8.4 KiB
Plaintext
193 lines
8.4 KiB
Plaintext
Metadata-Version: 2.1
|
||
Name: QtPy
|
||
Version: 2.3.0
|
||
Summary: Provides an abstraction layer on top of the various Qt bindings (PyQt5/6 and PySide2/6).
|
||
Home-page: https://github.com/spyder-ide/qtpy
|
||
Author: Colin Duquesnoy and the Spyder Development Team
|
||
Author-email: spyder.python@gmail.com
|
||
Maintainer: Spyder Development Team and QtPy Contributors
|
||
Maintainer-email: spyder.python@gmail.com
|
||
License: MIT
|
||
Project-URL: Github, https://github.com/spyder-ide/qtpy
|
||
Project-URL: Bug Tracker, https://github.com/spyder-ide/qtpy/issues
|
||
Project-URL: Parent Project, https://www.spyder-ide.org/
|
||
Keywords: qt PyQt5 PyQt6 PySide2 PySide6
|
||
Classifier: Development Status :: 5 - Production/Stable
|
||
Classifier: Environment :: MacOS X
|
||
Classifier: Environment :: Win32 (MS Windows)
|
||
Classifier: Environment :: X11 Applications :: Qt
|
||
Classifier: Intended Audience :: Developers
|
||
Classifier: License :: OSI Approved :: MIT License
|
||
Classifier: Operating System :: OS Independent
|
||
Classifier: Programming Language :: Python :: 3
|
||
Classifier: Programming Language :: Python :: 3 :: Only
|
||
Classifier: Programming Language :: Python :: 3.7
|
||
Classifier: Programming Language :: Python :: 3.8
|
||
Classifier: Programming Language :: Python :: 3.9
|
||
Classifier: Programming Language :: Python :: 3.10
|
||
Classifier: Topic :: Software Development :: Libraries
|
||
Classifier: Topic :: Software Development :: User Interfaces
|
||
Classifier: Topic :: Software Development :: Widget Sets
|
||
Requires-Python: >=3.7
|
||
Description-Content-Type: text/markdown
|
||
License-File: AUTHORS.md
|
||
License-File: LICENSE.txt
|
||
Requires-Dist: packaging
|
||
Provides-Extra: test
|
||
Requires-Dist: pytest (!=7.0.0,!=7.0.1,>=6) ; extra == 'test'
|
||
Requires-Dist: pytest-cov (>=3.0.0) ; extra == 'test'
|
||
Requires-Dist: pytest-qt ; extra == 'test'
|
||
|
||
# QtPy: Abstraction layer for PyQt5/PySide2/PyQt6/PySide6
|
||
|
||
[](./LICENSE)
|
||
[](https://pypi.org/project/QtPy/)
|
||
[](https://www.anaconda.com/download/)
|
||
[](https://www.anaconda.com/download/)
|
||
[](#backers)
|
||
[](https://gitter.im/spyder-ide/public)<br>
|
||
[](https://github.com/spyder-ide/qtpy)
|
||
[](https://github.com/spyder-ide/qtpy/actions)
|
||
[](https://coveralls.io/github/spyder-ide/qtpy?branch=master)
|
||
|
||
*Copyright © 2009–2022 The Spyder Development Team*
|
||
|
||
|
||
## Description
|
||
|
||
**QtPy** is a small abstraction layer that lets you
|
||
write applications using a single API call to either PyQt or PySide.
|
||
|
||
It provides support for PyQt5, PyQt6, PySide6, PySide2 using the Qt5 layout
|
||
(where the QtGui module has been split into QtGui and QtWidgets).
|
||
|
||
Basically, you can write your code as if you were using PyQt or PySide directly,
|
||
but import Qt modules from `qtpy` instead of `PyQt5`, `PySide2`, `PyQt6` or `PySide6`.
|
||
|
||
Accordingly, when porting code between different Qt bindings (PyQt vs PySide) or Qt versions (Qt5 vs Qt6), QtPy makes this much more painless, and allows you to easily and incrementally transition between them. QtPy handles incompatibilities and differences between bindings or Qt versions for you while keeping your project running, so you can focus more on your own code and less on keeping track of supporting every Qt version and binding. Furthermore, when you do want to upgrade or support new bindings, it allows you to update your project module by module rather than all at once. You can check out examples of this approach in projects using QtPy, like [git-cola](https://github.com/git-cola/git-cola/issues/232).
|
||
|
||
### Attribution and acknowledgments
|
||
|
||
This project is based on the [pyqode.qt](https://github.com/pyQode/pyqode.qt)
|
||
project and the [spyderlib.qt](https://github.com/spyder-ide/spyder/tree/2.3/spyderlib/qt)
|
||
module from the [Spyder](https://github.com/spyder-ide/spyder) project, and
|
||
also includes contributions adapted from
|
||
[qt-helpers](https://github.com/glue-viz/qt-helpers), developed as part of the
|
||
[glue](http://glueviz.org) project.
|
||
|
||
Unlike `pyqode.qt` this is not a namespace package, so it is not tied
|
||
to a particular project or namespace.
|
||
|
||
|
||
### License
|
||
|
||
This project is released under the MIT license.
|
||
|
||
|
||
### Requirements
|
||
|
||
You need PyQt5, PySide2, PyQt6 or PySide6 installed in your system to make use
|
||
of QtPy. If several of these packages are found, PyQt5 is used by
|
||
default unless you set the `QT_API` environment variable.
|
||
|
||
`QT_API` can take the following values:
|
||
|
||
* `pyqt5` (to use PyQt5).
|
||
* `pyside2` (to use PySide2).
|
||
* `pyqt6` (to use PyQt6).
|
||
* `pyside6` (to use PySide6).
|
||
|
||
|
||
### Module aliases and constants
|
||
|
||
* `QtCore.pyqtSignal`, `QtCore.pyqtSlot` and `QtCore.pyqtProperty` (available on PyQt5/6) are instead exposed as `QtCore.Signal`, `QtCore.Slot` and `QtCore.Property`, respectively, following the Qt5 module layout.
|
||
|
||
* The Qt version being used can be checked with `QtCore.__version__` (instead of `QtCore.QT_VERSION_STR`) as well as from `qtpy.QT_VERSION`.
|
||
|
||
* For PyQt6 enums, unscoped enum access was added by promoting the enums of the `QtCore`, `QtGui`, `QtTest` and `QtWidgets` modules.
|
||
|
||
* Compatibility is added between the `QtGui` and `QtOpenGL` modules for the `QOpenGL*` classes.
|
||
|
||
* To check the current binding version, you can use `qtpy.PYSIDE_VERSION` for PySide2/6 and `qtpy.PYQT_VERSION` for PyQt5/6. If the respective binding is not being used, the value of its attribute will be `None`.
|
||
|
||
* To check the current selected binding, you can use `qtpy.API_NAME`
|
||
|
||
* There are boolean values to check if Qt5/6, PyQt5/6 or PySide2/6 are being used: `qtpy.QT5`, `qtpy.QT6`, `qtpy.PYQT5`, `qtpy.PYQT6`, `qtpy.PYSIDE2` and `qtpy.PYSIDE6`. `True` if currently being used, `False` otherwise.
|
||
|
||
#### Compat module
|
||
|
||
In the `qtpy.compat` module, you can find wrappers for `QFileDialog` static methods and SIP/Shiboken functions, such as:
|
||
|
||
* `QFileDialog.getExistingDirectory` wrapped with `qtpy.compat.getexistingdirectory`
|
||
|
||
* `QFileDialog.getOpenFileName` wrapped with `qtpy.compat.getopenfilename`
|
||
|
||
* `QFileDialog.getOpenFileNames` wrapped with `qtpy.compat.getopenfilenames`
|
||
|
||
* `QFileDialog.getSaveFileName` wrapped with `qtpy.compat.getsavefilename`
|
||
|
||
* `sip.isdeleted` and `shiboken.isValid` wrapped with `qtpy.compat.isalive`
|
||
|
||
|
||
### Installation
|
||
|
||
```bash
|
||
pip install qtpy
|
||
```
|
||
|
||
or
|
||
|
||
```bash
|
||
conda install qtpy
|
||
```
|
||
|
||
|
||
### Type checker integration
|
||
|
||
A Command Line Interface (CLI) is offered to help with usage of QtPy.
|
||
Presently, its only feature is to generate command line arguments for Mypy
|
||
that will enable it to process the QtPy source files with the same API
|
||
as QtPy itself would have selected.
|
||
|
||
If you run
|
||
|
||
```bash
|
||
qtpy mypy-args
|
||
```
|
||
|
||
QtPy will output a string of Mypy CLI args that will reflect the currently
|
||
selected Qt API.
|
||
For example, in an environment where PyQt5 is installed and selected
|
||
(or the default fallback, if no binding can be found in the environment),
|
||
this would output the following:
|
||
|
||
```text
|
||
--always-true=PYQT5 --always-false=PYSIDE2 --always-false=PYQT6 --always-false=PYSIDE6
|
||
```
|
||
|
||
Using Bash or a similar shell, this can be injected into
|
||
the Mypy command line invocation as follows:
|
||
|
||
```bash
|
||
mypy --package mypackage $(qtpy mypy-args)
|
||
```
|
||
|
||
For Pyright support and other usage notes, see [this comment](https://github.com/spyder-ide/qtpy/issues/352#issuecomment-1170684412).
|
||
|
||
|
||
## Contributing
|
||
|
||
Everyone is welcome to contribute!
|
||
|
||
|
||
## Sponsors
|
||
|
||
QtPy is funded thanks to the generous support of
|
||
|
||
|
||
[](https://www.quansight.com/)[](https://numfocus.org/)
|
||
|
||
and the donations we have received from our users around the world through [Open Collective](https://opencollective.com/spyder/):
|
||
|
||
[](https://opencollective.com/spyder#support)
|