feat: avoiding reconnecting if MAPDL exited already

doc/changelog.d/3705.added.md

@@ -0,0 +1 @@
+feat: speed up `requires_package` using caching

doc/changelog.d/3708.miscellaneous.md

@@ -0,0 +1 @@
+feat: avoiding reconnecting if MAPDL exited already

src/ansys/mapdl/core/errors.py

@@ -327,27 +327,29 @@ def wrapper(*args, **kwargs):
 
             except grpc.RpcError as error:
                 mapdl = retrieve_mapdl_from_args(args)
+
                 mapdl._log.debug("A gRPC error has been detected.")
 
-                i_attemps += 1
-                if i_attemps <= n_attempts:
+                if not mapdl.exited:
+                    i_attemps += 1
+                    if i_attemps <= n_attempts:
 
-                    wait = (
-                        initial_backoff * multiplier_backoff**i_attemps
-                    )  # Exponential backoff
+                        wait = (
+                            initial_backoff * multiplier_backoff**i_attemps
+                        )  # Exponential backoff
 
-                    # reconnect
-                    mapdl._log.debug(
-                        f"Re-connection attempt {i_attemps} after waiting {wait:0.3f} seconds"
-                    )
+                        # reconnect
+                        mapdl._log.debug(
+                            f"Re-connection attempt {i_attemps} after waiting {wait:0.3f} seconds"
+                        )
 
-                    if not mapdl.is_alive:
-                        connected = mapdl._connect(timeout=wait)
-                    else:
-                        sleep(wait)
+                        if not mapdl.is_alive:
+                            connected = mapdl._connect(timeout=wait)
+                        else:
+                            sleep(wait)
 
-                    # Retry again
-                    continue
+                        # Retry again
+                        continue
 
                 # Custom errors
                 reason = ""

src/ansys/mapdl/core/misc.py

@@ -22,7 +22,7 @@
 
 """Module for miscellaneous functions and methods"""
 from enum import Enum
-from functools import wraps
+from functools import cache, wraps
 import importlib
 import inspect
 import os
@@ -415,6 +415,16 @@ def write_array(filename: Union[str, bytes], array: np.ndarray) -> None:
     np.savetxt(filename, array, fmt="%20.12f")
 
 
+@cache
+def is_package_installed_cached(package_name):
+    try:
+        importlib.import_module(package_name)
+        return True
+
+    except ModuleNotFoundError:
+        return False
+
+
 def requires_package(package_name: str, softerror: bool = False) -> Callable:
     """
     Decorator check whether a package is installed or not.
@@ -430,11 +440,11 @@ def requires_package(package_name: str, softerror: bool = False) -> Callable:
     def decorator(function):
         @wraps(function)
         def wrapper(self, *args, **kwargs):
-            try:
-                importlib.import_module(package_name)
+
+            if is_package_installed_cached(package_name):
                 return function(self, *args, **kwargs)
 
-            except ModuleNotFoundError:
+            else:
                 msg = (
                     f"To use the method '{function.__name__}', "
                     f"the package '{package_name}' is required.\n"

tests/common.py

@@ -26,6 +26,7 @@
 import subprocess
 import time
 from typing import Dict, List
+from warnings import warn
 
 import psutil
 

tests/test_mapdl.py

@@ -2749,7 +2749,8 @@ def test_comment_on_debug_mode(mapdl, cleared):
 
 @patch("ansys.mapdl.core.errors.N_ATTEMPTS", 2)
 @patch("ansys.mapdl.core.errors.MULTIPLIER_BACKOFF", 1)
-def test_timeout_when_exiting(mapdl):
+@pytest.mark.parametrize("is_exited", [True, False])
+def test_timeout_when_exiting(mapdl, is_exited):
     from ansys.mapdl.core import errors
 
     def raise_exception(*args, **kwargs):
@@ -2759,9 +2760,13 @@ def raise_exception(*args, **kwargs):
         e.code = lambda: grpc.StatusCode.ABORTED
         e.details = lambda: "My gRPC error details"
 
+        # Simulating MAPDL exiting by force
+        mapdl._exited = is_exited
+
         raise e
 
     handle_generic_grpc_error = errors.handle_generic_grpc_error
+
     with (
         patch("ansys.mapdl.core.mapdl_grpc.pb_types.CmdRequest") as mock_cmdrequest,
         patch(
@@ -2787,9 +2792,17 @@ def raise_exception(*args, **kwargs):
         assert mapdl._exited
 
         assert mock_handle.call_count == 1
-        assert mock_connect.call_count == errors.N_ATTEMPTS
-        assert mock_cmdrequest.call_count == errors.N_ATTEMPTS + 1
-        assert mock_is_alive.call_count == errors.N_ATTEMPTS + 1
+
+        if is_exited:
+            # Checking no trying to reconnect
+            assert mock_connect.call_count == 0
+            assert mock_cmdrequest.call_count == 1
+            assert mock_is_alive.call_count == 1
+
+        else:
+            assert mock_connect.call_count == errors.N_ATTEMPTS
+            assert mock_cmdrequest.call_count == errors.N_ATTEMPTS + 1
+            assert mock_is_alive.call_count == errors.N_ATTEMPTS + 1
 
         mapdl._exited = False
 
@@ -2836,3 +2849,14 @@ def test_none_on_selecting(mapdl, cleared, func):
 
     assert len(selfunc("all")) > 0
     assert len(selfunc(None)) == 0
+
+
+def test_requires_package_speed():
+    from ansys.mapdl.core.misc import requires_package
+
+    @requires_package("pyvista")
+    def my_func(i):
+        return i + 1
+
+    for i in range(1_000_000):
+        my_func(i)