fix: pre-commit

Author: AlejandroFernandezLuces

doc/source/user_guide/index.rst

@@ -117,7 +117,7 @@ The Visualization Interface Tool provides a base class, ``AbstractPicker``, for
 callbacks of the plotter. This class provides a set of methods that can be overridden so that you can adapt the
 picker and hover functionalities to the specific need of your PyAnsys library.
 
-The first thing you must do is to create a class that inherits from the ``AbstractPicker`` class. After that, see 
+The first thing you must do is to create a class that inherits from the ``AbstractPicker`` class. After that, see
 these main use cases for customizing the picker and hover callbacks:
 
 * You may want to change the way that objects are picked in the plotter. To do this, you can override the

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

@@ -21,11 +21,11 @@
 # SOFTWARE.
 
 """
-.. _ref_picker:
+.. _ref_custom_picker:
 
-===================
-Activate the picker
-===================
+====================
+Create custom picker
+====================
 
 This example shows how to create a custom picker. In this case we will show how the default
 picker is implemented through the ``AbstractPicker`` class.
@@ -51,6 +51,17 @@
 # =================================
 
 class CustomPicker(AbstractPicker):
+    """Custom picker class that extends the AbstractPicker.
+    This custom picker changes the color of picked objects to red and adds a label with the object's name.
+    It also adds a label when hovering over an object.
+
+    Parameters
+    ----------
+    plotter_backend : Plotter
+        The plotter backend to use.
+    plot_picked_names : bool, optional
+        Whether to plot the names of picked objects, by default True.
+    """
     def __init__(self, plotter_backend: "Plotter", plot_picked_names: bool = True) -> None:
         """Initialize the ``Picker`` class."""
         # Picking variables
@@ -101,7 +112,7 @@ def pick_select_object(self, custom_object: MeshObjectPlot, pt: "np.ndarray") ->
             )
             # Add the label actor to the list of added actors
             added_actors.append(label_actor)
-        
+
         # Add the picked object to the picked dictionary if not already present, to keep track of it
         if custom_object.name not in self._picked_dict:
             self._picked_dict[custom_object.name] = custom_object
@@ -150,7 +161,7 @@ def hover_select_object(self, custom_object: MeshObjectPlot, actor: "Actor") ->
             show_points=False,
         )
         self._added_hover_labels.append(label_actor)
-    
+
     def hover_unselect_object(self):
         """Remove all hover labels from the scene."""
         for label in self._added_hover_labels:
@@ -159,7 +170,7 @@ def hover_unselect_object(self):
     @property
     def picked_dict(self) -> dict:
         """Return the dictionary of picked objects.
-        
+
         Returns
         -------
         dict

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

@@ -1,3 +1,25 @@
+# Copyright (C) 2024 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
 """Module for managing picking and hovering of objects in a PyVista plotter."""
 from typing import TYPE_CHECKING, Union
 
@@ -7,13 +29,15 @@
 
 if TYPE_CHECKING:
     import numpy as np
-    from ansys.tools.visualization_interface.backends.pyvista.pyvista import Plotter
     from pyvista import Actor
 
+    from ansys.tools.visualization_interface.backends.pyvista.pyvista import Plotter
+
 class AbstractPicker:
     """Abstract base class for pickers."""
 
     def __init__(self):
+        """Initialize the AbstractPicker class."""
         pass
 
     def pick_select_object(self, custom_object: Union[MeshObjectPlot, EdgePlot], pt: "np.ndarray") -> None:
@@ -36,6 +60,7 @@ def picked_dict(self) -> dict:
         """Return the dictionary of picked objects."""
         pass
 
+
 class Picker(AbstractPicker):
     """Class to manage picking and hovering of objects in the plotter.
 
@@ -44,7 +69,7 @@ class Picker(AbstractPicker):
     currently selected and hovered objects, and provides methods to select and unselect
     them.
 
-    
+
     Parameters
     ----------
     plotter_backend : Plotter
@@ -164,7 +189,7 @@ def hover_select_object(self, custom_object: Union[MeshObjectPlot, EdgePlot], ac
             show_points=False,
         )
         self._added_hover_labels.append(label_actor)
-    
+
     def hover_unselect_object(self):
         """Remove all hover labels from the scene."""
         for label in self._added_hover_labels:

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

@@ -32,6 +32,7 @@
 
 import ansys.tools.visualization_interface
 from ansys.tools.visualization_interface.backends._base import BaseBackend
+from ansys.tools.visualization_interface.backends.pyvista.picker import AbstractPicker, Picker
 from ansys.tools.visualization_interface.backends.pyvista.pyvista_interface import PyVistaInterface
 from ansys.tools.visualization_interface.backends.pyvista.widgets.dark_mode import DarkModeButton
 from ansys.tools.visualization_interface.backends.pyvista.widgets.displace_arrows import (
@@ -54,14 +55,13 @@
 from ansys.tools.visualization_interface.types.edge_plot import EdgePlot
 from ansys.tools.visualization_interface.utils.color import Color
 from ansys.tools.visualization_interface.utils.logger import logger
-from ansys.tools.visualization_interface.backends.pyvista.picker import Picker, AbstractPicker
 
 _HAS_TRAME = importlib.util.find_spec("pyvista.trame") and importlib.util.find_spec("trame.app")
 
 DARK_MODE_THRESHOLD = 120
 
 if TYPE_CHECKING:
-    import numpy as np
+    pass
 
 
 class PyVistaBackendInterface(BaseBackend):
@@ -563,12 +563,12 @@ def __init__(
     ) -> None:
         """Initialize the generic plotter."""
         super().__init__(
-            use_trame, 
-            allow_picking, 
-            allow_hovering, 
-            plot_picked_names, 
-            use_qt=use_qt, 
-            show_qt=show_qt, 
+            use_trame,
+            allow_picking,
+            allow_hovering,
+            plot_picked_names,
+            use_qt=use_qt,
+            show_qt=show_qt,
             custom_picker=custom_picker
         )