ansys-tools-visualization-interface 0.9.2__py3-none-any.whl → 0.11.0__py3-none-any.whl

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

@@ -21,6 +21,7 @@
 # SOFTWARE.
 """Provides a wrapper to aid in plotting."""
 from abc import abstractmethod
+from collections.abc import Callable
 import importlib.util
 from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union
 
@@ -405,6 +406,31 @@ class PyVistaBackendInterface(BaseBackend):
         """Disable hover capabilities in the plotter."""
         self._hover_widget.EnabledOff()
 
+    def __extract_kwargs(self, func_name: Callable, input_kwargs: Dict[str, Any]) -> Dict[str, Any]:
+        """Extracts the keyword arguments from a function signature and returns it as dict.
+
+        Parameters
+        ----------
+        func_name : Callable
+            Function to extract the keyword arguments from. It should be a callable function
+        input_kwargs : Dict[str, Any]
+            Dictionary with the keyword arguments to update the extracted ones.
+
+        Returns
+        -------
+        Dict[str, Any]
+            Dictionary with the keyword arguments extracted from the function signature and
+            updated with the input kwargs.
+        """
+        import inspect
+        signature = inspect.signature(func_name)
+        kwargs = {}
+        for k, v in signature.parameters.items():
+            # We are ignoring positional arguments, and passing everything as kwarg
+            if v.default is not inspect.Parameter.empty:
+                kwargs[k] = input_kwargs[k] if k in input_kwargs else v.default
+        return kwargs
+
     def show(
         self,
         plottable_object: Any = None,
@@ -412,7 +438,7 @@ class PyVistaBackendInterface(BaseBackend):
         view_2d: Dict = None,
         name_filter: str = None,
         dark_mode: bool = False,
-        **plotting_options,
+        **kwargs: Dict[str, Any],
     ) -> List[Any]:
         """Plot and show any PyAnsys object.
 
@@ -431,9 +457,8 @@ class PyVistaBackendInterface(BaseBackend):
             Regular expression with the desired name or names to include in the plotter.
         dark_mode : bool, default: False
             Whether to use dark mode for the widgets.
-        **plotting_options : dict, default: None
-            Keyword arguments. For allowable keyword arguments, see the
-            :meth:`Plotter.add_mesh <pyvista.Plotter.add_mesh>` method.
+        **kwargs : Any
+            Additional keyword arguments for the show or plot method.
 
         Returns
         -------
@@ -441,6 +466,14 @@ class PyVistaBackendInterface(BaseBackend):
             List with the picked bodies in the picked order.
 
         """
+        plotting_options = self.__extract_kwargs(
+            self._pl._scene.add_mesh,
+            kwargs,
+        )
+        show_options = self.__extract_kwargs(
+            self._pl.scene.show,
+            kwargs,
+        )
         self.plot(plottable_object, name_filter, **plotting_options)
         if self._pl.object_to_actors_map:
             self._object_to_actors_map = self._pl.object_to_actors_map
@@ -476,7 +509,9 @@ class PyVistaBackendInterface(BaseBackend):
         # Update all buttons/widgets
         [widget.update() for widget in self._widgets]
 
-        self.show_plotter(screenshot, **plotting_options)
+        # Remove screenshot from show options since we pass it manually
+        show_options.pop("screenshot", None)
+        self.show_plotter(screenshot, **show_options)
 
         picked_objects_list = []
         if isinstance(plottable_object, list):
@@ -512,8 +547,7 @@ class PyVistaBackendInterface(BaseBackend):
             visualizer.set_scene(self._pl)
             visualizer.show()
         else:
-            jupyter_backend = kwargs.pop("jupyter_backend", None)
-            self.pv_interface.show(screenshot=screenshot, jupyter_backend=jupyter_backend)
+            self.pv_interface.show(screenshot=screenshot, **kwargs)
 
         pv.OFF_SCREEN = self._pv_off_screen_original
 

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

@@ -328,8 +328,9 @@ class PyVistaInterface:
         jupyter_backend : str, default: None
             PyVista Jupyter backend.
         **kwargs : dict, default: None
-            Plotting keyword arguments. For allowable keyword arguments, see the
-            :meth:`Plotter.show <pyvista.Plotter.show>` method.
+            Plotting and show keyword arguments. For allowable keyword arguments, see the
+            :meth:`Plotter.show <pyvista.Plotter.show>` and
+            :meth:`Plotter.show <pyvista.Plotter.add_mesh>` methods.
 
         Notes
         -----
@@ -360,6 +361,8 @@ class PyVistaInterface:
         if kwargs.get("screenshot") is not None:
             self.scene.off_screen = True
         if jupyter_backend:
+            # Remove jupyter_backend from show options since we pass it manually
+            kwargs.pop("jupyter_backend", None)
             self.scene.show(jupyter_backend=jupyter_backend, **kwargs)
         else:
             if self._use_qt:

ansys/tools/visualization_interface/backends/pyvista/widgets/button.py

@@ -33,10 +33,6 @@ from ansys.tools.visualization_interface.backends.pyvista.widgets.widget import
 class Button(PlotterWidget):
     """Provides the abstract class for implementing buttons in PyAnsys.
 
-    Notes
-    -----
-    This class wraps the PyVista ``add_checkbox_button_widget()`` method.
-
     Parameters
     ----------
     plotter : Plotter
@@ -46,6 +42,9 @@ class Button(PlotterWidget):
     dark_mode : bool, optional
         Whether to activate the dark mode or not.
 
+    Notes
+    -----
+    This class wraps the PyVista ``add_checkbox_button_widget()`` method.
     """
 
     def __init__(self, plotter: Plotter, button_config: tuple, dark_mode: bool = False) -> None:

ansys/tools/visualization_interface/backends/pyvista/widgets/ruler.py

@@ -56,16 +56,15 @@ class Ruler(PlotterWidget):
     def callback(self, state: bool) -> None:
         """Remove or add the ruler widget actor upon click.
 
-        Notes
-        -----
-        This method provides a callback function for the ruler widet.
-        It is called every time the ruler widget is clicked.
-
         Parameters
         ----------
         state : bool
             Whether the state of the button, which is inherited from PyVista, is ``True``.
 
+        Notes
+        -----
+        This method provides a callback function for the ruler widet.
+        It is called every time the ruler widget is clicked.
         """
         if not state and self._actor:
             self.plotter.remove_actor(self._actor)

ansys/tools/visualization_interface/backends/pyvista/widgets/screenshot.py

@@ -56,16 +56,16 @@ class ScreenshotButton(PlotterWidget):
     def callback(self, state: bool) -> None:
         """Remove or add the screenshot widget actor upon click.
 
-        Notes
-        -----
-        This method provides a callback function for the screenshot widget.
-        It is called every time the screenshot widget is clicked.
-
         Parameters
         ----------
         state : bool
             Whether the state of the button, which is inherited from PyVista, is ``True``.
 
+
+        Notes
+        -----
+        This method provides a callback function for the screenshot widget.
+        It is called every time the screenshot widget is clicked.
         """
         self.plotter._pl.scene.screenshot("screenshot.png")
 

ansys/tools/visualization_interface/plotter.py

@@ -66,7 +66,7 @@ class Plotter():
         plottable_object: Any = None,
         screenshot: str = None,
         name_filter: bool = None,
-        **plotting_options
+        **kwargs
         ) -> None:
         """Show the plotted objects.
 
@@ -78,12 +78,12 @@ class Plotter():
             Path to save a screenshot, by default None.
         name_filter : bool, optional
             Flag to filter the object, by default None.
-        plotting_options : dict
-            Additional plotting options the selected backend accepts.
+        kwargs : dict
+            Additional options the selected backend accepts.
         """
         self._backend.show(
             plottable_object=plottable_object,
             screenshot=screenshot,
             name_filter=name_filter,
-            **plotting_options
+            **kwargs
         )

{ansys_tools_visualization_interface-0.9.2.dist-info → ansys_tools_visualization_interface-0.11.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ansys-tools-visualization-interface
-Version: 0.9.2
+Version: 0.11.0
 Summary: A Python visualization interface for PyAnsys libraries
 Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
 Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
@@ -14,29 +14,32 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: pyvista >= 0.43.0,<1
 Requires-Dist: websockets >= 12.0,< 16
 Requires-Dist: trame >= 3.6.0,<4
 Requires-Dist: trame-vtk >= 2.8.7,<3,!=2.8.16
 Requires-Dist: trame-vuetify >= 2.4.3,< 4
-Requires-Dist: ansys-sphinx-theme==1.3.2 ; extra == "doc"
+Requires-Dist: pyvista==0.45.2 ; extra == "doc"
+Requires-Dist: ansys-sphinx-theme==1.5.2 ; extra == "doc"
 Requires-Dist: jupyter_sphinx==0.5.3 ; extra == "doc"
-Requires-Dist: jupytext==1.16.7 ; extra == "doc"
+Requires-Dist: jupytext==1.17.2 ; extra == "doc"
 Requires-Dist: nbsphinx==0.9.6 ; extra == "doc"
-Requires-Dist: numpydoc==1.8.0 ; extra == "doc"
+Requires-Dist: numpydoc==1.9.0 ; extra == "doc"
 Requires-Dist: sphinx==8.2.3 ; extra == "doc"
 Requires-Dist: sphinx-autoapi==3.6.0 ; extra == "doc"
 Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "doc"
 Requires-Dist: sphinx_design==0.6.1 ; extra == "doc"
 Requires-Dist: sphinx-gallery==0.19.0 ; extra == "doc"
 Requires-Dist: sphinx-jinja==2.0.2 ; extra == "doc"
-Requires-Dist: ansys-fluent-core==0.30.3 ; extra == "doc"
+Requires-Dist: ansys-fluent-core==0.33.0 ; extra == "doc"
 Requires-Dist: pyside6 >= 6.8.0,<7 ; extra == "pyvistaqt"
 Requires-Dist: pyvistaqt >= 0.11.1,<1 ; extra == "pyvistaqt"
-Requires-Dist: pytest==8.3.5 ; extra == "tests"
+Requires-Dist: pytest==8.4.1 ; extra == "tests"
+Requires-Dist: pyvista==0.45.2 ; extra == "tests"
 Requires-Dist: pytest-pyvista==0.1.9 ; extra == "tests"
-Requires-Dist: pytest-cov==6.1.1 ; extra == "tests"
-Requires-Dist: pyside6==6.9.0 ; extra == "tests"
+Requires-Dist: pytest-cov==6.2.1 ; extra == "tests"
+Requires-Dist: pyside6==6.9.1 ; extra == "tests"
 Project-URL: Discussions, https://github.com/ansys/ansys-tools-visualization-interface/discussions
 Project-URL: Documentation, https://visualization-interface.tools.docs.pyansys.com/
 Project-URL: Issues, https://github.com/ansys/ansys-tools-visualization-interface/issues

{ansys_tools_visualization_interface-0.9.2.dist-info → ansys_tools_visualization_interface-0.11.0.dist-info}/RECORD

@@ -1,21 +1,21 @@
 ansys/tools/visualization_interface/__init__.py,sha256=9xKdGyp63iNNgVipyeE6gEJ2CnB3OLEyZX_QYf4T8OU,2432
-ansys/tools/visualization_interface/plotter.py,sha256=Q2WCPzq5w5bz84cEeknSGUqILYsacNgg3vGUvuemSDM,3230
+ansys/tools/visualization_interface/plotter.py,sha256=WIHP7qsxiXBT7qyr_aAugzgiQOMJj9owt-e8Jfwqprw,3191
 ansys/tools/visualization_interface/backends/__init__.py,sha256=QrhkJRa-r6kqBqdw7FVPE4eofL4RGC5FcWM20Pgjcr0,1180
 ansys/tools/visualization_interface/backends/_base.py,sha256=pR_uqDCngqpuPsoA5qPI4Ul8kPqB_nMGZTCIbcjPBBM,1871
 ansys/tools/visualization_interface/backends/pyvista/__init__.py,sha256=V7w7QRUGTxmyl4eW5uZeY-mBjrrz9cN-T8HeS2qOC3E,1320
-ansys/tools/visualization_interface/backends/pyvista/pyvista.py,sha256=YA2xc-bo3jndnghuAXJovI4IYt4NdVgePm-ZyPac0oU,25984
-ansys/tools/visualization_interface/backends/pyvista/pyvista_interface.py,sha256=H5h8aoamLhygHjOfLzxQlf_NTXxzdZDNzGBw5F2R34k,15629
+ansys/tools/visualization_interface/backends/pyvista/pyvista.py,sha256=zHwVijwI7UKs6U3EMxmWa7LOTcfrlZhQNcNOflpKsUE,27239
+ansys/tools/visualization_interface/backends/pyvista/pyvista_interface.py,sha256=V9p9SlLEAqyMNf35ZUm9csrsH3MV3JYOXsEMEnbEMLs,15832
 ansys/tools/visualization_interface/backends/pyvista/trame_local.py,sha256=6jIDMqJhZGUPru3ebfKflW9qIHOikUl5zrLGFsMCGP0,2996
 ansys/tools/visualization_interface/backends/pyvista/trame_remote.py,sha256=LxiVbwyvKoBiOX5wj_U4oZ7E-i-_gD3z7H2ZMC6UiSU,2834
 ansys/tools/visualization_interface/backends/pyvista/trame_service.py,sha256=eseK01KmnXherN-sMyv5XSmkLeD_7mPd32BFT97K3K0,5404
 ansys/tools/visualization_interface/backends/pyvista/widgets/__init__.py,sha256=gxGGvlW2dn3jASvH1KOhMXRH2WaY0bgXjsfuuVRX6gs,1339
-ansys/tools/visualization_interface/backends/pyvista/widgets/button.py,sha256=W1_EcyvAuDPEgw485Xch0q22gxg8P1RwtvLoQfWwLfI,3251
+ansys/tools/visualization_interface/backends/pyvista/widgets/button.py,sha256=n4cMOTNi5Uu-nhpLMEEDrzUqUuja1wEcw9pvuSRrjRU,3250
 ansys/tools/visualization_interface/backends/pyvista/widgets/displace_arrows.py,sha256=xJy8UQmpgK6F6AZQmM7c5JOeAfQYhRwL_OO4VUFEReM,4337
 ansys/tools/visualization_interface/backends/pyvista/widgets/hide_buttons.py,sha256=78Kb_LRKMl7YgSGN2o4_fMyRYrSV70MEpGkt19Hv2k4,3934
 ansys/tools/visualization_interface/backends/pyvista/widgets/measure.py,sha256=6ilSFoJxnZOy0jVIEBo5Ca3BWLKp2_ImnJN4M6QR50Y,4266
 ansys/tools/visualization_interface/backends/pyvista/widgets/mesh_slider.py,sha256=jRbqDxeIREJlP5iLRzfqQjINBERVbtnlpMo1k4QYHdA,5155
-ansys/tools/visualization_interface/backends/pyvista/widgets/ruler.py,sha256=w6VsNw1ShwlWkb_hRMy2w1MBjrelRFNWwXesFA9Vmbs,3866
-ansys/tools/visualization_interface/backends/pyvista/widgets/screenshot.py,sha256=XeH8PZNsJPNju-8iFqElRevnutTLQK7M5CX3-4aa3vo,3375
+ansys/tools/visualization_interface/backends/pyvista/widgets/ruler.py,sha256=E1H0_b-zbF6IAXZrXSQ_FQCt8EJIuYHgA66dXyAf9y0,3865
+ansys/tools/visualization_interface/backends/pyvista/widgets/screenshot.py,sha256=ziZByCihKWG20Bwl5XESwYukviCvb36w-keRm_R0pxk,3375
 ansys/tools/visualization_interface/backends/pyvista/widgets/view_button.py,sha256=8QvWoTXcCrRMtn3X_-dFvjksypNWq7baIXDoGa-nTF0,3444
 ansys/tools/visualization_interface/backends/pyvista/widgets/widget.py,sha256=M15gpahjGoZaCKwES0Jcgua5-Y3jukwlw5hx46lvqU0,2311
 ansys/tools/visualization_interface/backends/pyvista/widgets/_images/+xy.png,sha256=aPjLBmnKYIBmp_FKdDSp9M-NQuxnJ_VyMxZ6dqd1j6c,499
@@ -59,7 +59,7 @@ ansys/tools/visualization_interface/utils/__init__.py,sha256=KMyCn7hV7fzhvMntMqH
 ansys/tools/visualization_interface/utils/clip_plane.py,sha256=Mbavan9rZu86hgoBunEwWfh6Ts2mQJUCzUw9jEifrDU,2911
 ansys/tools/visualization_interface/utils/color.py,sha256=OPOO87b4bE00aRR014ob__82_rllLKu86kI1hQGmxFc,1641
 ansys/tools/visualization_interface/utils/logger.py,sha256=SRw6fcjly5dabAn4xRLYoug3WBoGulX9znSopCv4jA4,3825
-ansys_tools_visualization_interface-0.9.2.dist-info/LICENSE,sha256=hG7YAylqSVoTbB2JgP7Euy_f2WZRx8zwJ_x4yMttDTg,1098
-ansys_tools_visualization_interface-0.9.2.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
-ansys_tools_visualization_interface-0.9.2.dist-info/METADATA,sha256=ng4zYYUgqF_D1zsT5xHmUh_jU6OY7oDhL6LVTyR4oxE,7260
-ansys_tools_visualization_interface-0.9.2.dist-info/RECORD,,
+ansys_tools_visualization_interface-0.11.0.dist-info/LICENSE,sha256=hG7YAylqSVoTbB2JgP7Euy_f2WZRx8zwJ_x4yMttDTg,1098
+ansys_tools_visualization_interface-0.11.0.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
+ansys_tools_visualization_interface-0.11.0.dist-info/METADATA,sha256=zbYEjVuhOfr_dYd5xWjGJ9NYRS67YQgK2rJis6JbpT4,7410
+ansys_tools_visualization_interface-0.11.0.dist-info/RECORD,,