feat: auto on_xxx_done in Python async extension

core/src/ten_runtime/binding/python/interface/ten/async_extension.py

@@ -32,11 +32,13 @@ async def _thread_routine(self, ten_env: TenEnv):
         )
 
         await self.on_configure(self._async_ten_env)
+        ten_env.on_configure_done()
 
         # Suspend the thread until stopEvent is set.
         await self._ten_stop_event.wait()
 
         await self.on_deinit(self._async_ten_env)
+        self._async_ten_env._deinit()
 
     async def _stop_thread(self):
         self._ten_stop_event.set()
@@ -57,21 +59,36 @@ def _proxy_on_configure(self, ten_env: TenEnv) -> None:
     @final
     def _proxy_on_init(self, ten_env: TenEnv) -> None:
         asyncio.run_coroutine_threadsafe(
-            self.on_init(self._async_ten_env), self._ten_loop
+            self._proxy_async_on_init(ten_env), self._ten_loop
         )
 
+    @final
+    async def _proxy_async_on_init(self, ten_env: TenEnv):
+        await self.on_init(self._async_ten_env)
+        ten_env.on_init_done()
+
     @final
     def _proxy_on_start(self, ten_env: TenEnv) -> None:
         asyncio.run_coroutine_threadsafe(
-            self.on_start(self._async_ten_env), self._ten_loop
+            self._proxy_async_on_start(ten_env), self._ten_loop
         )
 
+    @final
+    async def _proxy_async_on_start(self, ten_env: TenEnv):
+        await self.on_start(self._async_ten_env)
+        ten_env.on_start_done()
+
     @final
     def _proxy_on_stop(self, ten_env: TenEnv) -> None:
         asyncio.run_coroutine_threadsafe(
-            self.on_stop(self._async_ten_env), self._ten_loop
+            self._proxy_async_on_stop(ten_env), self._ten_loop
         )
 
+    @final
+    async def _proxy_async_on_stop(self, ten_env: TenEnv):
+        await self.on_stop(self._async_ten_env)
+        ten_env.on_stop_done()
+
     @final
     def _proxy_on_deinit(self, ten_env: TenEnv) -> None:
         asyncio.run_coroutine_threadsafe(self._stop_thread(), self._ten_loop)
@@ -109,19 +126,19 @@ def _proxy_on_audio_frame(
     # Override these methods in your extension
 
     async def on_configure(self, async_ten_env: AsyncTenEnv) -> None:
-        async_ten_env.on_configure_done()
+        pass
 
     async def on_init(self, async_ten_env: AsyncTenEnv) -> None:
-        async_ten_env.on_init_done()
+        pass
 
     async def on_start(self, async_ten_env: AsyncTenEnv) -> None:
-        async_ten_env.on_start_done()
+        pass
 
     async def on_stop(self, async_ten_env: AsyncTenEnv) -> None:
-        async_ten_env.on_stop_done()
+        pass
 
     async def on_deinit(self, async_ten_env: AsyncTenEnv) -> None:
-        async_ten_env.on_deinit_done()
+        pass
 
     async def on_cmd(self, async_ten_env: AsyncTenEnv, cmd: Cmd) -> None:
         pass

core/src/ten_runtime/binding/python/interface/ten/async_ten_env.py

@@ -55,7 +55,32 @@ def _on_release(self) -> None:
         if hasattr(self, "_deinit_thread"):
             self._deinit_thread.join()
 
-    def on_deinit_done(self) -> None:
+    def _deinit(self) -> None:
         # Start the deinit thread to avoid blocking the extension thread.
         self._deinit_thread = threading.Thread(target=self._deinit_routine)
         self._deinit_thread.start()
+
+    def on_configure_done(self) -> None:
+        raise NotImplementedError(
+            "No need to call this method in async extension"
+        )
+
+    def on_init_done(self) -> None:
+        raise NotImplementedError(
+            "No need to call this method in async extension"
+        )
+
+    def on_start_done(self) -> None:
+        raise NotImplementedError(
+            "No need to call this method in async extension"
+        )
+
+    def on_stop_done(self) -> None:
+        raise NotImplementedError(
+            "No need to call this method in async extension"
+        )
+
+    def on_deinit_done(self) -> None:
+        raise NotImplementedError(
+            "No need to call this method in async extension"
+        )

docs/ten_framework/ten_packages/python_async_extension.md

@@ -15,26 +15,18 @@ class DefaultAsyncExtension(AsyncExtension):
         # Mock async operation, e.g. network, file I/O.
         await asyncio.sleep(0.5)
 
-        ten_env.on_configure_done()
-
     async def on_init(self, ten_env: AsyncTenEnv) -> None:
         # Mock async operation, e.g. network, file I/O.
         await asyncio.sleep(0.5)
 
-        ten_env.on_init_done()
-
     async def on_start(self, ten_env: AsyncTenEnv) -> None:
         # Mock async operation, e.g. network, file I/O.
         await asyncio.sleep(0.5)
 
-        ten_env.on_start_done()
-
     async def on_deinit(self, ten_env: AsyncTenEnv) -> None:
         # Mock async operation, e.g. network, file I/O.
         await asyncio.sleep(0.5)
 
-        ten_env.on_deinit_done()
-
     async def on_cmd(self, ten_env: AsyncTenEnv, cmd: Cmd) -> None:
         cmd_json = cmd.to_json()
         ten_env.log_debug(f"DefaultAsyncExtension on_cmd: {cmd_json}")

packages/core_extensions/default_async_extension_python/extension.py

@@ -18,25 +18,19 @@
 class DefaultAsyncExtension(AsyncExtension):
     async def on_init(self, ten_env: AsyncTenEnv) -> None:
         ten_env.log_debug("on_init")
-        ten_env.on_init_done()
 
     async def on_start(self, ten_env: AsyncTenEnv) -> None:
         ten_env.log_debug("on_start")
 
         # TODO: read properties, initialize resources
 
-        ten_env.on_start_done()
-
     async def on_stop(self, ten_env: AsyncTenEnv) -> None:
         ten_env.log_debug("on_stop")
 
         # TODO: clean up resources
 
-        ten_env.on_stop_done()
-
     async def on_deinit(self, ten_env: AsyncTenEnv) -> None:
         ten_env.log_debug("on_deinit")
-        ten_env.on_deinit_done()
 
     async def on_cmd(self, ten_env: AsyncTenEnv, cmd: Cmd) -> None:
         cmd_name = cmd.get_name()

packages/core_extensions/default_async_extension_python/extension.py.tent

@@ -18,22 +18,17 @@ from ten import (
 class {{class_name_prefix}}Extension(AsyncExtension):
     async def on_init(self, ten_env: AsyncTenEnv) -> None:
         ten_env.log_debug("on_init")
-        ten_env.on_init_done()
 
     async def on_start(self, ten_env: AsyncTenEnv) -> None:
         ten_env.log_debug("on_start")
 
         # TODO: read properties, initialize resources
 
-        ten_env.on_start_done()
-
     async def on_stop(self, ten_env: AsyncTenEnv) -> None:
         ten_env.log_debug("on_stop")
 
         # TODO: clean up resources
 
-        ten_env.on_stop_done()
-
     async def on_deinit(self, ten_env: AsyncTenEnv) -> None:
         ten_env.log_debug("on_deinit")
         ten_env.on_deinit_done()

packages/example_extensions/aio_http_server_python/main.py

@@ -106,7 +106,6 @@ def __init__(self, name: str) -> None:
 
     async def on_init(self, ten_env: AsyncTenEnv) -> None:
         self.ten_env = ten_env
-        ten_env.on_init_done()
 
     async def on_start(self, ten_env: AsyncTenEnv) -> None:
         ten_env.log_debug("on_start")
@@ -121,11 +120,8 @@ async def on_start(self, ten_env: AsyncTenEnv) -> None:
 
         await self.start_server("0.0.0.0", self.server_port)
 
-        ten_env.on_start_done()
-
     async def on_deinit(self, ten_env: AsyncTenEnv) -> None:
         ten_env.log_debug("on_deinit")
-        ten_env.on_deinit_done()
 
     async def on_cmd(self, ten_env: AsyncTenEnv, cmd: Cmd) -> None:
         ten_env.log_debug("on_cmd")
@@ -135,7 +131,6 @@ async def on_cmd(self, ten_env: AsyncTenEnv, cmd: Cmd) -> None:
 
     async def on_stop(self, ten_env: AsyncTenEnv) -> None:
         ten_env.log_debug("on_stop")
-        ten_env.on_stop_done()
 
 
 @register_addon_as_extension("aio_http_server_python")

tests/ten_runtime/integration/python/async_extension_basic_python/async_extension_basic_python_app/ten_packages/extension/default_async_extension_python/extension.py

@@ -19,11 +19,9 @@ def __init__(self, name: str) -> None:
 
     async def on_configure(self, ten_env: AsyncTenEnv) -> None:
         await asyncio.sleep(0.5)
-        ten_env.on_configure_done()
 
     async def on_init(self, ten_env: AsyncTenEnv) -> None:
         await asyncio.sleep(0.5)
-        ten_env.on_init_done()
 
     async def on_start(self, ten_env: AsyncTenEnv) -> None:
         await asyncio.sleep(0.5)
@@ -34,11 +32,8 @@ async def on_start(self, ten_env: AsyncTenEnv) -> None:
         ten_env.set_property_string("string_field", "hello")
         assert ten_env.is_property_exist("string_field") is True
 
-        ten_env.on_start_done()
-
     async def on_deinit(self, ten_env: AsyncTenEnv) -> None:
         await asyncio.sleep(0.5)
-        ten_env.on_deinit_done()
 
     async def on_cmd(self, ten_env: AsyncTenEnv, cmd: Cmd) -> None:
         cmd_json = cmd.to_json()
@@ -60,4 +55,3 @@ async def on_stop(self, ten_env: AsyncTenEnv) -> None:
         ten_env.log_debug("on_stop")
 
         await asyncio.sleep(0.5)
-        ten_env.on_stop_done()

tests/ten_runtime/integration/python/go_app_async_extension_python/go_app_async_extension_python_app/ten_packages/extension/default_extension_python/extension.py

@@ -27,8 +27,6 @@ async def on_configure(self, ten_env: AsyncTenEnv) -> None:
 
         await asyncio.sleep(0.5)
 
-        ten_env.on_configure_done()
-
     async def on_start(self, ten_env: AsyncTenEnv) -> None:
         ten_env.log_debug("on_start")
 
@@ -39,20 +37,15 @@ async def on_start(self, ten_env: AsyncTenEnv) -> None:
         testValue2 = ten_env.get_property_to_json("testKey2")
         ten_env.log_info(f"testValue: {testValue}, testValue2: {testValue2}")
 
-        ten_env.on_start_done()
-
     async def on_stop(self, ten_env: AsyncTenEnv) -> None:
         ten_env.log_debug("on_stop")
 
         await asyncio.sleep(0.5)
 
-        ten_env.on_stop_done()
-
     async def on_deinit(self, ten_env: AsyncTenEnv) -> None:
         ten_env.log_debug("on_deinit")
 
         await asyncio.sleep(0.5)
-        ten_env.on_deinit_done()
 
     async def greeting(self, ten_env: AsyncTenEnv) -> CmdResult:
         await asyncio.sleep(1)

tests/ten_runtime/integration/python/two_async_exts_one_group_python/two_async_exts_one_group_python_app/ten_packages/extension/default_extension_python/extension.py

@@ -19,21 +19,16 @@ def __init__(self, name: str) -> None:
 
     async def on_configure(self, ten_env: AsyncTenEnv) -> None:
         await asyncio.sleep(0.5)
-        ten_env.on_configure_done()
 
     async def on_init(self, ten_env: AsyncTenEnv) -> None:
         await asyncio.sleep(0.5)
-        ten_env.on_init_done()
 
     async def on_start(self, ten_env: AsyncTenEnv) -> None:
         await asyncio.sleep(0.5)
         ten_env.log_debug("on_start")
-        ten_env.on_start_done()
 
     async def on_deinit(self, ten_env: AsyncTenEnv) -> None:
         await asyncio.sleep(0.5)
-        ten_env.on_deinit_done()
-
         await asyncio.sleep(1)
 
     async def on_cmd(self, ten_env: AsyncTenEnv, cmd: Cmd) -> None:
@@ -53,4 +48,3 @@ async def on_stop(self, ten_env: AsyncTenEnv) -> None:
         ten_env.log_debug("on_stop")
 
         await asyncio.sleep(0.5)
-        ten_env.on_stop_done()

tests/ten_runtime/integration/python/two_async_exts_python/two_async_exts_python_app/ten_packages/extension/default_extension_python/extension.py

@@ -19,20 +19,16 @@ def __init__(self, name: str) -> None:
 
     async def on_configure(self, ten_env: AsyncTenEnv) -> None:
         await asyncio.sleep(0.5)
-        ten_env.on_configure_done()
 
     async def on_init(self, ten_env: AsyncTenEnv) -> None:
         await asyncio.sleep(0.5)
-        ten_env.on_init_done()
 
     async def on_start(self, ten_env: AsyncTenEnv) -> None:
         await asyncio.sleep(0.5)
         ten_env.log_debug("on_start")
-        ten_env.on_start_done()
 
     async def on_deinit(self, ten_env: AsyncTenEnv) -> None:
         await asyncio.sleep(0.5)
-        ten_env.on_deinit_done()
 
         await asyncio.sleep(1)
 
@@ -53,4 +49,3 @@ async def on_stop(self, ten_env: AsyncTenEnv) -> None:
         ten_env.log_debug("on_stop")
 
         await asyncio.sleep(0.5)
-        ten_env.on_stop_done()