File uploader in MPREAD and MPWRITE (#976)

* Improving docstring

* Improving MPWRITE docstring

* Adding wrapper to mpread and mpwrite

* Moving math._load_file to misc.load_file

* Adding unit tests

* Masking input inside MPREAD.

* fixing unit tests

* Fixing non implemented error

* Extending coverage

* Removed raising exception if downloading in local. It does not make sense.

* Adding test for writing outside working dir in remote

Author: germa89

src/ansys/mapdl/core/mapdl.py

@@ -2903,3 +2903,28 @@ def mpread(self, fname="", ext="", lib="", **kwargs):
         fname = load_file(self, fname_)
         self._log.info("Bypassing 'MPREAD' with 'INPUT'.")
         return self.input(fname)
+
+    @wraps(Commands.mpwrite)
+    def mpwrite(
+        self,
+        fname="",
+        ext="",
+        lib="",
+        mat="",
+        download_file=False,
+        progress_bar=True,
+        **kwargs,
+    ):
+        fname_ = fname + "." + ext
+        if not self._local:
+            if os.path.dirname(fname_):
+                raise IOError(
+                    "Only writing files to the MAPDL working directory is allowed. "
+                    f"The supplied path {fname_} is not allowed."
+                )
+
+        output = super().mpwrite(fname, ext, lib, mat, **kwargs)
+        if download_file:
+            self.download(os.path.basename(fname_), progress_bar=progress_bar)
+
+        return output

tests/test_mapdl.py

@@ -1476,18 +1476,60 @@ def test_mpfunctions(mapdl, cube_solve, capsys):
     fname = "test"
     ext = "mp1"
 
-    mapdl.mpwrite(fname, ext)
+    assert f"WRITE OUT MATERIAL PROPERTY LIBRARY TO FILE=" in mapdl.mpwrite(fname, ext)
     assert f"{fname}.{ext}" in mapdl.list_files()
 
-    nuxy = 0.3
+    # asserting downloading
+    ext = "mp2"
+    assert f"WRITE OUT MATERIAL PROPERTY LIBRARY TO FILE=" in mapdl.mpwrite(
+        fname, ext, download_file=True
+    )
+    assert f"{fname}.{ext}" in mapdl.list_files()
+    assert os.path.exists(f"{fname}.{ext}")
+
+    ## Checking reading
+    # Uploading a local file
+    with open(f"{fname}.{ext}", "r") as fid:
+        text = fid.read()
+
+    os.remove(f"{fname}.{ext}")  # remove temp file
+
+    ext = ext + "2"
+    fname_ = f"{fname}.{ext}"
+    new_nuxy = "MPDATA,NUXY,       1,   1, 0.4000000E+00,"
+    nuxy = float(new_nuxy.split(",")[4])
     ex = 0.2100000e12
 
+    with open(fname_, "w") as fid:
+        fid.write(text.replace("MPDATA,NUXY,       1,   1, 0.3000000E+00,", new_nuxy))
+
+    assert fname_ not in mapdl.list_files()
+    mapdl.clear()
+    mapdl.prep7()
+    captured = capsys.readouterr()  # To flush it
+    output = mapdl.mpread(fname, ext)
+    captured = capsys.readouterr()
+    assert f"Uploading {fname}.{ext}:" in captured.err
+    assert "PROPERTY TEMPERATURE TABLE    NUM. TEMPS=  1" in output
+    assert "TEMPERATURE TABLE ERASED." in output
+    assert "0.4000000" in output
+    assert fname_ in mapdl.list_files()
+    # check if materials are read into the db
+    assert mapdl.get_value("NUXY", "1", "TEMP", 0) == nuxy
+    assert np.allclose(mapdl.get_value("EX", 1, "TEMP", 0), ex)
+
     # Reding file in remote
+    fname_ = f"{fname}.{ext}"
+    os.remove(fname_)
+    assert not os.path.exists(fname_)
+    assert f"{fname}.{ext}" in mapdl.list_files()
+
     mapdl.clear()
     mapdl.prep7()
     output = mapdl.mpread(fname, ext)
     assert "PROPERTY TEMPERATURE TABLE    NUM. TEMPS=  1" in output
     assert "TEMPERATURE TABLE ERASED." in output
+    assert "0.4000000" in output
     assert np.allclose(mapdl.get_value("NUXY", "1", "TEMP", 0), nuxy)
     assert np.allclose(mapdl.get_value("EX", 1, "TEMP", 0), ex)
 
@@ -1498,3 +1540,7 @@ def test_mpfunctions(mapdl, cube_solve, capsys):
     # Test not implemented error
     with pytest.raises(NotImplementedError):
         mapdl.mpread(fname="dummy", ext="dummy", lib="something")
+
+    # Test suppliying a dir path when in remote
+    with pytest.raises(IOError):
+        mapdl.mpwrite("/test_dir/test", "mp")