fix(wheel): ship the fvtk.qt subpackage so pyvistaqt imports (#142) (#145)

Author: akaszynski

build-fvtk.sh

@@ -153,16 +153,17 @@ if [ "${FVTK_STRIP:-0}" = "1" ]; then
     echo "WARN: no strip binary found; wheel ships unstripped" >&2
   fi
 fi
-# Drop the GTK/Qt/Tk/wx UI-interactor helper packages — pyvista never imports
-# them (its Qt path is the separate pyvistaqt package). They're pure-Python so
-# they cost nothing to build, but they're junk for a pyvista wheel. The
-# generated setup.py hardcodes them in packages=[...]; remove both the dirs and
-# the setup.py references so bdist_wheel doesn't fail on the missing dirs.
-for sub in gtk qt test tk wx; do
+# Drop the GTK/Tk/wx/test UI-interactor helper packages — pyvista never imports
+# them. They're pure-Python so they cost nothing to build, but they're junk for a
+# pyvista wheel. The generated setup.py hardcodes them in packages=[...]; remove
+# both the dirs and the setup.py references so bdist_wheel doesn't fail on the
+# missing dirs. KEEP qt: pyvistaqt imports vtkmodules.qt (-> fvtk.qt) at import
+# time, so dropping it breaks pyvistaqt (gh-142).
+for sub in gtk test tk wx; do
   rm -rf "$BUILD/fvtk/$sub" "$BUILD"/build/lib.*/fvtk/$sub 2>/dev/null || true
 done
 if [ -f "$BUILD/setup.py" ]; then
-  sed -i -E "/'fvtk\.(gtk|qt|tk|wx|test)',?/d" "$BUILD/setup.py"
+  sed -i -E "/'fvtk\.(gtk|tk|wx|test)',?/d" "$BUILD/setup.py"
 fi
 
 echo "=== wheel ==="

ci/prune_setup_py.py

@@ -1,11 +1,15 @@
 #!/usr/bin/env python3
-"""Prune UI-interactor subpackages from the generated wheel build tree.
+"""Prune dead UI-interactor subpackages from the generated wheel build tree.
 
-PyVista never imports the gtk/qt/tk/wx/test helper subpackages (its Qt path is
-the separate pyvistaqt package), but VTK's generated setup.py hardcodes them in
-``packages=[...]``. Remove both the directories and the setup.py references so
-``setup.py bdist_wheel`` doesn't fail on missing dirs. Mirrors the same step in
-build-fvtk.sh.
+PyVista never imports the gtk/tk/wx/test helper subpackages, but VTK's generated
+setup.py hardcodes them in ``packages=[...]``. Remove both the directories and the
+setup.py references so ``setup.py bdist_wheel`` doesn't fail on missing dirs.
+Mirrors the same step in build-fvtk.sh.
+
+The ``qt`` subpackage is deliberately KEPT: pyvistaqt imports ``vtkmodules.qt``
+(redirected to ``fvtk.qt``) for ``PyQtImpl`` / ``QVTKRenderWindowInteractor``, and
+dropping it breaks pyvistaqt at import time (gh-142). It is pure Python and pulls
+in no Qt binding unless one is already imported, so shipping it is free.
 
 Usage:  python ci/prune_setup_py.py <build_dir>
 """
@@ -16,7 +20,7 @@
 import shutil
 import sys
 
-SUBPACKAGES = ("gtk", "qt", "tk", "wx", "test")
+SUBPACKAGES = ("gtk", "tk", "wx", "test")
 
 
 def main(build_dir: str) -> int:
@@ -38,7 +42,7 @@ def main(build_dir: str) -> int:
         with open(setup_py, "r", encoding="utf-8") as fh:
             text = fh.read()
         pat = re.compile(
-            r"^.*'(?:vtkmodules|fvtk)\.(?:gtk|qt|tk|wx|test)',?.*$\n?",
+            r"^.*'(?:vtkmodules|fvtk)\.(?:gtk|tk|wx|test)',?.*$\n?",
             re.MULTILINE,
         )
         new_text, n = pat.subn("", text)

ci/smoke_min.py

@@ -32,6 +32,13 @@ def main() -> int:
     cc = import_module(f"{IMPORT_NAME}.vtkCommonCore")
     print(f"smoke_min: VTK_VERSION = {cc.vtkVersion.GetVTKVersion()}")
 
+    # The qt helper subpackage must ship so pyvistaqt (imports vtkmodules.qt ->
+    # fvtk.qt) keeps working (gh-142). Pure Python; binds no Qt unless one is
+    # already imported.
+    qt = import_module(f"{IMPORT_NAME}.qt")
+    assert hasattr(qt, "PyQtImpl"), f"{IMPORT_NAME}.qt missing PyQtImpl"
+    print(f"smoke_min: {IMPORT_NAME}.qt present")
+
     # Non-rendering filter pipeline: sphere -> triangulate. Exercises the
     # Filters/Sources + Filters/Core kits and the Python wrapper bridge without
     # touching OpenGL.

ci/smoke_test.py

@@ -33,9 +33,18 @@ def main() -> int:
     except Exception as exc:  # noqa: BLE001
         print(f"smoke: WARNING could not read VTK version: {exc}")
 
+    from importlib import import_module
+
+    # The qt helper subpackage must ship: pyvistaqt imports vtkmodules.qt
+    # (redirected to fvtk.qt) at import time, so a wheel that drops it breaks
+    # pyvistaqt (gh-142). It is pure Python and binds no Qt unless one is already
+    # imported, so this import is safe with no Qt installed.
+    qt = import_module(f"{IMPORT_NAME}.qt")
+    assert hasattr(qt, "PyQtImpl"), f"{IMPORT_NAME}.qt missing PyQtImpl"
+    print(f"smoke: {IMPORT_NAME}.qt present (PyQtImpl={qt.PyQtImpl})")
+
     # Offscreen render: prove the OpenGL/render-window stack is importable and
     # can produce a frame headlessly.
-    from importlib import import_module
 
     # autoinit wires the rendering factory overrides.
     import_module(f"{IMPORT_NAME}.vtkRenderingOpenGL2")