feat: adding opened attribute (#3731)

* feat: adding opened attribute

* feat: adding opened attribute

* chore: adding changelog file 3731.miscellaneous.md [dependabot-skip]

* docs: adding docstring

* fix: tests

* fix: test

---------

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

Author: germa89

doc/changelog.d/3731.miscellaneous.md

@@ -0,0 +1 @@
+feat: adding opened attribute

src/ansys/mapdl/core/xpl.py

@@ -124,6 +124,7 @@ def close(self):
         """
         response = self._mapdl.run("*XPL,CLOSE")
         self._check_ignored(response)
+        self._filename = None
         self._open = False
         return response
 
@@ -373,6 +374,8 @@ def save(self):
         """Save the current file, ignoring the marked records."""
         response = self._mapdl.run("*XPL,SAVE").strip()
         self._check_ignored(response)
+        self._open = False
+        self._filename = None
         return response
 
     def extract(self, recordname, sets="ALL", asarray=False):
@@ -550,8 +553,22 @@ def write(self, recordname, vecname):
     def __repr__(self):
         txt = "MAPDL File Explorer\n"
         if self._open:
-            txt += "\tOpen file:%s" % self._filename
+            txt += f"\tOpen file : {self._filename}"
             txt += "\n".join(self.where().splitlines()[1:])
         else:
             txt += "\tNo open file"
         return txt
+
+    @property
+    def opened(self):
+        """
+        Check if a file is currently open.
+
+        Returns:
+            str or None: The filename if a file is open, otherwise None.
+        """
+
+        if self._open:
+            return self._filename
+        else:
+            return None

tests/test_xpl.py

@@ -46,6 +46,8 @@ def create_cube(self, mapdl):
         from conftest import clear
 
         clear(mapdl)
+        mapdl.clear()
+        mapdl.prep7()
 
         # set up the full file
         mapdl.block(0, 1, 0, 1, 0, 1)
@@ -70,9 +72,12 @@ def create_cube(self, mapdl):
         if mapdl.result_file in mapdl.list_files():
             mapdl.slashdelete(mapdl.result_file)
 
+        if "cube_solve_xpl" in mapdl.list_files():
+            mapdl.slashdelete("cube_solve_xpl.db")
+
         # solve first 10 non-trivial modes
         mapdl.modal_analysis(nmode=10, freqb=1)
-        mapdl.save("cube_solve_xpl")
+        mapdl.save("cube_solve_xpl", "db")
 
     @pytest.fixture(scope="class")
     def cube_solve(self, mapdl):
@@ -81,17 +86,20 @@ def cube_solve(self, mapdl):
     @pytest.fixture(scope="function")
     def xpl(self, mapdl, cube_solve):
         mapdl.prep7()
-        mapdl.resume("cube_solve_xpl")
+        mapdl.resume("cube_solve_xpl", "db")
 
         xpl = mapdl.xpl
         if not self.full_file and not self.full_file in mapdl.list_files():
             self.create_cube(mapdl)
 
         xpl.open(self.full_file)
-        return xpl
 
-    @staticmethod
-    def test_close(xpl):
+        yield xpl
+
+        if xpl.opened:
+            xpl.close()
+
+    def test_close(self, xpl):
         xpl.close()
         with pytest.raises(MapdlCommandIgnoredError):
             xpl.list()
@@ -198,3 +206,10 @@ def test_extract(self, xpl):
 
         mat = xpl.extract("NSL")
         assert mat.shape == (243, 10)
+
+    def test_opened(self, xpl):
+        assert xpl.opened
+        xpl.close()
+        assert not xpl.opened
+        xpl.open(self.full_file)
+        assert xpl.opened