feat: add support for say_stream utility by WilliamBergamin · Pull Request #1462 · slackapi/bolt-python · GitHub

Summary

This PR aims to introduce a new kwarg say_stream, it allows developers the ability to easily use a WebClient.chat_stream object initialized with logical default values.

say_stream is WebClient.chat_stream initialized with

channel_id: from the event payload
thread_ts: thread_ts from the event payload or falls back to the ts value if it is available
recipient_team_id: the team_id from the event received or the enterprise_id if the app is installed on the org
recipient_user_id: the user_id from the event received

say_stream is available on app.event and app.message listeners, if Bolt fails to extract channel_id or thread_ts then say_stream will be None

Testing

clone this branch
build the project with scripts/build_pypi_package.sh
Import the package in a Bolt project
Play around with say_stream

Sample app.py

import os
import logging
from time import sleep

from slack_bolt import App, BoltContext, SayStream
from slack_bolt.adapter.socket_mode import SocketModeHandler
from slack_sdk import WebClient

logging.basicConfig(level=logging.DEBUG)

app = App(token=os.environ.get("SLACK_BOT_TOKEN"))

@app.event("app_mention")
def handle_app_mention(client: WebClient, say_stream: SayStream, context: BoltContext):
  stream = say_stream(buffer_size=100)

  client.assistant_threads_setStatus(
      channel_id=context.channel_id,
      thread_ts=say_stream.thread_ts,
      status="Thinking...",
      loading_messages=[
          "Waking up from my mass-production nap...",
          "Putting on my thinking cap...",
          "Consulting the ancient Stack Overflow...",
          "Bribing the servers with virtual cookies...",
          "Loading witty response... please hold...",
      ],
  )

  stream.append(markdown_text="*Someone rang the bat signal!* :bat:\n\n")
  sleep(5)
  stream.append(markdown_text="Oh wait, it's just an @mention. Even better!\n\n")
  stream.append(markdown_text="> Fun fact: I was mass-produced in a mass-production factory, but I like to think I'm *one of a kind*.\n\n")
  sleep(1)
  stream.append(markdown_text="Anyway, here's my *totally professional* take:\n\n")
  stream.append(markdown_text="1. `say_stream` is basically magic — words appear like I'm *actually typing* :sparkles:\n")
  sleep(1)
  stream.append(markdown_text="2. Streaming means you don't have to stare at a blank screen wondering if I ghosted you\n")
  sleep(1)
  stream.append(markdown_text="3. Bolt for Python makes building Slack apps easier than microwaving leftovers\n\n")
  sleep(0.5)
  stream.append(markdown_text="_*mic drop*_ :microphone:")
  stream.stop()

@app.message("")
def handle_ask_bot(client: WebClient, say_stream: SayStream, context: BoltContext):
  stream = say_stream(buffer_size=100)

  client.assistant_threads_setStatus(
      channel_id=context.channel_id,
      thread_ts=say_stream.thread_ts,
      status="Thinking...",
      loading_messages=[
          "Rummaging through my one brain cell...",
          "Asking my rubber duck for advice...",
          "Warming up the nonsense generator...",
          "Downloading more RAM (just kidding)...",
          "Practicing my typing... clack clack clack...",
      ],
  )

  stream.append(markdown_text="*Psst...* you just DMed a bot. Bold move. I respect that. :sunglasses:\n\n")
  sleep(5)
  stream.append(markdown_text="Let me consult my *vast knowledge database*...\n\n")
  stream.append(markdown_text="```\n[ scanning... ]\n[ found: 1 brain cell ]\n[ deploying it now ]\n```\n\n")
  sleep(1)
  stream.append(markdown_text="Okay here's the deal:\n\n")
  sleep(1)
  stream.append(markdown_text=":rocket: *Streaming responses* means you get to watch me think in real time — terrifying, I know\n")
  sleep(1)
  stream.append(markdown_text=":hammer_and_wrench: *Bolt for Python* is the secret sauce behind my dazzling personality\n")
  sleep(1)
  stream.append(markdown_text=":zap: *Socket Mode* keeps our conversation nice and private — no nosy webhooks here\n\n")
  sleep(0.5)
  stream.append(markdown_text="That's all I've got. Don't forget to tip your bot! :robot_face:")
  stream.stop()

if __name__ == "__main__":
  SocketModeHandler(app, os.environ.get("SLACK_APP_TOKEN")).start()

manifest.json

{
    "_metadata": {
        "major_version": 1,
        "minor_version": 1
    },
    "display_information": {
        "name": "say_stream_experiment"
    },
    "features": {
        "app_home": {
            "home_tab_enabled": false,
            "messages_tab_enabled": true,
            "messages_tab_read_only_enabled": false
        },
        "bot_user": {
            "display_name": "say_stream_experiment",
            "always_online": false
        }
    },
    "oauth_config": {
        "scopes": {
            "bot": [
                "app_mentions:read",
                "chat:write",
                "im:read",
                "im:write",
                "channels:history",
                "im:history"
            ]
        }
    },
    "settings": {
        "event_subscriptions": {
            "bot_events": [
                "app_mention",
                "message.im"
            ]
        },
        "interactivity": {
            "is_enabled": true
        },
        "org_deploy_enabled": true,
        "socket_mode_enabled": true,
        "token_rotation_enabled": false
    }
}

Requirements

Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.

I've read and understood the Contributing Guidelines and have done my best effort to follow them.
I've read and agree to the Code of Conduct.
I've run ./scripts/install_all_and_run_tests.sh after making the changes.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.43%. Comparing base (785b813) to head (393f9b0).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1462      +/-   ##
==========================================
+ Coverage   91.35%   91.43%   +0.08%     
==========================================
  Files         229      232       +3     
  Lines        7262     7334      +72     
==========================================
+ Hits         6634     6706      +72     
  Misses        628      628

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@WilliamBergamin Thanks a bunch for this PR! It's super exciting.

❓ Can you please provide some code for us to manually test? I'm having trouble importing SayStream and I'm unsure if I'm importing the incorrect path or have the sample app configured incorrectly. What is the import path?

🎙️ Leaving a few comments too but an example listener in description might be helpful for later CHANGELOG I agree!

👾 thought: Defaulting to different threading behavior for say and say_stream concerns me somewhat.

🔮 ramble: I understand thread_ts is required to stream chat at this time, but if "parent" messages can be streamed in the future we might want to revisit also say behavior?

Yess I think we can revisite the say behavior in the future, but changing it I think would result a breaking change 🤔

I can add a TODO or maybe create an issue for this?

@WilliamBergamin Thanks for keeping note of this too! 📫

I'm partial to waiting for related feedback since this might be an expected experience for most! I fear that knowing some of the implementation details biases me...

🌟 praise: This is a pleasant assertion to have for application code guards too I think!

Co-authored-by: Eden Zimbelman <eden.zimbelman@salesforce.com>

@mwbrooks check out this app I've been using for testing

app.py

import os
import logging
from time import sleep

from slack_bolt import App, BoltContext, SayStream
from slack_bolt.adapter.socket_mode import SocketModeHandler
from slack_sdk import WebClient

logging.basicConfig(level=logging.DEBUG)

app = App(token=os.environ.get("SLACK_BOT_TOKEN"))

@app.event("app_mention")
def handle_app_mention(client: WebClient, say_stream: SayStream, context: BoltContext):
  stream = say_stream(buffer_size=100)

  client.assistant_threads_setStatus(
      channel_id=context.channel_id,
      thread_ts=say_stream.thread_ts,
      status="Thinking...",
      loading_messages=[
          "Waking up from my mass-production nap...",
          "Putting on my thinking cap...",
          "Consulting the ancient Stack Overflow...",
          "Bribing the servers with virtual cookies...",
          "Loading witty response... please hold...",
      ],
  )

  stream.append(markdown_text="*Someone rang the bat signal!* :bat:\n\n")
  sleep(5)
  stream.append(markdown_text="Oh wait, it's just an @mention. Even better!\n\n")
  stream.append(markdown_text="> Fun fact: I was mass-produced in a mass-production factory, but I like to think I'm *one of a kind*.\n\n")
  sleep(1)
  stream.append(markdown_text="Anyway, here's my *totally professional* take:\n\n")
  stream.append(markdown_text="1. `say_stream` is basically magic — words appear like I'm *actually typing* :sparkles:\n")
  sleep(1)
  stream.append(markdown_text="2. Streaming means you don't have to stare at a blank screen wondering if I ghosted you\n")
  sleep(1)
  stream.append(markdown_text="3. Bolt for Python makes building Slack apps easier than microwaving leftovers\n\n")
  sleep(0.5)
  stream.append(markdown_text="_*mic drop*_ :microphone:")
  stream.stop()

@app.message("")
def handle_ask_bot(client: WebClient, say_stream: SayStream, context: BoltContext):
  stream = say_stream(buffer_size=100)

  client.assistant_threads_setStatus(
      channel_id=context.channel_id,
      thread_ts=say_stream.thread_ts,
      status="Thinking...",
      loading_messages=[
          "Rummaging through my one brain cell...",
          "Asking my rubber duck for advice...",
          "Warming up the nonsense generator...",
          "Downloading more RAM (just kidding)...",
          "Practicing my typing... clack clack clack...",
      ],
  )

  stream.append(markdown_text="*Psst...* you just DMed a bot. Bold move. I respect that. :sunglasses:\n\n")
  sleep(5)
  stream.append(markdown_text="Let me consult my *vast knowledge database*...\n\n")
  stream.append(markdown_text="```\n[ scanning... ]\n[ found: 1 brain cell ]\n[ deploying it now ]\n```\n\n")
  sleep(1)
  stream.append(markdown_text="Okay here's the deal:\n\n")
  sleep(1)
  stream.append(markdown_text=":rocket: *Streaming responses* means you get to watch me think in real time — terrifying, I know\n")
  sleep(1)
  stream.append(markdown_text=":hammer_and_wrench: *Bolt for Python* is the secret sauce behind my dazzling personality\n")
  sleep(1)
  stream.append(markdown_text=":zap: *Socket Mode* keeps our conversation nice and private — no nosy webhooks here\n\n")
  sleep(0.5)
  stream.append(markdown_text="That's all I've got. Don't forget to tip your bot! :robot_face:")
  stream.stop()

if __name__ == "__main__":
  SocketModeHandler(app, os.environ.get("SLACK_APP_TOKEN")).start()

manifest.json

{
    "_metadata": {
        "major_version": 1,
        "minor_version": 1
    },
    "display_information": {
        "name": "say_stream_experiment"
    },
    "features": {
        "app_home": {
            "home_tab_enabled": false,
            "messages_tab_enabled": true,
            "messages_tab_read_only_enabled": false
        },
        "bot_user": {
            "display_name": "say_stream_experiment",
            "always_online": false
        }
    },
    "oauth_config": {
        "scopes": {
            "bot": [
                "app_mentions:read",
                "chat:write",
                "im:read",
                "im:write",
                "channels:history",
                "im:history"
            ]
        }
    },
    "settings": {
        "event_subscriptions": {
            "bot_events": [
                "app_mention",
                "message.im"
            ]
        },
        "interactivity": {
            "is_enabled": true
        },
        "org_deploy_enabled": true,
        "socket_mode_enabled": true,
        "token_rotation_enabled": false
    }
}

@WilliamBergamin Super awesome changes recent! I'm finding this streams to channel as expected 🐢 💨

I'm leaving a note on experimental documentation but nothing to block this from merging I think!

🔍 note: I might not find this in outputs at the moment - would this be something to include in docstring for say_stream too?

I might not find this in outputs at the moment

Interesting 🤔 I an seeing it on my end, let me see how I should add this to the docstring

Warning added to docstring

✅ Woohoo, I'm already loving seeing say and say_stream side-by-side. Best friends 🫛

🧪 I've tested this on a Standalone Workspace and Enterprise Organization. Both work great now!

➡️ I'll look into rolling this into our sample agent app tomorrow!

WilliamBergamin added 4 commits March 17, 2026 17:27

feat: add support for say_stream utility function

cacf2ad

Improve unit tests around SayStream

f30dd71

Patch fixes and better test coverage

3e49461

claude found some stuff to fix

a4a63c8

WilliamBergamin added this to the 1.27.1 milestone Mar 17, 2026

WilliamBergamin requested review from mwbrooks, srtaalej and zimeg March 17, 2026 22:16

WilliamBergamin self-assigned this Mar 17, 2026

WilliamBergamin added enhancement New feature or request area:async area:sync semver:minor experiment Experimental feature documented with ExperimentalWarning and pydoc Experiment section labels Mar 17, 2026

fix python 3.7 test issues

55ea797

WilliamBergamin marked this pull request as ready for review March 17, 2026 22:45

WilliamBergamin requested a review from a team as a code owner March 17, 2026 22:45

mwbrooks reviewed Mar 17, 2026

View reviewed changes

zimeg reviewed Mar 17, 2026

View reviewed changes

Update tests/scenario_tests/test_events_say_stream.py

6a7f0f7

Co-authored-by: Eden Zimbelman <eden.zimbelman@salesforce.com>

WilliamBergamin added 5 commits March 18, 2026 12:30

Improve conssistancy in naming

42b6c4d

surface the buffer_size override

eda8e73

make things alphabet

db99b51

improving asserts in unit tests

9aaedf7

make things work for org apps

143e8e3

WilliamBergamin requested review from mwbrooks and zimeg March 18, 2026 20:02

zimeg approved these changes Mar 18, 2026

View reviewed changes

mwbrooks approved these changes Mar 19, 2026

View reviewed changes

Add warning to docstring

393f9b0

WilliamBergamin merged commit f1bc61f into main Mar 19, 2026
16 checks passed

WilliamBergamin deleted the say_stream branch March 19, 2026 13:57

+                          # TODO: in the future we might want to introduce a "proper" extract_ts utility
+                          thread_ts = req.context.thread_ts or event.get("ts")
+                          if req.context.channel_id and thread_ts:
+                              req.context["say_stream"] = SayStream(
+                                  client=req.context.client,
+                                  channel_id=req.context.channel_id,
+                                  thread_ts=thread_ts,
+                                  team_id=req.context.team_id,
+                                  user_id=req.context.user_id,
+                              )

+                          "say_stream is experimental and may change in future versions.",
+                          category=ExperimentalWarning,
+                          stacklevel=2,
+                      )

		assert say_stream is None
		assert context.say_stream is None

feat: add support for say_stream utility by WilliamBergamin · Pull Request #1462 · slackapi/bolt-python · GitHub

Uh oh!

feat: add support for say_stream utility - #1462

feat: add support for say_stream utility#1462WilliamBergamin merged 12 commits intomainslackapi/bolt-python:mainfrom say_streamslackapi/bolt-python:say_streamCopy head branch name to clipboard

Conversation

WilliamBergamin commented Mar 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Testing

Category

Requirements

Uh oh!

codecov Bot commented Mar 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

mwbrooks left a comment

Choose a reason for hiding this comment

Uh oh!

zimeg left a comment

Choose a reason for hiding this comment

Uh oh!

zimeg Mar 17, 2026

Choose a reason for hiding this comment

Uh oh!

WilliamBergamin Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

zimeg Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

zimeg Mar 17, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

WilliamBergamin commented Mar 18, 2026

Uh oh!

zimeg left a comment

Choose a reason for hiding this comment

Uh oh!

zimeg Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

WilliamBergamin Mar 19, 2026

Choose a reason for hiding this comment

Uh oh!

WilliamBergamin Mar 19, 2026

Choose a reason for hiding this comment

Uh oh!

mwbrooks left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat: add support for say_stream utility#1462
WilliamBergamin merged 12 commits into
mainfrom
say_stream

WilliamBergamin commented Mar 17, 2026 •
edited
Loading

codecov Bot commented Mar 17, 2026 •
edited
Loading