Merge branch 'main' into main

tracyboehrer · web-flow · commit 41cfc8ada9ad · 2025-12-29T10:54:03.000-06:00
diff --git a/README.md b/README.md
@@ -1,5 +1,14 @@
 # ![Bot Framework SDK v4 Python](./doc/media/FrameWorkPython.png)
 
+# ARCHIVE NOTICE:
+
+> We are in the process of archiving the Bot Framework Python SDK repository on GitHub. This means that this project will no longer be updated or maintained. Customers using this tool will not be disrupted. However, the tool will no longer be supported through 
+> service tickets in the Azure portal and will not receive product updates.
+
+> To build agents with your choice of AI services, orchestration, and knowledge, consider using the [Microsoft 365 Agents SDK](https://github.com/microsoft/agents). The Agents SDK is GA and has support for C#, JavaScript or Python. You can learn more about the Agents SDK at aka.ms/agents. If you're looking for a SaaS-based agent platform, consider Microsoft Copilot Studio. If you have an existing bot built with the Bot Framework SDK, you can update your bot to the Agents SDK. You can review the core changes and updates at Bot Framework SDK to Agents SDK migration guidance [here](https://learn.microsoft.com/en-us/microsoft-365/agents-sdk/bf-migration-guidance). Support tickets for the Bot Framework SDK will no longer be serviced as of December 31, 2025.
+
+> We plan to archive this project no later than end of December of 2025.
+
 This repository contains code for the Python version of the [Microsoft Bot Framework SDK](https://github.com/Microsoft/botframework-sdk), which is part of the Microsoft Bot Framework - a comprehensive framework for building enterprise-grade conversational AI experiences.
 
 This SDK enables developers to model conversation and build sophisticated bot applications using Python. SDKs for [JavaScript](https://github.com/Microsoft/botbuilder-js) and [.NET](https://github.com/Microsoft/botbuilder-dotnet) are also available.
@@ -118,7 +127,7 @@ We use the [@msbotframework](https://twitter.com/msbotframework) account on twit
 The [Gitter Channel](https://gitter.im/Microsoft/BotBuilder) provides a place where the Community can get together and collaborate.
 
 ## Contributing and our code of conduct
-We welcome contributions and suggestions. Please see our [contributing guidelines](./contributing.md) for more information.
+We welcome contributions and suggestions. Please see our [contributing guidelines](./Contributing.md) for more information.
 
 This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
 
diff --git a/libraries/botbuilder-adapters-slack/requirements.txt b/libraries/botbuilder-adapters-slack/requirements.txt
@@ -1,4 +1,4 @@
-aiohttp==3.10.11
+aiohttp
 pyslack
 botbuilder-core==4.17.0
 slackclient
diff --git a/libraries/botbuilder-ai/setup.py b/libraries/botbuilder-ai/setup.py
@@ -8,7 +8,7 @@
     "azure-cognitiveservices-language-luis==0.2.0",
     "botbuilder-schema==4.17.0",
     "botbuilder-core==4.17.0",
-    "aiohttp==3.10.11",
+    "aiohttp>=3.10,<4.0",
 ]
 
 TESTS_REQUIRES = ["aiounittest>=1.1.0"]
diff --git a/libraries/botbuilder-azure/setup.py b/libraries/botbuilder-azure/setup.py
@@ -10,7 +10,7 @@
     "azure-storage-queue==12.4.0",
     "botbuilder-schema==4.17.0",
     "botframework-connector==4.17.0",
-    "jsonpickle>=1.2,<1.5",
+    "jsonpickle>=1.2,<4",
 ]
 TEST_REQUIRES = ["aiounittest==1.3.0"]
 
diff --git a/libraries/botbuilder-core/botbuilder/core/__init__.py b/libraries/botbuilder-core/botbuilder/core/__init__.py
@@ -48,6 +48,7 @@
 from .user_state import UserState
 from .register_class_middleware import RegisterClassMiddleware
 from .adapter_extensions import AdapterExtensions
+from .serializer_helper import serializer_helper
 
 __all__ = [
     "ActivityHandler",
@@ -100,5 +101,6 @@
     "TurnContext",
     "UserState",
     "UserTokenProvider",
+    "serializer_helper",
     "__version__",
 ]
diff --git a/libraries/botbuilder-core/botbuilder/core/activity_handler.py b/libraries/botbuilder-core/botbuilder/core/activity_handler.py
@@ -478,12 +478,19 @@ async def on_invoke_activity(  # pylint: disable=unused-argument
             if (
                 turn_context.activity.name
                 == SignInConstants.verify_state_operation_name
-                or turn_context.activity.name
-                == SignInConstants.token_exchange_operation_name
             ):
                 await self.on_sign_in_invoke(turn_context)
                 return self._create_invoke_response()
 
+            # This is for back-compat with previous versions of Python SDK.  This method does not
+            # exist in the C# SDK, and is not used in the Python SDK.
+            if (
+                turn_context.activity.name
+                == SignInConstants.token_exchange_operation_name
+            ):
+                await self.on_teams_signin_token_exchange(turn_context)
+                return self._create_invoke_response()
+
             if turn_context.activity.name == "adaptiveCard/action":
                 invoke_value = self._get_adaptive_card_invoke_value(
                     turn_context.activity
diff --git a/libraries/botbuilder-core/botbuilder/core/teams/teams_activity_handler.py b/libraries/botbuilder-core/botbuilder/core/teams/teams_activity_handler.py
@@ -56,13 +56,6 @@ async def on_invoke_activity(self, turn_context: TurnContext) -> InvokeResponse:
             ):
                 return await self.on_teams_card_action_invoke(turn_context)
 
-            if (
-                turn_context.activity.name
-                == SignInConstants.token_exchange_operation_name
-            ):
-                await self.on_teams_signin_token_exchange(turn_context)
-                return self._create_invoke_response()
-
             if turn_context.activity.name == "fileConsent/invoke":
                 return await self.on_teams_file_consent(
                     turn_context,
@@ -250,7 +243,9 @@ async def on_teams_signin_verify_state(self, turn_context: TurnContext):
         raise _InvokeResponseException(status_code=HTTPStatus.NOT_IMPLEMENTED)
 
     async def on_teams_signin_token_exchange(self, turn_context: TurnContext):
-        raise _InvokeResponseException(status_code=HTTPStatus.NOT_IMPLEMENTED)
+        # This is for back-compat with previous versions of Python SDK.  This method does not
+        # exist in the C# SDK, and is not used in the Python SDK.
+        return await self.on_teams_signin_verify_state(turn_context)
 
     async def on_teams_file_consent(
         self,
@@ -319,7 +314,7 @@ async def on_teams_o365_connector_card_action(  # pylint: disable=unused-argumen
         self, turn_context: TurnContext, query: O365ConnectorCardActionQuery
     ):
         """
-        Invoked when a O365 Connector Card Action activity is received from the connector.
+        Invoked when an O365 Connector Card Action activity is received from the connector.
 
         :param turn_context: A context object for this turn.
         :param query: The O365 connector card HttpPOST invoke query.
diff --git a/libraries/botbuilder-core/botbuilder/core/teams/teams_sso_token_exchange_middleware.py b/libraries/botbuilder-core/botbuilder/core/teams/teams_sso_token_exchange_middleware.py
@@ -26,6 +26,7 @@
     StoreItem,
     TurnContext,
 )
+from botframework.connector.auth.user_token_client import UserTokenClient
 
 
 class _TokenStoreItem(StoreItem):
@@ -147,17 +148,29 @@ async def _exchanged_token(self, turn_context: TurnContext) -> bool:
         token_exchange_response: TokenResponse = None
         aux_dict = {}
         if turn_context.activity.value:
-            for prop in ["id", "connection_name", "token", "properties"]:
+            for prop in ["id", "connectionName", "token", "properties"]:
                 aux_dict[prop] = turn_context.activity.value.get(prop)
         token_exchange_request = TokenExchangeInvokeRequest(
             id=aux_dict["id"],
-            connection_name=aux_dict["connection_name"],
+            connection_name=aux_dict["connectionName"],
             token=aux_dict["token"],
             properties=aux_dict["properties"],
         )
         try:
             adapter = turn_context.adapter
-            if isinstance(turn_context.adapter, ExtendedUserTokenProvider):
+
+            user_token_client: UserTokenClient = turn_context.turn_state.get(
+                UserTokenClient.__name__, None
+            )
+            if user_token_client:
+                # If the adapter has UserTokenClient, use it to exchange the token.
+                token_exchange_response = await user_token_client.exchange_token(
+                    turn_context.activity.from_property.id,
+                    token_exchange_request.connection_name,
+                    turn_context.activity.channel_id,
+                    TokenExchangeRequest(token=token_exchange_request.token),
+                )
+            elif isinstance(turn_context.adapter, ExtendedUserTokenProvider):
                 token_exchange_response = await adapter.exchange_token(
                     turn_context,
                     self._oauth_connection_name,
diff --git a/libraries/botbuilder-core/botbuilder/core/turn_context.py b/libraries/botbuilder-core/botbuilder/core/turn_context.py
@@ -396,9 +396,13 @@ def remove_mention_text(activity: Activity, identifier: str) -> str:
         mentions = TurnContext.get_mentions(activity)
         for mention in mentions:
             if mention.additional_properties["mentioned"]["id"] == identifier:
+                replace_text = (
+                    mention.additional_properties.get("text")
+                    or mention.additional_properties.get("mentioned")["name"]
+                )
                 mention_name_match = re.match(
                     r"<at(.*)>(.*?)<\/at>",
-                    escape(mention.additional_properties["text"]),
+                    escape(replace_text),
                     re.IGNORECASE,
                 )
                 if mention_name_match:
diff --git a/libraries/botbuilder-core/setup.py b/libraries/botbuilder-core/setup.py
@@ -9,7 +9,7 @@
     "botbuilder-schema==4.17.0",
     "botframework-connector==4.17.0",
     "botframework-streaming==4.17.0",
-    "jsonpickle>=1.2,<1.5",
+    "jsonpickle>=1.2,<4",
 ]
 
 root = os.path.abspath(os.path.dirname(__file__))
diff --git a/libraries/botbuilder-core/tests/test_turn_context.py b/libraries/botbuilder-core/tests/test_turn_context.py
@@ -350,6 +350,48 @@ def test_should_remove_at_mention_with_regex_characters(self):
         assert text == " test activity"
         assert activity.text == " test activity"
 
+    def test_should_remove_custom_mention_from_activity(self):
+        activity = Activity(
+            text="Hallo",
+            text_format="plain",
+            type="message",
+            timestamp="2025-03-11T14:16:47.0093935Z",
+            id="1741702606984",
+            channel_id="msteams",
+            service_url="https://smba.trafficmanager.net/emea/REDACTED/",
+            from_property=ChannelAccount(
+                id="29:1J-K4xVh-sLpdwQ-R5GkOZ_TB0W3ec_37p710aH8qe8bITA0zxdgIGc9l-MdDdkdE_jasSfNOeWXyyL1nsrHtBQ",
+                name="",
+                aad_object_id="REDACTED",
+            ),
+            conversation=ConversationAccount(
+                is_group=True,
+                conversation_type="groupChat",
+                tenant_id="REDACTED",
+                id="19:Ql86tXNM2lTBXNKJdqKdwIF9ltGZwpvluLvnJdA0tmg1@thread.v2",
+            ),
+            recipient=ChannelAccount(
+                id="28:c5d5fb56-a1a4-4467-a7a3-1b37905498a0", name="Azure AI Agent"
+            ),
+            entities=[
+                Entity().deserialize(
+                    Mention(
+                        type="mention",
+                        mentioned=ChannelAccount(
+                            id="28:c5d5fb56-a1a4-4467-a7a3-1b37905498a0",
+                            name="Custom Agent",
+                        ),
+                    ).serialize()
+                )
+            ],
+            channel_data={"tenant": {"id": "REDACTED"}, "productContext": "COPILOT"},
+        )
+
+        text = TurnContext.remove_mention_text(activity, activity.recipient.id)
+
+        assert text == "Hallo"
+        assert activity.text == "Hallo"
+
     async def test_should_send_a_trace_activity(self):
         context = TurnContext(SimpleAdapter(), ACTIVITY)
         called = False
diff --git a/libraries/botbuilder-dialogs/botbuilder/dialogs/dialog.py b/libraries/botbuilder-dialogs/botbuilder/dialogs/dialog.py
@@ -125,7 +125,7 @@ async def on_dialog_event(
 
         # Bubble as needed
         if (not handled) and dialog_event.bubble and dialog_context.parent:
-            handled = await dialog_context.parent.emit(
+            handled = await dialog_context.parent.emit_event(
                 dialog_event.name, dialog_event.value, True, False
             )
 
diff --git a/libraries/botbuilder-dialogs/botbuilder/dialogs/prompts/oauth_prompt.py b/libraries/botbuilder-dialogs/botbuilder/dialogs/prompts/oauth_prompt.py
@@ -341,6 +341,13 @@ async def _send_oauth_card(
                     if sign_in_resource.token_exchange_resource
                     else None
                 )
+
+                json_token_ex_post = (
+                    sign_in_resource.token_post_resource.as_dict()
+                    if sign_in_resource.token_post_resource
+                    else None
+                )
+
                 prompt.attachments.append(
                     CardFactory.oauth_card(
                         OAuthCard(
@@ -355,6 +362,7 @@ async def _send_oauth_card(
                                 )
                             ],
                             token_exchange_resource=json_token_ex_resource,
+                            token_post_resource=json_token_ex_post,
                         )
                     )
                 )
diff --git a/libraries/botbuilder-integration-aiohttp/botbuilder/integration/aiohttp/cloud_adapter.py b/libraries/botbuilder-integration-aiohttp/botbuilder/integration/aiohttp/cloud_adapter.py
@@ -1,6 +1,8 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 
+import json
+
 from typing import Awaitable, Callable, Optional
 
 from aiohttp.web import (
@@ -17,6 +19,7 @@
     Bot,
     CloudAdapterBase,
     InvokeResponse,
+    serializer_helper,
     TurnContext,
 )
 from botbuilder.core.streaming import (
@@ -102,7 +105,8 @@ async def process(
                 # Write the response, serializing the InvokeResponse
                 if invoke_response:
                     return json_response(
-                        data=invoke_response.body, status=invoke_response.status
+                        data=serializer_helper(invoke_response.body),
+                        status=invoke_response.status,
                     )
                 return Response(status=201)
             else:
diff --git a/libraries/botbuilder-integration-aiohttp/requirements.txt b/libraries/botbuilder-integration-aiohttp/requirements.txt
@@ -1,4 +1,4 @@
 msrest== 0.7.*
 botframework-connector==4.17.0
 botbuilder-schema==4.17.0
-aiohttp==3.10.11
+aiohttp==3.*.*
diff --git a/libraries/botbuilder-integration-aiohttp/setup.py b/libraries/botbuilder-integration-aiohttp/setup.py
@@ -10,7 +10,7 @@
     "botframework-connector==4.17.0",
     "botbuilder-core==4.17.0",
     "yarl>=1.8.1",
-    "aiohttp==3.10.11",
+    "aiohttp>=3.10,<4.0",
 ]
 
 root = os.path.abspath(os.path.dirname(__file__))
diff --git a/libraries/botbuilder-integration-applicationinsights-aiohttp/setup.py b/libraries/botbuilder-integration-applicationinsights-aiohttp/setup.py
@@ -6,7 +6,7 @@
 
 REQUIRES = [
     "applicationinsights>=0.11.9",
-    "aiohttp==3.10.11",
+    "aiohttp>=3.10,<4.0",
     "botbuilder-schema==4.17.0",
     "botframework-connector==4.17.0",
     "botbuilder-core==4.17.0",
diff --git a/libraries/botbuilder-schema/botbuilder/schema/_models_py3.py b/libraries/botbuilder-schema/botbuilder/schema/_models_py3.py
@@ -1909,6 +1909,7 @@ class OAuthCard(Model):
         "connection_name": {"key": "connectionName", "type": "str"},
         "buttons": {"key": "buttons", "type": "[CardAction]"},
         "token_exchange_resource": {"key": "tokenExchangeResource", "type": "object"},
+        "token_post_resource": {"key": "tokenPostResource", "type": "object"},
     }
 
     def __init__(
@@ -1918,13 +1919,15 @@ def __init__(
         connection_name: str = None,
         buttons=None,
         token_exchange_resource=None,
+        token_post_resource=None,
         **kwargs
     ) -> None:
         super(OAuthCard, self).__init__(**kwargs)
         self.text = text
         self.connection_name = connection_name
         self.buttons = buttons
         self.token_exchange_resource = token_exchange_resource
+        self.token_post_resource = token_post_resource
 
 
 class PagedMembersResult(Model):
diff --git a/libraries/botframework-connector/botframework/connector/token_api/models/__init__.py b/libraries/botframework-connector/botframework/connector/token_api/models/__init__.py
@@ -13,6 +13,7 @@
     from ._models_py3 import SignInUrlResponse
     from ._models_py3 import TokenExchangeRequest
     from ._models_py3 import TokenExchangeResource
+    from ._models_py3 import TokenPostResource
     from ._models_py3 import TokenResponse
     from ._models_py3 import TokenStatus
 except (SyntaxError, ImportError):
@@ -23,6 +24,7 @@
     from ._models import SignInUrlResponse
     from ._models import TokenExchangeRequest
     from ._models import TokenExchangeResource
+    from ._models import TokenPostResource
     from ._models import TokenResponse
     from ._models import TokenStatus
 
@@ -35,6 +37,7 @@
     "SignInUrlResponse",
     "TokenExchangeRequest",
     "TokenExchangeResource",
+    "TokenPostResource",
     "TokenResponse",
     "TokenStatus",
 ]
diff --git a/libraries/botframework-connector/botframework/connector/token_api/models/_models.py b/libraries/botframework-connector/botframework/connector/token_api/models/_models.py
diff --git a/libraries/botframework-connector/botframework/connector/token_api/models/_models_py3.py b/libraries/botframework-connector/botframework/connector/token_api/models/_models_py3.py
diff --git a/tests/skills/skills-buffered/child/requirements.txt b/tests/skills/skills-buffered/child/requirements.txt
diff --git a/tests/skills/skills-buffered/parent/requirements.txt b/tests/skills/skills-buffered/parent/requirements.txt

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`"azure-cognitiveservices-language-luis==0.2.0",`
`9`	`9`	`"botbuilder-schema==4.17.0",`
`10`	`10`	`"botbuilder-core==4.17.0",`
`11`		`- "aiohttp==3.10.11",`
	`11`	`+ "aiohttp>=3.10,<4.0",`
`12`	`12`	`]`
`13`	`13`
`14`	`14`	`TESTS_REQUIRES = ["aiounittest>=1.1.0"]`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`"azure-storage-queue==12.4.0",`
`11`	`11`	`"botbuilder-schema==4.17.0",`
`12`	`12`	`"botframework-connector==4.17.0",`
`13`		`- "jsonpickle>=1.2,<1.5",`
	`13`	`+ "jsonpickle>=1.2,<4",`
`14`	`14`	`]`
`15`	`15`	`TEST_REQUIRES = ["aiounittest==1.3.0"]`
`16`	`16`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`"botbuilder-schema==4.17.0",`
`10`	`10`	`"botframework-connector==4.17.0",`
`11`	`11`	`"botframework-streaming==4.17.0",`
`12`		`- "jsonpickle>=1.2,<1.5",`
	`12`	`+ "jsonpickle>=1.2,<4",`
`13`	`13`	`]`
`14`	`14`
`15`	`15`	`root = os.path.abspath(os.path.dirname(__file__))`