Mode exposed in Mapdl class (#1560)

* Adding 'mode' method to mapdl class

* Added unit tests

* Clarification in the API section

Author: germa89

doc/source/contribution_and_api/index.rst

@@ -107,8 +107,9 @@ This way, it's not possible for you to push code that fails the style checks. Fo
 
 API Reference
 =============
-This section gives an overview of the API of several public PyMAPDL
-classes, functions, and attributes.
+This page gives an overview of the API of several public PyMAPDL
+classes, functions, and attributes. You can find them
+on the left sidebar.
 
 These methods may include some MAPDL commands but are generally
 specific to pymapdl specific methods and classes (i.e. methods that

src/ansys/mapdl/core/mapdl.py

@@ -165,6 +165,7 @@ def __init__(
         self._store_commands = False
         self._stored_commands = []
         self._response = None
+        self._mode = None
 
         if _HAS_PYVISTA:
             if use_vtk is not None:  # pragma: no cover
@@ -236,6 +237,26 @@ def print_com(self, value):
                 f"The property ``print_com`` only allows booleans, but type {type(value)} was supplied."
             )
 
+    @property
+    def mode(self):
+        """Return the type of instance, namely: grpc, corba or console."""
+        return self._mode
+
+    @property
+    def is_grpc(self):
+        """Return true if using grpc to connect to the MAPDL instance."""
+        return self._mode == "grpc"
+
+    @property
+    def is_corba(self):
+        """Return true if using corba to connect to the MAPDL instance."""
+        return self._mode == "corba"
+
+    @property
+    def is_console(self):
+        """Return true if using console to connect to the MAPDL instance."""
+        return self._mode == "console"
+
     def _wrap_listing_functions(self):
         # Wrapping LISTING FUNCTIONS.
         def wrap_listing_function(func):

src/ansys/mapdl/core/mapdl_console.py

@@ -99,6 +99,7 @@ def __init__(
             print_com=print_com,
             **start_parm,
         )
+        self._mode = "console"
 
     def _launch(self, start_parm):
         """Connect to MAPDL process using pexpect"""

src/ansys/mapdl/core/mapdl_corba.py

@@ -188,6 +188,7 @@ def __init__(
             **start_parm,
         )
 
+        self._mode = "corba"
         self._broadcast_logger = None
         self._server = None
         self._outfile = None

src/ansys/mapdl/core/mapdl_grpc.py

@@ -322,6 +322,7 @@ def __init__(
             print_com=print_com,
             **start_parm,
         )
+        self._mode = "grpc"
 
         # gRPC request specific locks as these gRPC request are not thread safe
         self._vget_lock = False

tests/test_console.py

@@ -587,3 +587,10 @@ def test_load_table(mapdl_console):
     )
     mapdl_console.load_table("my_conv", my_conv, "TIME")
     assert np.allclose(mapdl_console.parameters["my_conv"], my_conv[:, -1])
+
+
+def test_mode_corba(mapdl_console):
+    assert mapdl_console.mode == "console"
+    assert not mapdl_console.is_grpc
+    assert not mapdl_console.is_corba
+    assert mapdl_console.is_console

tests/test_corba.py

@@ -572,3 +572,10 @@ def test_load_table(mapdl, dim_rows, dim_cols):
         )
     else:
         assert np.allclose(mapdl.parameters["my_conv"], my_conv[1:, 1:], 1e-7)
+
+
+def test_mode_corba(mapdl_corba):
+    assert mapdl_corba.mode == "corba"
+    assert not mapdl_corba.is_grpc
+    assert mapdl_corba.is_corba
+    assert not mapdl_corba.is_console

tests/test_grpc.py

@@ -364,3 +364,10 @@ def test__channel_str(mapdl):
     assert ":" in mapdl._channel_str
     assert re.search("\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}", mapdl._channel_str)
     assert re.search("\d{4,6}", mapdl._channel_str)
+
+
+def test_mode_corba(mapdl):
+    assert mapdl.mode == "grpc"
+    assert mapdl.is_grpc
+    assert not mapdl.is_corba
+    assert not mapdl.is_console

tests/test_mapdl.py

@@ -1594,3 +1594,22 @@ def test_use_uploading(mapdl, cleared, tmpdir):
     # Raise an error
     with pytest.raises(FileNotFoundError):
         mapdl.use("asdf/myinexistentmacro.mac")
+
+
+def test_mode(mapdl):
+    assert mapdl.mode == "grpc"
+    assert mapdl.is_grpc
+    assert not mapdl.is_corba
+    assert not mapdl.is_console
+
+    mapdl._mode = "corba"  # overwriting underlying parameter
+    assert not mapdl.is_grpc
+    assert mapdl.is_corba
+    assert not mapdl.is_console
+
+    mapdl._mode = "console"  # overwriting underlying parameter
+    assert not mapdl.is_grpc
+    assert not mapdl.is_corba
+    assert mapdl.is_console
+
+    mapdl._mode = "grpc"  # Going back to default