feat: add authorship arguments to chat stream helper

Author: zimeg

slack_sdk/web/async_chat_stream.py

@@ -40,6 +40,9 @@ def __init__(
         recipient_team_id: Optional[str] = None,
         recipient_user_id: Optional[str] = None,
         task_display_mode: Optional[str] = None,
+        icon_emoji: Optional[str] = None,
+        icon_url: Optional[str] = None,
+        username: Optional[str] = None,
         **kwargs,
     ):
         """Initialize a new ChatStream instance.
@@ -57,6 +60,9 @@ def __init__(
             recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels.
             task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks
               with text and "plan" displays all tasks together.
+            icon_emoji: Emoji to use as the icon for this message. Overrides icon_url.
+            icon_url: Image URL to use as the icon for this message.
+            username: The bot's username to display.
             buffer_size: The length of markdown_text to buffer in-memory before calling a method. Increasing this value
               decreases the number of method calls made for the same amount of text, which is useful to avoid rate limits.
             **kwargs: Additional arguments passed to the underlying API calls.
@@ -70,6 +76,9 @@ def __init__(
             "recipient_team_id": recipient_team_id,
             "recipient_user_id": recipient_user_id,
             "task_display_mode": task_display_mode,
+            "icon_emoji": icon_emoji,
+            "icon_url": icon_url,
+            "username": username,
             **kwargs,
         }
         self._buffer = ""

slack_sdk/web/async_client.py

@@ -2977,6 +2977,9 @@ async def chat_stream(
         recipient_team_id: Optional[str] = None,
         recipient_user_id: Optional[str] = None,
         task_display_mode: Optional[str] = None,
+        icon_emoji: Optional[str] = None,
+        icon_url: Optional[str] = None,
+        username: Optional[str] = None,
         **kwargs,
     ) -> AsyncChatStream:
         """Stream markdown text into a conversation.
@@ -3005,6 +3008,9 @@ async def chat_stream(
             recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels.
             task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks
               with text and "plan" displays all tasks together.
+            icon_emoji: Emoji to use as the icon for this message. Overrides icon_url.
+            icon_url: Image URL to use as the icon for this message.
+            username: The bot's username to display.
             **kwargs: Additional arguments passed to the underlying API calls.
 
         Returns:
@@ -3031,6 +3037,9 @@ async def chat_stream(
             recipient_team_id=recipient_team_id,
             recipient_user_id=recipient_user_id,
             task_display_mode=task_display_mode,
+            icon_emoji=icon_emoji,
+            icon_url=icon_url,
+            username=username,
             buffer_size=buffer_size,
             **kwargs,
         )

slack_sdk/web/chat_stream.py

@@ -30,6 +30,9 @@ def __init__(
         recipient_team_id: Optional[str] = None,
         recipient_user_id: Optional[str] = None,
         task_display_mode: Optional[str] = None,
+        icon_emoji: Optional[str] = None,
+        icon_url: Optional[str] = None,
+        username: Optional[str] = None,
         **kwargs,
     ):
         """Initialize a new ChatStream instance.
@@ -47,6 +50,9 @@ def __init__(
             recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels.
             task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks
               with text and "plan" displays all tasks together.
+            icon_emoji: Emoji to use as the icon for this message. Overrides icon_url.
+            icon_url: Image URL to use as the icon for this message.
+            username: The bot's username to display.
             buffer_size: The length of markdown_text to buffer in-memory before calling a method. Increasing this value
               decreases the number of method calls made for the same amount of text, which is useful to avoid rate limits.
             **kwargs: Additional arguments passed to the underlying API calls.
@@ -60,6 +66,9 @@ def __init__(
             "recipient_team_id": recipient_team_id,
             "recipient_user_id": recipient_user_id,
             "task_display_mode": task_display_mode,
+            "icon_emoji": icon_emoji,
+            "icon_url": icon_url,
+            "username": username,
             **kwargs,
         }
         self._buffer = ""

slack_sdk/web/client.py

@@ -2967,6 +2967,9 @@ def chat_stream(
         recipient_team_id: Optional[str] = None,
         recipient_user_id: Optional[str] = None,
         task_display_mode: Optional[str] = None,
+        icon_emoji: Optional[str] = None,
+        icon_url: Optional[str] = None,
+        username: Optional[str] = None,
         **kwargs,
     ) -> ChatStream:
         """Stream markdown text into a conversation.
@@ -2995,6 +2998,9 @@ def chat_stream(
             recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels.
             task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks
               with text and "plan" displays all tasks together.
+            icon_emoji: Emoji to use as the icon for this message. Overrides icon_url.
+            icon_url: Image URL to use as the icon for this message.
+            username: The bot's username to display.
             **kwargs: Additional arguments passed to the underlying API calls.
 
         Returns:
@@ -3021,6 +3027,9 @@ def chat_stream(
             recipient_team_id=recipient_team_id,
             recipient_user_id=recipient_user_id,
             task_display_mode=task_display_mode,
+            icon_emoji=icon_emoji,
+            icon_url=icon_url,
+            username=username,
             buffer_size=buffer_size,
             **kwargs,
         )

tests/slack_sdk/web/test_chat_stream.py

@@ -242,6 +242,26 @@ def test_streams_a_chunk_message(self):
                 '[{"text": "\\n", "type": "markdown_text"}, {"text": ":space_invader:", "type": "markdown_text"}]',
             )
 
+    def test_streams_with_authorship_args(self):
+        streamer = self.client.chat_stream(
+            channel="C0123456789",
+            thread_ts="123.000",
+            username="Abacus",
+            icon_emoji="abacus",
+        )
+        self.assertEqual(streamer._stream_args["username"], "Abacus")
+        self.assertEqual(streamer._stream_args["icon_emoji"], "abacus")
+        self.assertIsNone(streamer._stream_args["icon_url"])
+
+        streamer.append(markdown_text="counting...")
+        streamer.stop()
+
+        if hasattr(self.thread.server, "chat_stream_requests"):
+            start_request = self.thread.server.chat_stream_requests.get("/chat.startStream", {})
+            self.assertEqual(start_request.get("username"), "Abacus")
+            self.assertEqual(start_request.get("icon_emoji"), "abacus")
+            self.assertNotIn("icon_url", start_request)
+
     def test_streams_errors_when_appending_to_an_unstarted_stream(self):
         streamer = self.client.chat_stream(
             channel="C0123456789",