feat: not utilize nest_asyncio if only async APIs are used

erdewit/nest_asyncio#87

Author: Chaoses-Ib

script/runtime/README.md

@@ -1,4 +1,23 @@
 # Runtime
+## Async support
+The runtime is internally asynchronous, but only exposes synchronous APIs for the following reasons:
+- To make the script more friendly to Python newbies
+- To avoid being infectious
+  
+  Some libraries, such as ipywidgets, do not support async yet.
+- To make scripts shorter
+
+If you want to use the asynchronous APIs, you need to:
+- Prefix all APIs support async with an underscore and await
+  
+  For example:
+  - `load()` → `await runtime._load()`
+  - `queue.cancel_all()` → `await queue._cancel_all()`
+  - `obj.display()` (and `display(obj)`) → `await obj._display()`
+- Replace `with Workflow` with `async with Workflow`
+- Replace `obj.wait()` with `await obj`, `obj.wait_result()` with `await obj.result()`
+- Replace `ImageBatchResult[i]` with `await ImageBatchResult.get(i)`
+
 ## Other differences from ComfyUI's web UI
 - No limitations on input precision and range.
 

script/runtime/__init__.py

@@ -109,7 +109,7 @@ async def _watch(self):
                                         if self.queue_remaining == 0:
                                             for task in self._tasks.values():
                                                 print(f'ComfyScript: The queue is empty but {task} has not been executed')
-                                                task._set_result_threadsafe(None, {})
+                                                await task._set_result_threadsafe(None, {})
                                             self._tasks.clear()
 
                                         for callback in self._queue_remaining_callbacks:
@@ -120,15 +120,15 @@ async def _watch(self):
                                         outputs = {}
                                         if history is not None:
                                             outputs = history['outputs']
-                                        task._set_result_threadsafe(None, outputs, self._watch_display_task)
+                                        await task._set_result_threadsafe(None, outputs, self._watch_display_task)
                                         if self._watch_display_task:
                                             print(f'Queue remaining: {self.queue_remaining}')
                                 elif msg['type'] == 'executed':
                                     data = msg['data']
                                     prompt_id = data['prompt_id']
                                     task: Task = self._tasks.get(prompt_id)
                                     if task is not None:
-                                        task._set_result_threadsafe(data['node'], data['output'], self._watch_display_node)
+                                        await task._set_result_threadsafe(data['node'], data['output'], self._watch_display_node)
                                         if self._watch_display_node:
                                             print(f'Queue remaining: {self.queue_remaining}')
                                 elif msg['type'] == 'progress':
@@ -311,16 +311,23 @@ def __str__(self):
     def __repr__(self):
         return f'Task(n={self.number}, id={self.prompt_id})'
 
-    def _set_result_threadsafe(self, node_id: str | None, output: dict, display_result: bool = False) -> None:
+    async def _set_result_threadsafe(self, node_id: str | None, output: dict, display_result: bool = False) -> None:
         if node_id is not None:
             self._new_outputs[node_id] = output
             if display_result:
                 from IPython.display import display
-                display(data.Result.from_output(output), clear=True)
+
+                display(clear=True)
+                result = data.Result.from_output(output)
+                if isinstance(result, data.ImageBatchResult):
+                    await Images(result)._display()
+                else:
+                    display(result)
         else:
             self.get_loop().call_soon_threadsafe(self._fut.set_result, output)
             if display_result:
                 from IPython.display import display
+
                 image_batches = []
                 others = []
                 # TODO: Sort by the parsed id
@@ -333,7 +340,7 @@ def _set_result_threadsafe(self, node_id: str | None, output: dict, display_resu
                 if image_batches or others:
                     display(clear=True)
                 if image_batches:
-                    display(Images(*image_batches))
+                    await Images(*image_batches)._display()
                 if others:
                     display(*others)
 

script/runtime/requirements.txt

@@ -1,4 +1,7 @@
 -r ../requirements.txt
 
+# Already required by ComfyUI
+Pillow
+
 # Jupyter
 ipywidgets ~= 8.1