Feat/qtpy

.ci/azure-pipelines.yml

@@ -321,6 +321,11 @@ jobs:
 
   - script: |
       sudo apt-get install python3-tk
+      # The following linux deps are necessary to use the builtin xcb:
+      # https://github.com/pyvista/pyvistaqt/pull/61#issuecomment-709320826
+      sudo apt-get install -y libxkbcommon-x11-0 libxcb-icccm4 libxcb-image0    \
+                              libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 \
+                              libxcb-xinerama0 libxcb-xfixes0
       pip install -r requirements_docs.txt
     displayName: 'Install dependencies'
 

Makefile

@@ -48,7 +48,7 @@ codespell:
 
 pydocstyle:
 	@echo "Running pydocstyle"
-	@pydocstyle pyvista
+	@pydocstyle pyvistaqt
 
 coverage:
 	@echo "Running coverage"

docs/index.rst

@@ -21,7 +21,9 @@ Overview
    :alt: MIT License
 
 The python package ``pyvistaqt`` extends the
-functionality of ``pyvista`` through the usage of ``PyQt5``.  Since ``PyQt5`` operates in a separate thread than VTK, you can similtaniously have an active VTK plot and a non-blocking Python session.
+functionality of ``pyvista`` through the usage of *Qt*. 
+Since *Qt* applications operates in a separate thread than VTK,
+you can simultaneously have an active VTK plot and a non-blocking Python session.
 
 .. figure:: ./images/user-generated/qt_multiplot.png
     :width: 450pt
@@ -84,6 +86,16 @@ sphere.
 License
 *******
 
-While ``pyvistaqt`` is under the MIT license, ``pyqt5`` is subject to
-the GPL license.  Please see deails at
+``pyvistaqt`` is under the MIT license.
+However, Qt bindings have licenses of their own.
+
+Historically, ``pyvistaqt`` has used ``pyqt5``, which is subject
+to the GPL license. See details at
 `Riverbank License FAQ <https://www.riverbankcomputing.com/commercial/license-faq>`_.
+
+``pyvistaqt`` is transitioning to using ``qtpy``
+
+> QtPy is a small abstraction layer that lets you write applications using a single API call to either PyQt or PySide.
+
+Please refer to the `QtPy documentation <https://github.com/spyder-ide/qtpy>`_
+to learn more.

docs/usage.rst

@@ -6,9 +6,9 @@ Usage
 PyVista has an interface for placing plots in ``pyvistaqt`` that extends the
 functionality of the ``QVTKRenderWindowInteractor`` class.
 The ``pyvistaqt.QtInteractor`` class allows you to have the same functionality
-of the ``Plotter`` class within a ``PyQt5`` application.
+of the ``Plotter`` class within a Qt application.
 This simplifies adding meshes, updating, and controlling them when using
-``PyQt5``.
+Qt.
 
 
 Background Plotting
@@ -43,20 +43,26 @@ sphere to an empty plotting window.
 
     import sys
 
-    from PyQt5 import Qt
+    # Setting the Qt bindings for QtPy
+    import os
+    os.environ["QT_API"] = "pyqt5"
+
+    from qtpy import QtWidgets
+    from qtpy.QtWidgets import QMainWindow
+
     import numpy as np
 
     import pyvista as pv
     from pyvistaqt import QtInteractor
 
-    class MainWindow(Qt.QMainWindow):
+    class MainWindow(QMainWindow):
 
         def __init__(self, parent=None, show=True):
-            Qt.QMainWindow.__init__(self, parent)
+            QtWidgets.QMainWindow.__init__(self, parent)
 
             # create the frame
-            self.frame = Qt.QFrame()
-            vlayout = Qt.QVBoxLayout()
+            self.frame = QtWidgets.QFrame()
+            vlayout = QtWidgets.QVBoxLayout()
 
             # add the pyvista interactor object
             self.plotter = QtInteractor(self.frame)
@@ -68,14 +74,14 @@ sphere to an empty plotting window.
             # simple menu to demo functions
             mainMenu = self.menuBar()
             fileMenu = mainMenu.addMenu('File')
-            exitButton = Qt.QAction('Exit', self)
+            exitButton = QtWidgets.QAction('Exit', self)
             exitButton.setShortcut('Ctrl+Q')
             exitButton.triggered.connect(self.close)
             fileMenu.addAction(exitButton)
 
             # allow adding a sphere
             meshMenu = mainMenu.addMenu('Mesh')
-            self.add_sphere_action = Qt.QAction('Add Sphere', self)
+            self.add_sphere_action = QtWidgets.QAction('Add Sphere', self)
             self.add_sphere_action.triggered.connect(self.add_sphere)
             meshMenu.addAction(self.add_sphere_action)
 
@@ -85,12 +91,12 @@ sphere to an empty plotting window.
         def add_sphere(self):
             """ add a sphere to the pyqt frame """
             sphere = pv.Sphere()
-            self.plotter.add_mesh(sphere)
+            self.plotter.add_mesh(sphere, show_edges=True)
             self.plotter.reset_camera()
 
 
     if __name__ == '__main__':
-        app = Qt.QApplication(sys.argv)
+        app = QtWidgets.QApplication(sys.argv)
         window = MainWindow()
         sys.exit(app.exec_())
 
@@ -99,3 +105,26 @@ sphere to an empty plotting window.
     :width: 600pt
 
     PyQt5 pyvista QtInteractor
+
+
+Using Different Qt bindings
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To use different Qt bindings you must first install them.
+For example, to use *PySide2*, you install it via:
+
+.. code:: bash
+
+    pip install PySide2
+
+
+Then you set the ``QT_API`` value to the specific binding you would
+like to use:
+
+.. code:: python
+
+    os.environ["QT_API"] = "pyside2"
+
+Please refer to the
+`*QtPy* documentation page <https://github.com/spyder-ide/qtpy>`_
+for more information.

environment.yml

@@ -10,6 +10,7 @@ dependencies:
   - matplotlib
   - appdirs
   - pyqt
+  - qtpy
   - imageio>=2.5.0
   - imageio-ffmpeg
   - colorcet

mypy.ini

@@ -7,7 +7,7 @@ ignore_missing_imports = True
 [mypy-pyvista.*]
 ignore_missing_imports = True
 
-[mypy-PyQt5.*]
+[mypy-qtpy.*]
 ignore_missing_imports = True
 
 [mypy-IPython.*]

pyvistaqt/counter.py

@@ -1,17 +1,14 @@
-"""
-This module contains a basic Qt-compatible counter class.
-"""
-from PyQt5.QtCore import QObject, pyqtSignal, pyqtSlot
+"""This module contains a basic Qt-compatible counter class."""
+
+from qtpy.QtCore import QObject, Signal, Slot
 
 
 class Counter(QObject):
-    """
-    Counter class with Qt signal/slot.
-    """
+    """Counter class with Qt signal/slot."""
 
     # pylint: disable=too-few-public-methods
 
-    signal_finished = pyqtSignal()
+    signal_finished = Signal()
 
     def __init__(self, count: int) -> None:
         """Initialize the counter."""
@@ -25,7 +22,7 @@ def __init__(self, count: int) -> None:
         else:
             raise ValueError("count is not strictly positive.")
 
-    @pyqtSlot()
+    @Slot()
     def decrease(self) -> None:
         """Decrease the count."""
         self.count -= 1

pyvistaqt/dialog.py

@@ -1,14 +1,12 @@
-"""
-This module contains Qt dialog widgets.
-"""
+"""This module contains Qt dialog widgets."""
 import os
 from typing import Any, List
 
 import numpy as np  # type: ignore
 import pyvista as pv
-from PyQt5 import QtCore
-from PyQt5.QtCore import pyqtSignal
-from PyQt5.QtWidgets import (
+from qtpy import QtCore
+from qtpy.QtCore import Signal
+from qtpy.QtWidgets import (
     QDialog,
     QDoubleSpinBox,
     QFileDialog,
@@ -29,7 +27,7 @@ class FileDialog(QFileDialog):
 
     # pylint: disable=too-few-public-methods
 
-    dlg_accepted = pyqtSignal(str)
+    dlg_accepted = Signal(str)
 
     # pylint: disable=too-many-arguments
     def __init__(
@@ -196,14 +194,12 @@ def value(self, new_value: float) -> None:
 
 
 class ScaleAxesDialog(QDialog):
-    """
-    Dialog to control axes scaling.
-    """
+    """Dialog to control axes scaling."""
 
     # pylint: disable=too-few-public-methods
 
-    accepted = pyqtSignal(float)
-    signal_close = pyqtSignal()
+    accepted = Signal(float)
+    signal_close = Signal()
 
     def __init__(
         self, parent: MainWindow, plotter: pv.Plotter, show: bool = True

pyvistaqt/editor.py

@@ -1,11 +1,11 @@
-"""
-This module contains the Qt scene editor.
-"""
+"""This module contains the Qt scene editor."""
+
 from typing import List
 
 import vtk
-from PyQt5.QtCore import Qt
-from PyQt5.QtWidgets import (
+from pyvista import Renderer
+from qtpy.QtCore import Qt
+from qtpy.QtWidgets import (
     QCheckBox,
     QDialog,
     QDoubleSpinBox,
@@ -17,7 +17,6 @@
     QVBoxLayout,
     QWidget,
 )
-from pyvista import Renderer
 
 from .window import MainWindow
 

pyvistaqt/plotting.py

@@ -1,4 +1,6 @@
 """
+This module contains the QtInteractor and BackgroundPlotter.
+
 Diagram
 ^^^^^^^
 
@@ -49,9 +51,12 @@
 import pyvista
 import scooby  # type: ignore
 import vtk
-from PyQt5 import QtCore
-from PyQt5.QtCore import QSize, QTimer, pyqtSignal
-from PyQt5.QtWidgets import (  # pylint: disable=unused-import
+from pyvista.plotting.plotting import BasePlotter
+from pyvista.plotting.theme import rcParams
+from pyvista.utilities import conditional_decorator, threaded
+from qtpy import QtCore
+from qtpy.QtCore import QSize, QTimer, Signal
+from qtpy.QtWidgets import (
     QAction,
     QApplication,
     QFrame,
@@ -60,9 +65,6 @@
     QToolBar,
     QVBoxLayout,
 )
-from pyvista.plotting.plotting import BasePlotter
-from pyvista.plotting.theme import rcParams
-from pyvista.utilities import conditional_decorator, threaded
 from vtk.qt.QVTKRenderWindowInteractor import QVTKRenderWindowInteractor
 
 from .counter import Counter
@@ -74,7 +76,7 @@
     # pylint: disable=unused-import
     from IPython.external.qt_for_kernel import QtGui
 else:
-    from PyQt5 import QtGui  # pylint: disable=ungrouped-imports
+    from qtpy import QtGui  # pylint: disable=ungrouped-imports
 
 LOG = logging.getLogger("pyvistaqt")
 LOG.setLevel(logging.CRITICAL)
@@ -167,8 +169,8 @@ class QtInteractor(QVTKRenderWindowInteractor, BasePlotter):
     # pylint: disable=too-many-statements
 
     # Signals must be class attributes
-    render_signal = pyqtSignal()
-    key_press_event_signal = pyqtSignal(vtk.vtkGenericRenderWindowInteractor, str)
+    render_signal = Signal()
+    key_press_event_signal = Signal(vtk.vtkGenericRenderWindowInteractor, str)
 
     # pylint: disable=too-many-arguments
     def __init__(
@@ -301,6 +303,7 @@ def render(self) -> None:
     # pylint: disable=invalid-name,no-self-use
     def dragEnterEvent(self, event: QtGui.QDragEnterEvent) -> None:
         """Event is called when something is dropped onto the vtk window.
+
         Only triggers event when event contains file paths that
         exist.  User can drop anything in this window and we only want
         to allow files.
@@ -592,9 +595,6 @@ def __init__(
 
         # run within python
         if app is None:
-            # pylint: disable=import-outside-toplevel,redefined-outer-name,reimported
-            from PyQt5.QtWidgets import QApplication
-
             app = QApplication.instance()
             if not app:  # pragma: no cover
                 app = QApplication(["PyVista"])

pyvistaqt/window.py

@@ -1,18 +1,15 @@
-"""
-This module contains a Qt-compatible MainWindow class.
-"""
-from PyQt5 import QtCore
-from PyQt5.QtCore import pyqtSignal
-from PyQt5.QtWidgets import QMainWindow
+"""This module contains a Qt-compatible MainWindow class."""
+
+from qtpy import QtCore
+from qtpy.QtCore import Signal
+from qtpy.QtWidgets import QMainWindow
 
 
 class MainWindow(QMainWindow):
-    """
-    Convenience MainWindow that manages the application.
-    """
+    """Convenience MainWindow that manages the application."""
 
-    signal_close = pyqtSignal()
-    signal_gesture = pyqtSignal(QtCore.QEvent)
+    signal_close = Signal()
+    signal_gesture = Signal(QtCore.QEvent)
 
     def event(self, event: QtCore.QEvent) -> bool:
         """Manage window events and filter the gesture event."""

requirements_docs.txt

@@ -4,6 +4,7 @@ imageio-ffmpeg
 colorcet
 cmocean
 meshio>=4.0.3, <5.0
+qtpy
 PyQt5==5.11.3
 pytest-sphinx
 Sphinx

requirements_test.txt

@@ -6,6 +6,7 @@ pytest
 pytest-cov
 pytest-memprof
 codecov
+qtpy
 PyQt5==5.11.3
 pytest-qt
 imageio>=2.5.0

setup.py

@@ -42,7 +42,8 @@
     keywords='vtk numpy plotting mesh qt pyqt',
     python_requires='>=3.6.*',
     install_requires=['pyvista>=0.25.0',
-                      'PyQt5>=5.11.3',
+                      'QtPy>=1.9.0',
+                      'PyQt5>=5.11.3'
                       'imageio>=2.5.0',
     ],
     package_data={'pyvistaqt': [