Change to property named latest_message_stream

Author: cpsievert

CHANGELOG.md

@@ -25,7 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * The `ui.Chat()` component also gains the following:
     * The `.on_user_submit()` decorator method now passes the user input to the decorated function. This makes it a bit easier to access the user input. See the new templates (mentioned below) for examples. (#1801)
     * The assistant icon is now configurable via `ui.chat_ui()` (or the `ui.Chat.ui()` method in Shiny Express) or for individual messages in the `.append_message()` and `.append_message_stream()` methods of `ui.Chat()`. (#1853)
-    * A new `get_message_stream()` method was added for an easy way to reactively read the stream's status, result, and also cancel an in progress stream. (#1846)
+    * A new `latest_message_stream` property was added for an easy way to reactively read the stream's status, result, and also cancel an in progress stream. (#1846)
     * The `.append_message_stream()` method now returns the `reactive.extended_task` instance that it launches. (#1846)
     * The `ui.Chat()` component's `.update_user_input()` method gains `submit` and `focus` options that allow you to submit the input on behalf of the user and to choose whether the input receives focus after the update. (#1851)
 

shiny/ui/_chat.py

@@ -673,11 +673,12 @@ async def _handle_error():
 
         return _stream_task
 
-    def get_message_stream(self) -> reactive.ExtendedTask[[], str]:
+    @property
+    def latest_message_stream(self) -> reactive.ExtendedTask[[], str]:
         """
         React to changes in the latest message stream.
 
-        Reactively reads for the latest :class:`~shiny.reactive.ExtendedTask` behind the
+        Reactively reads for the :class:`~shiny.reactive.ExtendedTask` behind the
         latest message stream.
 
         From the return value (i.e., the extended task), you can then:
@@ -695,10 +696,9 @@ def get_message_stream(self) -> reactive.ExtendedTask[[], str]:
 
         Note
         ----
-        If no stream has yet been started when this method is called, then a "mock" task
-        is returned. This mock task behaves much like a stream that hasn't yet completed,
-        except it has a `.status()` of "initial" instead of "running", and `.cancel()`
-        is a no-op.
+        If no stream has yet been started when this method is called, then it returns an
+        extended task with `.status()` of `"initial"` and that it status doesn't change
+        state until a message is streamed.
         """
         return self._latest_stream()