Improve sending changed settings back to the launcher

pyflowlauncher/method.py

@@ -1,15 +1,11 @@
 from __future__ import annotations
-from typing import Any, Iterable, TypedDict
+from typing import Any, Dict, Optional
 from abc import ABC, abstractmethod
 
-from .result import Result, JsonRPCAction, send_results
+from .result import Result, JsonRPCAction, ResultResponse, send_results
 from .shared import logger
 
 
-class ResultResponse(TypedDict):
-    result: Iterable[dict[str, Any]]
-
-
 class Method(ABC):
 
     def __init__(self) -> None:
@@ -19,8 +15,8 @@ def __init__(self) -> None:
     def add_result(self, result: Result) -> None:
         self._results.append(result)
 
-    def return_results(self) -> ResultResponse:
-        return send_results(self._results)
+    def return_results(self, settings: Optional[Dict[str, Any]] = None) -> ResultResponse:
+        return send_results(self._results, settings)
 
     @abstractmethod
     def __call__(self, *args, **kwargs) -> ResultResponse | JsonRPCAction:

pyflowlauncher/plugin.py

@@ -50,4 +50,7 @@ def run(self) -> None:
         method = request.get('method')
         parameters = request.get('parameters', [])
         feedback = self._event_handler(method, *parameters)
+        # Inject settings if changed
+        if 'result' in feedback and self._settings is not None:
+            feedback['SettingsChange'] = self.settings
         self._client.send(feedback)

pyflowlauncher/result.py

@@ -9,6 +9,7 @@
     Optional,
     Union,
     Dict,
+    List
 )
 
 if sys.version_info < (3, 11):
@@ -62,9 +63,10 @@ def add_action(self, method: Method,
 
 
 class ResultResponse(TypedDict):
-    result: Iterable[Dict[str, Any]]
+    result: List[Dict[str, Any]]
+    SettingsChange: NotRequired[Optional[Dict[str, Any]]]
 
 
-def send_results(results: Iterable[Result]) -> ResultResponse:
+def send_results(results: Iterable[Result], settings: Optional[Dict[str, Any]] = None) -> ResultResponse:
     """Formats and returns results as a JsonRPCResponse"""
-    return {'result': [result.as_dict() for result in results]}
+    return {'result': [result.as_dict() for result in results], 'SettingsChange': settings}