Simplify usages of task.outputs['result']

For retrieval, we can use the new task.result() convenience method.
For assignment, we can rely on result being set automatically.

Author: ctrueden

README.md

@@ -76,8 +76,7 @@ Environment env = Appose.system();
 try (Service python = env.python()) {
     Task task = python.task("5 + 6");
     task.waitFor();
-    Object result = task.outputs.get("result");
-    assertEquals(11, result);
+    assertEquals(11, task.result());
 }
 ```
 

src/main/java/org/apposed/appose/Appose.java

@@ -69,8 +69,7 @@
  *     5 + 6
  *     """);
  * task.waitFor();
- * Object result = task.outputs.get("result");
- * assertEquals(11, result);
+ * assertEquals(11, task.result());
  * }</pre>
  * <p>
  * And here is an example using a few more of Appose's features:
@@ -163,7 +162,7 @@
  * {
  *    "task" : "87427f91-d193-4b25-8d35-e1292a34b5c4",
  *    "requestType" : "EXECUTE",
- *    "script" : "task.outputs[\"result\"] = computeResult(gamma)\n",
+ *    "script" : "task.outputs[\"answer\"] = computeResult(gamma)\n",
  *    "inputs" : {"gamma": 2.2}
  * }
  * </code></pre>

src/main/java/org/apposed/appose/Service.java

@@ -286,7 +286,7 @@ public Object getVar(String name) throws IOException, InterruptedException {
 		Syntaxes.validate(this);
 		String script = syntax.getVar(name);
 		Task task = task(script).waitFor();
-		if (task.status == TaskStatus.COMPLETE) return task.outputs.get("result");
+		if (task.status == TaskStatus.COMPLETE) return task.result();
 		throw new IllegalStateException("Failed to get variable '" + name + "': " + task.error);
 	}
 
@@ -350,7 +350,7 @@ public Object call(String function, Object... args) throws IOException, Interrup
 		}
 		String script = syntax.call(function, varNames);
 		Task task = task(script, inputs).waitFor();
-		if (task.status == TaskStatus.COMPLETE) return task.outputs.get("result");
+		if (task.status == TaskStatus.COMPLETE) return task.result();
 		throw new IllegalStateException("Failed to call function '" + function + "': " + task.error);
 	}
 

src/main/java/org/apposed/appose/util/Proxies.java

@@ -112,7 +112,7 @@ public static <T> T create(Service service, String var, Class<T> api) {
 	 * Each method invocation on the returned proxy generates a script of the form
 	 * {@code var.methodName(arg0, arg1, ...)} and submits it as a task to the worker.
 	 * Arguments are passed via the task's {@code inputs} map, and the return value
-	 * is retrieved from {@code task.outputs["result"]}.
+	 * is retrieved from {@code task.result()}.
 	 * </p>
 	 * <p>
 	 * <strong>Variable export requirement:</strong> The variable must have been previously
@@ -141,7 +141,7 @@ public static <T> T create(Service service, String var, Class<T> api) {
 	 * @param queue Optional queue identifier for task execution. Pass {@code "main"} to ensure
 	 *              execution on the worker's main thread, or {@code null} for default behavior.
 	 * @return A proxy object implementing the specified interface. Method calls block until
-	 *         the remote execution completes and return the value from {@code task.outputs["result"]}.
+	 *         the remote execution completes and return the value from {@code task.result()}.
 	 * @throws RuntimeException If a proxied method call fails in the worker process.
 	 * @see Service#proxy(String, Class, String) Convenience method available on Service instances.
 	 * @see Service#task(String, String) For understanding queue behavior.
@@ -171,7 +171,7 @@ public static <T> T create(Service service, String var, Class<T> api, String que
 			if (task.status != Service.TaskStatus.COMPLETE) {
 				throw new RuntimeException(task.error);
 			}
-			return task.outputs.get("result");
+			return task.result();
 		});
 	}
 }

src/test/java/org/apposed/appose/BuilderTest.java

@@ -234,10 +234,10 @@ public void testCustom() throws IOException, InterruptedException {
 		// Verify that the custom environment can execute Python tasks.
 		try (Service service = env.python()) {
 			maybeDebug(service);
-			Task task = service.task("task.outputs['result'] = 2 + 2");
+			Task task = service.task("2 + 2");
 			task.waitFor();
 			assertComplete(task);
-			Number result = (Number) task.outputs.get("result");
+			Number result = (Number) task.result();
 			assertEquals(4, result.intValue());
 		}
 

src/test/java/org/apposed/appose/NDArrayExampleGroovy.java

@@ -62,9 +62,9 @@ public static void main(String[] args) throws Exception {
 		try (Service service = env.groovy()) {
 			final Map< String, Object > inputs = new HashMap<>();
 			inputs.put( "img", ndArray);
-			Service.Task task = service.task(PRINT_INPUT, inputs );
+			Service.Task task = service.task(PRINT_INPUT, inputs);
 			task.waitFor();
-			System.out.println( "result = " + task.outputs.get("result") );
+			System.out.println("result = " + task.result());
 		}
 		ndArray.close();
 	}

src/test/java/org/apposed/appose/NDArrayExamplePython.java

@@ -59,7 +59,7 @@ public static void main(String[] args) throws Exception {
 			inputs.put( "img", ndArray);
 			Service.Task task = service.task(PRINT_INPUT, inputs );
 			task.waitFor();
-			final String result = ( String ) task.outputs.get( "result" );
+			final String result = ( String ) task.result();
 			System.out.println( "result = \n" + result );
 		}
 		ndArray.close();
@@ -68,6 +68,6 @@ public static void main(String[] args) throws Exception {
 
 	private static final String PRINT_INPUT = "" + //
 		"import numpy as np\n" + //
-		"task.outputs['result'] = str(img.ndarray())";
+		"str(img.ndarray())";
 
 }

src/test/java/org/apposed/appose/ServiceTest.java

@@ -79,7 +79,7 @@ public void testScopeGroovy() throws IOException, InterruptedException {
 			assertEquals(10, result.intValue());
 
 			inputs.put("age", 81);
-			task = service.task("task.outputs['result'] = sqrt_age(age)", inputs).waitFor();
+			task = service.task("sqrt_age(age)", inputs).waitFor();
 			assertComplete(task);
 			result = (Number) task.result();
 			assertEquals(9, result.intValue());
@@ -284,7 +284,7 @@ public void testInit() throws IOException, InterruptedException {
 			maybeDebug(service);
 
 			// Verify that the init script was executed and the variable is accessible.
-			Task task = service.task("task.outputs['result'] = init_value").waitFor();
+			Task task = service.task("init_value").waitFor();
 			assertComplete(task);
 
 			String result = (String) task.result();
@@ -301,7 +301,7 @@ public void testTaskResult() throws IOException, InterruptedException {
 			maybeDebug(service);
 
 			// Create a task that produces a result.
-			Task task = service.task("task.outputs['result'] = 'success'").waitFor();
+			Task task = service.task("'success'").waitFor();
 			assertComplete(task);
 
 			// Test the result() convenience method.

src/test/java/org/apposed/appose/SyntaxTest.java

@@ -105,9 +105,9 @@ public void testPutVarPython() throws IOException, InterruptedException {
 			service.putVar("my_number", 123);
 
 			// Verify the variable is accessible in subsequent tasks
-			Task task = service.task("task.outputs['result'] = my_number * 2").waitFor();
+			Task task = service.task("my_number * 2").waitFor();
 			assertComplete(task);
-			Number result = (Number) task.outputs.get("result");
+			Number result = (Number) task.result();
 			assertEquals(246, result.intValue());
 		}
 	}
@@ -123,9 +123,9 @@ public void testPutVarGroovy() throws IOException, InterruptedException {
 			service.putVar("my_string", "test");
 
 			// Verify the variable is accessible in subsequent tasks
-			Task task = service.task("task.outputs['result'] = my_string.toUpperCase()").waitFor();
+			Task task = service.task("my_string.toUpperCase()").waitFor();
 			assertComplete(task);
-			String result = (String) task.outputs.get("result");
+			String result = (String) task.result();
 			assertEquals("TEST", result);
 		}
 	}
@@ -142,9 +142,9 @@ public void testPutVarList() throws IOException, InterruptedException {
 			service.putVar("my_list", values);
 
 			// Verify the list is accessible and can be manipulated
-			Task task = service.task("task.outputs['result'] = sum(my_list)").waitFor();
+			Task task = service.task("sum(my_list)").waitFor();
 			assertComplete(task);
-			Number result = (Number) task.outputs.get("result");
+			Number result = (Number) task.result();
 			assertEquals(15, result.intValue());
 		}
 	}

src/test/java/org/apposed/appose/TestBase.java

@@ -113,7 +113,7 @@ class TaskState {
 
 		// Validate the execution result.
 		assertComplete(task);
-		Number result = (Number) task.outputs.get("result");
+		Number result = (Number) task.result();
 		assertEquals(91, result.intValue());
 
 		// Validate the events received.
@@ -148,13 +148,13 @@ public void cowsayAndAssert(Environment env, String greeting)
 			maybeDebug(service);
 			Task task = service.task(
 				"import cowsay\n" +
-				"task.outputs['result'] = cowsay.get_output_string('cow', '" + greeting + "')\n"
+				"cowsay.get_output_string('cow', '" + greeting + "')\n"
 			);
 			task.waitFor();
 			assertComplete(task);
 			// Verify cowsay output contains the greeting and key elements
 			// (exact spacing can vary between cowsay versions).
-			String actual = (String) task.outputs.get("result");
+			String actual = (String) task.result();
 			assertNotNull(actual, "Cowsay output should not be null");
 			assertTrue(actual.contains(greeting), "Output should contain the greeting: " + greeting);
 			assertTrue(actual.contains("^__^"), "Output should contain cow face");