decouple pyvista from mapdl and mapdl_grpc (#1129)

* decouple pyvista from mapdl and mapdl_grpc

* style

* fix null

* PR review suggestions

* fix formatting

* typo

* Update src/ansys/mapdl/core/mapdl_grpc.py

Co-authored-by: Alex Kaszynski <[email protected]>

* Update src/ansys/mapdl/core/mapdl_grpc.py

Co-authored-by: Alex Kaszynski <[email protected]>

* Removing more dependency

* Adding more checks

* Increasing coverage and removing some analyser errors

* removing hint

* Fixing unit test

Co-authored-by: Alex Kaszynski <[email protected]>
Co-authored-by: German <[email protected]>

Author: 3 people

src/ansys/mapdl/core/mapdl.py

@@ -13,7 +13,6 @@
 from warnings import warn
 import weakref
 
-from ansys.mapdl.reader.rst import Result
 import numpy as np
 
 from ansys.mapdl import core as pymapdl
@@ -36,11 +35,15 @@
     last_created,
     load_file,
     random_string,
+    requires_package,
     run_as_prep7,
     supress_logging,
     wrap_point_SEL,
 )
-from ansys.mapdl.core.plotting import general_plotter
+
+if _HAS_PYVISTA:
+    from ansys.mapdl.core.plotting import general_plotter
+
 from ansys.mapdl.core.post import PostProcessing
 
 _PERMITTED_ERRORS = [
@@ -138,7 +141,7 @@ class _MapdlCore(Commands):
     def __init__(
         self,
         loglevel="DEBUG",
-        use_vtk=True,
+        use_vtk=None,
         log_apdl=None,
         log_file=False,
         local=True,
@@ -156,7 +159,10 @@ def __init__(
         self._response = None
 
         if _HAS_PYVISTA:
-            self._use_vtk = use_vtk
+            if use_vtk is not None:  # pragma: no cover
+                self._use_vtk = use_vtk
+            else:
+                self._use_vtk = True
         else:  # pragma: no cover
             if use_vtk:
                 raise ModuleNotFoundError(
@@ -573,6 +579,7 @@ def info(self):
         return self._info
 
     @property
+    @requires_package("pyvista", softerror=True)
     def geometry(self):
         """Geometry information.
 
@@ -622,6 +629,7 @@ def _geometry(self):  # pragma: no cover
         return Geometry(self)
 
     @property
+    @requires_package("pyvista", softerror=True)
     def mesh(self):
         """Mesh information.
 
@@ -668,6 +676,7 @@ def mesh(self):
         return self._mesh
 
     @property
+    @requires_package("ansys.mapdl.reader", softerror=True)
     @supress_logging
     def _mesh(self):
         """Write entire archive to ASCII and read it in as an
@@ -1698,7 +1707,8 @@ def kplot(
         return super().kplot(np1=np1, np2=np2, ninc=ninc, lab=lab, **kwargs)
 
     @property
-    def result(self) -> Result:
+    @requires_package("ansys.mapdl.reader", softerror=True)
+    def result(self) -> "ansys.mapdl.reader.rst.Result":
         """Binary interface to the result file using :class:`ansys.mapdl.reader.rst.Result`.
 
         Returns

src/ansys/mapdl/core/mapdl_geometry.py

@@ -2,7 +2,11 @@
 import re
 
 import numpy as np
-import pyvista as pv
+
+from ansys.mapdl.core import _HAS_PYVISTA
+
+if _HAS_PYVISTA:
+    import pyvista as pv
 
 from ansys.mapdl.core.misc import run_as_prep7, supress_logging
 

src/ansys/mapdl/core/mapdl_grpc.py

@@ -57,6 +57,7 @@
     check_valid_ip,
     last_created,
     random_string,
+    requires_package,
     run_as_prep7,
     supress_logging,
 )
@@ -506,10 +507,15 @@ def _connect(self, timeout=5, set_no_abort=True, enable_health_check=False):
             self._timer.start()
 
         # initialize mesh, post processing, and file explorer interfaces
-        from ansys.mapdl.core.mesh_grpc import MeshGrpc
+        try:
+            from ansys.mapdl.core.mesh_grpc import MeshGrpc
+
+            self._mesh_rep = MeshGrpc(self)
+        except ModuleNotFoundError:  # pragma: no cover
+            self._mesh_rep = None
+
         from ansys.mapdl.core.xpl import ansXpl
 
-        self._mesh_rep = MeshGrpc(self)
         self._post = PostProcessing(self)
         self._xpl = ansXpl(self)
 
@@ -661,10 +667,14 @@ def _set_no_abort(self):
 
     def _reset_cache(self):
         """Reset cached items"""
-        self._mesh_rep._reset_cache()
-        self._geometry._reset_cache()
+        if self._mesh_rep is not None:
+            self._mesh_rep._reset_cache()
+
+        if self.geometry is not None:
+            self._geometry._reset_cache()
 
     @property
+    @requires_package("pyvista")
     def _mesh(self):
         return self._mesh_rep
 
@@ -2197,6 +2207,7 @@ def list_error_file(self):
         return self._download_as_raw(error_file).decode("latin-1")
 
     @property
+    @requires_package("ansys.mapdl.reader", softerror=True)
     def result(self):
         """Binary interface to the result file using ``pyansys.Result``
 

src/ansys/mapdl/core/misc.py

@@ -1,5 +1,6 @@
 """Module for miscellaneous functions and methods"""
 from functools import wraps
+import importlib
 import inspect
 import os
 import platform
@@ -974,6 +975,62 @@ def _get_load_step_options(self):
         return self._get_between(init_, end_string)
 
 
+def write_array(filename, array):
+    """
+    Write an array to a file.
+
+    This function aim to replace
+    ``ansys.mapdl.reader._reader write_array``.
+
+    Parameters
+    ----------
+    filename : str
+        Name of the file.
+    array : numpy.ndarray
+        Array.
+    """
+    np.savetxt(filename, array, fmt="%20.12f")  # pragma: no cover
+
+
+def requires_package(package_name, softerror=False):
+    """
+    Decorator check whether a package is installed or not.
+
+    If it is not, it will return None.
+
+    Parameters
+    ----------
+    package_name : str
+        Name of the package.
+    """
+
+    def decorator(function):
+        @wraps(function)
+        def wrapper(self, *args, **kwargs):
+
+            try:
+                importlib.import_module(package_name)
+                return function(self, *args, **kwargs)
+
+            except ModuleNotFoundError:
+                msg = (
+                    f"To use the method '{function.__name__}', "
+                    f"the package '{package_name}' is required.\n"
+                    f"Please try to install '{package_name}' with:\n"
+                    f"pip install {package_name.replace('.','-') if 'ansys' in package_name else package_name}"
+                )
+
+                if softerror:
+                    warn(msg)
+                    return None
+                else:
+                    raise ModuleNotFoundError(msg)
+
+        return wrapper
+
+    return decorator
+
+
 def _get_args_xsel(*args, **kwargs):
     type_ = kwargs.pop("type_", args[0]).upper()
     item = kwargs.pop("item", str(args[1]) if len(args) > 1 else "").upper()

src/ansys/mapdl/core/parameters.py

@@ -2,7 +2,15 @@
 import tempfile
 import weakref
 
-from ansys.mapdl.reader._reader import write_array
+try:
+    from ansys.mapdl.reader._reader import write_array
+
+    _HAS_READER = True
+except ModuleNotFoundError:  # pragma: no cover
+    from ansys.mapdl.core.misc import write_array
+
+    _HAS_READER = False
+
 import numpy as np
 
 from ansys.mapdl.core.mapdl import _MapdlCore

src/ansys/mapdl/core/plotting.py

@@ -107,19 +107,19 @@ def get_VOLT():
 
     HEAT = pv.Cube(center=(0, 0, 0), x_length=1.0, y_length=1.0, z_length=1.0)
 
-BC_plot_settings = {
-    "TEMP": {"color": "orange", "glyph": TEMP},
-    "HEAT": {"color": "red", "glyph": HEAT},
-    "UX": {"color": "red", "glyph": UX},
-    "UY": {"color": "green", "glyph": UY},
-    "UZ": {"color": "blue", "glyph": UZ},
-    "VOLT": {"color": "yellow", "glyph": VOLT},
-    "FX": {"color": "red", "glyph": FX},
-    "FY": {"color": "green", "glyph": FY},
-    "FZ": {"color": "blue", "glyph": FZ},
-    "AMPS": {"color": "grey", "glyph": VOLT},
-    "CHRGS": {"color": "grey", "glyph": VOLT},
-}
+    BC_plot_settings = {
+        "TEMP": {"color": "orange", "glyph": TEMP},
+        "HEAT": {"color": "red", "glyph": HEAT},
+        "UX": {"color": "red", "glyph": UX},
+        "UY": {"color": "green", "glyph": UY},
+        "UZ": {"color": "blue", "glyph": UZ},
+        "VOLT": {"color": "yellow", "glyph": VOLT},
+        "FX": {"color": "red", "glyph": FX},
+        "FY": {"color": "green", "glyph": FY},
+        "FZ": {"color": "blue", "glyph": FZ},
+        "AMPS": {"color": "grey", "glyph": VOLT},
+        "CHRGS": {"color": "grey", "glyph": VOLT},
+    }
 
 # Using * to force all the following arguments to be keyword only.
 def _general_plotter(

src/ansys/mapdl/core/post.py

@@ -2,7 +2,6 @@
 import weakref
 
 import numpy as np
-from pyvista.plotting.renderer import CameraPosition
 
 from ansys.mapdl.core.errors import MapdlRuntimeError
 from ansys.mapdl.core.misc import supress_logging
@@ -467,7 +466,7 @@ def plot_nodal_values(self, item, comp, show_elem_numbering=False, **kwargs):
 
     def plot_element_values(
         self, item, comp, option="AVG", show_elem_numbering=False, **kwargs
-    ) -> CameraPosition:
+    ):
         """Plot element values.
 
         Displays the solution results as discontinuous element contours.
@@ -1052,7 +1051,7 @@ def element_displacement(self, component="ALL", option="AVG") -> np.ndarray:
 
     def plot_element_displacement(
         self, component="NORM", option="AVG", show_elem_numbering=False, **kwargs
-    ) -> CameraPosition:
+    ):
         """Plot element displacement.
 
         Parameters
@@ -1172,7 +1171,7 @@ def element_stress(self, component, option="AVG") -> np.ndarray:
 
     def plot_element_stress(
         self, component, option="AVG", show_elem_numbering=False, **kwargs
-    ) -> CameraPosition:
+    ):
         """Plot element component or principal stress.
 
         One value per element.  Either minimum, maximum, or average of
@@ -1277,7 +1276,7 @@ def element_temperature(self, option="AVG") -> np.ndarray:
 
     def plot_element_temperature(
         self, option="AVG", show_elem_numbering=False, **kwargs
-    ) -> CameraPosition:
+    ):
         """Plot element temperature.
 
         One value per element.  Either minimum, maximum, or average of

src/ansys/mapdl/core/theme.py

@@ -1,8 +1,20 @@
 """Store parameters for a PyMAPDL-specific theme for pyvista"""
-from pyvista import themes
+from ansys.mapdl.core import _HAS_PYVISTA
 
+if _HAS_PYVISTA:
+    from pyvista import themes
 
-class MapdlTheme(themes.DefaultTheme):
+    base_class = themes.DefaultTheme
+
+else:  # pragma: no cover
+
+    class myEmptyClass:
+        pass
+
+    base_class = myEmptyClass
+
+
+class MapdlTheme(base_class):
     """PyMAPDL-specific theme for pyvista.
 
     Theme includes the following defaults:

tests/test_misc.py

@@ -15,6 +15,7 @@
     last_created,
     load_file,
     no_return,
+    requires_package,
     run_as_prep7,
 )
 
@@ -278,3 +279,36 @@ def test_plain_report_no_options():
     assert "Core packages" in rep_str
     assert "Optional packages" not in rep_str
     assert "Additional packages" not in rep_str
+
+
+def test_requires_package_decorator():
+    class myClass:
+        @requires_package("numpy")
+        def myfun(self):
+            return True
+
+        @property
+        @requires_package("numpy")
+        def myfun2(self):
+            return True
+
+        @property
+        @requires_package("nuuumpy")
+        def myotherfun(self):
+            return False
+
+        @property
+        @requires_package("nuuumpy", softerror=True)
+        def myotherfun2(self):
+            return False
+
+    myclass = myClass()
+
+    assert myclass.myfun()
+    assert myclass.myfun2
+
+    with pytest.raises(ModuleNotFoundError):
+        assert myclass.myotherfun
+
+    with pytest.warns(UserWarning):
+        assert myclass.myotherfun2 is None