feat: add api to get keyword names (#745)

Co-authored-by: Mohamed Koubaa <[email protected]>
Co-authored-by: pyansys-ci-bot <[email protected]>

Author: 3 people

doc/changelog/745.documentation.md

@@ -0,0 +1 @@
+feat: add api to get keyword names

src/ansys/dyna/core/lib/deck.py

@@ -539,6 +539,19 @@ def title(self) -> typing.Optional[str]:
     def title(self, value: str) -> None:
         self._title = value
 
+    @property
+    def keyword_names(self) -> typing.List[str]:
+        names = []
+        for kw in self.all_keywords:
+            if isinstance(kw, KeywordBase):
+                names.append(f"{kw.get_title()}")
+            elif isinstance(kw, str):
+                try_title = kw.split("\n")[0]
+                names.append(f"str({try_title}...)")
+            elif isinstance(kw, EncryptedKeyword):
+                names.append(f"Encrypted")
+        return names
+
     def __repr__(self) -> str:
         """Get a console-friendly representation of a list of all keywords in the deck."""
         kwlist = self.all_keywords

tests/test_deck.py

@@ -279,6 +279,8 @@ def test_kwdeck_basic_002(file_utils, ref_string):
     deck.extend([curve1, curve2, include1, volume1, volume2, volume3, tshell1, seatbelt1] + string)
     deck_string = deck.write()
     file_utils.compare_string_with_file(deck_string, "test.k")
+    assert deck.keyword_names[0] == "*DEFINE_CURVE"
+    assert deck.keyword_names[2] == "*INCLUDE"
 
 
 @pytest.mark.keywords