refactor: removing-run_as_prep7-in-favour-of-run_as (#3551)

* refactor: using a common wrapper based on context manager

* refactor: replace elsewhere

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

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

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

* feat: making sure we are properly getting the mapdl object in the wrappers

---------

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

Author: 3 people

doc/changelog.d/3551.added.md

@@ -0,0 +1 @@
+refactor: removing-`run_as_prep7`-in-favour-of-`run_as`

src/ansys/mapdl/core/mapdl_core.py

@@ -72,7 +72,7 @@
     last_created,
     random_string,
     requires_package,
-    run_as_prep7,
+    run_as,
     supress_logging,
 )
 
@@ -1574,7 +1574,7 @@ def open_apdl_log(
         )
 
     @supress_logging
-    @run_as_prep7
+    @run_as("PREP7")
     def _generate_iges(self):
         """Save IGES geometry representation to disk"""
         filename = os.path.join(self.directory, "_tmp.iges")

src/ansys/mapdl/core/mapdl_geometry.py

@@ -36,7 +36,7 @@
 if TYPE_CHECKING:  # pragma: no cover
     from pyiges import Iges
 
-from ansys.mapdl.core.misc import requires_package, run_as_prep7, supress_logging
+from ansys.mapdl.core.misc import requires_package, run_as, supress_logging
 from ansys.mapdl.core.plotting.theme import MapdlTheme
 
 VALID_SELECTION_TYPE = ["S", "R", "A", "U"]
@@ -614,7 +614,7 @@ def get_areas(
         return areas
 
     @supress_logging
-    @run_as_prep7
+    @run_as("PREP7")
     @requires_package("pyvista")
     def generate_surface(
         self,

src/ansys/mapdl/core/mapdl_grpc.py

@@ -90,7 +90,7 @@
     last_created,
     only_numbers_and_dots,
     random_string,
-    run_as_prep7,
+    run_as,
     supress_logging,
 )
 from ansys.mapdl.core.parameters import interp_star_status
@@ -2961,7 +2961,7 @@ def __str__(self):
         return info
 
     @supress_logging
-    @run_as_prep7
+    @run_as("PREP7")
     def _generate_iges(self):
         """Save IGES geometry representation to disk"""
         basename = "_tmp.iges"

src/ansys/mapdl/core/misc.py

@@ -136,7 +136,15 @@ def supress_logging(func):
 
     @wraps(func)
     def wrapper(*args, **kwargs):
+        from ansys.mapdl.core.mapdl import MapdlBase
+
         mapdl = args[0]
+        if not issubclass(type(mapdl), (MapdlBase)):
+            # Assuming we are on a module object.
+            mapdl = mapdl._mapdl
+            if not issubclass(type(mapdl), (MapdlBase)):
+                raise Exception("This wrapper cannot access MAPDL object")
+
         prior_log_level = mapdl._log.level
         if prior_log_level != "CRITICAL":
             mapdl._set_log_level("CRITICAL")
@@ -151,28 +159,27 @@ def wrapper(*args, **kwargs):
     return wrapper
 
 
-def run_as_prep7(func):
+def run_as(routine: ROUTINES):
     """Run a MAPDL method at PREP7 and always revert to the prior processor"""
 
-    @wraps(func)
-    def wrapper(*args, **kwargs):
-        mapdl = args[0]
-        if hasattr(mapdl, "_mapdl"):
-            mapdl = mapdl._mapdl
-        prior_processor = mapdl.parameters.routine
-        if prior_processor != "PREP7":
-            mapdl.prep7()
+    def decorator(function):
+        @wraps(function)
+        def wrapper(self, *args, **kwargs):
+            from ansys.mapdl.core.mapdl import MapdlBase
 
-        out = func(*args, **kwargs)
+            mapdl = self
+            if not issubclass(type(mapdl), (MapdlBase)):
+                # Assuming we are on a module object.
+                mapdl = mapdl._mapdl
+                if not issubclass(type(mapdl), (MapdlBase)):
+                    raise Exception("This wrapper cannot access MAPDL object")
 
-        if prior_processor == "Begin level":
-            mapdl.finish()
-        elif prior_processor != "PREP7":
-            mapdl.run("/%s" % prior_processor)
+            with mapdl.run_as_routine(routine.upper()):
+                return function(self, *args, **kwargs)
 
-        return out
+        return wrapper
 
-    return wrapper
+    return decorator
 
 
 def threaded(func):

tests/test_misc.py

@@ -36,7 +36,7 @@
     load_file,
     no_return,
     requires_package,
-    run_as_prep7,
+    run_as,
 )
 from conftest import requires
 
@@ -103,7 +103,7 @@ def test_run_as_prep7(mapdl, cleared):
     mapdl.post1()
     assert "POST1" in mapdl.parameters.routine
 
-    @run_as_prep7
+    @run_as("PREP7")
     def fun(
         mapdl,
     ):  # This function is for mapdl methods, hence we have to pass the MAPDL instance somehow.