refactor: do not import ansys.tools.visualizer by default when importing ansys.mapdl.core (#3887)

* change how the install check works

* chore: adding changelog file 3887.miscellaneous.md [dependabot-skip]

* chore: adding changelog file 3887.added.md [dependabot-skip]

* don't expect requests to be loaded on import

* only set the default theme once

* use default symbol

* Don't import plotter from visualizer by default

Don't import plotter from post module

* ci: auto fixes from pre-commit.com hooks.

for more information, see https://pre-commit.ci

* remove global import of Plotter

* chore: adding changelog file 3887.added.md [dependabot-skip]

* cicd: empty commit to retrigger CICD

* fix ci

* update

* fix autodoc

* hold the bc settings per plotter instance (#3897)

* hold the bc settings per plotter instance

* ci: auto fixes from pre-commit.com hooks.

for more information, see https://pre-commit.ci

* chore: adding changelog file 3897.miscellaneous.md [dependabot-skip]

---------

Co-authored-by: Mohamed Koubaa <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: pyansys-ci-bot <[email protected]>

* add docstring

* type hint

---------

Co-authored-by: Mohamed Koubaa <[email protected]>
Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: German <[email protected]>

Author: 5 people

doc/changelog.d/3887.added.md

@@ -0,0 +1 @@
+refactor: do not import ansys.tools.visualizer by default when importing ansys.mapdl.core

doc/changelog.d/3897.miscellaneous.md

@@ -0,0 +1 @@
+hold the bc settings per plotter instance

doc/source/api/plotting.rst

@@ -9,7 +9,7 @@ Various PyMAPDL specific plotting commands.
 .. autosummary::
    :toctree: _autosummary
 
-   plotting.MapdlPlotter
+   plotting.visualizer.MapdlPlotter
    plotting.MapdlTheme
    Mapdl.aplot
    Mapdl.eplot

src/ansys/mapdl/core/__init__.py

@@ -26,7 +26,6 @@
 #
 import logging
 import os
-import sys
 from typing import Dict, List, Tuple
 from warnings import warn
 
@@ -135,6 +134,3 @@
         get_mapdl_path,
         save_ansys_path,
     )
-
-if _HAS_VISUALIZER:
-    from ansys.tools.visualization_interface import Plotter

src/ansys/mapdl/core/helpers.py

@@ -23,7 +23,7 @@
 """Module for helper functions"""
 
 from functools import namedtuple
-import importlib
+import importlib.util
 import os
 import sys
 from warnings import warn
@@ -34,14 +34,15 @@
 def is_installed(package_name: str) -> bool:
     """Check if a package is installed"""
     package_name = package_name.replace("-", ".")
-
     try:
-        importlib.import_module(package_name)
-
-        return True
-    except ModuleNotFoundError:  # pragma: no cover
+        package_spec = importlib.util.find_spec(package_name)
+        if package_spec is None:  # pragma: no cover
+            LOG.debug(f"The module '{package_name}' is not installed.")
+            return False
+    except ModuleNotFoundError:
         LOG.debug(f"The module '{package_name}' is not installed.")
         return False
+    return True
 
 
 def get_python_version() -> namedtuple:
@@ -94,13 +95,7 @@ def run_first_time() -> None:
 
 def run_every_import() -> None:
     # Run every time we import PyMAPDL
-    from ansys.mapdl.core import _HAS_VISUALIZER, RUNNING_TESTS
-
-    # Apply custom theme
-    if _HAS_VISUALIZER:
-        from ansys.mapdl.core.plotting.theme import _apply_default_theme
-
-        _apply_default_theme()
+    from ansys.mapdl.core import RUNNING_TESTS
 
     # In case we want to do something specific for testing.
     if RUNNING_TESTS:  # pragma: no cover

src/ansys/mapdl/core/plotting/__init__.py

@@ -46,4 +46,3 @@ class GraphicsBackend(Enum):
 
 if _HAS_VISUALIZER:
     from ansys.mapdl.core.plotting.theme import MapdlTheme  # noqa: F401
-    from ansys.mapdl.core.plotting.visualizer import MapdlPlotter  # noqa: F401

src/ansys/mapdl/core/plotting/visualizer.py

@@ -22,7 +22,7 @@
 
 """Module for the MapdlPlotter class."""
 from collections import OrderedDict
-from typing import Any, Dict, Iterable, Optional, Union
+from typing import Any, Callable, Dict, Iterable, Optional, Union
 
 from ansys.tools.visualization_interface import Plotter
 from ansys.tools.visualization_interface.backends.pyvista import PyVistaBackendInterface
@@ -43,12 +43,22 @@
 )
 from ansys.mapdl.core.plotting.theme import MapdlTheme
 
+_FIRST_USE_RUN = False
+
 if _HAS_VISUALIZER:
     import pyvista as pv
 
-    from ansys.mapdl.core.plotting.plotting_defaults import DefaultSymbol
 
-    BC_plot_settings = DefaultSymbol()
+def _first_use():
+    # Run first time we use the visualizer
+    global _FIRST_USE_RUN
+    if _FIRST_USE_RUN is True:
+        return
+    if _HAS_VISUALIZER:
+        from ansys.mapdl.core.plotting.theme import _apply_default_theme
+
+        _apply_default_theme()
+    _FIRST_USE_RUN = True
 
 
 class MapdlPlotterBackend(PyVistaBackendInterface):
@@ -115,6 +125,7 @@ def __init__(
         self, use_trame: bool = False, theme: pv.Plotter.theme = None, **plotter_kwargs
     ):
         """Initialize the ``MapdlPlotter`` class."""
+        _first_use()
         self._backend = MapdlPlotterBackend(use_trame=use_trame, **plotter_kwargs)
         super().__init__(backend=self._backend)
         self._theme = theme
@@ -124,6 +135,19 @@ def __init__(
         self._notebook = None
         self._savefig = None
         self._title = None
+        self._bc_settings = None
+
+    @property
+    def bc_settings(self) -> Callable:
+        """Get the boundary condition settings object."""
+        if self._bc_settings is None:
+            self._make_bc_settings()
+        return self._bc_settings
+
+    def _make_bc_settings(self) -> None:
+        from ansys.mapdl.core.plotting.plotting_defaults import DefaultSymbol
+
+        self._bc_settings = DefaultSymbol()
 
     def _bc_labels_checker(self, bc_labels):
         """Make sure we have allowed parameters and data types for ``bc_labels``"""
@@ -587,13 +611,13 @@ def bc_nodes_plot(
                 orient=False,
                 scale="scale",
                 # tolerance=0.05,
-                geom=BC_plot_settings(each_label)["glyph"],
+                geom=self.bc_settings(each_label)["glyph"],
             )
             name_ = f"{each_label}"
             self.scene.add_mesh(
                 glyphs,
                 # name_filter=None,
-                color=BC_plot_settings(each_label)["color"],
+                color=self.bc_settings(each_label)["color"],
                 style="surface",
                 # style='wireframe',
                 # line_width=3,
@@ -644,11 +668,11 @@ def bc_nodes_plot(
                     # something it can be seen properly in the legend
                     label_ = value[1]
                     if "U" in label_:
-                        value = [BC_plot_settings("UY")["glyph"], label_, value[2]]
+                        value = [self.bc_settings("UY")["glyph"], label_, value[2]]
                     elif "F" in label_:
-                        value = [BC_plot_settings("FX")["glyph"], label_, value[2]]
+                        value = [self.bc_settings("FX")["glyph"], label_, value[2]]
                     else:
-                        value = [BC_plot_settings(label_)["glyph"], label_, value[2]]
+                        value = [self.bc_settings(label_)["glyph"], label_, value[2]]
 
                     if symbol == value[1]:
                         sorted_dict[key] = value

src/ansys/mapdl/core/post.py

@@ -25,13 +25,9 @@
 
 import numpy as np
 
-from ansys.mapdl.core import _HAS_VISUALIZER
 from ansys.mapdl.core.errors import MapdlRuntimeError
 from ansys.mapdl.core.misc import requires_package, supress_logging
 
-if _HAS_VISUALIZER:
-    from ansys.mapdl.core.plotting.visualizer import MapdlPlotter
-
 COMPONENT_STRESS_TYPE = ["X", "Y", "Z", "XY", "YZ", "XZ"]
 PRINCIPAL_TYPE = ["1", "2", "3"]
 STRESS_TYPES = ["X", "Y", "Z", "XY", "YZ", "XZ", "1", "2", "3", "INT", "EQV"]
@@ -633,6 +629,8 @@ def _plot_point_scalars(self, scalars, show_node_numbering=False, **kwargs):
                 "exist within the result file."
             )
 
+        from ansys.mapdl.core.plotting.visualizer import MapdlPlotter
+
         with self._mapdl.save_selection:
             mask = self.selected_nodes
             nodes_ids = self._mapdl.get_array("NODE", item1="NLIST")
@@ -679,6 +677,8 @@ def _plot_cell_scalars(self, scalars, show_elem_numbering=False, **kwargs):
                 "exist within the result file."
             )
 
+        from ansys.mapdl.core.plotting.visualizer import MapdlPlotter
+
         with self._mapdl.save_selection:
             # Select nodes to avoid segfault
             self._mapdl.nsle("s", "all")

tests/test_examples.py

@@ -179,7 +179,6 @@ def test_detach_examples_submodule():
 
 assert 'ansys.mapdl.core' in sys.modules, 'PyMAPDL is not loaded!'
 assert 'ansys.mapdl.core.examples' not in sys.modules, 'Examples is loaded!'
-assert 'requests' in sys.modules, 'Requests is loaded!'
 
 from ansys.mapdl.core.examples import vmfiles