Add PyQt6 and PySide{2,6} support.

Author: bwoodsend

docs/source/Figures.rst

@@ -8,7 +8,7 @@ This section outlines:
 * General figure management.
 * Functions for controlling the camera position.
 * Screenshotting the figure contents to a frozen image (file).
-* Embedding a figure into PyQt5_.
+* Embedding a figure into PyQt6_.
 
 Overview
 --------

docs/source/conf.py

@@ -159,7 +159,7 @@ def add_url(name, url):
     'python': ('http://docs.python.org/3', None),
     'numpy': ('https://numpy.org/doc/stable/', None),
     'scipy': ('https://docs.scipy.org/doc/scipy/', None),
-    'PyQt5': ('https://www.riverbankcomputing.com/static/Docs/PyQt5/', None),
+    'PyQt6': ('https://www.riverbankcomputing.com/static/Docs/PyQt6/', None),
     'wxPython': ('https://docs.wxpython.org/', None),
     'matplotib': ('https://matplotlib.org', None),
     'pillow': ('https://pillow.readthedocs.io/en/stable/', None),
@@ -169,7 +169,7 @@ def add_url(name, url):
 def setup(app):
     # type: (Sphinx) -> None
 
-    # PyQt5 has all its cross reference targets in a special :sip: domain which
+    # PyQt6 has all its cross reference targets in a special :sip: domain which
     # needs to be registered to be used. Don't ask me how this works. It's
     # mostly guess work and copy/paste from sphinx.domains.c.CDomain.
 

docs/source/lookup_example.rst

@@ -67,4 +67,4 @@ Or, for time-critical applications, using a KDTree from either
 Note that having a ``MouseMoveEvent`` which modifies the contents of a figure and
 therefore requires ``fig.update()`` to be called for every such event requires a
 lot of processing power. A better option is to use an output outside of the
-renderer such as a `PyQt5.QtWidgets.QLabel`.
+renderer such as a `PyQt6.QtWidgets.QLabel`.

docs/source/quickstart.rst

@@ -30,7 +30,7 @@ Key features
 * Clean and easy to install.
 * Takes advantage of VTK's lesser known numpy support so that data can be efficiently copied by reference between numpy and VTK making it much faster than most of the VTK examples you'll find online.
 * Has direct support for STL plotting.
-* Can be embedded seamlessly into `PyQt5`_ applications.
+* Can be embedded seamlessly into `PyQt6`_ (or PyQt5, PySide2 or PySide6) applications.
 * Is freezable with `PyInstaller`_.
 
 
@@ -63,14 +63,14 @@ Optional requirements:
 Some features require you to install the following:
 
  - `numpy-stl`_ or any other STL library if you want to plot STL files. `numpy-stl`_ is my STL library of choice.
- - `PyQt5`_ if you want to include your plots in a larger Qt GUI.
+ - `PyQt6`_ if you want to include your plots in a larger Qt GUI.
  - `namegenerator`_ for fun.
 
 
 .. _numpy: http://numpy.org/
 .. _matplotlib: http://matplotlib.org/
 .. _vtk: https://pypi.org/project/vtk/
-.. _PyQt5: https://pypi.org/project/PyQt5/
+.. _PyQt6: https://pypi.org/project/PyQt6/
 .. _numpy-stl: https://pypi.org/project/numpy-stl/
 .. _PyInstaller: https://www.pyinstaller.org/
 .. _namegenerator: https://pypi.org/project/namegenerator/

docs/source/rst_prolog.txt

@@ -13,7 +13,7 @@
 .. _numpy: http://numpy.org/
 .. _matplotlib: http://matplotlib.org/
 .. _vtk: https://pypi.org/project/vtk/
-.. _PyQt5: https://pypi.org/project/PyQt5/
+.. _PyQt6: https://pypi.org/project/PyQt6/
 .. _numpy-stl: https://pypi.org/project/numpy-stl/
 .. _PyInstaller: https://www.pyinstaller.org/
 .. _namegenerator: https://pypi.org/project/namegenerator/

setup.py

@@ -34,7 +34,7 @@
         "test_full": [
             "pytest",
             "pytest-order",
-            "PyQt5",
+            "PyQt6",
             "numpy-stl",
             "namegenerator",
             "pillow",

tests/_common.py

@@ -3,203 +3,13 @@
 Shared variables/markers for testing.
 """
 
-import os
-import numpy as np
 from pathlib import Path
 
 import pytest
 
-try:
-    import inspect
-
-except ImportError:
-    VTKPLOTLIB_WINDOWLESS_TEST = False
-    DEFAULT_MODE = ""
-else:
-    VTKPLOTLIB_WINDOWLESS_TEST = bool(
-        int(os.environ.get("VTKPLOTLIB_WINDOWLESS_TEST", "0")))
-
-    if VTKPLOTLIB_WINDOWLESS_TEST:
-        DEFAULT_MODE = "r"
-    else:
-        DEFAULT_MODE = "w"
-
 TEST_DIR = Path(__file__).parent.absolute().resolve() / "temp"
 TEST_DIR.mkdir(exist_ok=True)
 
 
-class AutoChecker(object):
-    """Attempts to assess reproducibility of visualisations between runs so I
-    don't have to manually click through each test to verify that it looks OK.
-
-    Wraps around any test function which plots something but doesn't call
-    ``vpl.show()`` at the end. The wrapped function, if called in **write** mode
-    (determined by the **mode** argument to that newly wrapped function) it will
-    call the original function, screenshot and store the image, then call
-    ``vpl.show()`` so you can verify it. If called in **read** mode, then it
-    will call the original function, screenshot the result and verify it matches
-    the stored one, then closes so that you don't have to interact with it."""
-
-    def __init__(self):
-        self.path = TEST_DIR / "test-data.json"
-        self.load()
-
-    def auto_check_contents(self, test_func):
-        name = self.name_function(test_func)
-
-        def wrapped(testcase=None, mode=DEFAULT_MODE):
-            from vtkplotlib.figures.figure_manager import gcf, close, show
-
-            close()
-
-            np.random.seed(0)
-            if testcase is None:
-                out = test_func()
-            else:
-                out = test_func(testcase)
-            from vtkplotlib.plots.BasePlot import BasePlot
-            from vtkplotlib.figures.BaseFigure import BaseFigure
-            if isinstance(out, BasePlot):
-                out = None
-            if out is None:
-                out = gcf()
-
-            if isinstance(out, BaseFigure):
-                fig = out
-            else:
-                fig = "gcf"
-
-            if mode == "r":
-                correct_value = self.data[name]
-                self.validate(self.reduce(out), correct_value)
-                close(fig=fig)
-            elif mode == "w":
-                self.data[name] = self.reduce(out)
-                if not isinstance(out, np.ndarray):
-                    show(fig=fig)
-                self.save()
-            else:
-                show(fig=fig)
-
-        return wrapped
-
-    __call__ = auto_check_contents
-
-    @staticmethod
-    def reduce_image_array(arr):
-        """Serialise an image array into something that can go into a json file
-        i.e plain text."""
-        # Ideally I'd just use 'shape' and 'crc32_checksum' but there are
-        # subtle, visually invisible differences between snapshots from
-        # different OSs and VTK versions. So image matching must be fuzzy
-        # meaning we have to store the whole image.
-        # Interestingly bz2 gives better compression than PNG.
-        import zlib, bz2, base64
-        return {
-            "shape": list(arr.shape),
-            "crc32_checksum": zlib.crc32(arr.tobytes("C")),
-            "image": base64.b64encode(bz2.compress(arr.tobytes("C"))).decode()
-        }
-
-    @classmethod
-    def reduce_fig(cls, fig):
-        from vtkplotlib.figures.figure_manager import screenshot_fig
-        return cls.reduce_image_array(screenshot_fig(fig=fig))
-
-    @classmethod
-    def reduce(cls, obj):
-        if isinstance(obj, dict):
-            return obj
-        if isinstance(obj, np.ndarray):
-            return cls.reduce_image_array(obj)
-        return cls.reduce_fig(obj)
-
-    def save(self):
-        import json
-        text = json.dumps(self.data, indent=2)
-        self.path.write_text(text)
-
-    def load(self):
-        import json
-        if self.path.exists():
-            text = self.path.read_text()
-            self.data = json.loads(text)
-        else:
-            self.data = {}
-
-    @staticmethod
-    def name_function(func):
-        module = inspect.getmodulename(func.__code__.co_filename)
-        name = str(module) + "." + func.__name__
-        assert "__main__" not in name
-        return name
-
-    def validate(self, old_dic, new_dic):
-        assert old_dic["shape"] == new_dic["shape"]
-        if old_dic["crc32_checksum"] == new_dic["crc32_checksum"]:
-            return True
-        old_im = self.extract_dic_image(old_dic)
-        new_im = self.extract_dic_image(new_dic)
-        self.assertLess(np.abs(old_im - new_im.astype(float)).mean(), 5)
-
-    @staticmethod
-    def extract_dic_image(dic):
-        import bz2, base64
-        shape = dic["shape"]
-        bin = bz2.decompress(base64.b64decode(dic["image"].encode()))
-        arr = np.frombuffer(bin, np.uint8).reshape(shape)
-        return arr
-
-    def show_saved(self, func_name):
-        from matplotlib import pylab
-        pylab.imshow(self.extract_dic_image(self.data[func_name]))
-        pylab.show()
-
-
-_checker = None
-
-
-def checker(*no_arguments):
-    if len(no_arguments):
-        raise TypeError("Checker takes no arguments. You probably forgot the "
-                        "parenthesis. Should be `@checker()\\n"
-                        "def function...`.")
-    global _checker
-    if _checker is None:
-        _checker = AutoChecker()
-    return _checker
-
-
-def reset():
-    checker().data.clear()
-    checker().save()
-    global _checker
-    _checker = None
-
-
-@checker()
-def test_quick_test_plot():
-    import vtkplotlib as vpl
-    vpl.quick_test_plot()
-
-
-def test_checker():
-
-    test_quick_test_plot(mode=DEFAULT_MODE and "w")
-
-    checker().save()
-    checker().load()
-
-    test_quick_test_plot(mode=DEFAULT_MODE and "r")
-
-
-requires_interaction = pytest.mark.skipif(VTKPLOTLIB_WINDOWLESS_TEST,
-                                          reason="Requires manual interaction.")
-
-
 def numpy_stl():
     return pytest.importorskip("stl.mesh", reason="Requires numpy-stl")
-
-
-if __name__ == "__main__":
-    test_checker()

tests/test_colors.py

@@ -11,8 +11,6 @@
 
 from matplotlib import cm
 
-from tests._common import checker
-
 pytestmark = pytest.mark.order(0)
 
 # Target output. Everything below should normalise to this.
@@ -31,15 +29,6 @@
     (u"bright green", A, None),
 ]
 
-try:
-    from PyQt5.QtGui import QColor
-    parameters += [
-        (QColor(*(int(i * 255) for i in RGB)), A, None),
-        (QColor("#01FF06"), A, None),
-    ]
-except ImportError:
-    pass
-
 
 @pytest.mark.parametrize(("rgb", "a", "warns"), parameters)
 def test_as_rgb_a(rgb, a, warns):