Rename append_message_context() -> message_stream_context()

Author: cpsievert

shiny/ui/_chat.py

@@ -591,7 +591,7 @@ async def append_message(
         )
 
     @asynccontextmanager
-    async def append_message_context(self):
+    async def message_stream_context(self):
         """
         Message stream context manager.
 
@@ -629,9 +629,9 @@ async def append_message_context(self):
 
         @reactive.effect
         async def _():
-            async with chat.append_message_context() as msg:
+            async with chat.message_stream_context() as msg:
                 await msg.append("Starting stream...\n\nProgress:")
-                async with chat.append_message_context() as progress:
+                async with chat.message_stream_context() as progress:
                     for x in [0, 50, 100]:
                         await progress.append(f" {x}%")
                         await asyncio.sleep(1)
@@ -643,7 +643,7 @@ async def _():
         Note
         ----
         A useful pattern for displaying tool calls in a chatbot is for the tool to
-        display using `.append_message_context()` while the the response generation is
+        display using `.message_stream_context()` while the the response generation is
         happening through `.append_message_stream()`. This allows the tool to display
         things like progress updates (or other "ephemeral" content) and optionally
         `.restore()` the stream back to it's initial state when ready to display the
@@ -1492,7 +1492,7 @@ def chat_ui(
 
 class MessageStream:
     """
-    An object to yield from a `.append_message_context()` context manager.
+    An object to yield from a `.message_stream_context()` context manager.
     """
 
     def __init__(self, chat: Chat, stream_id: str):

tests/playwright/shiny/components/chat/append_message_context/app.py

@@ -34,7 +34,7 @@ async def _(user_input: str):
 @reactive.effect
 @reactive.event(input.stream_1)
 async def _():
-    async with chat.append_message_context() as msg:
+    async with chat.message_stream_context() as msg:
         await msg.append("Basic")
         await asyncio.sleep(SLEEP_TIME)
         await msg.append(" stream")
@@ -43,7 +43,7 @@ async def _():
 @reactive.effect
 @reactive.event(input.stream_2)
 async def _():
-    async with chat.append_message_context() as msg:
+    async with chat.message_stream_context() as msg:
         await msg.append("Basic")
         await asyncio.sleep(SLEEP_TIME)
         await msg.append(" stream")
@@ -56,10 +56,10 @@ async def _():
 @reactive.effect
 @reactive.event(input.stream_3)
 async def _():
-    async with chat.append_message_context() as outer:
+    async with chat.message_stream_context() as outer:
         await outer.append("Outer start")
         await asyncio.sleep(SLEEP_TIME)
-        async with chat.append_message_context() as inner:
+        async with chat.message_stream_context() as inner:
             await inner.append("Inner start")
             await asyncio.sleep(SLEEP_TIME)
             await inner.append("Inner end")
@@ -70,10 +70,10 @@ async def _():
 @reactive.effect
 @reactive.event(input.stream_4)
 async def _():
-    async with chat.append_message_context() as outer:
+    async with chat.message_stream_context() as outer:
         await outer.append("Outer start")
         await asyncio.sleep(SLEEP_TIME)
-        async with chat.append_message_context() as inner:
+        async with chat.message_stream_context() as inner:
             await inner.append("Inner start")
             await asyncio.sleep(SLEEP_TIME)
             await inner.restore()
@@ -85,11 +85,11 @@ async def _():
 @reactive.effect
 @reactive.event(input.stream_5)
 async def _():
-    async with chat.append_message_context() as outer:
+    async with chat.message_stream_context() as outer:
         await outer.append("Outer start")
         await asyncio.sleep(SLEEP_TIME)
         await outer.restore()
-        async with chat.append_message_context() as inner:
+        async with chat.message_stream_context() as inner:
             await inner.append("Inner start")
             await asyncio.sleep(SLEEP_TIME)
             await inner.append("Inner end")
@@ -112,7 +112,7 @@ async def outer_stream():
 
 
 async def inner_stream():
-    async with chat.append_message_context() as stream:
+    async with chat.message_stream_context() as stream:
         await stream.append("Inner start")
         await asyncio.sleep(SLEEP_TIME)
         await stream.append("Inner progress")