Richer command output

ansys/mapdl/core/commands.py

@@ -212,3 +212,164 @@ class Commands(
     """Wrapped MAPDL commands"""
 
     pass
+
+class CommandOutput(str):
+
+    ## References:
+    # - https://stackoverflow.com/questions/7255655/how-to-subclass-str-in-python
+    # - https://docs.python.org/3/library/collections.html#userstring-objects
+    # - Source code of UserString
+
+    def __new__(cls, content, cmd=None):
+        obj = super().__new__(cls, content)
+        obj._cmd = cmd
+        return obj
+
+    def _copyobj(self, seq):
+        # __new__ needs type and the args.
+        return self.__new__(type(self), seq, self._cmd)
+
+    # Overwriting the string methods.
+    # I used the UserString API.
+    def __getitem__(self, index):
+        return self._copyobj(super().__getitem__(index))
+
+    def __add__(self, other):
+        return self._copyobj(super().__add__(other))
+
+    def __mul__(self, n):
+        return self._copyobj(super().__mul__(n))
+
+    __rmul__ = __mul__
+
+    def __mod__(self, args):
+        return self._copyobj(super().__mod__(args))
+
+    def __rmod__(self, template):
+        return self._copyobj(str(template).__rmod__(self))
+
+    # the following methods are overwritten and defined in alphabetical order:
+    def capitalize(self):
+        return self._copyobj(super().capitalize())
+
+    def casefold(self):
+        return self._copyobj(super().casefold())
+
+    def center(self, width, *args):
+        return self._copyobj(super().center(width, *args))
+
+    def removeprefix(self, prefix):
+        return self._copyobj(super().removeprefix(prefix))
+
+    def removesuffix(self, suffix):
+        return self._copyobj(super().removesuffix(suffix))
+
+    def expandtabs(self, tabsize=8):
+        return self._copyobj(super().expandtabs(tabsize))
+
+    def join(self, seq):
+        return self._copyobj(super().join(seq))
+
+    def ljust(self, width, *args):
+        return self._copyobj(super().ljust(width, *args))
+
+    def lower(self):
+        return self._copyobj(super().lower())
+
+    def lstrip(self, chars=None):
+        return self._copyobj(super().lstrip(chars))
+
+    maketrans = str.maketrans
+
+    def replace(self, old, new, maxsplit=-1):
+        return self._copyobj(super().replace(old, new, maxsplit))
+
+    def rjust(self, width, *args):
+        return self._copyobj(super().rjust(width, *args))
+
+    def rstrip(self, chars=None):
+        return self._copyobj(super().rstrip(chars))
+
+    def strip(self, chars=None):
+        return self._copyobj(super().strip(chars))
+
+    def swapcase(self):
+        return self._copyobj(super().swapcase())
+
+    def title(self):
+        return self._copyobj(super().title())
+
+    def translate(self, *args):
+        return self._copyobj(super().translate(*args))
+
+    def upper(self):
+        return self._copyobj(super().upper())
+
+    def zfill(self, width):
+        return self._copyobj(super().zfill(width))
+
+    def splitlines(self, keepends=False):
+        return [self._copyobj(each) for each in super().splitlines(keepends)]
+
+    def rpartition(self, sep):
+        return tuple(self._copyobj(each) for each in super().rpartition(sep))
+
+    def rstrip(self, chars=None):
+        return self._copyobj(super().rstrip(chars))
+
+    def split(self, sep=None, maxsplit=-1):
+        return [self._copyobj(each) for each in super().split(sep, maxsplit)]
+
+    def rsplit(self, sep=None, maxsplit=-1):
+        return [self._copyobj(each) for each in super().rsplit(sep, maxsplit)]
+
+    def format(self, *args, **kwds):
+        return self._copyobj(super().format(*args, **kwds))
+
+    def format_map(self, mapping):
+        return self._copyobj(super().format_map(mapping))
+
+    @property
+    def cmd(self):
+        return self._cmd
+
+    @cmd.setter
+    def cmd(self, cmd):
+        """Forbidden to change the value of ``cmd``."""
+        pass
+
+class CommandOutput2(str):
+
+    ## References:
+    # - https://stackoverflow.com/questions/7255655/how-to-subclass-str-in-python
+    # - https://docs.python.org/3/library/collections.html#userstring-objects
+    # - Source code of UserString
+
+    def __new__(cls, content, cmd=None):
+        obj = super().__new__(cls, content)
+        obj._cmd = cmd
+        return obj
+
+    # def _copyobj(self, seq):
+    #     # __new__ needs type and the args.
+    #     # return self.__new__(type(self), seq, self._cmd)
+
+    def __getattribute__(self, name):
+        if name in dir(str) and name != '_copyobj': # only handle str methods here
+            def method(self, *args, **kwargs):
+                value = getattr(super(), name)(*args, **kwargs)
+                # not every string method returns a str:
+                if isinstance(value, str) and not isinstance(value, CommandOutput2):
+                    # return type(self)(value)
+                    return self.__new__(value, self._cmd)
+
+                elif isinstance(value, list):
+                    return [self.__new__(i, self._cmd) for i in value]
+
+                elif isinstance(value, tuple):
+                    return tuple(self.__new__(i, self._cmd) for i in value)
+                else: # dict, bool, or int or type
+                    return value
+            return method.__get__(self) # bound method
+        # else: # delegate to parent
+        #     return super().__getattribute__(name)

ansys/mapdl/core/mapdl_grpc.py

@@ -64,7 +64,7 @@
 )
 from ansys.mapdl.core import __version__, _LOCAL_PORTS
 from ansys.mapdl.core import check_version
-
+from ansys.mapdl.core.commands import CommandOutput as CommandOutput
 
 VOID_REQUEST = anskernel.EmptyRequest()
 
@@ -624,7 +624,7 @@ def _run(self, cmd, verbose=False, mute=None):
         else:
             response = self._send_command(cmd, mute=mute)
         self._busy = False
-        return response.strip()
+        return CommandOutput(response.strip(), cmd)
 
     @property
     def busy(self):

tests/conftest.py

@@ -1,6 +1,7 @@
 from pathlib import Path
 from collections import namedtuple
 import os
+import signal
 import time
 
 import pytest
@@ -76,7 +77,10 @@
 def check_pid(pid):
     """Check For the existence of a pid."""
     try:
-        os.kill(pid, 0)
+        # There are two main options:
+        # - Termination signal (SIGTERM) int=15. Soft termination (Recommended)
+        # - Kill signal (KILLTER). int=9. Hard termination
+        os.kill(pid, signal.SIGTERM)
     except OSError:
         return False
     else: