Merge pull request #225 from unihd-cag/219-block-script

Implement the block flag for the direct mode

docs/usage/quickstart.rst

@@ -98,3 +98,13 @@ And you can pass CLI arguments to the script
 
     If used with the above code, this will print "geGetEditCellView()" to *stdout* and
     "cell view: 1234" to *stderr*.
+
+.. warning::
+
+    Running a python script with ``pyRunScript`` does **not wait** until the script
+    is finished. If you rely on side effects the script causes, you can block until
+    the script is finished.
+
+.. code-block:: lisp
+
+    pyRunScript "pathToScript.py" ?block t

skillbridge/server/python_server.il

@@ -218,10 +218,12 @@ let((_filename _baseName _moduleFolder _logDirectory _executable _unbound)
     pyStartServer.logName = lsprintf("%s/skillbridge_skill.log" _logDirectory)
 
     putd('pyRunScript nil)
-    defun(pyRunScript (script @key (python "python") (args nil) "ttl")
-        let((command)
+    defun(pyRunScript (script @key (python "python") (args nil) (block nil) "ttlg")
+        let((command process)
             command = lsprintf("%s %s %s" python script buildString(args))
-            ipcBeginProcess(command "" '__pyOnData '__pyOnError '__pyOnFinishScript pyRunScript.logName)
+            process = ipcBeginProcess(command "" '__pyOnData '__pyOnError '__pyOnFinishScript pyRunScript.logName)
+
+            if(block then ipcWait(process) else process)
         )
     )
 

tests/script.py

@@ -0,0 +1,13 @@
+from ast import literal_eval
+from sys import argv
+from time import sleep
+
+from skillbridge import Symbol, Workspace
+
+ws = Workspace.open(direct=True)
+
+_, variable_name, value, delay = argv
+
+sleep(float(delay))
+
+ws['set'](Symbol(variable_name), literal_eval(value))

tests/test_integration.py

@@ -1,9 +1,12 @@
+from pathlib import Path
+from time import sleep
 from warnings import warn
 
-from _pytest.python_api import raises
-from pytest import fixture, skip
+from pytest import fixture, raises, skip
 
-from skillbridge import LazyList, RemoteObject, RemoteTable, SkillCode, Symbol, Workspace
+from skillbridge import LazyList, RemoteObject, RemoteTable, SkillCode, Symbol, Var, Workspace
+
+here = Path(__file__).parent
 
 
 @fixture(scope='module')
@@ -214,3 +217,21 @@ def test_table_getattr_is_equivalent_to_symbol_lookup(ws: Workspace) -> None:
 
 def test_nil_t_nil_is_not_a_disembodied_property_list(ws: Workspace) -> None:
     assert ws["cdr"]([0, None, True, None]) == [None, True, None]
+
+
+def test_run_script_does_not_block(ws: Workspace) -> None:
+    variable = 'skillbridge_script_args'
+    ws['set'](Symbol(variable), 0)
+    assert ws['pyRunScript'](str(here / 'script.py'), args=(variable, '42', '0.25'))
+
+    assert ws['plus'](Var(variable), 1) == 1
+    sleep(1.0)
+    assert ws['plus'](Var(variable), 1) == 43
+
+
+def test_run_script_blocks_when_requested(ws: Workspace) -> None:
+    variable = 'skillbridge_script_args'
+    ws['set'](Symbol(variable), 0)
+    assert ws['pyRunScript'](str(here / 'script.py'), args=(variable, '42', '0.25'), block=True)
+
+    assert ws['plus'](Var(variable), 1) == 43