Improving cmlist to allow to_list

src/ansys/mapdl/core/commands.py

@@ -832,6 +832,15 @@ def to_dataframe(self):
         return df
 
 
+class ComponentListing(CommandListingOutput):
+    @property
+    def _parsed(self):
+        from ansys.mapdl.core.component import _parse_cmlist
+
+        # To keep same API as commands
+        return np.array(list(_parse_cmlist(self).keys()))
+
+
 class StringWithLiteralRepr(str):
     def __repr__(self):
         return self.__str__()

src/ansys/mapdl/core/component.py

@@ -1,5 +1,5 @@
 """Component related module"""
-
+import re
 from typing import (
     TYPE_CHECKING,
     Any,
@@ -514,3 +514,73 @@
             if i_type_ == type_:
                 dict_[each_comp] = i_items
         return dict_
+
+
+def _parse_cmlist_indiv(
+    cmname: str, cmtype: str, cmlist: Optional[str] = None
+) -> List[int]:
+    # Capturing blocks
+    if "NAME" in cmlist and "SUBCOMPONENTS" in cmlist:
+        header = r"NAME\s+TYPE\s+SUBCOMPONENTS"
+
+    elif "LIST COMPONENT" in cmlist:
+        header = ""
+
+    cmlist = "\n\n".join(
+        re.findall(
+            r"(?s)" + header + r"\s+(.*?)\s*(?=\n\s*\n|\Z)",
+            cmlist,
+            flags=re.DOTALL,
+        )
+    )
+
+    # Capturing items in each block
+    rg = cmname.upper() + r"\s+" + cmtype.upper() + r"\s+(.*?)\s*(?=\n\s*\n|\Z)"
+    items = "\n".join(re.findall(rg, cmlist, flags=re.DOTALL))
+
+    # Joining them together and giving them format.
+    items = items.replace("\n", "  ").split()
+    items = [int(each) for each in items]
+
+    return items
+
+
+def _parse_cmlist(cmlist: Optional[str] = None) -> Dict[str, Any]:
+    include_selection = False
+    if re.search(r"NAME\s+TYPE\s+SUBCOMPONENTS", cmlist):
+        # header
+        #  "NAME                            TYPE      SUBCOMPONENTS"
+        blocks = re.findall(
+            r"(?s)NAME\s+TYPE\s+SUBCOMPONENTS\s+(.*?)\s*(?=\n\s*\n|\Z)",
+            cmlist,
+            flags=re.DOTALL,
+        )
+    elif re.search(r"NAME\s+SELE\s+TYPE\s+SUBCOMPONENTS", cmlist):
+        blocks = re.findall(
+            r"(?s)NAME\s+SELE\s+TYPE\s+SUBCOMPONENTS\s+(.*?)\s*(?=\n\s*\n|\Z)",
+            cmlist,
+            flags=re.DOTALL,
+        )
+        # Using `cmlist,all` which also includes selection
+        include_selection = True
+    elif "LIST ALL SELECTED COMPONENTS":
+        blocks = cmlist.splitlines()[1:]
+    else:
+        raise ValueError("The format of the CMLIST output is not recognaised.")
+
+    cmlist = "\n".join(blocks)
+
+    def extract(each_line, ind):
+        return each_line.split()[ind].strip()
+
+    def extract_line(each_line):
+        if include_selection:
+            return [extract(each_line, 1), extract(each_line, 2)]
+        else:
+            return extract(each_line, 1)
+
+    return {
+        extract(each_line, 0): extract_line(each_line)
+        for each_line in cmlist.splitlines()
+        if each_line
+    }

src/ansys/mapdl/core/mapdl.py

@@ -4965,62 +4965,22 @@ def _parse_rlist(self) -> Dict[int, float]:
         return const_
 
     def _parse_cmlist(self, cmlist: Optional[str] = None) -> Dict[str, Any]:
+        from ansys.mapdl.core.component import _parse_cmlist
+
         if not cmlist:
             cmlist = self.cmlist()
 
-        if "NAME" in cmlist and "SUBCOMPONENTS" in cmlist:
-            # header
-            #  "NAME                            TYPE      SUBCOMPONENTS"
-            blocks = re.findall(
-                r"(?s)NAME\s+TYPE\s+SUBCOMPONENTS\s+(.*?)\s*(?=\n\s*\n|\Z)",
-                cmlist,
-                flags=re.DOTALL,
-            )
-        elif "LIST ALL SELECTED COMPONENTS":
-            blocks = cmlist.splitlines()[1:]
-        else:
-            raise ValueError("The format of the CMLIST output is not recognaised.")
-
-        cmlist = "\n".join(blocks)
-
-        def extract(each_line, ind):
-            return each_line.split()[ind].strip()
-
-        return {
-            extract(each_line, 0): extract(each_line, 1)
-            for each_line in cmlist.splitlines()
-            if each_line
-        }
+        return _parse_cmlist(cmlist)
 
     def _parse_cmlist_indiv(
         self, cmname: str, cmtype: str, cmlist: Optional[str] = None
     ) -> List[int]:
+        from ansys.mapdl.core.component import _parse_cmlist_indiv
+
         if not cmlist:
             cmlist = self.cmlist(cmname, 1)
-        # Capturing blocks
-        if "NAME" in cmlist and "SUBCOMPONENTS" in cmlist:
-            header = r"NAME\s+TYPE\s+SUBCOMPONENTS"
-
-        elif "LIST COMPONENT" in cmlist:
-            header = ""
-
-        cmlist = "\n\n".join(
-            re.findall(
-                r"(?s)" + header + r"\s+(.*?)\s*(?=\n\s*\n|\Z)",
-                cmlist,
-                flags=re.DOTALL,
-            )
-        )
-
-        # Capturing items in each block
-        rg = cmname.upper() + r"\s+" + cmtype.upper() + r"\s+(.*?)\s*(?=\n\s*\n|\Z)"
-        items = "\n".join(re.findall(rg, cmlist, flags=re.DOTALL))
 
-        # Joining them together and giving them format.
-        items = items.replace("\n", "  ").split()
-        items = [int(each) for each in items]
-
-        return items
+        return _parse_cmlist_indiv(cmname, cmtype, cmlist)
 
     @wraps(Commands.cmplot)
     def cmplot(self, label: str = "", entity: str = "", keyword: str = "", **kwargs):
@@ -5733,3 +5693,9 @@ def rexport(self, *args, **kwargs):
                 "The command 'Mapdl.rexport()' for explicit analysis was deprecated in Ansys 19.1"
             )
         super().rexport(*args, **kwargs)
+
+    @wraps(Commands.cmlist)
+    def cmlist(self, *args, **kwargs):
+        from ansys.mapdl.core.commands import ComponentListing
+
+        return ComponentListing(super().cmlist(*args, **kwargs))

tests/test_commands.py

@@ -710,3 +710,36 @@ def test_nlist_to_array(mapdl, beam_solve):
     assert len(nlist.to_list()) == len(mapdl.mesh.nodes)
     assert len(nlist.to_array()) == len(mapdl.mesh.nodes)
     assert np.allclose(nlist.to_array()[:, 1:4], mapdl.mesh.nodes)
+
+
+def test_cmlist(mapdl):
+    mapdl.clear()
+
+    mapdl.prep7()
+    # setup the full file
+    mapdl.block(0, 1, 0, 1, 0, 1)
+    mapdl.et(1, 186)
+    mapdl.esize(0.5)
+    mapdl.vmesh("all")
+
+    mapdl.cm("myComp", "node")
+    mapdl.cm("_myComp", "node")
+    mapdl.cm("_myComp_", "node")
+
+    cmlist = mapdl.cmlist()
+    assert "MYCOMP" in cmlist
+
+    cmlist_all = mapdl.cmlist("all")
+    assert "_MYCOMP_" in cmlist_all
+    assert "_MYCOMP" in cmlist_all
+    assert "MYCOMP" in cmlist_all
+
+    assert ["MYCOMP"] == mapdl.cmlist().to_list()
+
+    assert "_MYCOMP_" in cmlist_all.to_list()
+    assert "_MYCOMP" in cmlist_all.to_list()
+    assert "MYCOMP" in cmlist_all.to_list()
+
+    assert len(cmlist_all.to_array()) == len(cmlist_all.to_list())
+    for each_ in cmlist_all.to_list():
+        assert each_ in cmlist_all