Merge pull request #246 in LCL/wolframclientforpython from feature/12.3-zmq-features to master

* commit '284dbdd4cd688a5f316f530d708486f7899651fe':
  SocketListen disabled but left in place for posterity
  Use SocketListen to evaluate message
  wrong color scheme for message name
  increase minor version
  new ZMQ module lazy starts during the function call.
  removing unfortunate use of the word slave
  test should not trigger lib installation
  updating minor version in paclet info
  introducing 12.3 functions

Author: Dorian Birraux

PacletInfo.m

@@ -1,6 +1,6 @@
 Paclet[
     Name -> "WolframClientForPython",
-    Version -> "1.1.3",
+    Version -> "1.1.5",
     MathematicaVersion -> "11.3+",
     Loading -> Automatic,
     Extensions -> {}

docs/wri_theme/static/mma.scss

@@ -29,7 +29,7 @@ $green: rgb(67, 137, 88);
     color: $black;
   }
   .ne { // Messages (the "foo" in General::foo)
-    color: $magenta;
+    color: $black;
   }
   .nf { // Slots
     color: $green;

wolframclient/about.py

@@ -2,6 +2,6 @@
 
 __name__ = "wolframclient"
 __description__ = "A Python library with various tools to interact with the Wolfram Language and the Wolfram Cloud."
-__version__ = "1.1.4"
+__version__ = "1.1.5"
 __author__ = "Wolfram Research"
 __author_email__ = "support@wolfram.com, dorianb@wolfram.com, riccardod@wolfram.com"

wolframclient/cli/commands/test.py

@@ -10,20 +10,20 @@
 from wolframclient.utils.importutils import module_path
 
 
-@to_tuple
-def dependencies():
-    yield ("pytz", "2018.6")
-
-    if not six.JYTHON:
-        yield ("numpy", not six.PY2 and "1.15.3" or None)
-        yield ("pillow", "7.1.2")
-        yield ("requests", "2.20.0")
-        yield ("oauthlib", "2.1.0")
-        yield ("pyzmq", "17.1.2")
-        yield ("pandas", "1.0.4")
-        yield ("unittest-xml-reporting", None)
-    if not six.PY2:
-        yield ("aiohttp", "3.6.2")
+# @to_tuple
+# def dependencies():
+    # yield ("pytz", "2018.6")
+    #
+    # if not six.JYTHON:
+    #     yield ("numpy", not six.PY2 and "1.15.3" or None)
+    #     yield ("pillow", "7.1.2")
+    #     yield ("requests", "2.20.0")
+    #     yield ("oauthlib", "2.1.0")
+    #     yield ("pyzmq", "17.1.2")
+    #     yield ("pandas", "1.0.4")
+    #     yield ("unittest-xml-reporting", None)
+    # if not six.PY2:
+    #     yield ("aiohttp", "3.6.2")
 
 
 class Command(SimpleCommand):
@@ -33,7 +33,7 @@ class Command(SimpleCommand):
 
     modules = ["wolframclient.tests"]
 
-    dependencies = dependencies()
+    dependencies = ()
 
     def add_arguments(self, parser):
         parser.add_argument(

wolframclient/evaluation/kernel/initkernel.m

@@ -1,7 +1,6 @@
 (* ::Package:: *)
 
-(* Not useful since we apparently never receive multipart messages,
-no matter the total size (tested with 80MB) *)
+
 $NotSupportedVersionErrNo = 10;
 $MinVersionSupported = 11.3;
 If[$VersionNumber < $MinVersionSupported, Exit[$NotSupportedVersionErrNo]];
@@ -44,11 +43,15 @@ no matter the total size (tested with 80MB) *)
 			]
 		]
 	},
-	True
-	,
+	PacletFind["ZeroMQLink" -> "1.2*"] == {},
 	{
 		ZMQSocketWriteMessage,
 		SocketReadMessage[#, "Blocking"->False] &
+	},
+	True,
+	{
+		SocketWriteMessage[##, "Blocking"->False] &,
+		SocketReadMessage[#, "Blocking"->False] &
 	}
 ];
 
@@ -185,10 +188,10 @@ no matter the total size (tested with 80MB) *)
 $MaxIdlePause=.001;
 $MinIdlePause=0.0001;
 $PauseIncrement=0.0001;
-$TaskSupportMinVersion = Infinity;
-
+(*$ListenerSupportMinVersion = 12.3;*)
+$ListenerSupportMinVersion = Infinity;
 Which[
-	$VersionNumber < $TaskSupportMinVersion,
+	$VersionNumber < $ListenerSupportMinVersion,
 	(* Low CPU wait but need synchronous loop. *)
 	evaluationLoop[socketIn_SocketObject]:= With[
 		{maxPause=$MaxIdlePause, minPause=$MinIdlePause, incr=$PauseIncrement, poller={socketIn}},
@@ -204,8 +207,20 @@ no matter the total size (tested with 80MB) *)
 			]
 		]
 	],
+	(* Version with SocketListen, code is cleaner is 3 times slower as the version above.
+	Possibly during the async events and pre-emptive evaluation.
+	 *)
 	True,
-	(* Version with fixed asynchronous tasks *)
+	evaluationLoop[socketIn_SocketObject]:= (
+		$SocketListener = SocketListen[
+			socketIn,
+			socketEventHandler[#DataByteArray]&
+		];
+		SendAck[];
+		Pause[2^60];
+	);
+	(*
+	 Version with fixed asynchronous tasks
 	evaluationLoop[socketIn_SocketObject]:= With[
 		{maxPause=$MaxIdlePause, minPause=$MinIdlePause, incr=$PauseIncrement, poller={socketIn}},
 		$Task = SessionSubmit[
@@ -218,32 +233,33 @@ no matter the total size (tested with 80MB) *)
 					SocketWaitNext[poller];
 				]
 			),
-			0.0001 (*negligeable compared to IO operations ~1ms. We basically need 0 but can't use this value. *)
+			0.0001 negligeable compared to IO operations ~1ms. We basically need 0 but can't use this value.
 			],
 			Method->"Idle",
 			HandlerFunctions-><|"TaskStarted"->SendAck[]|>
 		];
 	];
+	*)
 ];
 (* can be useful for loopback connections which are available only if a task can be used. 
 Does not kill the kernel *)
 ClientLibrary`disconnect[] := Quit[];
-ClientLibrary`disconnect[] /; ($Task =!= None) := (
-	TaskRemove[$Task];
+ClientLibrary`disconnect[] /; ($SocketListener =!= None) := (
+	DeleteObject[$SocketListener];
 	Scan[
 		If[# =!= None, Close[#]] &,
 		{$LoggerSocket, $OutputSocket, $InputSocket}
 	]
 );
-$Task = None;
+$SocketListener = None;
 $LoggerSocket=None;
 $OutputSocket=None;
 $InputSocket=None;
 
 $MaxMessagesReturned = 31;
 $NoMessage = ByteArray[{0}];
 
-SlaveKernelPrivateStart[inputsocket_String, outputsocket_String, logsocket_String, loglevel_Integer] := (
+KernelPrivateStart[inputsocket_String, outputsocket_String, logsocket_String, loglevel_Integer] := (
 	$LoggerSocket=SocketConnect[logsocket,"ZMQ_PUB"];
 	If[FailureQ[$LoggerSocket],
 		Print["Failed to connect to logging socket: ", logsocket]
@@ -252,12 +268,12 @@ no matter the total size (tested with 80MB) *)
 		setLogLevel[loglevel];
 		addMessageHandler[];
 		addPrintHandler[];
-		SlaveKernelPrivateStart[inputsocket, outputsocket]
+		KernelPrivateStart[inputsocket, outputsocket]
 	];
 );
 
 
-SlaveKernelPrivateStart[inputsocket_String, outputsocket_String] := Block[
+KernelPrivateStart[inputsocket_String, outputsocket_String] := Block[
 	{listener, msg},
 	$InputSocket = SocketConnect[inputsocket, "ZMQ_Pull"];
 	$OutputSocket = SocketConnect[outputsocket, "ZMQ_Push"];

wolframclient/evaluation/kernel/kernelcontroller.py

@@ -392,7 +392,7 @@ def _kernel_start(self):
             self.kernel_logger.start()
             cmd.append("-run")
             cmd.append(
-                'ClientLibrary`Private`SlaveKernelPrivateStart["%s", "%s", "%s", %i];'
+                'ClientLibrary`Private`KernelPrivateStart["%s", "%s", "%s", %i];'
                 % (
                     self.kernel_socket_out.uri,
                     self.kernel_socket_in.uri,
@@ -403,7 +403,7 @@ def _kernel_start(self):
         else:
             cmd.append("-run")
             cmd.append(
-                'ClientLibrary`Private`SlaveKernelPrivateStart["%s", "%s"];'
+                'ClientLibrary`Private`KernelPrivateStart["%s", "%s"];'
                 % (self.kernel_socket_out.uri, self.kernel_socket_in.uri)
             )
 

wolframclient/tests/evaluation/test_kernel.py

@@ -298,27 +298,27 @@ def test_throw(self):
 class TestSessionTimeout(TestCaseSettings):
     def test_evaluate_async_basic_inputform(self):
         future = self.kernel_session.evaluate_future("1+1")
-        self.assertEqual(future.result(timeout=1), 2)
+        self.assertEqual(future.result(timeout=2), 2)
 
     def test_evaluate_async_basic_wl(self):
         future = self.kernel_session.evaluate_future(wl.Plus(1, 2))
-        self.assertEqual(future.result(timeout=1), 3)
+        self.assertEqual(future.result(timeout=2), 3)
 
     def test_evaluate_multiple_async(self):
         with WolframLanguageSession(kernel_path) as kernel_session:
             future1 = kernel_session.evaluate_future("3+4")
             result1 = future1.result(timeout=3)
             self.assertEqual(result1, 7)
             future2 = kernel_session.evaluate_future("10+1")
-            self.assertEqual(future2.result(timeout=1), 11)
+            self.assertEqual(future2.result(timeout=2), 11)
             future3 = kernel_session.evaluate_future("100+1")
-            self.assertEqual(future3.result(timeout=1), 101)
+            self.assertEqual(future3.result(timeout=2), 101)
 
     def test_many_failures_wrap_async(self):
         future = self.kernel_session.evaluate_wrap_future(
             'ImportString["[1,2", "RawJSON"]; 1/0'
         )
-        res = future.result(timeout=1)
+        res = future.result(timeout=2)
         self.assertFalse(res.success)
         expected_msgs = (
             "Expecting end of array or a value separator.",
@@ -342,7 +342,7 @@ def test_many_failures_wrap_async(self):
 
     def test_valid_evaluate_wxf_async(self):
         future = self.kernel_session.evaluate_wxf_future("Range[3]")
-        wxf = future.result(timeout=1)
+        wxf = future.result(timeout=2)
         result = binary_deserialize(wxf, consumer=WXFConsumer())
         self.assertEqual(result, [1, 2, 3])