Skip to content

Commit a6bb951

Browse files
zimegzimeg
committed
style: prefer using markdown text chunks in internal calls
1 parent 85081e1 commit a6bb951

File tree

4 files changed

+24
-24
lines changed

4 files changed

+24
-24
lines changed

‎slack_sdk/web/async_chat_stream.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010

1111
import json
1212
import logging
13-
from typing import TYPE_CHECKING, Dict, Optional, Sequence, Union
13+
from typing import TYPE_CHECKING, Dict, List, Optional, Sequence, Union
1414

1515
import slack_sdk.errors as e
1616
from slack_sdk.models.blocks.blocks import Block
17-
from slack_sdk.models.messages.chunk import Chunk
17+
from slack_sdk.models.messages.chunk import Chunk, MarkdownTextChunk
1818
from slack_sdk.models.metadata import Metadata
1919
from slack_sdk.web.async_slack_response import AsyncSlackResponse
2020

@@ -183,9 +183,9 @@ async def stop(
183183
raise e.SlackRequestError("Failed to stop stream: stream not started")
184184
self._stream_ts = str(response["ts"])
185185
self._state = "in_progress"
186-
flushings = []
186+
flushings: List[Chunk] = []
187187
if len(self._buffer) != 0:
188-
flushings.append({"type": "markdown_text", "text": self._buffer})
188+
flushings.append(MarkdownTextChunk(text=self._buffer))
189189
if chunks is not None:
190190
flushings.extend(chunks)
191191
response = await self._client.chat_stopStream(
@@ -202,9 +202,9 @@ async def stop(
202202

203203
async def _flush_buffer(self, chunks: Optional[Sequence[Chunk]] = None, **kwargs) -> AsyncSlackResponse:
204204
"""Flush the internal buffer with chunks by making appropriate API calls."""
205-
flushings = []
205+
flushings: List[Chunk] = []
206206
if len(self._buffer) != 0:
207-
flushings.append({"type": "markdown_text", "text": self._buffer})
207+
flushings.append(MarkdownTextChunk(text=self._buffer))
208208
if chunks is not None:
209209
flushings.extend(chunks)
210210
if not self._stream_ts:

‎slack_sdk/web/chat_stream.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
import json
22
import logging
3-
from typing import TYPE_CHECKING, Dict, Optional, Sequence, Union
3+
from typing import TYPE_CHECKING, Dict, List, Optional, Sequence, Union
44

55
import slack_sdk.errors as e
66
from slack_sdk.models.blocks.blocks import Block
7-
from slack_sdk.models.messages.chunk import Chunk
7+
from slack_sdk.models.messages.chunk import Chunk, MarkdownTextChunk
88
from slack_sdk.models.metadata import Metadata
99
from slack_sdk.web.slack_response import SlackResponse
1010

@@ -173,9 +173,9 @@ def stop(
173173
raise e.SlackRequestError("Failed to stop stream: stream not started")
174174
self._stream_ts = str(response["ts"])
175175
self._state = "in_progress"
176-
flushings = []
176+
flushings: List[Chunk] = []
177177
if len(self._buffer) != 0:
178-
flushings.append({"type": "markdown_text", "text": self._buffer})
178+
flushings.append(MarkdownTextChunk(text=self._buffer))
179179
if chunks is not None:
180180
flushings.extend(chunks)
181181
response = self._client.chat_stopStream(
@@ -192,9 +192,9 @@ def stop(
192192

193193
def _flush_buffer(self, chunks: Optional[Sequence[Chunk]] = None, **kwargs) -> SlackResponse:
194194
"""Flush the internal buffer with chunks by making appropriate API calls."""
195-
flushings = []
195+
flushings: List[Chunk] = []
196196
if len(self._buffer) != 0:
197-
flushings.append({"type": "markdown_text", "text": self._buffer})
197+
flushings.append(MarkdownTextChunk(text=self._buffer))
198198
if chunks is not None:
199199
flushings.extend(chunks)
200200
if not self._stream_ts:

‎tests/slack_sdk/web/test_chat_stream.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ def test_streams_a_short_message(self):
108108
self.assertEqual(stop_request.get("ts"), "123.123")
109109
self.assertEqual(
110110
json.dumps(stop_request.get("chunks")),
111-
'[{"type": "markdown_text", "text": "nice!"}]',
111+
'[{"text": "nice!", "type": "markdown_text"}]',
112112
)
113113

114114
def test_streams_a_long_message(self):
@@ -152,7 +152,7 @@ def test_streams_a_long_message(self):
152152
self.assertEqual(start_request.get("thread_ts"), "123.000")
153153
self.assertEqual(
154154
json.dumps(start_request.get("chunks")),
155-
'[{"type": "markdown_text", "text": "**this messag"}]',
155+
'[{"text": "**this messag", "type": "markdown_text"}]',
156156
)
157157
self.assertEqual(start_request.get("recipient_team_id"), "T0123456789")
158158
self.assertEqual(start_request.get("recipient_user_id"), "U0123456789")
@@ -161,7 +161,7 @@ def test_streams_a_long_message(self):
161161
self.assertEqual(append_request.get("channel"), "C0123456789")
162162
self.assertEqual(
163163
json.dumps(append_request.get("chunks")),
164-
'[{"type": "markdown_text", "text": "e is bold!"}]',
164+
'[{"text": "e is bold!", "type": "markdown_text"}]',
165165
)
166166
self.assertEqual(append_request.get("token"), "xoxb-chat_stream_test_token1")
167167
self.assertEqual(append_request.get("ts"), "123.123")
@@ -174,7 +174,7 @@ def test_streams_a_long_message(self):
174174
self.assertEqual(stop_request.get("channel"), "C0123456789")
175175
self.assertEqual(
176176
json.dumps(stop_request.get("chunks")),
177-
'[{"type": "markdown_text", "text": "**"}]',
177+
'[{"text": "**", "type": "markdown_text"}]',
178178
)
179179
self.assertEqual(stop_request.get("token"), "xoxb-chat_stream_test_token2")
180180
self.assertEqual(stop_request.get("ts"), "123.123")
@@ -219,7 +219,7 @@ def test_streams_a_chunk_message(self):
219219
self.assertEqual(start_request.get("thread_ts"), "123.000")
220220
self.assertEqual(
221221
json.dumps(start_request.get("chunks")),
222-
'[{"type": "markdown_text", "text": "**this is buffered**"}, {"id": "001", "status": "pending", "title": "Counting...", "type": "task_update"}]',
222+
'[{"text": "**this is buffered**", "type": "markdown_text"}, {"id": "001", "status": "pending", "title": "Counting...", "type": "task_update"}]',
223223
)
224224
self.assertEqual(start_request.get("recipient_team_id"), "T0123456789")
225225
self.assertEqual(start_request.get("recipient_user_id"), "U0123456789")
@@ -237,7 +237,7 @@ def test_streams_a_chunk_message(self):
237237
self.assertEqual(stop_request.get("ts"), "123.123")
238238
self.assertEqual(
239239
json.dumps(stop_request.get("chunks")),
240-
'[{"type": "markdown_text", "text": "\\n"}, {"text": ":space_invader:", "type": "markdown_text"}]',
240+
'[{"text": "\\n", "type": "markdown_text"}, {"text": ":space_invader:", "type": "markdown_text"}]',
241241
)
242242

243243
def test_streams_errors_when_appending_to_an_unstarted_stream(self):

‎tests/slack_sdk_async/web/test_async_chat_stream.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ async def test_streams_a_short_message(self):
110110
self.assertEqual(stop_request.get("ts"), "123.123")
111111
self.assertEqual(
112112
json.dumps(stop_request.get("chunks")),
113-
'[{"type": "markdown_text", "text": "nice!"}]',
113+
'[{"text": "nice!", "type": "markdown_text"}]',
114114
)
115115

116116
@async_test
@@ -155,7 +155,7 @@ async def test_streams_a_long_message(self):
155155
self.assertEqual(start_request.get("thread_ts"), "123.000")
156156
self.assertEqual(
157157
json.dumps(start_request.get("chunks")),
158-
'[{"type": "markdown_text", "text": "**this messag"}]',
158+
'[{"text": "**this messag", "type": "markdown_text"}]',
159159
)
160160
self.assertEqual(start_request.get("recipient_team_id"), "T0123456789")
161161
self.assertEqual(start_request.get("recipient_user_id"), "U0123456789")
@@ -164,7 +164,7 @@ async def test_streams_a_long_message(self):
164164
self.assertEqual(append_request.get("channel"), "C0123456789")
165165
self.assertEqual(
166166
json.dumps(append_request.get("chunks")),
167-
'[{"type": "markdown_text", "text": "e is bold!"}]',
167+
'[{"text": "e is bold!", "type": "markdown_text"}]',
168168
)
169169
self.assertEqual(append_request.get("token"), "xoxb-chat_stream_test_token1")
170170
self.assertEqual(append_request.get("ts"), "123.123")
@@ -177,7 +177,7 @@ async def test_streams_a_long_message(self):
177177
self.assertEqual(stop_request.get("channel"), "C0123456789")
178178
self.assertEqual(
179179
json.dumps(stop_request.get("chunks")),
180-
'[{"type": "markdown_text", "text": "**"}]',
180+
'[{"text": "**", "type": "markdown_text"}]',
181181
)
182182
self.assertEqual(stop_request.get("token"), "xoxb-chat_stream_test_token2")
183183
self.assertEqual(stop_request.get("ts"), "123.123")
@@ -223,7 +223,7 @@ async def test_streams_a_chunk_message(self):
223223
self.assertEqual(start_request.get("thread_ts"), "123.000")
224224
self.assertEqual(
225225
json.dumps(start_request.get("chunks")),
226-
'[{"type": "markdown_text", "text": "**this is buffered**"}, {"id": "001", "status": "pending", "title": "Counting...", "type": "task_update"}]',
226+
'[{"text": "**this is buffered**", "type": "markdown_text"}, {"id": "001", "status": "pending", "title": "Counting...", "type": "task_update"}]',
227227
)
228228
self.assertEqual(start_request.get("recipient_team_id"), "T0123456789")
229229
self.assertEqual(start_request.get("recipient_user_id"), "U0123456789")
@@ -241,7 +241,7 @@ async def test_streams_a_chunk_message(self):
241241
self.assertEqual(stop_request.get("ts"), "123.123")
242242
self.assertEqual(
243243
json.dumps(stop_request.get("chunks")),
244-
'[{"type": "markdown_text", "text": "\\n"}, {"text": ":space_invader:", "type": "markdown_text"}]',
244+
'[{"text": "\\n", "type": "markdown_text"}, {"text": ":space_invader:", "type": "markdown_text"}]',
245245
)
246246

247247
@async_test

0 commit comments

Comments
 (0)