Added support for CWD to contain spaces (#643)

* Added support for CWD to contain spaces

the cwd command accepts directory paths with spaces when enclosed in a
pair of single quotes/apostrophes. However, it seems that it does NOT
support directory path's that otherwise contain single quotes. I have
added a note to this effect to the docstring.

Otherwise this commit enables the supplication of directory paths with
spaces in as well as two tests for this. The methods could (and perhaps
should) be extended to other path-related commands, but I'm not sure
which these are, and would welcome input from other people.

Otherwise, this commit should fix issue #641.

* fixed blank line problem

* ignore path tests on cloud

Co-authored-by: Alex Kaszynski <[email protected]>

Author: jgd10

ansys/mapdl/core/_commands/session/run_controls.py

@@ -113,6 +113,9 @@ def config(self, lab="", value="", **kwargs):
     def cwd(self, dirpath="", **kwargs):
         """Changes the current working directory.
 
+        ``dirpath`` must not contain any singular quotations/apostrophes.
+        These are not supported in APDL.
+
         APDL Command: /CWD
 
         Parameters
@@ -124,9 +127,11 @@ def cwd(self, dirpath="", **kwargs):
         -----
         After issuing the /CWD command, all new files opened with no default
         directory specified (via the FILE, /COPY, or RESUME commands, for
-        example) default to the new DIRPATH directory.
+        example) default to the new ``dirpath`` directory.
         """
-        command = "/CWD,%s" % (str(dirpath))
+        if not (dirpath.startswith('\'') and dirpath.endswith('\'')) and "'" in dirpath:
+            raise RuntimeError('The CWD command does not accept paths that contain singular quotes "'"")
+        command = f"/CWD,'{dirpath}'"
         return self.run(command, **kwargs)
 
     def filname(self, fname="", key="", **kwargs):

tests/conftest.py

@@ -1,4 +1,5 @@
 from pathlib import Path
+from collections import namedtuple
 import os
 import time
 
@@ -19,6 +20,9 @@
 # Necessary for CI plotting
 pyvista.OFF_SCREEN = True
 
+SpacedPaths = namedtuple('SpacedPaths', ['path_without_spaces', 'path_with_spaces',
+                                         'path_with_single_quote'])
+
 
 # Check if MAPDL is installed
 # NOTE: checks in this order to get the newest installed version
@@ -240,6 +244,14 @@ def mapdl(request, tmpdir_factory):
                 assert not check_pid(pid)
 
 
+@pytest.fixture
+def path_tests(tmpdir):
+    p1 = tmpdir.mkdir("./temp/")
+    p2 = tmpdir.mkdir("./t e m p/")
+    p3 = tmpdir.mkdir("./temp'")
+    return SpacedPaths(str(p1), str(p2), str(p3))
+
+
 @pytest.fixture(scope="function")
 def cleared(mapdl):
     mapdl.finish(mute=True)

tests/test_mapdl.py

@@ -20,7 +20,10 @@
 
 skip_in_cloud = pytest.mark.skipif(
     not get_start_instance(),
-    reason="Must be able to launch MAPDL locally. Cloud does not allow create folders."
+    reason="""
+Must be able to launch MAPDL locally. Remote execution does not allow for
+directory creation.
+"""
 )
 
 
@@ -819,3 +822,22 @@ def test_inval_commands_silent(mapdl, tmpdir, cleared):
     assert not mapdl.run("parm = 'asdf'")  # assert it is not empty
 
     mapdl._run('/gopr') # getting settings back
+
+
+@skip_in_cloud
+def test_path_without_spaces(mapdl, path_tests):
+    resp = mapdl.cwd(path_tests.path_without_spaces)
+    assert 'WARNING' not in resp
+
+
+@skip_in_cloud
+def test_path_with_spaces(mapdl, path_tests):
+    resp = mapdl.cwd(path_tests.path_with_spaces)
+    assert 'WARNING' not in resp
+
+
+@skip_in_cloud
+def test_path_with_single_quote(mapdl, path_tests):
+    with pytest.raises(RuntimeError):
+        resp = mapdl.cwd(path_tests.path_with_single_quote)
+        assert 'WARNING' not in resp