Skip to content

Commit d767159

Browse files
Virtual-Joshjohnataylor
authored andcommitted
adding return types (#499)
* adding return types * updating method name * updating tests * fixing black
1 parent d841395 commit d767159

File tree

2 files changed

+30
-20
lines changed

2 files changed

+30
-20
lines changed

libraries/botbuilder-core/botbuilder/core/teams/teams_activity_handler.py

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,11 @@
1616
TeamsChannelAccount,
1717
MessagingExtensionAction,
1818
MessagingExtensionQuery,
19+
MessagingExtensionActionResponse,
20+
MessagingExtensionResponse,
1921
O365ConnectorCardActionQuery,
2022
TaskModuleRequest,
23+
TaskModuleResponse,
2124
)
2225
from botframework.connector import Channels
2326

@@ -49,7 +52,7 @@ async def on_turn(self, turn_context: TurnContext):
4952

5053
await super().on_turn(turn_context)
5154

52-
async def on_invoke_activity(self, turn_context: TurnContext):
55+
async def on_invoke_activity(self, turn_context: TurnContext) -> InvokeResponse:
5356
try:
5457
if (
5558
not turn_context.activity.name
@@ -171,7 +174,9 @@ async def on_invoke_activity(self, turn_context: TurnContext):
171174
except _InvokeResponseException as err:
172175
return err.create_invoke_response()
173176

174-
async def on_teams_card_action_invoke_activity(self, turn_context: TurnContext):
177+
async def on_teams_card_action_invoke_activity(
178+
self, turn_context: TurnContext
179+
) -> InvokeResponse:
175180
raise _InvokeResponseException(status_code=HTTPStatus.NOT_IMPLEMENTED)
176181

177182
async def on_teams_signin_verify_state(self, turn_context: TurnContext):
@@ -181,7 +186,7 @@ async def on_teams_file_consent(
181186
self,
182187
turn_context: TurnContext,
183188
file_consent_card_response: FileConsentCardResponse,
184-
):
189+
) -> InvokeResponse:
185190
if file_consent_card_response.action == "accept":
186191
await self.on_teams_file_consent_accept_activity(
187192
turn_context, file_consent_card_response
@@ -220,22 +225,22 @@ async def on_teams_o365_connector_card_action( # pylint: disable=unused-argumen
220225

221226
async def on_teams_app_based_link_query( # pylint: disable=unused-argument
222227
self, turn_context: TurnContext, query: AppBasedLinkQuery
223-
):
228+
) -> MessagingExtensionResponse:
224229
raise _InvokeResponseException(status_code=HTTPStatus.NOT_IMPLEMENTED)
225230

226231
async def on_teams_messaging_extension_query( # pylint: disable=unused-argument
227232
self, turn_context: TurnContext, query: MessagingExtensionQuery
228-
):
233+
) -> MessagingExtensionResponse:
229234
raise _InvokeResponseException(status_code=HTTPStatus.NOT_IMPLEMENTED)
230235

231236
async def on_teams_messaging_extension_select_item( # pylint: disable=unused-argument
232237
self, turn_context: TurnContext, query
233-
):
238+
) -> MessagingExtensionResponse:
234239
raise _InvokeResponseException(status_code=HTTPStatus.NOT_IMPLEMENTED)
235240

236241
async def on_teams_messaging_extension_submit_action_dispatch(
237242
self, turn_context: TurnContext, action: MessagingExtensionAction
238-
):
243+
) -> MessagingExtensionActionResponse:
239244
if not action.bot_message_preview_action:
240245
return await self.on_teams_messaging_extension_submit_action_activity(
241246
turn_context, action
@@ -247,7 +252,7 @@ async def on_teams_messaging_extension_submit_action_dispatch(
247252
)
248253

249254
if action.bot_message_preview_action == "send":
250-
return await self.on_teams_messaging_extension_bot_message_send_activity(
255+
return await self.on_teams_messaging_extension_bot_message_preview_send_activity(
251256
turn_context, action
252257
)
253258

@@ -258,27 +263,27 @@ async def on_teams_messaging_extension_submit_action_dispatch(
258263

259264
async def on_teams_messaging_extension_bot_message_preview_edit_activity( # pylint: disable=unused-argument
260265
self, turn_context: TurnContext, action
261-
):
266+
) -> MessagingExtensionActionResponse:
262267
raise _InvokeResponseException(status_code=HTTPStatus.NOT_IMPLEMENTED)
263268

264-
async def on_teams_messaging_extension_bot_message_send_activity( # pylint: disable=unused-argument
269+
async def on_teams_messaging_extension_bot_message_preview_send_activity( # pylint: disable=unused-argument
265270
self, turn_context: TurnContext, action
266-
):
271+
) -> MessagingExtensionActionResponse:
267272
raise _InvokeResponseException(status_code=HTTPStatus.NOT_IMPLEMENTED)
268273

269274
async def on_teams_messaging_extension_submit_action_activity( # pylint: disable=unused-argument
270275
self, turn_context: TurnContext, action: MessagingExtensionAction
271-
):
276+
) -> MessagingExtensionActionResponse:
272277
raise _InvokeResponseException(status_code=HTTPStatus.NOT_IMPLEMENTED)
273278

274279
async def on_teams_messaging_extension_fetch_task( # pylint: disable=unused-argument
275280
self, turn_context: TurnContext, action: MessagingExtensionAction
276-
):
281+
) -> MessagingExtensionActionResponse:
277282
raise _InvokeResponseException(status_code=HTTPStatus.NOT_IMPLEMENTED)
278283

279284
async def on_teams_messaging_extension_configuration_query_settings_url( # pylint: disable=unused-argument
280285
self, turn_context: TurnContext, query: MessagingExtensionQuery
281-
):
286+
) -> MessagingExtensionResponse:
282287
raise _InvokeResponseException(status_code=HTTPStatus.NOT_IMPLEMENTED)
283288

284289
async def on_teams_messaging_extension_configuration_setting( # pylint: disable=unused-argument
@@ -293,12 +298,12 @@ async def on_teams_messaging_extension_card_button_clicked( # pylint: disable=u
293298

294299
async def on_teams_task_module_fetch( # pylint: disable=unused-argument
295300
self, turn_context: TurnContext, task_module_request: TaskModuleRequest
296-
):
301+
) -> TaskModuleResponse:
297302
raise _InvokeResponseException(status_code=HTTPStatus.NOT_IMPLEMENTED)
298303

299304
async def on_teams_task_module_submit( # pylint: disable=unused-argument
300305
self, turn_context: TurnContext, task_module_request: TaskModuleRequest
301-
):
306+
) -> TaskModuleResponse:
302307
raise _InvokeResponseException(status_code=HTTPStatus.NOT_IMPLEMENTED)
303308

304309
async def on_conversation_update_activity(self, turn_context: TurnContext):

libraries/botbuilder-core/tests/teams/test_teams_activity_handler.py

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -171,11 +171,13 @@ async def on_teams_messaging_extension_bot_message_preview_edit_activity(
171171
turn_context, action
172172
)
173173

174-
async def on_teams_messaging_extension_bot_message_send_activity(
174+
async def on_teams_messaging_extension_bot_message_preview_send_activity(
175175
self, turn_context: TurnContext, action: MessagingExtensionAction
176176
):
177-
self.record.append("on_teams_messaging_extension_bot_message_send_activity")
178-
return await super().on_teams_messaging_extension_bot_message_send_activity(
177+
self.record.append(
178+
"on_teams_messaging_extension_bot_message_preview_send_activity"
179+
)
180+
return await super().on_teams_messaging_extension_bot_message_preview_send_activity(
179181
turn_context, action
180182
)
181183

@@ -531,7 +533,10 @@ async def test_on_teams_messaging_extension_bot_message_send_activity(self):
531533
assert len(bot.record) == 3
532534
assert bot.record[0] == "on_invoke_activity"
533535
assert bot.record[1] == "on_teams_messaging_extension_submit_action_dispatch"
534-
assert bot.record[2] == "on_teams_messaging_extension_bot_message_send_activity"
536+
assert (
537+
bot.record[2]
538+
== "on_teams_messaging_extension_bot_message_preview_send_activity"
539+
)
535540

536541
async def test_on_teams_messaging_extension_bot_message_send_activity_with_none(
537542
self,

0 commit comments

Comments
 (0)