fix: Refactor to have independent backend

Author: AlejandroFernandezLuces

.github/workflows/ci_cd.yml

@@ -69,7 +69,7 @@ jobs:
   docs-build:
     name: Documentation Build
     runs-on: ubuntu-latest
-    # needs: [docs-style]
+    needs: [docs-style]
     steps:
     - name: Install system dependencies
       run: sudo apt install -qq libglu1-mesa-dev libx11-xcb-dev '^libxcb*'
@@ -104,7 +104,7 @@ jobs:
 
   testing:
     name: Run Unit Tests
-    # needs: [ smoke-tests ]
+    needs: [ smoke-tests ]
     runs-on: ubuntu-latest
     steps:
       - name: Install system dependencies

examples/00-basic-pyvista-examples/qt_backend.py

@@ -37,15 +37,17 @@
 import pyvista as pv
 
 from ansys.tools.visualization_interface import Plotter
-from ansys.tools.visualization_interface.backends.pyvista import PyVistaBackend
+from ansys.tools.visualization_interface.backends.pyvista.pyvistaqt_interface import (
+    PyVistaQtBackend,
+)
 
 #########################
 # Open a pyvistaqt window
 # =======================
 # .. code-block:: python
 #
 #    cube = pv.Cube()
-#    pv_backend = PyVistaBackend(use_qt=True)
+#    pv_backend = PyVistaQtBackend()
 #    pl = Plotter(backend=pv_backend)
 #    pl.plot(cube)
 #    pl.show()

src/ansys/tools/visualization_interface/backends/pyvista/pyvista.py

@@ -88,8 +88,6 @@ class PyVistaBackendInterface(BaseBackend):
         Whether to plot the names of the picked objects.
     show_plane : Optional[bool], default: False
         Whether to show the plane in the plotter.
-    use_qt : Optional[bool], default: False
-        Whether to use the Qt backend for the plotter.
     """
 
     def __init__(
@@ -99,14 +97,12 @@ def __init__(
         allow_hovering: Optional[bool] = False,
         plot_picked_names: Optional[bool] = False,
         show_plane: Optional[bool] = False,
-        use_qt: Optional[bool] = False,
         **plotter_kwargs,
     ) -> None:
         """Initialize the ``use_trame`` parameter and save the current ``pv.OFF_SCREEN`` value."""
         # Check if the use of trame was requested
         if use_trame is None:
             use_trame = ansys.tools.visualization_interface.USE_TRAME
-        self._use_qt = use_qt
         self._use_trame = use_trame
         self._allow_picking = allow_picking
         self._allow_hovering = allow_hovering
@@ -153,7 +149,7 @@ def __init__(
             logger.warning(warn_msg)
             self._pl = PyVistaInterface(show_plane=show_plane)
         else:
-            self._pl = PyVistaInterface(show_plane=show_plane, use_qt=use_qt, **plotter_kwargs)
+            self._pl = PyVistaInterface(show_plane=show_plane, **plotter_kwargs)
 
         self._enable_widgets = self._pl._enable_widgets
 
@@ -182,8 +178,7 @@ def enable_widgets(self):
             ]
             self._widgets.append(MeasureWidget(self))
             self._widgets.append(ScreenshotButton(self))
-            if not self._use_qt:
-                self._widgets.append(MeshSliderWidget(self))
+            self._widgets.append(MeshSliderWidget(self))
             self._widgets.append(HideButton(self))
 
     def add_widget(self, widget: Union[PlotterWidget, List[PlotterWidget]]):
@@ -550,10 +545,9 @@ def __init__(
         allow_picking: Optional[bool] = False,
         allow_hovering: Optional[bool] = False,
         plot_picked_names: Optional[bool] = True,
-        use_qt: Optional[bool] = False
     ) -> None:
         """Initialize the generic plotter."""
-        super().__init__(use_trame, allow_picking, allow_hovering, plot_picked_names, use_qt=use_qt)
+        super().__init__(use_trame, allow_picking, allow_hovering, plot_picked_names)
 
     def plot_iter(
         self,
@@ -599,8 +593,3 @@ def plot(self, plottable_object: Any, name_filter: str = None, **plotting_option
             self.pv_interface.plot_iter(plottable_object, name_filter, **plotting_options)
         else:
             self.pv_interface.plot(plottable_object, name_filter, **plotting_options)
-
-    def close(self):
-        """Close the plotter for PyVistaQT."""
-        if self._use_qt:
-            self.pv_interface.scene.close()

src/ansys/tools/visualization_interface/backends/pyvista/pyvista_interface.py

@@ -20,13 +20,11 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 """Provides plotting for various PyAnsys objects."""
-import importlib
 import re
 from typing import Any, Dict, List, Optional, Union
 
 import pyvista as pv
 from pyvista.plotting.plotter import Plotter as PyVistaPlotter
-import pyvistaqt
 
 import ansys.tools.visualization_interface as viz_interface
 from ansys.tools.visualization_interface.types.edge_plot import EdgePlot
@@ -35,8 +33,6 @@
 from ansys.tools.visualization_interface.utils.color import Color
 from ansys.tools.visualization_interface.utils.logger import logger
 
-_HAS_PYVISTAQT = importlib.util.find_spec("pyvistaqt")
-
 
 class PyVistaInterface:
     """Provides the middle class between PyVista plotting operations and PyAnsys objects.
@@ -62,9 +58,6 @@ class PyVistaInterface:
         for visualization.
     show_plane : bool, default: False
         Whether to show the XY plane in the plotter window.
-    use_qt : bool, default: False
-        Whether to use the Qt backend for the plotter window.
-
     """
 
     def __init__(
@@ -74,27 +67,16 @@ def __init__(
         num_points: int = 100,
         enable_widgets: bool = True,
         show_plane: bool = False,
-        use_qt: bool = False,
         **plotter_kwargs,
     ) -> None:
         """Initialize the plotter."""
         # Generate custom scene if ``None`` is provided
         if scene is None:
             if viz_interface.TESTING_MODE:
-                if use_qt and _HAS_PYVISTAQT:
-                    scene = pyvistaqt.BackgroundPlotter(off_screen=True)
-                else:
-                    if use_qt and not _HAS_PYVISTAQT:
-                        message = "PyVistaQt dependency is not installed. Install it with " + \
-                                  "`pip install ansys-tools-visualization-interface[pyvistaqt]`."
-                        logger.warning(message)
-                    scene = pv.Plotter(off_screen=True, **plotter_kwargs)
-            elif use_qt:
-                scene = pyvistaqt.BackgroundPlotter()
+                scene = pv.Plotter(off_screen=True, **plotter_kwargs)
             else:
                 scene = pv.Plotter(**plotter_kwargs)
 
-        self._use_qt = use_qt
         # If required, use a white background with no gradient
         if not color_opts:
             color_opts = dict(color="white")
@@ -109,9 +91,7 @@ def __init__(
 
         # Show the XY plane
         self._show_plane = show_plane
-        # if (not DOCUMENTATION_BUILD) or (DOCUMENTATION_BUILD and not use_qt) or (TESTING_MODE and not use_qt):
-        if not use_qt:
-            self.scene.add_axes(interactive=False)
+        self.scene.add_axes(interactive=False)
 
         # objects to actors mapping
         self._object_to_actors_map = {}
@@ -355,10 +335,7 @@ def show(
         if jupyter_backend:
             self.scene.show(jupyter_backend=jupyter_backend, **kwargs)
         else:
-            if self._use_qt:
-                self.scene.show()
-            else:
-                self.scene.show(**kwargs)
+            self.scene.show(**kwargs)
 
     def set_add_mesh_defaults(self, plotting_options: Optional[Dict]) -> None:
         """Set the default values for the plotting options.