From 8a7b47cbe6e4def39d51bc76594a57fa53e739a3 Mon Sep 17 00:00:00 2001 From: Zitong Yang Date: Mon, 27 Jul 2026 15:31:01 +1000 Subject: [PATCH 1/6] Add generated Web PubSub Chat SDK --- .../CHANGELOG.md | 12 + .../LICENSE | 21 + .../MANIFEST.in | 8 + .../README.md | 82 + .../_metadata.json | 6 + .../apiview-properties.json | 49 + .../azure/__init__.py | 1 + .../azure/messaging/__init__.py | 1 + .../messaging/webpubsubservice/__init__.py | 1 + .../webpubsubservice/chat/__init__.py | 32 + .../webpubsubservice/chat/_client.py | 110 + .../webpubsubservice/chat/_configuration.py | 71 + .../chat/_operations/__init__.py | 23 + .../chat/_operations/_operations.py | 2606 +++++++++++++++++ .../chat/_operations/_patch.py | 21 + .../messaging/webpubsubservice/chat/_patch.py | 21 + .../webpubsubservice/chat/_utils/__init__.py | 6 + .../chat/_utils/model_base.py | 1770 +++++++++++ .../chat/_utils/serialization.py | 2175 ++++++++++++++ .../webpubsubservice/chat/_utils/utils.py | 57 + .../webpubsubservice/chat/_version.py | 9 + .../webpubsubservice/chat/aio/__init__.py | 29 + .../webpubsubservice/chat/aio/_client.py | 112 + .../chat/aio/_configuration.py | 71 + .../chat/aio/_operations/__init__.py | 23 + .../chat/aio/_operations/_operations.py | 2019 +++++++++++++ .../chat/aio/_operations/_patch.py | 21 + .../webpubsubservice/chat/aio/_patch.py | 21 + .../webpubsubservice/chat/models/__init__.py | 46 + .../webpubsubservice/chat/models/_enums.py | 17 + .../webpubsubservice/chat/models/_models.py | 333 +++ .../webpubsubservice/chat/models/_patch.py | 21 + .../messaging/webpubsubservice/chat/py.typed | 1 + .../messaging/webpubsubservice/chat/types.py | 167 ++ .../dev_requirements.txt | 4 + .../chat/create_or_replace_role.py | 45 + .../chat/create_or_replace_room.py | 43 + .../chat/create_or_replace_room_member.py | 44 + .../chat/create_or_replace_user.py | 43 + .../generated_samples/chat/delete_message.py | 42 + .../generated_samples/chat/delete_role.py | 41 + .../generated_samples/chat/delete_room.py | 41 + .../chat/delete_room_member.py | 42 + .../generated_samples/chat/delete_user.py | 41 + .../chat/get_conversation.py | 42 + .../generated_samples/chat/get_role.py | 42 + .../generated_samples/chat/get_room.py | 42 + .../generated_samples/chat/get_user.py | 42 + .../generated_samples/chat/list_messages.py | 43 + .../generated_samples/chat/list_roles.py | 41 + .../chat/list_room_members.py | 43 + .../generated_samples/chat/update_message.py | 44 + .../generated_tests/conftest.py | 45 + .../test_web_pub_sub_chat_service.py | 213 ++ .../test_web_pub_sub_chat_service_async.py | 214 ++ .../generated_tests/testpreparer.py | 28 + .../generated_tests/testpreparer_async.py | 20 + .../setup.py | 73 + .../tsp-location.yaml | 5 + 59 files changed, 11286 insertions(+) create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/CHANGELOG.md create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/LICENSE create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/MANIFEST.in create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/README.md create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/_metadata.json create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/apiview-properties.json create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/__init__.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/__init__.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/__init__.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/__init__.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_client.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_configuration.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_operations/__init__.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_operations/_operations.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_operations/_patch.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_patch.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/__init__.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/model_base.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/serialization.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/utils.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_version.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/__init__.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_client.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_configuration.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_operations/__init__.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_operations/_operations.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_operations/_patch.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_patch.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/__init__.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_enums.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_models.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_patch.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/py.typed create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/types.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/dev_requirements.txt create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/create_or_replace_role.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/create_or_replace_room.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/create_or_replace_room_member.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/create_or_replace_user.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/delete_message.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/delete_role.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/delete_room.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/delete_room_member.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/delete_user.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/get_conversation.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/get_role.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/get_room.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/get_user.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/list_messages.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/list_roles.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/list_room_members.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/update_message.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/conftest.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/test_web_pub_sub_chat_service.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/test_web_pub_sub_chat_service_async.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/testpreparer.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/testpreparer_async.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/setup.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/tsp-location.yaml diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/CHANGELOG.md b/sdk/webpubsub/azure-messaging-webpubsubchatservice/CHANGELOG.md new file mode 100644 index 000000000000..24a1b4c4f4da --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/CHANGELOG.md @@ -0,0 +1,12 @@ +# Release History + +## 1.0.0b1 (2026-07-01) + +### Features Added + + - Initial preview release of the Azure Web PubSub Chat Service client library for Python + - Support for room management (create, get, update, delete rooms) + - Support for user management (create, get, delete users) + - Support for room membership management (add, list, delete room members) + - Support for message operations (list, update, delete messages) + - Support for role-based access control (create, get, list, delete roles) \ No newline at end of file diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/LICENSE b/sdk/webpubsub/azure-messaging-webpubsubchatservice/LICENSE new file mode 100644 index 000000000000..63447fd8bbbf --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/LICENSE @@ -0,0 +1,21 @@ +Copyright (c) Microsoft Corporation. + +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/MANIFEST.in b/sdk/webpubsub/azure-messaging-webpubsubchatservice/MANIFEST.in new file mode 100644 index 000000000000..216566cd1f7e --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/MANIFEST.in @@ -0,0 +1,8 @@ +include *.md +include LICENSE +include azure/messaging/webpubsubservice/chat/py.typed +recursive-include tests *.py +recursive-include samples *.py *.md +include azure/__init__.py +include azure/messaging/__init__.py +include azure/messaging/webpubsubservice/__init__.py diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/README.md b/sdk/webpubsub/azure-messaging-webpubsubchatservice/README.md new file mode 100644 index 000000000000..73cf59ab5098 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/README.md @@ -0,0 +1,82 @@ +# "Azure Web PubSub Chat Service" client library for Python + + +## Getting started + +### Install the package + +```bash +python -m pip install azure-messaging-webpubsubchatservice +``` + +#### Prequisites + +- Python 3.10 or later is required to use this package. +- You need an [Azure subscription][azure_sub] to use this package. +- An existing "Azure Web PubSub Chat Service" instance. + +### Use with AI tools + +AI coding tools such as VS Code and GitHub Copilot can help you write and debug code that uses this library. See [Using the Azure SDK for Python with AI tools](https://aka.ms/azsdk/python/ai) for available integrations. + +#### Create with an Azure Active Directory Credential +To use an [Azure Active Directory (AAD) token credential][authenticate_with_token], +provide an instance of the desired credential type obtained from the +[azure-identity][azure_identity_credentials] library. + +To authenticate with AAD, you must first [pip][pip] install [`azure-identity`][azure_identity_pip] + +After setup, you can choose which type of [credential][azure_identity_credentials] from azure.identity to use. +As an example, [DefaultAzureCredential][default_azure_credential] can be used to authenticate the client: + +Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: +`AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET` + +Use the returned token credential to authenticate the client: + +```python +>>> from azure.messaging.webpubsubservice.chat import WebPubSubChatClient +>>> from azure.identity import DefaultAzureCredential +>>> client = WebPubSubChatClient(endpoint='', credential=DefaultAzureCredential()) +``` + +## Examples + +```python +>>> from azure.messaging.webpubsubservice.chat import WebPubSubChatClient +>>> from azure.identity import DefaultAzureCredential +>>> from azure.core.exceptions import HttpResponseError + +>>> client = WebPubSubChatClient(endpoint='', credential=DefaultAzureCredential()) +>>> try: + + except HttpResponseError as e: + print('service responds error: {}'.format(e.response.json())) + +``` + +## Contributing + +This project welcomes contributions and suggestions. Most contributions require +you to agree to a Contributor License Agreement (CLA) declaring that you have +the right to, and actually do, grant us the rights to use your contribution. +For details, visit https://cla.microsoft.com. + +When you submit a pull request, a CLA-bot will automatically determine whether +you need to provide a CLA and decorate the PR appropriately (e.g., label, +comment). Simply follow the instructions provided by the bot. You will only +need to do this once across all repos using our CLA. + +This project has adopted the +[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information, +see the Code of Conduct FAQ or contact opencode@microsoft.com with any +additional questions or comments. + + +[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ +[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token +[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials +[azure_identity_pip]: https://pypi.org/project/azure-identity/ +[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential +[pip]: https://pypi.org/project/pip/ +[azure_sub]: https://azure.microsoft.com/free/ diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/_metadata.json b/sdk/webpubsub/azure-messaging-webpubsubchatservice/_metadata.json new file mode 100644 index 000000000000..46cdcde90533 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/_metadata.json @@ -0,0 +1,6 @@ +{ + "apiVersion": "2026-02-01-preview", + "apiVersions": { + "WebPubSubChat": "2026-02-01-preview" + } +} \ No newline at end of file diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/apiview-properties.json b/sdk/webpubsub/azure-messaging-webpubsubchatservice/apiview-properties.json new file mode 100644 index 000000000000..49ad854cfff7 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/apiview-properties.json @@ -0,0 +1,49 @@ +{ + "CrossLanguagePackageId": "WebPubSubChat", + "CrossLanguageDefinitionId": { + "azure.messaging.webpubsubservice.chat.models.ChatConversation": "WebPubSubChat.ChatConversation", + "azure.messaging.webpubsubservice.chat.models.ChatMessage": "WebPubSubChat.ChatMessage", + "azure.messaging.webpubsubservice.chat.models.ChatRole": "WebPubSubChat.ChatRole", + "azure.messaging.webpubsubservice.chat.models.ChatRoom": "WebPubSubChat.ChatRoom", + "azure.messaging.webpubsubservice.chat.models.ChatRoomMember": "WebPubSubChat.ChatRoomMember", + "azure.messaging.webpubsubservice.chat.models.ChatUser": "WebPubSubChat.ChatUser", + "azure.messaging.webpubsubservice.chat.models.HumanChatUser": "WebPubSubChat.HumanChatUser", + "azure.messaging.webpubsubservice.chat.models.MessageContent": "WebPubSubChat.MessageContent", + "azure.messaging.webpubsubservice.chat.models.ChatUserKind": "WebPubSubChat.ChatUserKind", + "azure.messaging.webpubsubservice.chat.WebPubSubChatServiceClient.get_conversation": "WebPubSubChat.WebPubSubChatServiceClient.getConversation", + "azure.messaging.webpubsubservice.chat.aio.WebPubSubChatServiceClient.get_conversation": "WebPubSubChat.WebPubSubChatServiceClient.getConversation", + "azure.messaging.webpubsubservice.chat.WebPubSubChatServiceClient.list_messages": "WebPubSubChat.WebPubSubChatServiceClient.listMessages", + "azure.messaging.webpubsubservice.chat.aio.WebPubSubChatServiceClient.list_messages": "WebPubSubChat.WebPubSubChatServiceClient.listMessages", + "azure.messaging.webpubsubservice.chat.WebPubSubChatServiceClient.delete_message": "WebPubSubChat.WebPubSubChatServiceClient.deleteMessage", + "azure.messaging.webpubsubservice.chat.aio.WebPubSubChatServiceClient.delete_message": "WebPubSubChat.WebPubSubChatServiceClient.deleteMessage", + "azure.messaging.webpubsubservice.chat.WebPubSubChatServiceClient.update_message": "WebPubSubChat.WebPubSubChatServiceClient.updateMessage", + "azure.messaging.webpubsubservice.chat.aio.WebPubSubChatServiceClient.update_message": "WebPubSubChat.WebPubSubChatServiceClient.updateMessage", + "azure.messaging.webpubsubservice.chat.WebPubSubChatServiceClient.list_roles": "WebPubSubChat.WebPubSubChatServiceClient.listRoles", + "azure.messaging.webpubsubservice.chat.aio.WebPubSubChatServiceClient.list_roles": "WebPubSubChat.WebPubSubChatServiceClient.listRoles", + "azure.messaging.webpubsubservice.chat.WebPubSubChatServiceClient.get_role": "WebPubSubChat.WebPubSubChatServiceClient.getRole", + "azure.messaging.webpubsubservice.chat.aio.WebPubSubChatServiceClient.get_role": "WebPubSubChat.WebPubSubChatServiceClient.getRole", + "azure.messaging.webpubsubservice.chat.WebPubSubChatServiceClient.create_or_replace_role": "WebPubSubChat.WebPubSubChatServiceClient.createOrReplaceRole", + "azure.messaging.webpubsubservice.chat.aio.WebPubSubChatServiceClient.create_or_replace_role": "WebPubSubChat.WebPubSubChatServiceClient.createOrReplaceRole", + "azure.messaging.webpubsubservice.chat.WebPubSubChatServiceClient.delete_role": "WebPubSubChat.WebPubSubChatServiceClient.deleteRole", + "azure.messaging.webpubsubservice.chat.aio.WebPubSubChatServiceClient.delete_role": "WebPubSubChat.WebPubSubChatServiceClient.deleteRole", + "azure.messaging.webpubsubservice.chat.WebPubSubChatServiceClient.create_or_replace_room": "WebPubSubChat.WebPubSubChatServiceClient.createOrReplaceRoom", + "azure.messaging.webpubsubservice.chat.aio.WebPubSubChatServiceClient.create_or_replace_room": "WebPubSubChat.WebPubSubChatServiceClient.createOrReplaceRoom", + "azure.messaging.webpubsubservice.chat.WebPubSubChatServiceClient.get_room": "WebPubSubChat.WebPubSubChatServiceClient.getRoom", + "azure.messaging.webpubsubservice.chat.aio.WebPubSubChatServiceClient.get_room": "WebPubSubChat.WebPubSubChatServiceClient.getRoom", + "azure.messaging.webpubsubservice.chat.WebPubSubChatServiceClient.delete_room": "WebPubSubChat.WebPubSubChatServiceClient.deleteRoom", + "azure.messaging.webpubsubservice.chat.aio.WebPubSubChatServiceClient.delete_room": "WebPubSubChat.WebPubSubChatServiceClient.deleteRoom", + "azure.messaging.webpubsubservice.chat.WebPubSubChatServiceClient.list_room_members": "WebPubSubChat.WebPubSubChatServiceClient.listRoomMembers", + "azure.messaging.webpubsubservice.chat.aio.WebPubSubChatServiceClient.list_room_members": "WebPubSubChat.WebPubSubChatServiceClient.listRoomMembers", + "azure.messaging.webpubsubservice.chat.WebPubSubChatServiceClient.create_or_replace_room_member": "WebPubSubChat.WebPubSubChatServiceClient.createOrReplaceRoomMember", + "azure.messaging.webpubsubservice.chat.aio.WebPubSubChatServiceClient.create_or_replace_room_member": "WebPubSubChat.WebPubSubChatServiceClient.createOrReplaceRoomMember", + "azure.messaging.webpubsubservice.chat.WebPubSubChatServiceClient.delete_room_member": "WebPubSubChat.WebPubSubChatServiceClient.deleteRoomMember", + "azure.messaging.webpubsubservice.chat.aio.WebPubSubChatServiceClient.delete_room_member": "WebPubSubChat.WebPubSubChatServiceClient.deleteRoomMember", + "azure.messaging.webpubsubservice.chat.WebPubSubChatServiceClient.get_user": "WebPubSubChat.WebPubSubChatServiceClient.getUser", + "azure.messaging.webpubsubservice.chat.aio.WebPubSubChatServiceClient.get_user": "WebPubSubChat.WebPubSubChatServiceClient.getUser", + "azure.messaging.webpubsubservice.chat.WebPubSubChatServiceClient.create_or_replace_user": "WebPubSubChat.WebPubSubChatServiceClient.createOrReplaceUser", + "azure.messaging.webpubsubservice.chat.aio.WebPubSubChatServiceClient.create_or_replace_user": "WebPubSubChat.WebPubSubChatServiceClient.createOrReplaceUser", + "azure.messaging.webpubsubservice.chat.WebPubSubChatServiceClient.delete_user": "WebPubSubChat.WebPubSubChatServiceClient.deleteUser", + "azure.messaging.webpubsubservice.chat.aio.WebPubSubChatServiceClient.delete_user": "WebPubSubChat.WebPubSubChatServiceClient.deleteUser" + }, + "CrossLanguageVersion": "bc8ec95ed6af" +} \ No newline at end of file diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/__init__.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/__init__.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/__init__.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/__init__.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/__init__.py new file mode 100644 index 000000000000..9ed1fbc12dbd --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/__init__.py @@ -0,0 +1,32 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._client import WebPubSubChatServiceClient # type: ignore +from ._version import VERSION + +__version__ = VERSION + +try: + from ._patch import __all__ as _patch_all + from ._patch import * +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "WebPubSubChatServiceClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore + +_patch_sdk() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_client.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_client.py new file mode 100644 index 000000000000..f12668af9984 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_client.py @@ -0,0 +1,110 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +import sys +from typing import Any, TYPE_CHECKING + +from azure.core import PipelineClient +from azure.core.pipeline import policies +from azure.core.rest import HttpRequest, HttpResponse + +from ._configuration import WebPubSubChatServiceClientConfiguration +from ._operations import _WebPubSubChatServiceClientOperationsMixin +from ._utils.serialization import Deserializer, Serializer + +if sys.version_info >= (3, 11): + from typing import Self +else: + from typing_extensions import Self # type: ignore + +if TYPE_CHECKING: + from azure.core.credentials import TokenCredential + + +class WebPubSubChatServiceClient(_WebPubSubChatServiceClientOperationsMixin): + """WebPubSubChatServiceClient. + + :param endpoint: HTTP or HTTPS endpoint for the Web PubSub service instance. Required. + :type endpoint: str + :param credential: Credential used to authenticate requests to the service. Required. + :type credential: ~azure.core.credentials.TokenCredential + :param hub: Target hub name, which should start with alphabetic characters and only contain + alpha-numeric characters or underscore. Required. + :type hub: str + :keyword api_version: The API version to use for this operation. Known values are + "2026-02-01-preview" and None. Default value is None. If not set, the operation's default API + version will be used. Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "TokenCredential", hub: str, **kwargs: Any) -> None: + _endpoint = "{endpoint}" + self._config = WebPubSubChatServiceClientConfiguration( + endpoint=endpoint, credential=credential, hub=hub, **kwargs + ) + + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.HttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + def close(self) -> None: + self._client.close() + + def __enter__(self) -> Self: + self._client.__enter__() + return self + + def __exit__(self, *exc_details: Any) -> None: + self._client.__exit__(*exc_details) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_configuration.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_configuration.py new file mode 100644 index 000000000000..d05d95783c7a --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_configuration.py @@ -0,0 +1,71 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, TYPE_CHECKING + +from azure.core.pipeline import policies + +from ._version import VERSION + +if TYPE_CHECKING: + from azure.core.credentials import TokenCredential + + +class WebPubSubChatServiceClientConfiguration: # pylint: disable=too-many-instance-attributes + """Configuration for WebPubSubChatServiceClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: HTTP or HTTPS endpoint for the Web PubSub service instance. Required. + :type endpoint: str + :param credential: Credential used to authenticate requests to the service. Required. + :type credential: ~azure.core.credentials.TokenCredential + :param hub: Target hub name, which should start with alphabetic characters and only contain + alpha-numeric characters or underscore. Required. + :type hub: str + :keyword api_version: The API version to use for this operation. Known values are + "2026-02-01-preview" and None. Default value is None. If not set, the operation's default API + version will be used. Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "TokenCredential", hub: str, **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2026-02-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + if hub is None: + raise ValueError("Parameter 'hub' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.hub = hub + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://webpubsub.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "messaging-webpubsubchatservice/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.BearerTokenCredentialPolicy( + self.credential, *self.credential_scopes, **kwargs + ) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_operations/__init__.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_operations/__init__.py new file mode 100644 index 000000000000..72deab389c50 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_operations/__init__.py @@ -0,0 +1,23 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._operations import _WebPubSubChatServiceClientOperationsMixin # type: ignore # pylint: disable=unused-import + +from ._patch import __all__ as _patch_all +from ._patch import * +from ._patch import patch_sdk as _patch_sdk + +__all__ = [] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore +_patch_sdk() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_operations/_operations.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_operations/_operations.py new file mode 100644 index 000000000000..405738ee44f2 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_operations/_operations.py @@ -0,0 +1,2606 @@ +# pylint: disable=too-many-lines +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from collections.abc import MutableMapping +from io import IOBase +import json +from typing import Any, Callable, IO, Optional, TypeVar, Union, overload +import urllib.parse + +from azure.core import MatchConditions, PipelineClient +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceModifiedError, + ResourceNotFoundError, + ResourceNotModifiedError, + StreamClosedError, + StreamConsumedError, + map_error, +) +from azure.core.paging import ItemPaged +from azure.core.pipeline import PipelineResponse +from azure.core.rest import HttpRequest, HttpResponse +from azure.core.tracing.decorator import distributed_trace +from azure.core.utils import case_insensitive_dict + +from .. import models as _models, types as _types +from .._configuration import WebPubSubChatServiceClientConfiguration +from .._utils.model_base import SdkJSONEncoder, _deserialize +from .._utils.serialization import Serializer +from .._utils.utils import ClientMixinABC, prep_if_match, prep_if_none_match + +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, dict[str, Any]], Any]] + +_SERIALIZER = Serializer() +_SERIALIZER.client_side_validation = False + + +def build_web_pub_sub_chat_service_get_conversation_request( # pylint: disable=name-too-long + conversation_id: str, hub: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-02-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/api/hubs/{hub}/chat/conversations/{conversationId}" + path_format_arguments = { + "hub": _SERIALIZER.url("hub", hub, "str"), + "conversationId": _SERIALIZER.url("conversation_id", conversation_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_web_pub_sub_chat_service_list_messages_request( # pylint: disable=name-too-long + conversation_id: str, + hub: str, + *, + latest_message_id: Optional[str] = None, + earliest_message_id: Optional[str] = None, + maxpagesize: Optional[int] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-02-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/api/hubs/{hub}/chat/conversations/{conversationId}/messages" + path_format_arguments = { + "hub": _SERIALIZER.url("hub", hub, "str"), + "conversationId": _SERIALIZER.url("conversation_id", conversation_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if latest_message_id is not None: + _params["latestMessageId"] = _SERIALIZER.query("latest_message_id", latest_message_id, "str") + if earliest_message_id is not None: + _params["earliestMessageId"] = _SERIALIZER.query("earliest_message_id", earliest_message_id, "str") + if maxpagesize is not None: + _params["maxpagesize"] = _SERIALIZER.query("maxpagesize", maxpagesize, "int") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_web_pub_sub_chat_service_delete_message_request( # pylint: disable=name-too-long + conversation_id: str, + message_id: str, + hub: str, + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-02-01-preview")) + # Construct URL + _url = "/api/hubs/{hub}/chat/conversations/{conversationId}/messages/{messageId}" + path_format_arguments = { + "hub": _SERIALIZER.url("hub", hub, "str"), + "conversationId": _SERIALIZER.url("conversation_id", conversation_id, "str"), + "messageId": _SERIALIZER.url("message_id", message_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if_match = prep_if_match(etag, match_condition) + if if_match is not None: + _headers["If-Match"] = _SERIALIZER.header("if_match", if_match, "str") + if_none_match = prep_if_none_match(etag, match_condition) + if if_none_match is not None: + _headers["If-None-Match"] = _SERIALIZER.header("if_none_match", if_none_match, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_web_pub_sub_chat_service_update_message_request( # pylint: disable=name-too-long + conversation_id: str, + message_id: str, + hub: str, + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-02-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/api/hubs/{hub}/chat/conversations/{conversationId}/messages/{messageId}" + path_format_arguments = { + "hub": _SERIALIZER.url("hub", hub, "str"), + "conversationId": _SERIALIZER.url("conversation_id", conversation_id, "str"), + "messageId": _SERIALIZER.url("message_id", message_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if_match = prep_if_match(etag, match_condition) + if if_match is not None: + _headers["If-Match"] = _SERIALIZER.header("if_match", if_match, "str") + if_none_match = prep_if_none_match(etag, match_condition) + if if_none_match is not None: + _headers["If-None-Match"] = _SERIALIZER.header("if_none_match", if_none_match, "str") + + return HttpRequest(method="PATCH", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_web_pub_sub_chat_service_list_roles_request( # pylint: disable=name-too-long + hub: str, *, maxpagesize: Optional[int] = None, continuation_token_parameter: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-02-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/api/hubs/{hub}/chat/roles" + path_format_arguments = { + "hub": _SERIALIZER.url("hub", hub, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if maxpagesize is not None: + _params["maxpagesize"] = _SERIALIZER.query("maxpagesize", maxpagesize, "int") + if continuation_token_parameter is not None: + _params["continuationToken"] = _SERIALIZER.query( + "continuation_token_parameter", continuation_token_parameter, "str" + ) + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_web_pub_sub_chat_service_get_role_request( # pylint: disable=name-too-long + role_name: str, hub: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-02-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/api/hubs/{hub}/chat/roles/{roleName}" + path_format_arguments = { + "hub": _SERIALIZER.url("hub", hub, "str"), + "roleName": _SERIALIZER.url("role_name", role_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_web_pub_sub_chat_service_create_or_replace_role_request( # pylint: disable=name-too-long + role_name: str, + hub: str, + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-02-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/api/hubs/{hub}/chat/roles/{roleName}" + path_format_arguments = { + "hub": _SERIALIZER.url("hub", hub, "str"), + "roleName": _SERIALIZER.url("role_name", role_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if_match = prep_if_match(etag, match_condition) + if if_match is not None: + _headers["If-Match"] = _SERIALIZER.header("if_match", if_match, "str") + if_none_match = prep_if_none_match(etag, match_condition) + if if_none_match is not None: + _headers["If-None-Match"] = _SERIALIZER.header("if_none_match", if_none_match, "str") + + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_web_pub_sub_chat_service_delete_role_request( # pylint: disable=name-too-long + role_name: str, + hub: str, + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-02-01-preview")) + # Construct URL + _url = "/api/hubs/{hub}/chat/roles/{roleName}" + path_format_arguments = { + "hub": _SERIALIZER.url("hub", hub, "str"), + "roleName": _SERIALIZER.url("role_name", role_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if_match = prep_if_match(etag, match_condition) + if if_match is not None: + _headers["If-Match"] = _SERIALIZER.header("if_match", if_match, "str") + if_none_match = prep_if_none_match(etag, match_condition) + if if_none_match is not None: + _headers["If-None-Match"] = _SERIALIZER.header("if_none_match", if_none_match, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_web_pub_sub_chat_service_create_or_replace_room_request( # pylint: disable=name-too-long + room_id: str, + hub: str, + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-02-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/api/hubs/{hub}/chat/rooms/{roomId}" + path_format_arguments = { + "hub": _SERIALIZER.url("hub", hub, "str"), + "roomId": _SERIALIZER.url("room_id", room_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if_match = prep_if_match(etag, match_condition) + if if_match is not None: + _headers["If-Match"] = _SERIALIZER.header("if_match", if_match, "str") + if_none_match = prep_if_none_match(etag, match_condition) + if if_none_match is not None: + _headers["If-None-Match"] = _SERIALIZER.header("if_none_match", if_none_match, "str") + + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_web_pub_sub_chat_service_get_room_request( # pylint: disable=name-too-long + room_id: str, hub: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-02-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/api/hubs/{hub}/chat/rooms/{roomId}" + path_format_arguments = { + "hub": _SERIALIZER.url("hub", hub, "str"), + "roomId": _SERIALIZER.url("room_id", room_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_web_pub_sub_chat_service_delete_room_request( # pylint: disable=name-too-long + room_id: str, + hub: str, + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-02-01-preview")) + # Construct URL + _url = "/api/hubs/{hub}/chat/rooms/{roomId}" + path_format_arguments = { + "hub": _SERIALIZER.url("hub", hub, "str"), + "roomId": _SERIALIZER.url("room_id", room_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if_match = prep_if_match(etag, match_condition) + if if_match is not None: + _headers["If-Match"] = _SERIALIZER.header("if_match", if_match, "str") + if_none_match = prep_if_none_match(etag, match_condition) + if if_none_match is not None: + _headers["If-None-Match"] = _SERIALIZER.header("if_none_match", if_none_match, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_web_pub_sub_chat_service_list_room_members_request( # pylint: disable=name-too-long + room_id: str, + hub: str, + *, + maxpagesize: Optional[int] = None, + continuation_token_parameter: Optional[str] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-02-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/api/hubs/{hub}/chat/rooms/{roomId}/members" + path_format_arguments = { + "hub": _SERIALIZER.url("hub", hub, "str"), + "roomId": _SERIALIZER.url("room_id", room_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if maxpagesize is not None: + _params["maxpagesize"] = _SERIALIZER.query("maxpagesize", maxpagesize, "int") + if continuation_token_parameter is not None: + _params["continuationToken"] = _SERIALIZER.query( + "continuation_token_parameter", continuation_token_parameter, "str" + ) + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_web_pub_sub_chat_service_create_or_replace_room_member_request( # pylint: disable=name-too-long + room_id: str, + user_id: str, + hub: str, + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-02-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/api/hubs/{hub}/chat/rooms/{roomId}/members/{userId}" + path_format_arguments = { + "hub": _SERIALIZER.url("hub", hub, "str"), + "roomId": _SERIALIZER.url("room_id", room_id, "str"), + "userId": _SERIALIZER.url("user_id", user_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if_match = prep_if_match(etag, match_condition) + if if_match is not None: + _headers["If-Match"] = _SERIALIZER.header("if_match", if_match, "str") + if_none_match = prep_if_none_match(etag, match_condition) + if if_none_match is not None: + _headers["If-None-Match"] = _SERIALIZER.header("if_none_match", if_none_match, "str") + + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_web_pub_sub_chat_service_delete_room_member_request( # pylint: disable=name-too-long + room_id: str, + user_id: str, + hub: str, + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-02-01-preview")) + # Construct URL + _url = "/api/hubs/{hub}/chat/rooms/{roomId}/members/{userId}" + path_format_arguments = { + "hub": _SERIALIZER.url("hub", hub, "str"), + "roomId": _SERIALIZER.url("room_id", room_id, "str"), + "userId": _SERIALIZER.url("user_id", user_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if_match = prep_if_match(etag, match_condition) + if if_match is not None: + _headers["If-Match"] = _SERIALIZER.header("if_match", if_match, "str") + if_none_match = prep_if_none_match(etag, match_condition) + if if_none_match is not None: + _headers["If-None-Match"] = _SERIALIZER.header("if_none_match", if_none_match, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_web_pub_sub_chat_service_get_user_request( # pylint: disable=name-too-long + user_id: str, hub: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-02-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/api/hubs/{hub}/chat/users/{userId}" + path_format_arguments = { + "hub": _SERIALIZER.url("hub", hub, "str"), + "userId": _SERIALIZER.url("user_id", user_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_web_pub_sub_chat_service_create_or_replace_user_request( # pylint: disable=name-too-long + user_id: str, + hub: str, + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-02-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/api/hubs/{hub}/chat/users/{userId}" + path_format_arguments = { + "hub": _SERIALIZER.url("hub", hub, "str"), + "userId": _SERIALIZER.url("user_id", user_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if_match = prep_if_match(etag, match_condition) + if if_match is not None: + _headers["If-Match"] = _SERIALIZER.header("if_match", if_match, "str") + if_none_match = prep_if_none_match(etag, match_condition) + if if_none_match is not None: + _headers["If-None-Match"] = _SERIALIZER.header("if_none_match", if_none_match, "str") + + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_web_pub_sub_chat_service_delete_user_request( # pylint: disable=name-too-long + user_id: str, + hub: str, + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-02-01-preview")) + # Construct URL + _url = "/api/hubs/{hub}/chat/users/{userId}" + path_format_arguments = { + "hub": _SERIALIZER.url("hub", hub, "str"), + "userId": _SERIALIZER.url("user_id", user_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if_match = prep_if_match(etag, match_condition) + if if_match is not None: + _headers["If-Match"] = _SERIALIZER.header("if_match", if_match, "str") + if_none_match = prep_if_none_match(etag, match_condition) + if if_none_match is not None: + _headers["If-None-Match"] = _SERIALIZER.header("if_none_match", if_none_match, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) + + +class _WebPubSubChatServiceClientOperationsMixin( + ClientMixinABC[PipelineClient[HttpRequest, HttpResponse], WebPubSubChatServiceClientConfiguration] +): + + @distributed_trace + def get_conversation(self, conversation_id: str, **kwargs: Any) -> _models.ChatConversation: + """Get conversation information. + + Get conversation information. + + :param conversation_id: Conversation identifier. Required. + :type conversation_id: str + :return: ChatConversation. The ChatConversation is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatConversation + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.ChatConversation] = kwargs.pop("cls", None) + + _request = build_web_pub_sub_chat_service_get_conversation_request( + conversation_id=conversation_id, + hub=self._config.hub, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.ChatConversation, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_messages( + self, + conversation_id: str, + *, + latest_message_id: Optional[str] = None, + earliest_message_id: Optional[str] = None, + **kwargs: Any + ) -> ItemPaged["_models.ChatMessage"]: + """Query messages in a conversation from latest to earliest. + + Query messages in a conversation from latest to earliest. + + :param conversation_id: Conversation identifier. Required. + :type conversation_id: str + :keyword latest_message_id: Latest message ID (exclusive) for pagination. Default value is + None. + :paramtype latest_message_id: str + :keyword earliest_message_id: Earliest message ID (exclusive) for pagination. Default value is + None. + :paramtype earliest_message_id: str + :return: An iterator like instance of ChatMessage + :rtype: ~azure.core.paging.ItemPaged[~azure.messaging.webpubsubservice.chat.models.ChatMessage] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + maxpagesize = kwargs.pop("maxpagesize", None) + cls: ClsType[list[_models.ChatMessage]] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_web_pub_sub_chat_service_list_messages_request( + conversation_id=conversation_id, + hub=self._config.hub, + latest_message_id=latest_message_id, + earliest_message_id=earliest_message_id, + maxpagesize=maxpagesize, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", + urllib.parse.urljoin(next_link, _parsed_next_link.path), + headers=_headers, + params=_next_request_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize( + list[_models.ChatMessage], + deserialized.get("value", []), + ) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + @distributed_trace + def delete_message( # pylint: disable=inconsistent-return-statements + self, + conversation_id: str, + message_id: str, + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> None: + """Delete a message. + + Delete a message. + + :param conversation_id: Conversation identifier. Required. + :type conversation_id: str + :param message_id: Message identifier. Required. + :type message_id: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + if match_condition == MatchConditions.IfNotModified: + error_map[412] = ResourceModifiedError + elif match_condition == MatchConditions.IfPresent: + error_map[412] = ResourceNotFoundError + elif match_condition == MatchConditions.IfMissing: + error_map[412] = ResourceExistsError + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_web_pub_sub_chat_service_delete_message_request( + conversation_id=conversation_id, + message_id=message_id, + hub=self._config.hub, + etag=etag, + match_condition=match_condition, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + def update_message( + self, + conversation_id: str, + message_id: str, + resource: _models.ChatMessage, + *, + content_type: str = "application/merge-patch+json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatMessage: + """Update a message. + + Update a message. + + :param conversation_id: Conversation identifier. Required. + :type conversation_id: str + :param message_id: Message identifier. Required. + :type message_id: str + :param resource: The resource instance. Required. + :type resource: ~azure.messaging.webpubsubservice.chat.models.ChatMessage + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatMessage. The ChatMessage is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatMessage + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def update_message( + self, + conversation_id: str, + message_id: str, + resource: _types.ChatMessage, + *, + content_type: str = "application/merge-patch+json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatMessage: + """Update a message. + + Update a message. + + :param conversation_id: Conversation identifier. Required. + :type conversation_id: str + :param message_id: Message identifier. Required. + :type message_id: str + :param resource: The resource instance. Required. + :type resource: ~azure.messaging.webpubsubservice.chat.types.ChatMessage + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatMessage. The ChatMessage is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatMessage + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def update_message( + self, + conversation_id: str, + message_id: str, + resource: IO[bytes], + *, + content_type: str = "application/merge-patch+json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatMessage: + """Update a message. + + Update a message. + + :param conversation_id: Conversation identifier. Required. + :type conversation_id: str + :param message_id: Message identifier. Required. + :type message_id: str + :param resource: The resource instance. Required. + :type resource: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatMessage. The ChatMessage is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatMessage + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def update_message( + self, + conversation_id: str, + message_id: str, + resource: Union[_models.ChatMessage, _types.ChatMessage, IO[bytes]], + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatMessage: + """Update a message. + + Update a message. + + :param conversation_id: Conversation identifier. Required. + :type conversation_id: str + :param message_id: Message identifier. Required. + :type message_id: str + :param resource: The resource instance. Is either a ChatMessage type or a IO[bytes] type. + Required. + :type resource: ~azure.messaging.webpubsubservice.chat.models.ChatMessage or + ~azure.messaging.webpubsubservice.chat.types.ChatMessage or IO[bytes] + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatMessage. The ChatMessage is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatMessage + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + if match_condition == MatchConditions.IfNotModified: + error_map[412] = ResourceModifiedError + elif match_condition == MatchConditions.IfPresent: + error_map[412] = ResourceNotFoundError + elif match_condition == MatchConditions.IfMissing: + error_map[412] = ResourceExistsError + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.ChatMessage] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(resource, (IOBase, bytes)): + _content = resource + else: + _content = json.dumps(resource, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_web_pub_sub_chat_service_update_message_request( + conversation_id=conversation_id, + message_id=message_id, + hub=self._config.hub, + etag=etag, + match_condition=match_condition, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["ETag"] = self._deserialize("str", response.headers.get("ETag")) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.ChatMessage, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_roles( + self, *, continuation_token_parameter: Optional[str] = None, **kwargs: Any + ) -> ItemPaged["_models.ChatRole"]: + """Query roles in a hub. + + Query roles in a hub. + + :keyword continuation_token_parameter: Continuation token for pagination. Default value is + None. + :paramtype continuation_token_parameter: str + :return: An iterator like instance of ChatRole + :rtype: ~azure.core.paging.ItemPaged[~azure.messaging.webpubsubservice.chat.models.ChatRole] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + maxpagesize = kwargs.pop("maxpagesize", None) + cls: ClsType[list[_models.ChatRole]] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_web_pub_sub_chat_service_list_roles_request( + hub=self._config.hub, + maxpagesize=maxpagesize, + continuation_token_parameter=continuation_token_parameter, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", + urllib.parse.urljoin(next_link, _parsed_next_link.path), + headers=_headers, + params=_next_request_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize( + list[_models.ChatRole], + deserialized.get("value", []), + ) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + @distributed_trace + def get_role(self, role_name: str, **kwargs: Any) -> _models.ChatRole: + """Get role information. + + Get role information. + + :param role_name: Role name. Must start with 'user.' or 'room.' prefix. Required. + :type role_name: str + :return: ChatRole. The ChatRole is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRole + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.ChatRole] = kwargs.pop("cls", None) + + _request = build_web_pub_sub_chat_service_get_role_request( + role_name=role_name, + hub=self._config.hub, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.ChatRole, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def create_or_replace_role( + self, + role_name: str, + resource: _models.ChatRole, + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRole: + """Create or replace a role. + + Create or replace a role. + + :param role_name: Role name. Must start with 'user.' or 'room.' prefix. Required. + :type role_name: str + :param resource: The resource instance. Required. + :type resource: ~azure.messaging.webpubsubservice.chat.models.ChatRole + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRole. The ChatRole is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRole + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def create_or_replace_role( + self, + role_name: str, + resource: _types.ChatRole, + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRole: + """Create or replace a role. + + Create or replace a role. + + :param role_name: Role name. Must start with 'user.' or 'room.' prefix. Required. + :type role_name: str + :param resource: The resource instance. Required. + :type resource: ~azure.messaging.webpubsubservice.chat.types.ChatRole + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRole. The ChatRole is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRole + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def create_or_replace_role( + self, + role_name: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRole: + """Create or replace a role. + + Create or replace a role. + + :param role_name: Role name. Must start with 'user.' or 'room.' prefix. Required. + :type role_name: str + :param resource: The resource instance. Required. + :type resource: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRole. The ChatRole is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRole + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def create_or_replace_role( + self, + role_name: str, + resource: Union[_models.ChatRole, _types.ChatRole, IO[bytes]], + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRole: + """Create or replace a role. + + Create or replace a role. + + :param role_name: Role name. Must start with 'user.' or 'room.' prefix. Required. + :type role_name: str + :param resource: The resource instance. Is either a ChatRole type or a IO[bytes] type. + Required. + :type resource: ~azure.messaging.webpubsubservice.chat.models.ChatRole or + ~azure.messaging.webpubsubservice.chat.types.ChatRole or IO[bytes] + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRole. The ChatRole is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRole + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + if match_condition == MatchConditions.IfNotModified: + error_map[412] = ResourceModifiedError + elif match_condition == MatchConditions.IfPresent: + error_map[412] = ResourceNotFoundError + elif match_condition == MatchConditions.IfMissing: + error_map[412] = ResourceExistsError + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.ChatRole] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(resource, (IOBase, bytes)): + _content = resource + else: + _content = json.dumps(resource, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_web_pub_sub_chat_service_create_or_replace_role_request( + role_name=role_name, + hub=self._config.hub, + etag=etag, + match_condition=match_condition, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["ETag"] = self._deserialize("str", response.headers.get("ETag")) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.ChatRole, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def delete_role( # pylint: disable=inconsistent-return-statements + self, + role_name: str, + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> None: + """Delete a role. + + Delete a role. + + :param role_name: Role name. Must start with 'user.' or 'room.' prefix. Required. + :type role_name: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + if match_condition == MatchConditions.IfNotModified: + error_map[412] = ResourceModifiedError + elif match_condition == MatchConditions.IfPresent: + error_map[412] = ResourceNotFoundError + elif match_condition == MatchConditions.IfMissing: + error_map[412] = ResourceExistsError + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_web_pub_sub_chat_service_delete_role_request( + role_name=role_name, + hub=self._config.hub, + etag=etag, + match_condition=match_condition, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + def create_or_replace_room( + self, + room_id: str, + resource: _models.ChatRoom, + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRoom: + """Create or replace a room. + + Create or replace a room with a client-specified ID. + + :param room_id: Room identifier. Required. + :type room_id: str + :param resource: The resource instance. Required. + :type resource: ~azure.messaging.webpubsubservice.chat.models.ChatRoom + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRoom. The ChatRoom is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRoom + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def create_or_replace_room( + self, + room_id: str, + resource: _types.ChatRoom, + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRoom: + """Create or replace a room. + + Create or replace a room with a client-specified ID. + + :param room_id: Room identifier. Required. + :type room_id: str + :param resource: The resource instance. Required. + :type resource: ~azure.messaging.webpubsubservice.chat.types.ChatRoom + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRoom. The ChatRoom is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRoom + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def create_or_replace_room( + self, + room_id: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRoom: + """Create or replace a room. + + Create or replace a room with a client-specified ID. + + :param room_id: Room identifier. Required. + :type room_id: str + :param resource: The resource instance. Required. + :type resource: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRoom. The ChatRoom is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRoom + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def create_or_replace_room( + self, + room_id: str, + resource: Union[_models.ChatRoom, _types.ChatRoom, IO[bytes]], + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRoom: + """Create or replace a room. + + Create or replace a room with a client-specified ID. + + :param room_id: Room identifier. Required. + :type room_id: str + :param resource: The resource instance. Is either a ChatRoom type or a IO[bytes] type. + Required. + :type resource: ~azure.messaging.webpubsubservice.chat.models.ChatRoom or + ~azure.messaging.webpubsubservice.chat.types.ChatRoom or IO[bytes] + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRoom. The ChatRoom is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRoom + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + if match_condition == MatchConditions.IfNotModified: + error_map[412] = ResourceModifiedError + elif match_condition == MatchConditions.IfPresent: + error_map[412] = ResourceNotFoundError + elif match_condition == MatchConditions.IfMissing: + error_map[412] = ResourceExistsError + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.ChatRoom] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(resource, (IOBase, bytes)): + _content = resource + else: + _content = json.dumps(resource, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_web_pub_sub_chat_service_create_or_replace_room_request( + room_id=room_id, + hub=self._config.hub, + etag=etag, + match_condition=match_condition, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["ETag"] = self._deserialize("str", response.headers.get("ETag")) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.ChatRoom, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_room(self, room_id: str, **kwargs: Any) -> _models.ChatRoom: + """Get room information. + + Get room information. + + :param room_id: Room identifier. Required. + :type room_id: str + :return: ChatRoom. The ChatRoom is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRoom + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.ChatRoom] = kwargs.pop("cls", None) + + _request = build_web_pub_sub_chat_service_get_room_request( + room_id=room_id, + hub=self._config.hub, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.ChatRoom, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def delete_room( # pylint: disable=inconsistent-return-statements + self, + room_id: str, + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> None: + """Delete a room. + + Delete a room. + + :param room_id: Room identifier. Required. + :type room_id: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + if match_condition == MatchConditions.IfNotModified: + error_map[412] = ResourceModifiedError + elif match_condition == MatchConditions.IfPresent: + error_map[412] = ResourceNotFoundError + elif match_condition == MatchConditions.IfMissing: + error_map[412] = ResourceExistsError + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_web_pub_sub_chat_service_delete_room_request( + room_id=room_id, + hub=self._config.hub, + etag=etag, + match_condition=match_condition, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace + def list_room_members( + self, room_id: str, *, continuation_token_parameter: Optional[str] = None, **kwargs: Any + ) -> ItemPaged["_models.ChatRoomMember"]: + """Get room members. + + Get room members. + + :param room_id: Room identifier. Required. + :type room_id: str + :keyword continuation_token_parameter: Continuation token for pagination. Default value is + None. + :paramtype continuation_token_parameter: str + :return: An iterator like instance of ChatRoomMember + :rtype: + ~azure.core.paging.ItemPaged[~azure.messaging.webpubsubservice.chat.models.ChatRoomMember] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + maxpagesize = kwargs.pop("maxpagesize", None) + cls: ClsType[list[_models.ChatRoomMember]] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_web_pub_sub_chat_service_list_room_members_request( + room_id=room_id, + hub=self._config.hub, + maxpagesize=maxpagesize, + continuation_token_parameter=continuation_token_parameter, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", + urllib.parse.urljoin(next_link, _parsed_next_link.path), + headers=_headers, + params=_next_request_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize( + list[_models.ChatRoomMember], + deserialized.get("value", []), + ) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + @overload + def create_or_replace_room_member( + self, + room_id: str, + user_id: str, + resource: _models.ChatRoomMember, + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRoomMember: + """Create or replace a room member. + + Create or replace a room member. + + :param room_id: Room identifier. Required. + :type room_id: str + :param user_id: User ID of the member. Required. + :type user_id: str + :param resource: The resource instance. Required. + :type resource: ~azure.messaging.webpubsubservice.chat.models.ChatRoomMember + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRoomMember. The ChatRoomMember is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRoomMember + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def create_or_replace_room_member( + self, + room_id: str, + user_id: str, + resource: _types.ChatRoomMember, + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRoomMember: + """Create or replace a room member. + + Create or replace a room member. + + :param room_id: Room identifier. Required. + :type room_id: str + :param user_id: User ID of the member. Required. + :type user_id: str + :param resource: The resource instance. Required. + :type resource: ~azure.messaging.webpubsubservice.chat.types.ChatRoomMember + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRoomMember. The ChatRoomMember is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRoomMember + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def create_or_replace_room_member( + self, + room_id: str, + user_id: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRoomMember: + """Create or replace a room member. + + Create or replace a room member. + + :param room_id: Room identifier. Required. + :type room_id: str + :param user_id: User ID of the member. Required. + :type user_id: str + :param resource: The resource instance. Required. + :type resource: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRoomMember. The ChatRoomMember is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRoomMember + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def create_or_replace_room_member( + self, + room_id: str, + user_id: str, + resource: Union[_models.ChatRoomMember, _types.ChatRoomMember, IO[bytes]], + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRoomMember: + """Create or replace a room member. + + Create or replace a room member. + + :param room_id: Room identifier. Required. + :type room_id: str + :param user_id: User ID of the member. Required. + :type user_id: str + :param resource: The resource instance. Is either a ChatRoomMember type or a IO[bytes] type. + Required. + :type resource: ~azure.messaging.webpubsubservice.chat.models.ChatRoomMember or + ~azure.messaging.webpubsubservice.chat.types.ChatRoomMember or IO[bytes] + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRoomMember. The ChatRoomMember is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRoomMember + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + if match_condition == MatchConditions.IfNotModified: + error_map[412] = ResourceModifiedError + elif match_condition == MatchConditions.IfPresent: + error_map[412] = ResourceNotFoundError + elif match_condition == MatchConditions.IfMissing: + error_map[412] = ResourceExistsError + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.ChatRoomMember] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(resource, (IOBase, bytes)): + _content = resource + else: + _content = json.dumps(resource, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_web_pub_sub_chat_service_create_or_replace_room_member_request( + room_id=room_id, + user_id=user_id, + hub=self._config.hub, + etag=etag, + match_condition=match_condition, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["ETag"] = self._deserialize("str", response.headers.get("ETag")) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.ChatRoomMember, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def delete_room_member( # pylint: disable=inconsistent-return-statements + self, + room_id: str, + user_id: str, + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> None: + """Delete a room member. + + Delete a room member. + + :param room_id: Room identifier. Required. + :type room_id: str + :param user_id: User ID of the member. Required. + :type user_id: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + if match_condition == MatchConditions.IfNotModified: + error_map[412] = ResourceModifiedError + elif match_condition == MatchConditions.IfPresent: + error_map[412] = ResourceNotFoundError + elif match_condition == MatchConditions.IfMissing: + error_map[412] = ResourceExistsError + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_web_pub_sub_chat_service_delete_room_member_request( + room_id=room_id, + user_id=user_id, + hub=self._config.hub, + etag=etag, + match_condition=match_condition, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace + def get_user(self, user_id: str, **kwargs: Any) -> _models.ChatUser: + """Get a user's profile. + + Get a user's profile. The response is a polymorphic ``ChatUser`` (e.g. ``HumanChatUser``) + selected by the ``kind`` discriminator. + + :param user_id: User identifier. Required. + :type user_id: str + :return: ChatUser. The ChatUser is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatUser + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.ChatUser] = kwargs.pop("cls", None) + + _request = build_web_pub_sub_chat_service_get_user_request( + user_id=user_id, + hub=self._config.hub, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.ChatUser, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def create_or_replace_user( + self, + user_id: str, + resource: _models.ChatUser, + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatUser: + """Create or replace a user. + + Create or replace a user. The request body is a polymorphic ``ChatUser`` (e.g. + ``HumanChatUser``) selected by the ``kind`` discriminator. + + :param user_id: User identifier. Required. + :type user_id: str + :param resource: The resource instance. Required. + :type resource: ~azure.messaging.webpubsubservice.chat.models.ChatUser + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatUser. The ChatUser is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatUser + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def create_or_replace_user( + self, + user_id: str, + resource: _types.ChatUser, + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatUser: + """Create or replace a user. + + Create or replace a user. The request body is a polymorphic ``ChatUser`` (e.g. + ``HumanChatUser``) selected by the ``kind`` discriminator. + + :param user_id: User identifier. Required. + :type user_id: str + :param resource: The resource instance. Required. + :type resource: ~azure.messaging.webpubsubservice.chat.types.ChatUser + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatUser. The ChatUser is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatUser + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def create_or_replace_user( + self, + user_id: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatUser: + """Create or replace a user. + + Create or replace a user. The request body is a polymorphic ``ChatUser`` (e.g. + ``HumanChatUser``) selected by the ``kind`` discriminator. + + :param user_id: User identifier. Required. + :type user_id: str + :param resource: The resource instance. Required. + :type resource: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatUser. The ChatUser is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatUser + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def create_or_replace_user( + self, + user_id: str, + resource: Union[_models.ChatUser, _types.ChatUser, IO[bytes]], + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatUser: + """Create or replace a user. + + Create or replace a user. The request body is a polymorphic ``ChatUser`` (e.g. + ``HumanChatUser``) selected by the ``kind`` discriminator. + + :param user_id: User identifier. Required. + :type user_id: str + :param resource: The resource instance. Is either a ChatUser type or a IO[bytes] type. + Required. + :type resource: ~azure.messaging.webpubsubservice.chat.models.ChatUser or + ~azure.messaging.webpubsubservice.chat.types.ChatUser or IO[bytes] + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatUser. The ChatUser is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatUser + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + if match_condition == MatchConditions.IfNotModified: + error_map[412] = ResourceModifiedError + elif match_condition == MatchConditions.IfPresent: + error_map[412] = ResourceNotFoundError + elif match_condition == MatchConditions.IfMissing: + error_map[412] = ResourceExistsError + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.ChatUser] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(resource, (IOBase, bytes)): + _content = resource + else: + _content = json.dumps(resource, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_web_pub_sub_chat_service_create_or_replace_user_request( + user_id=user_id, + hub=self._config.hub, + etag=etag, + match_condition=match_condition, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["ETag"] = self._deserialize("str", response.headers.get("ETag")) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.ChatUser, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def delete_user( # pylint: disable=inconsistent-return-statements + self, + user_id: str, + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> None: + """Delete a user. + + Delete a user. + + :param user_id: User identifier. Required. + :type user_id: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + if match_condition == MatchConditions.IfNotModified: + error_map[412] = ResourceModifiedError + elif match_condition == MatchConditions.IfPresent: + error_map[412] = ResourceNotFoundError + elif match_condition == MatchConditions.IfMissing: + error_map[412] = ResourceExistsError + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_web_pub_sub_chat_service_delete_user_request( + user_id=user_id, + hub=self._config.hub, + etag=etag, + match_condition=match_condition, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_operations/_patch.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_operations/_patch.py new file mode 100644 index 000000000000..87676c65a8f0 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_operations/_patch.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" + + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_patch.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_patch.py new file mode 100644 index 000000000000..87676c65a8f0 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_patch.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" + + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/__init__.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/__init__.py new file mode 100644 index 000000000000..8026245c2abc --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/__init__.py @@ -0,0 +1,6 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/model_base.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/model_base.py new file mode 100644 index 000000000000..b93f5120d517 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/model_base.py @@ -0,0 +1,1770 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=protected-access, broad-except + +import copy +import calendar +import decimal +import functools +import sys +import logging +import base64 +import re +import typing +import enum +import email.utils +from datetime import datetime, date, time, timedelta, timezone +from json import JSONEncoder +import xml.etree.ElementTree as ET +from collections.abc import MutableMapping +import isodate +from azure.core.exceptions import DeserializationError +from azure.core import CaseInsensitiveEnumMeta +from azure.core.pipeline import PipelineResponse +from azure.core.serialization import _Null + +from azure.core.rest import HttpResponse + +if sys.version_info >= (3, 11): + from typing import Self +else: + from typing_extensions import Self + +_LOGGER = logging.getLogger(__name__) + +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] + +TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") +_NONE_TYPE = type(None) + + +def _timedelta_as_isostr(td: timedelta) -> str: + """Converts a datetime.timedelta object into an ISO 8601 formatted string, e.g. 'P4DT12H30M05S' + + Function adapted from the Tin Can Python project: https://github.com/RusticiSoftware/TinCanPython + + :param timedelta td: The timedelta to convert + :rtype: str + :return: ISO8601 version of this timedelta + """ + + # Split seconds to larger units + seconds = td.total_seconds() + minutes, seconds = divmod(seconds, 60) + hours, minutes = divmod(minutes, 60) + days, hours = divmod(hours, 24) + + days, hours, minutes = list(map(int, (days, hours, minutes))) + seconds = round(seconds, 6) + + # Build date + date_str = "" + if days: + date_str = "%sD" % days + + if hours or minutes or seconds: + # Build time + time_str = "T" + + # Hours + bigger_exists = date_str or hours + if bigger_exists: + time_str += "{:02}H".format(hours) + + # Minutes + bigger_exists = bigger_exists or minutes + if bigger_exists: + time_str += "{:02}M".format(minutes) + + # Seconds + try: + if seconds.is_integer(): + seconds_string = "{:02}".format(int(seconds)) + else: + # 9 chars long w/ leading 0, 6 digits after decimal + seconds_string = "%09.6f" % seconds + # Remove trailing zeros + seconds_string = seconds_string.rstrip("0") + except AttributeError: # int.is_integer() raises + seconds_string = "{:02}".format(seconds) + + time_str += "{}S".format(seconds_string) + else: + time_str = "" + + return "P" + date_str + time_str + + +def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: + encoded = base64.b64encode(o).decode() + if format == "base64url": + return encoded.strip("=").replace("+", "-").replace("/", "_") + return encoded + + +def _serialize_duration(td: timedelta, format: typing.Optional[str] = None): + """Serialize a timedelta to its wire representation. + + For the ``seconds``/``milliseconds`` encodings the value is converted to a + numeric value, otherwise it falls back to an ISO 8601 duration string. + + :param timedelta td: The timedelta to serialize. + :param str format: The duration encoding format. + :rtype: int or float or str + :return: serialized duration + """ + seconds = td.total_seconds() + if format == "duration-seconds-int": + return int(seconds) + if format == "duration-seconds-float": + return seconds + if format == "duration-milliseconds-int": + return int(seconds * 1000) + if format == "duration-milliseconds-float": + return seconds * 1000 + return _timedelta_as_isostr(td) + + +def _serialize_datetime(o, format: typing.Optional[str] = None): + if hasattr(o, "year") and hasattr(o, "hour"): + if format == "rfc7231": + return email.utils.format_datetime(o, usegmt=True) + if format == "unix-timestamp": + return int(calendar.timegm(o.utctimetuple())) + + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) + if not o.tzinfo: + iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() + else: + iso_formatted = o.astimezone(TZ_UTC).isoformat() + # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) + return iso_formatted.replace("+00:00", "Z") + # Next try datetime.date or datetime.time + return o.isoformat() + + +def _is_readonly(p): + try: + return p._visibility == ["read"] + except AttributeError: + return False + + +class SdkJSONEncoder(JSONEncoder): + """A JSON encoder that's capable of serializing datetime objects and bytes.""" + + def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + super().__init__(*args, **kwargs) + self.exclude_readonly = exclude_readonly + self.format = format + + def default(self, o): # pylint: disable=too-many-return-statements + if _is_model(o): + if self.exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + return dict(o.items()) + try: + return super(SdkJSONEncoder, self).default(o) + except TypeError: + if isinstance(o, _Null): + return None + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, self.format) + try: + # First try datetime.datetime + return _serialize_datetime(o, self.format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return super(SdkJSONEncoder, self).default(o) + + +_VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") +_VALID_RFC7231 = re.compile( + r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" + r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" +) + +_ARRAY_ENCODE_MAPPING = { + "pipeDelimited": "|", + "spaceDelimited": " ", + "commaDelimited": ",", + "newlineDelimited": "\n", +} + + +def _deserialize_array_encoded(delimit: str, attr): + if isinstance(attr, str): + if attr == "": + return [] + return attr.split(delimit) + return attr + + +def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + attr = attr.upper() + match = _VALID_DATE.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + return date_obj # type: ignore[no-any-return] + + +def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize RFC7231 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + match = _VALID_RFC7231.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + return email.utils.parsedate_to_datetime(attr) + + +def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: + """Deserialize unix timestamp into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + return datetime.fromtimestamp(attr, TZ_UTC) + + +def _deserialize_date(attr: typing.Union[str, date]) -> date: + """Deserialize ISO-8601 formatted string into Date object. + :param str attr: response string to be deserialized. + :rtype: date + :returns: The date object from that input + """ + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + if isinstance(attr, date): + return attr + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore + + +def _deserialize_time(attr: typing.Union[str, time]) -> time: + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :returns: The time object from that input + """ + if isinstance(attr, time): + return attr + return isodate.parse_time(attr) # type: ignore[no-any-return] + + +def _deserialize_bytes(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + return bytes(base64.b64decode(attr)) + + +def _deserialize_bytes_base64(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return bytes(base64.b64decode(encoded)) + + +def _deserialize_duration(attr): + if isinstance(attr, timedelta): + return attr + return isodate.parse_duration(attr) + + +def _deserialize_duration_numeric(attr, unit): + if isinstance(attr, timedelta): + return attr + return timedelta(**{unit: float(attr)}) + + +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + +def _deserialize_int_as_str(attr): + if isinstance(attr, int): + return attr + return int(attr) + + +_DESERIALIZE_MAPPING = { + datetime: _deserialize_datetime, + date: _deserialize_date, + time: _deserialize_time, + bytes: _deserialize_bytes, + bytearray: _deserialize_bytes, + timedelta: _deserialize_duration, + typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, +} + +_DESERIALIZE_MAPPING_WITHFORMAT = { + "rfc3339": _deserialize_datetime, + "rfc7231": _deserialize_datetime_rfc7231, + "unix-timestamp": _deserialize_datetime_unix_timestamp, + "base64": _deserialize_bytes, + "base64url": _deserialize_bytes_base64, + "duration-seconds-int": functools.partial(_deserialize_duration_numeric, unit="seconds"), + "duration-seconds-float": functools.partial(_deserialize_duration_numeric, unit="seconds"), + "duration-milliseconds-int": functools.partial(_deserialize_duration_numeric, unit="milliseconds"), + "duration-milliseconds-float": functools.partial(_deserialize_duration_numeric, unit="milliseconds"), +} + + +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if annotation is int and rf and rf._format == "str": + return _deserialize_int_as_str + if annotation is str and rf and rf._format in _ARRAY_ENCODE_MAPPING: + return functools.partial(_deserialize_array_encoded, _ARRAY_ENCODE_MAPPING[rf._format]) + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) # pyright: ignore + + +def _get_type_alias_type(module_name: str, alias_name: str): + types = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, typing._GenericAlias) # type: ignore + } + if alias_name not in types: + return alias_name + return types[alias_name] + + +def _get_model(module_name: str, model_name: str): + models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)} + module_end = module_name.rsplit(".", 1)[0] + models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)}) + if isinstance(model_name, str): + model_name = model_name.split(".")[-1] + if model_name not in models: + return model_name + return models[model_name] + + +_UNSET = object() + + +class _MyMutableMapping(MutableMapping[str, typing.Any]): + def __init__(self, data: dict[str, typing.Any]) -> None: + self._data = data + + def __contains__(self, key: typing.Any) -> bool: + return key in self._data + + def __getitem__(self, key: str) -> typing.Any: + # If this key has been deserialized (for mutable types), we need to handle serialization + if hasattr(self, "_attr_to_rest_field"): + cache_attr = f"_deserialized_{key}" + if hasattr(self, cache_attr): + rf = _get_rest_field(getattr(self, "_attr_to_rest_field"), key) + if rf: + value = self._data.get(key) + if isinstance(value, (dict, list, set)): + # For mutable types, serialize and return + # But also update _data with serialized form and clear flag + # so mutations via this returned value affect _data + serialized = _serialize(value, rf._format) + # If serialized form is same type (no transformation needed), + # return _data directly so mutations work + if isinstance(serialized, type(value)) and serialized == value: + return self._data.get(key) + # Otherwise return serialized copy and clear flag + try: + object.__delattr__(self, cache_attr) + except AttributeError: + pass + # Store serialized form back + self._data[key] = serialized + return serialized + return self._data.__getitem__(key) + + def __setitem__(self, key: str, value: typing.Any) -> None: + # Clear any cached deserialized value when setting through dictionary access + cache_attr = f"_deserialized_{key}" + try: + object.__delattr__(self, cache_attr) + except AttributeError: + pass + self._data.__setitem__(key, value) + + def __delitem__(self, key: str) -> None: + self._data.__delitem__(key) + + def __iter__(self) -> typing.Iterator[typing.Any]: + return self._data.__iter__() + + def __len__(self) -> int: + return self._data.__len__() + + def __ne__(self, other: typing.Any) -> bool: + return not self.__eq__(other) + + def keys(self) -> typing.KeysView[str]: + """ + :returns: a set-like object providing a view on D's keys + :rtype: ~typing.KeysView + """ + return self._data.keys() + + def values(self) -> typing.ValuesView[typing.Any]: + """ + :returns: an object providing a view on D's values + :rtype: ~typing.ValuesView + """ + return self._data.values() + + def items(self) -> typing.ItemsView[str, typing.Any]: + """ + :returns: set-like object providing a view on D's items + :rtype: ~typing.ItemsView + """ + return self._data.items() + + def get(self, key: str, default: typing.Any = None) -> typing.Any: + """ + Get the value for key if key is in the dictionary, else default. + :param str key: The key to look up. + :param any default: The value to return if key is not in the dictionary. Defaults to None + :returns: D[k] if k in D, else d. + :rtype: any + """ + try: + return self[key] + except KeyError: + return default + + @typing.overload + def pop(self, key: str) -> typing.Any: ... # pylint: disable=arguments-differ + + @typing.overload + def pop(self, key: str, default: _T) -> _T: ... # pylint: disable=signature-differs + + @typing.overload + def pop(self, key: str, default: typing.Any) -> typing.Any: ... # pylint: disable=signature-differs + + def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + """ + Removes specified key and return the corresponding value. + :param str key: The key to pop. + :param any default: The value to return if key is not in the dictionary + :returns: The value corresponding to the key. + :rtype: any + :raises KeyError: If key is not found and default is not given. + """ + if default is _UNSET: + return self._data.pop(key) + return self._data.pop(key, default) + + def popitem(self) -> tuple[str, typing.Any]: + """ + Removes and returns some (key, value) pair + :returns: The (key, value) pair. + :rtype: tuple + :raises KeyError: if D is empty. + """ + return self._data.popitem() + + def clear(self) -> None: + """ + Remove all items from D. + """ + self._data.clear() + + def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: # pylint: disable=arguments-differ + """ + Updates D from mapping/iterable E and F. + :param any args: Either a mapping object or an iterable of key-value pairs. + """ + self._data.update(*args, **kwargs) + + @typing.overload + def setdefault(self, key: str, default: None = None) -> None: ... + + @typing.overload + def setdefault(self, key: str, default: typing.Any) -> typing.Any: ... # pylint: disable=signature-differs + + def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + """ + Same as calling D.get(k, d), and setting D[k]=d if k not found + :param str key: The key to look up. + :param any default: The value to set if key is not in the dictionary + :returns: D[k] if k in D, else d. + :rtype: any + """ + if default is _UNSET: + return self._data.setdefault(key) + return self._data.setdefault(key, default) + + def __eq__(self, other: typing.Any) -> bool: + if isinstance(other, _MyMutableMapping): + return self._data == other._data + try: + other_model = self.__class__(other) + except Exception: + return False + return self._data == other_model._data + + def __repr__(self) -> str: + return str(self._data) + + +def _is_model(obj: typing.Any) -> bool: + return getattr(obj, "_is_model", False) + + +def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements + if isinstance(o, list): + if format in _ARRAY_ENCODE_MAPPING and all(isinstance(x, str) for x in o): + return _ARRAY_ENCODE_MAPPING[format].join(o) + return [_serialize(x, format) for x in o] + if isinstance(o, dict): + return {k: _serialize(v, format) for k, v in o.items()} + if isinstance(o, set): + return {_serialize(x, format) for x in o} + if isinstance(o, tuple): + return tuple(_serialize(x, format) for x in o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, enum.Enum): + return o.value + if isinstance(o, int): + if format == "str": + return str(o) + return o + try: + # First try datetime.datetime + return _serialize_datetime(o, format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _serialize_duration(o, format) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return o + + +def _get_rest_field(attr_to_rest_field: dict[str, "_RestField"], rest_name: str) -> typing.Optional["_RestField"]: + try: + return next(rf for rf in attr_to_rest_field.values() if rf._rest_name == rest_name) + except StopIteration: + return None + + +def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: + if not rf: + return _serialize(value, None) + if rf._is_multipart_file_input: + return value + if rf._is_model: + return _deserialize(rf._type, value) + if isinstance(value, ET.Element): + value = _deserialize(rf._type, value) + return _serialize(value, rf._format) + + +# ============================================================================ +# Fast-path scalar deserializer functions for rest_field(deserializer=...) +# These are referenced from rest_field declarations to bypass the generic +# _deserialize -> _deserialize_with_callable chain. +# Only simple/primitive types — no models or container types. +# ============================================================================ + + +def _xml_deser_str(value): + if isinstance(value, ET.Element): + return value.text or "" + return str(value) if value is not None else None + + +def _xml_deser_int(value): + if isinstance(value, ET.Element): + return int(value.text) if value.text else None + return int(value) if value is not None else None + + +def _xml_deser_float(value): + if isinstance(value, ET.Element): + return float(value.text) if value.text else None + return float(value) if value is not None else None + + +def _xml_deser_bool(value): + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + if text in (True, False): + return text + return text.lower() == "true" + + +# pylint: disable=docstring-missing-param +def _xml_deser_bytes(value): + """Deserialize bytes from XML (base64).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_bytes(text) + + +def _xml_deser_bytes_base64url(value): + """Deserialize bytes from XML (base64url).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_bytes_base64(text) + + +def _xml_deser_datetime(value): + """Deserialize a datetime from XML (ISO 8601 / rfc3339).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_datetime(text) + + +def _xml_deser_datetime_rfc7231(value): + """Deserialize a datetime from XML (RFC7231 format).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_datetime_rfc7231(text) + + +def _xml_deser_datetime_unix_timestamp(value): + """Deserialize a datetime from XML (Unix timestamp).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_datetime_unix_timestamp(float(text)) + + +def _xml_deser_date(value): + """Deserialize a date from XML (ISO 8601).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_date(text) + + +def _xml_deser_time(value): + """Deserialize a time from XML (ISO 8601).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_time(text) + + +def _xml_deser_duration(value): + """Deserialize a timedelta from XML (ISO 8601 duration).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_duration(text) + + +def _xml_deser_decimal(value): + """Deserialize a Decimal from XML.""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_decimal(text) + + +def _xml_deser_enum_or_str(enum_cls, value): + """Deserialize a Union[EnumType, str] from XML.""" + text = value.text if isinstance(value, ET.Element) else value + if text is None: + return None + try: + return enum_cls(text) + except ValueError: + return text + + +def _extract_xml_model_type(rf_type): + """Extract the concrete Model class from a resolved rf._type partial chain. + + Unwraps ``Optional[Model]`` and ``_deserialize_model(Model, ...)`` + wrappers. Only handles Model and Optional[Model] — other composite + types (List, Dict, Union, etc.) return None and fall through to the + generic ``_deserialize`` path at runtime. + """ + if rf_type is None: + return None + if isinstance(rf_type, type) and _is_model(rf_type): + return rf_type + if not isinstance(rf_type, functools.partial): + return None + func = rf_type.func + args = rf_type.args + if func is _deserialize_with_optional and args: + return _extract_xml_model_type(args[0]) + if func is _deserialize_model and args: + cls = args[0] + return cls if isinstance(cls, type) and _is_model(cls) else None + return None + + +def _build_xml_field_plan( # pylint: disable=docstring-missing-return, docstring-missing-rtype, unused-variable + cls, attr_to_rest_field: dict +) -> list: + """Build a precomputed XML field plan for fast _init_from_xml iteration. + + Called once per model class in __new__. Returns a list of tuples: + (rest_name, xml_name, kind, deser, rf_type, is_optional, items_name) + + kind: 0=wrapped, 1=attribute, 2=unwrapped, 3=text + + For Model and Optional[Model] fields that lack a scalar + ``_deserializer``, this function precomputes the Model class as the + deserializer so ``_init_from_xml`` can call ``ModelClass(element)`` + directly instead of going through the expensive + ``_get_deserialize_callable_from_annotation`` chain at runtime. + """ + model_meta = getattr(cls, "_xml", {}) + model_ns = model_meta.get("ns") or model_meta.get("namespace") + plan = [] + + for rf in attr_to_rest_field.values(): + prop_meta = getattr(rf, "_xml", {}) + deser = rf._deserializer + + xml_name = prop_meta.get("name", rf._rest_name) + xml_ns = _resolve_xml_ns(prop_meta, model_meta) + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + + is_optional = rf._is_optional + + # For Model / Optional[Model] fields without a scalar deserializer, + # precompute the Model class as the deserializer. + if deser is None and rf._type is not None: + model_cls = _extract_xml_model_type(rf._type) + if model_cls is not None: + deser = model_cls + + if prop_meta.get("attribute", False): + plan.append((rf._rest_name, xml_name, 1, deser, rf._type, is_optional, None)) + elif prop_meta.get("unwrapped", False): + items_name = prop_meta.get("itemsName") + if items_name: + items_ns = prop_meta.get("itemsNs") + if items_ns is not None: + xml_ns = items_ns + if xml_ns: + items_name = "{" + xml_ns + "}" + items_name + else: + items_name = xml_name + plan.append((rf._rest_name, xml_name, 2, deser, rf._type, is_optional, items_name)) + elif prop_meta.get("text", False): + plan.append((rf._rest_name, xml_name, 3, deser, rf._type, is_optional, None)) + else: + plan.append((rf._rest_name, xml_name, 0, deser, rf._type, is_optional, None)) + + return plan + + +# pylint: enable=docstring-missing-param +class Model(_MyMutableMapping): + _is_model = True + # label whether current class's _attr_to_rest_field has been calculated + # could not see _attr_to_rest_field directly because subclass inherits it from parent class + _calculated: set[str] = set() + + def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: + class_name = self.__class__.__name__ + if len(args) > 1: + raise TypeError(f"{class_name}.__init__() takes 2 positional arguments but {len(args) + 1} were given") + dict_to_pass: dict[str, typing.Any] = {} + if args: + if isinstance(args[0], ET.Element): + dict_to_pass.update(self._init_from_xml(args[0])) + else: + dict_to_pass.update( + {k: _create_value(_get_rest_field(self._attr_to_rest_field, k), v) for k, v in args[0].items()} + ) + else: + non_attr_kwargs = [k for k in kwargs if k not in self._attr_to_rest_field] + if non_attr_kwargs: + # actual type errors only throw the first wrong keyword arg they see, so following that. + raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") + dict_to_pass.update( + { + self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) + for k, v in kwargs.items() + if v is not None + } + ) + # Apply client default values for fields the caller didn't set so that + # defaults are part of `_data` and therefore included during serialization. + for rf in self._attr_to_rest_field.values(): + if rf._default is _UNSET: + continue + if rf._rest_name in dict_to_pass: + continue + dict_to_pass[rf._rest_name] = _create_value(rf, rf._default) + super().__init__(dict_to_pass) + + def _init_from_xml( # pylint: disable=too-many-branches, too-many-statements + self, element: ET.Element + ) -> dict[str, typing.Any]: + """Deserialize an XML element into a dict mapping rest field names to values. + + :param ET.Element element: The XML element to deserialize from. + :returns: A dictionary of rest_name to deserialized value pairs. + :rtype: dict + """ + result: dict[str, typing.Any] = {} + existed_attr_keys: list[str] = [] + + field_plan = getattr(self, "_xml_field_plan", None) + if field_plan: + for rest_name, xml_name, kind, deser, rf_type, is_optional, items_name in field_plan: + if kind == 0: # wrapped element (most common) + item = element.find(xml_name) + if item is not None: + existed_attr_keys.append(xml_name) + if deser: + result[rest_name] = deser(item) + else: + result[rest_name] = _deserialize(rf_type, item) + elif kind == 1: # attribute + attr_val = element.get(xml_name) + if attr_val is not None: + existed_attr_keys.append(xml_name) + if deser: + result[rest_name] = deser(attr_val) + else: + result[rest_name] = attr_val + elif kind == 2: # unwrapped array + items = element.findall(items_name) # pyright: ignore + if len(items) > 0: + existed_attr_keys.append(items_name) + if deser: + result[rest_name] = deser(items) + else: + result[rest_name] = _deserialize(rf_type, items) + elif not is_optional: + existed_attr_keys.append(items_name) + result[rest_name] = [] + elif kind == 3: # text + if element.text is not None: + if deser: + result[rest_name] = deser(element.text) + else: + result[rest_name] = element.text + else: + model_meta = getattr(self, "_xml", {}) + for rf in self._attr_to_rest_field.values(): + prop_meta = getattr(rf, "_xml", {}) + xml_name = prop_meta.get("name", rf._rest_name) + xml_ns = _resolve_xml_ns(prop_meta, model_meta) + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + + # attribute + if prop_meta.get("attribute", False) and element.get(xml_name) is not None: + existed_attr_keys.append(xml_name) + result[rf._rest_name] = _deserialize(rf._type, element.get(xml_name)) + continue + + # unwrapped element is array + if prop_meta.get("unwrapped", False): + _items_name = prop_meta.get("itemsName") + if _items_name: + xml_name = _items_name + _items_ns = prop_meta.get("itemsNs") + if _items_ns is not None: + xml_ns = _items_ns + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + items = element.findall(xml_name) # pyright: ignore + if len(items) > 0: + existed_attr_keys.append(xml_name) + result[rf._rest_name] = _deserialize(rf._type, items) + elif not rf._is_optional: + existed_attr_keys.append(xml_name) + result[rf._rest_name] = [] + continue + + # text element is primitive type + if prop_meta.get("text", False): + if element.text is not None: + result[rf._rest_name] = _deserialize(rf._type, element.text) + continue + + # wrapped element could be normal property or array + item = element.find(xml_name) + if item is not None: + existed_attr_keys.append(xml_name) + result[rf._rest_name] = _deserialize(rf._type, item) + + # rest thing is additional properties + for e in element: + if e.tag not in existed_attr_keys: + result[e.tag] = _convert_element(e) + + return result + + def copy(self) -> "Model": + return Model(self.__dict__) + + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: + if f"{cls.__module__}.{cls.__qualname__}" not in cls._calculated: + # we know the last nine classes in mro are going to be 'Model', '_MyMutableMapping', 'MutableMapping', + # 'Mapping', 'Collection', 'Sized', 'Iterable', 'Container' and 'object' + mros = cls.__mro__[:-9][::-1] # ignore parents, and reverse the mro order + attr_to_rest_field: dict[str, _RestField] = { # map attribute name to rest_field property + k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type") + } + annotations = { + k: v + for mro_class in mros + if hasattr(mro_class, "__annotations__") + for k, v in mro_class.__annotations__.items() + } + for attr, rf in attr_to_rest_field.items(): + rf._module = cls.__module__ + if not rf._type: + rf._type = rf._get_deserialize_callable_from_annotation(annotations.get(attr, None)) + if not rf._rest_name_input: + rf._rest_name_input = attr + cls._attr_to_rest_field: dict[str, _RestField] = dict(attr_to_rest_field.items()) + # Build XML field plan for fast _init_from_xml (only for XML models) + if getattr(cls, "_xml", None): + cls._xml_field_plan = _build_xml_field_plan(cls, attr_to_rest_field) + cls._calculated.add(f"{cls.__module__}.{cls.__qualname__}") + + return super().__new__(cls) + + def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: + for base in cls.__bases__: + if hasattr(base, "__mapping__"): + base.__mapping__[discriminator or cls.__name__] = cls # type: ignore + + @classmethod + def _get_discriminator(cls, exist_discriminators) -> typing.Optional["_RestField"]: + for v in cls.__dict__.values(): + if isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators: + return v + return None + + @classmethod + def _deserialize(cls, data, exist_discriminators): + if not hasattr(cls, "__mapping__"): + return cls(data) + discriminator = cls._get_discriminator(exist_discriminators) + if discriminator is None: + return cls(data) + exist_discriminators.append(discriminator._rest_name) + if isinstance(data, ET.Element): + model_meta = getattr(cls, "_xml", {}) + prop_meta = getattr(discriminator, "_xml", {}) + xml_name = prop_meta.get("name", discriminator._rest_name) + xml_ns = _resolve_xml_ns(prop_meta, model_meta) + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + + if data.get(xml_name) is not None: + discriminator_value = data.get(xml_name) + else: + discriminator_value = data.find(xml_name).text # pyright: ignore + else: + discriminator_value = data.get(discriminator._rest_name) + mapped_cls = cls.__mapping__.get(discriminator_value, cls) # pyright: ignore # pylint: disable=no-member + return mapped_cls._deserialize(data, exist_discriminators) + + def as_dict(self, *, exclude_readonly: bool = False) -> dict[str, typing.Any]: + """Return a dict that can be turned into json using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + readonly_props = [] + if exclude_readonly: + readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] + for k, v in self.items(): + if exclude_readonly and k in readonly_props: # pyright: ignore + continue + is_multipart_file_input = False + try: + is_multipart_file_input = next( + rf for rf in self._attr_to_rest_field.values() if rf._rest_name == k + )._is_multipart_file_input + except StopIteration: + pass + result[k] = v if is_multipart_file_input else Model._as_dict_value(v, exclude_readonly=exclude_readonly) + return result + + @staticmethod + def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: + if v is None or isinstance(v, _Null): + return None + if isinstance(v, (list, tuple, set)): + return type(v)(Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v) + if isinstance(v, dict): + return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} + return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v + + +def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + +def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): + if obj is None: + return obj + return _deserialize_with_callable(if_obj_deserializer, obj) + + +def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + +def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj: dict[typing.Any, typing.Any], +): + if obj is None: + return obj + if isinstance(obj, ET.Element): + obj = {child.tag: child for child in obj} + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} + + +def _deserialize_multiple_sequence( + entry_deserializers: list[typing.Optional[typing.Callable]], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry, deserializer in zip(obj, entry_deserializers)) + + +def _is_array_encoded_deserializer(deserializer: functools.partial) -> bool: + return ( + isinstance(deserializer, functools.partial) + and isinstance(deserializer.args[0], functools.partial) + and deserializer.args[0].func == _deserialize_array_encoded # pylint: disable=comparison-with-callable + ) + + +def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + if isinstance(obj, ET.Element): + obj = list(obj) + + # encoded string may be deserialized to sequence + if isinstance(obj, str) and isinstance(deserializer, functools.partial): + # for list[str] + if _is_array_encoded_deserializer(deserializer): + return deserializer(obj) + + # for list[Union[...]] + if isinstance(deserializer.args[0], list): + for sub_deserializer in deserializer.args[0]: + if _is_array_encoded_deserializer(sub_deserializer): + return sub_deserializer(obj) + + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + +def _sorted_annotations(types: list[typing.Any]) -> list[typing.Any]: + return sorted( + types, + key=lambda x: hasattr(x, "__name__") and x.__name__.lower() in ("str", "float", "int", "bool"), + ) + + +def _get_deserialize_callable_from_annotation( # pylint: disable=too-many-return-statements, too-many-statements, too-many-branches + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, +) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + if not annotation: + return None + + # is it a type alias? + if isinstance(annotation, str): + if module is not None: + annotation = _get_type_alias_type(module, annotation) + + # is it a forward ref / in quotes? + if isinstance(annotation, (str, typing.ForwardRef)): + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if module is not None: + annotation = _get_model(module, model_name) # type: ignore + + try: + if module and _is_model(annotation): + if rf: + rf._is_model = True + + return functools.partial(_deserialize_model, annotation) # pyright: ignore + except Exception: + pass + + # is it a literal? + try: + if annotation.__origin__ is typing.Literal: # pyright: ignore + return None + except AttributeError: + pass + + # is it optional? + try: + if any(a is _NONE_TYPE for a in annotation.__args__): # pyright: ignore + if rf: + rf._is_optional = True + if len(annotation.__args__) <= 2: # pyright: ignore + if_obj_deserializer = _get_deserialize_callable_from_annotation( + next(a for a in annotation.__args__ if a is not _NONE_TYPE), module, rf # pyright: ignore + ) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + # the type is Optional[Union[...]], we need to remove the None type from the Union + annotation_copy = copy.copy(annotation) + annotation_copy.__args__ = [a for a in annotation_copy.__args__ if a is not _NONE_TYPE] # pyright: ignore + return _get_deserialize_callable_from_annotation(annotation_copy, module, rf) + except AttributeError: + pass + + # is it union? + if getattr(annotation, "__origin__", None) is typing.Union: + # initial ordering is we make `string` the last deserialization option, because it is often them most generic + deserializers = [ + _get_deserialize_callable_from_annotation(arg, module, rf) + for arg in _sorted_annotations(annotation.__args__) # pyright: ignore + ] + + return functools.partial(_deserialize_with_union, deserializers) + + try: + annotation_name = ( + annotation.__name__ if hasattr(annotation, "__name__") else annotation._name # pyright: ignore + ) + if annotation_name.lower() == "dict": + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) + + return functools.partial( + _deserialize_dict, + value_deserializer, + module, + ) + except (AttributeError, IndexError): + pass + try: + annotation_name = ( + annotation.__name__ if hasattr(annotation, "__name__") else annotation._name # pyright: ignore + ) + if annotation_name.lower() in ["list", "set", "tuple", "sequence"]: + if len(annotation.__args__) > 1: # pyright: ignore + entry_deserializers = [ + _get_deserialize_callable_from_annotation(dt, module, rf) + for dt in annotation.__args__ # pyright: ignore + ] + return functools.partial(_deserialize_multiple_sequence, entry_deserializers, module) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) + + return functools.partial(_deserialize_sequence, deserializer, module) + except (TypeError, IndexError, AttributeError, SyntaxError): + pass + + def _deserialize_default( + deserializer, + obj, + ): + if obj is None: + return obj + try: + return _deserialize_with_callable(deserializer, obj) + except Exception: + pass + return obj + + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) + + return functools.partial(_deserialize_default, annotation) + + +def _deserialize_with_callable( + deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], + value: typing.Any, +): # pylint: disable=too-many-return-statements + try: + if value is None or isinstance(value, _Null): + return None + if isinstance(value, ET.Element): + if deserializer is str: + return value.text or "" + if deserializer is int: + return int(value.text) if value.text else None + if deserializer is float: + return float(value.text) if value.text else None + if deserializer is bool: + return value.text == "true" if value.text else None + if deserializer and deserializer in _DESERIALIZE_MAPPING.values(): + return deserializer(value.text) if value.text else None + if deserializer and deserializer in _DESERIALIZE_MAPPING_WITHFORMAT.values(): + return deserializer(value.text) if value.text else None + if deserializer is None: + return value + if deserializer in [int, float, bool]: + return deserializer(value) + if isinstance(deserializer, CaseInsensitiveEnumMeta): + try: + return deserializer(value.text if isinstance(value, ET.Element) else value) + except ValueError: + # for unknown value, return raw value + return value.text if isinstance(value, ET.Element) else value + if isinstance(deserializer, type) and issubclass(deserializer, Model): + return deserializer._deserialize(value, []) + return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) + except Exception as e: + raise DeserializationError() from e + + +def _deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + if isinstance(value, PipelineResponse): + value = value.http_response.json() + if rf is None and format: + rf = _RestField(format=format) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) + return _deserialize_with_callable(deserializer, value) + + +def _failsafe_deserialize( + deserializer: typing.Any, + response: HttpResponse, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + try: + return _deserialize(deserializer, response.json(), module, rf, format) + except Exception: # pylint: disable=broad-except + _LOGGER.warning( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + +def _failsafe_deserialize_xml( + deserializer: typing.Any, + response: HttpResponse, +) -> typing.Any: + try: + return _deserialize_xml(deserializer, response.text()) + except Exception: # pylint: disable=broad-except + _LOGGER.warning( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + +# pylint: disable=too-many-instance-attributes +class _RestField: + def __init__( + self, + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + is_discriminator: bool = False, + visibility: typing.Optional[list[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + xml: typing.Optional[dict[str, typing.Any]] = None, + deserializer: typing.Optional[typing.Callable] = None, + ): + self._type = type + self._rest_name_input = name + self._module: typing.Optional[str] = None + self._is_discriminator = is_discriminator + self._visibility = visibility + self._is_model = False + self._is_optional = False + self._default = default + self._format = format + self._is_multipart_file_input = is_multipart_file_input + self._xml = xml if xml is not None else {} + self._deserializer = deserializer + + @property + def _class_type(self) -> typing.Any: + result = getattr(self._type, "args", [None])[0] + # type may be wrapped by nested functools.partial so we need to check for that + if isinstance(result, functools.partial): + return getattr(result, "args", [None])[0] + return result + + @property + def _rest_name(self) -> str: + if self._rest_name_input is None: + raise ValueError("Rest name was never set") + return self._rest_name_input + + def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin + # by this point, type and rest_name will have a value bc we default + # them in __new__ of the Model class + # Use _data.get() directly to avoid triggering __getitem__ which clears the cache + item = obj._data.get(self._rest_name, _UNSET) + if item is _UNSET: + # Field not set by user; return the client default if one exists, otherwise None + return self._default if self._default is not _UNSET else None + if item is None: + return item + if self._is_model: + return item + + # For mutable types, we want mutations to directly affect _data + # Check if we've already deserialized this value + cache_attr = f"_deserialized_{self._rest_name}" + if hasattr(obj, cache_attr): + # Return the value from _data directly (it's been deserialized in place) + return obj._data.get(self._rest_name) + + # Fast path: use _deserializer directly (avoids _serialize/_deserialize chain) + if self._deserializer: + deserialized = self._deserializer(item) + else: + deserialized = _deserialize(self._type, _serialize(item, self._format), rf=self) + + # For mutable types, store the deserialized value back in _data + # so mutations directly affect _data + if isinstance(deserialized, (dict, list, set)): + obj._data[self._rest_name] = deserialized + object.__setattr__(obj, cache_attr, True) # Mark as deserialized + return deserialized + + return deserialized + + def __set__(self, obj: Model, value) -> None: + # Clear the cached deserialized object when setting a new value + cache_attr = f"_deserialized_{self._rest_name}" + if hasattr(obj, cache_attr): + object.__delattr__(obj, cache_attr) + + if value is None: + # we want to wipe out entries if users set attr to None + try: + obj.__delitem__(self._rest_name) + except KeyError: + pass + return + if self._is_model: + if not _is_model(value): + value = _deserialize(self._type, value) + obj.__setitem__(self._rest_name, value) + return + obj.__setitem__(self._rest_name, _serialize(value, self._format)) + + def _get_deserialize_callable_from_annotation( + self, annotation: typing.Any + ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + return _get_deserialize_callable_from_annotation(annotation, self._module, self) + + +def rest_field( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[list[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + xml: typing.Optional[dict[str, typing.Any]] = None, + deserializer: typing.Optional[typing.Callable] = None, +) -> typing.Any: + return _RestField( + name=name, + type=type, + visibility=visibility, + default=default, + format=format, + is_multipart_file_input=is_multipart_file_input, + xml=xml, + deserializer=deserializer, + ) + + +def rest_discriminator( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[list[str]] = None, + xml: typing.Optional[dict[str, typing.Any]] = None, +) -> typing.Any: + return _RestField(name=name, type=type, is_discriminator=True, visibility=visibility, xml=xml) + + +def serialize_xml(model: Model, exclude_readonly: bool = False) -> str: + """Serialize a model to XML. + + :param Model model: The model to serialize. + :param bool exclude_readonly: Whether to exclude readonly properties. + :returns: The XML representation of the model. + :rtype: str + """ + return ET.tostring(_get_element(model, exclude_readonly), encoding="unicode") # type: ignore + + +def _get_xml_ns(meta: dict[str, typing.Any]) -> typing.Optional[str]: + """Return the XML namespace from a metadata dict, checking both 'ns' (old-style) and 'namespace' (DPG) keys. + + :param dict meta: The metadata dictionary to extract namespace from. + :returns: The namespace string if 'ns' or 'namespace' key is present, None otherwise. + :rtype: str or None + """ + ns = meta.get("ns") + if ns is None: + ns = meta.get("namespace") + return ns + + +def _resolve_xml_ns( + prop_meta: dict[str, typing.Any], model_meta: typing.Optional[dict[str, typing.Any]] = None +) -> typing.Optional[str]: + """Resolve XML namespace for a property, falling back to model namespace when appropriate. + + Checks the property metadata first; if no namespace is found and the model does not declare + an explicit prefix, falls back to the model-level namespace. + + :param dict prop_meta: The property metadata dictionary. + :param dict model_meta: The model metadata dictionary, used as fallback. + :returns: The resolved namespace string, or None. + :rtype: str or None + """ + ns = _get_xml_ns(prop_meta) + if ns is None and model_meta is not None and not model_meta.get("prefix"): + ns = _get_xml_ns(model_meta) + return ns + + +def _set_xml_attribute(element: ET.Element, name: str, value: typing.Any, prop_meta: dict[str, typing.Any]) -> None: + """Set an XML attribute on an element, handling namespace prefix registration. + + :param ET.Element element: The element to set the attribute on. + :param str name: The default attribute name (wire name). + :param any value: The attribute value. + :param dict prop_meta: The property metadata dictionary. + """ + xml_name = prop_meta.get("name", name) + _attr_ns = _get_xml_ns(prop_meta) + if _attr_ns: + _attr_prefix = prop_meta.get("prefix") + if _attr_prefix: + _safe_register_namespace(_attr_prefix, _attr_ns) + xml_name = "{" + _attr_ns + "}" + xml_name + element.set(xml_name, _get_primitive_type_value(value)) + + +def _get_element( + o: typing.Any, + exclude_readonly: bool = False, + parent_meta: typing.Optional[dict[str, typing.Any]] = None, + wrapped_element: typing.Optional[ET.Element] = None, +) -> typing.Union[ET.Element, list[ET.Element]]: + if _is_model(o): + model_meta = getattr(o, "_xml", {}) + + # if prop is a model, then use the prop element directly, else generate a wrapper of model + if wrapped_element is None: + # When serializing as an array item (parent_meta is set), check if the parent has an + # explicit itemsName. This ensures correct element names for unwrapped arrays (where + # the element tag is the property/items name, not the model type name). + _items_name = parent_meta.get("itemsName") if parent_meta is not None else None + element_name = _items_name if _items_name else (model_meta.get("name") or o.__class__.__name__) + _model_ns = _get_xml_ns(model_meta) + wrapped_element = _create_xml_element( + element_name, + model_meta.get("prefix"), + _model_ns, + ) + + readonly_props = [] + if exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + + for k, v in o.items(): + # do not serialize readonly properties + if exclude_readonly and k in readonly_props: + continue + + prop_rest_field = _get_rest_field(o._attr_to_rest_field, k) + if prop_rest_field: + prop_meta = getattr(prop_rest_field, "_xml").copy() + # use the wire name as xml name if no specific name is set + if prop_meta.get("name") is None: + prop_meta["name"] = k + else: + # additional properties will not have rest field, use the wire name as xml name + prop_meta = {"name": k} + + # Propagate model namespace to properties only for old-style "ns"-keyed models. + # DPG-generated models use the "namespace" key and explicitly declare namespace on + # each property that needs it, so propagation is intentionally skipped for them. + if prop_meta.get("ns") is None and model_meta.get("ns"): + prop_meta["ns"] = model_meta.get("ns") + prop_meta["prefix"] = model_meta.get("prefix") + + if prop_meta.get("unwrapped", False): + # unwrapped could only set on array + wrapped_element.extend(_get_element(v, exclude_readonly, prop_meta)) + elif prop_meta.get("text", False): + # text could only set on primitive type + wrapped_element.text = _get_primitive_type_value(v) + elif prop_meta.get("attribute", False): + _set_xml_attribute(wrapped_element, k, v, prop_meta) + else: + # other wrapped prop element + wrapped_element.append(_get_wrapped_element(v, exclude_readonly, prop_meta)) + return wrapped_element + if isinstance(o, list): + return [_get_element(x, exclude_readonly, parent_meta) for x in o] # type: ignore + if isinstance(o, dict): + result = [] + _dict_ns = _get_xml_ns(parent_meta) if parent_meta else None + for k, v in o.items(): + result.append( + _get_wrapped_element( + v, + exclude_readonly, + { + "name": k, + "ns": _dict_ns, + "prefix": parent_meta.get("prefix") if parent_meta else None, + }, + ) + ) + return result + + # primitive case need to create element based on parent_meta + if parent_meta: + _items_ns = parent_meta.get("itemsNs") + if _items_ns is None: + _items_ns = _get_xml_ns(parent_meta) + return _get_wrapped_element( + o, + exclude_readonly, + { + "name": parent_meta.get("itemsName", parent_meta.get("name")), + "prefix": parent_meta.get("itemsPrefix", parent_meta.get("prefix")), + "ns": _items_ns, + }, + ) + + raise ValueError("Could not serialize value into xml: " + o) + + +def _get_wrapped_element( + v: typing.Any, + exclude_readonly: bool, + meta: typing.Optional[dict[str, typing.Any]], +) -> ET.Element: + _meta_ns = _get_xml_ns(meta) if meta else None + wrapped_element = _create_xml_element( + meta.get("name") if meta else None, meta.get("prefix") if meta else None, _meta_ns + ) + if isinstance(v, (dict, list)): + wrapped_element.extend(_get_element(v, exclude_readonly, meta)) + elif _is_model(v): + _get_element(v, exclude_readonly, meta, wrapped_element) + else: + wrapped_element.text = _get_primitive_type_value(v) + return wrapped_element # type: ignore[no-any-return] + + +def _get_primitive_type_value(v) -> str: + if v is True: + return "true" + if v is False: + return "false" + if isinstance(v, _Null): + return "" + return str(v) + + +def _safe_register_namespace(prefix: str, ns: str) -> None: + """Register an XML namespace prefix, handling reserved prefix patterns. + + Some prefixes (e.g. 'ns2') match Python's reserved 'ns\\d+' pattern used for + auto-generated prefixes, causing register_namespace to raise ValueError. + Falls back to directly registering in the internal namespace map. + + :param str prefix: The namespace prefix to register. + :param str ns: The namespace URI. + """ + try: + ET.register_namespace(prefix, ns) + except ValueError: + _ns_map = getattr(ET, "_namespace_map", None) + if _ns_map is not None: + _ns_map[ns] = prefix + + +def _create_xml_element( + tag: typing.Any, prefix: typing.Optional[str] = None, ns: typing.Optional[str] = None +) -> ET.Element: + if prefix and ns: + _safe_register_namespace(prefix, ns) + if ns: + return ET.Element("{" + ns + "}" + tag) + return ET.Element(tag) + + +def _deserialize_xml( + deserializer: typing.Any, + value: str, +) -> typing.Any: + element = ET.fromstring(value) # nosec + if _is_model(deserializer): + return deserializer._deserialize(element, []) + return _deserialize(deserializer, element) + + +def _convert_element(e: ET.Element): + # dict case + if len(e.attrib) > 0 or len({child.tag for child in e}) > 1: + dict_result: dict[str, typing.Any] = {} + for child in e: + if dict_result.get(child.tag) is not None: + if isinstance(dict_result[child.tag], list): + dict_result[child.tag].append(_convert_element(child)) + else: + dict_result[child.tag] = [dict_result[child.tag], _convert_element(child)] + else: + dict_result[child.tag] = _convert_element(child) + dict_result.update(e.attrib) + return dict_result + # array case + if len(e) > 0: + array_result: list[typing.Any] = [] + for child in e: + array_result.append(_convert_element(child)) + return array_result + # primitive case + return e.text diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/serialization.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/serialization.py new file mode 100644 index 000000000000..75906e2eb77f --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/serialization.py @@ -0,0 +1,2175 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +# pyright: reportUnnecessaryTypeIgnoreComment=false + +from base64 import b64decode, b64encode +import calendar +import datetime +import decimal +import email +from enum import Enum +import json +import logging +import re +import sys +import codecs +from typing import ( + Any, + cast, + Optional, + Union, + AnyStr, + IO, + Mapping, + Callable, + MutableMapping, +) + +try: + from urllib import quote # type: ignore +except ImportError: + from urllib.parse import quote +import xml.etree.ElementTree as ET + +import isodate # type: ignore + +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull + +if sys.version_info >= (3, 11): + from typing import Self +else: + from typing_extensions import Self + +_BOM = codecs.BOM_UTF8.decode(encoding="utf-8") + +JSON = MutableMapping[str, Any] + + +class RawDeserializer: + + # Accept "text" because we're open minded people... + JSON_REGEXP = re.compile(r"^(application|text)/([a-z+.]+\+)?json$") + + # Name used in context + CONTEXT_NAME = "deserialized_data" + + @classmethod + def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: Optional[str] = None) -> Any: + """Decode data according to content-type. + + Accept a stream of data as well, but will be load at once in memory for now. + + If no content-type, will return the string version (not bytes, not stream) + + :param data: Input, could be bytes or stream (will be decoded with UTF8) or text + :type data: str or bytes or IO + :param str content_type: The content type. + :return: The deserialized data. + :rtype: object + """ + if hasattr(data, "read"): + # Assume a stream + data = cast(IO, data).read() + + if isinstance(data, bytes): + data_as_str = data.decode(encoding="utf-8-sig") + else: + # Explain to mypy the correct type. + data_as_str = cast(str, data) + + # Remove Byte Order Mark if present in string + data_as_str = data_as_str.lstrip(_BOM) + + if content_type is None: + return data + + if cls.JSON_REGEXP.match(content_type): + try: + return json.loads(data_as_str) + except ValueError as err: + raise DeserializationError("JSON is invalid: {}".format(err), err) from err + elif "xml" in (content_type or []): + try: + + try: + if isinstance(data, unicode): # type: ignore + # If I'm Python 2.7 and unicode XML will scream if I try a "fromstring" on unicode string + data_as_str = data_as_str.encode(encoding="utf-8") # type: ignore + except NameError: + pass + + return ET.fromstring(data_as_str) # nosec + except ET.ParseError as err: + # It might be because the server has an issue, and returned JSON with + # content-type XML.... + # So let's try a JSON load, and if it's still broken + # let's flow the initial exception + def _json_attemp(data): + try: + return True, json.loads(data) + except ValueError: + return False, None # Don't care about this one + + success, json_result = _json_attemp(data) + if success: + return json_result + # If i'm here, it's not JSON, it's not XML, let's scream + # and raise the last context in this block (the XML exception) + # The function hack is because Py2.7 messes up with exception + # context otherwise. + _LOGGER.critical("Wasn't XML not JSON, failing") + raise DeserializationError("XML is invalid") from err + elif content_type.startswith("text/"): + return data_as_str + raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) + + @classmethod + def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], headers: Mapping) -> Any: + """Deserialize from HTTP response. + + Use bytes and headers to NOT use any requests/aiohttp or whatever + specific implementation. + Headers will tested for "content-type" + + :param bytes body_bytes: The body of the response. + :param dict headers: The headers of the response. + :returns: The deserialized data. + :rtype: object + """ + # Try to use content-type from headers if available + content_type = None + if "content-type" in headers: + content_type = headers["content-type"].split(";")[0].strip().lower() + # Ouch, this server did not declare what it sent... + # Let's guess it's JSON... + # Also, since Autorest was considering that an empty body was a valid JSON, + # need that test as well.... + else: + content_type = "application/json" + + if body_bytes: + return cls.deserialize_from_text(body_bytes, content_type) + return None + + +_LOGGER = logging.getLogger(__name__) + +try: + _long_type = long # type: ignore +except NameError: + _long_type = int + +TZ_UTC = datetime.timezone.utc + +_FLATTEN = re.compile(r"(? None: + self.additional_properties: Optional[dict[str, Any]] = {} + for k in kwargs: # pylint: disable=consider-using-dict-items + if k not in self._attribute_map: + _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) + elif k in self._validation and self._validation[k].get("readonly", False): + _LOGGER.warning("Readonly attribute %s will be ignored in class %s", k, self.__class__) + else: + setattr(self, k, kwargs[k]) + + def __eq__(self, other: Any) -> bool: + """Compare objects by comparing all attributes. + + :param object other: The object to compare + :returns: True if objects are equal + :rtype: bool + """ + if isinstance(other, self.__class__): + return self.__dict__ == other.__dict__ + return False + + def __ne__(self, other: Any) -> bool: + """Compare objects by comparing all attributes. + + :param object other: The object to compare + :returns: True if objects are not equal + :rtype: bool + """ + return not self.__eq__(other) + + def __str__(self) -> str: + return str(self.__dict__) + + @classmethod + def enable_additional_properties_sending(cls) -> None: + cls._attribute_map["additional_properties"] = {"key": "", "type": "{object}"} + + @classmethod + def is_xml_model(cls) -> bool: + try: + cls._xml_map # type: ignore + except AttributeError: + return False + return True + + @classmethod + def _create_xml_node(cls): + """Create XML node. + + :returns: The XML node + :rtype: xml.etree.ElementTree.Element + """ + try: + xml_map = cls._xml_map # type: ignore + except AttributeError: + xml_map = {} + + return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) + + def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: + """Return the JSON that would be sent to server from this model. + + This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`. + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize( # type: ignore # pylint: disable=protected-access + self, keep_readonly=keep_readonly, **kwargs + ) + + def as_dict( + self, + keep_readonly: bool = True, + key_transformer: Callable[[str, dict[str, Any], Any], Any] = attribute_transformer, + **kwargs: Any + ) -> JSON: + """Return a dict that can be serialized using json.dump. + + Advanced usage might optionally use a callback as parameter: + + .. code::python + + def my_key_transformer(key, attr_desc, value): + return key + + Key is the attribute name used in Python. Attr_desc + is a dict of metadata. Currently contains 'type' with the + msrest type and 'key' with the RestAPI encoded key. + Value is the current value in this object. + + The string returned will be used to serialize the key. + If the return type is a list, this is considered hierarchical + result dict. + + See the three examples in this file: + + - attribute_transformer + - full_restapi_key_transformer + - last_restapi_key_transformer + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :param function key_transformer: A key transformer function. + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize( # type: ignore # pylint: disable=protected-access + self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs + ) + + @classmethod + def _infer_class_models(cls): + try: + str_models = cls.__module__.rsplit(".", 1)[0] + models = sys.modules[str_models] + client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} + if cls.__name__ not in client_models: + raise ValueError("Not Autorest generated code") + except Exception: # pylint: disable=broad-exception-caught + # Assume it's not Autorest generated (tests?). Add ourselves as dependencies. + client_models = {cls.__name__: cls} + return client_models + + @classmethod + def deserialize(cls, data: Any, content_type: Optional[str] = None) -> Self: + """Parse a str using the RestAPI syntax and return a model. + + :param str data: A str using RestAPI structure. JSON by default. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises DeserializationError: if something went wrong + :rtype: Self + """ + deserializer = Deserializer(cls._infer_class_models()) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def from_dict( + cls, + data: Any, + key_extractors: Optional[Callable[[str, dict[str, Any], Any], Any]] = None, + content_type: Optional[str] = None, + ) -> Self: + """Parse a dict using given key extractor return a model. + + By default consider key + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + and last_rest_key_case_insensitive_extractor) + + :param dict data: A dict using RestAPI structure + :param function key_extractors: A key extractor function. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises DeserializationError: if something went wrong + :rtype: Self + """ + deserializer = Deserializer(cls._infer_class_models()) + deserializer.key_extractors = ( # type: ignore + [ # type: ignore + attribute_key_case_insensitive_extractor, + rest_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + if key_extractors is None + else key_extractors + ) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def _flatten_subtype(cls, key, objects): + if "_subtype_map" not in cls.__dict__: + return {} + result = dict(cls._subtype_map[key]) + for valuetype in cls._subtype_map[key].values(): + result |= objects[valuetype]._flatten_subtype(key, objects) # pylint: disable=protected-access + return result + + @classmethod + def _classify(cls, response, objects): + """Check the class _subtype_map for any child classes. + We want to ignore any inherited _subtype_maps. + + :param dict response: The initial data + :param dict objects: The class objects + :returns: The class to be used + :rtype: class + """ + for subtype_key in cls.__dict__.get("_subtype_map", {}).keys(): + subtype_value = None + + if not isinstance(response, ET.Element): + rest_api_response_key = cls._get_rest_key_parts(subtype_key)[-1] + subtype_value = response.get(rest_api_response_key, None) or response.get(subtype_key, None) + else: + subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response) + if subtype_value: + # Try to match base class. Can be class name only + # (bug to fix in Autorest to support x-ms-discriminator-name) + if cls.__name__ == subtype_value: + return cls + flatten_mapping_type = cls._flatten_subtype(subtype_key, objects) + try: + return objects[flatten_mapping_type[subtype_value]] # type: ignore + except KeyError: + _LOGGER.warning( + "Subtype value %s has no mapping, use base class %s.", + subtype_value, + cls.__name__, + ) + break + else: + _LOGGER.warning("Discriminator %s is absent or null, use base class %s.", subtype_key, cls.__name__) + break + return cls + + @classmethod + def _get_rest_key_parts(cls, attr_key): + """Get the RestAPI key of this attr, split it and decode part + :param str attr_key: Attribute key must be in attribute_map. + :returns: A list of RestAPI part + :rtype: list + """ + rest_split_key = _FLATTEN.split(cls._attribute_map[attr_key]["key"]) + return [_decode_attribute_map_key(key_part) for key_part in rest_split_key] + + +def _decode_attribute_map_key(key): + """This decode a key in an _attribute_map to the actual key we want to look at + inside the received data. + + :param str key: A key string from the generated code + :returns: The decoded key + :rtype: str + """ + return key.replace("\\.", ".") + + +class Serializer: # pylint: disable=too-many-public-methods + """Request object model serializer.""" + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + _xml_basic_types_serializers = {"bool": lambda x: str(x).lower()} + days = {0: "Mon", 1: "Tue", 2: "Wed", 3: "Thu", 4: "Fri", 5: "Sat", 6: "Sun"} + months = { + 1: "Jan", + 2: "Feb", + 3: "Mar", + 4: "Apr", + 5: "May", + 6: "Jun", + 7: "Jul", + 8: "Aug", + 9: "Sep", + 10: "Oct", + 11: "Nov", + 12: "Dec", + } + validation = { + "min_length": lambda x, y: len(x) < y, + "max_length": lambda x, y: len(x) > y, + "minimum": lambda x, y: x < y, + "maximum": lambda x, y: x > y, + "minimum_ex": lambda x, y: x <= y, + "maximum_ex": lambda x, y: x >= y, + "min_items": lambda x, y: len(x) < y, + "max_items": lambda x, y: len(x) > y, + "pattern": lambda x, y: not re.match(y, x, re.UNICODE), + "unique": lambda x, y: len(x) != len(set(x)), + "multiple": lambda x, y: x % y != 0, + } + + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: + self.serialize_type = { + "iso-8601": Serializer.serialize_iso, + "rfc-1123": Serializer.serialize_rfc, + "unix-time": Serializer.serialize_unix, + "duration": Serializer.serialize_duration, + "duration-seconds-int": Serializer.serialize_duration_seconds_int, + "duration-seconds-float": Serializer.serialize_duration_seconds_float, + "duration-milliseconds-int": Serializer.serialize_duration_milliseconds_int, + "duration-milliseconds-float": Serializer.serialize_duration_milliseconds_float, + "date": Serializer.serialize_date, + "time": Serializer.serialize_time, + "decimal": Serializer.serialize_decimal, + "long": Serializer.serialize_long, + "bytearray": Serializer.serialize_bytearray, + "base64": Serializer.serialize_base64, + "object": self.serialize_object, + "[]": self.serialize_iter, + "{}": self.serialize_dict, + } + self.dependencies: dict[str, type] = dict(classes) if classes else {} + self.key_transformer = full_restapi_key_transformer + self.client_side_validation = True + + def _serialize( # pylint: disable=too-many-nested-blocks, too-many-branches, too-many-statements, too-many-locals + self, target_obj, data_type=None, **kwargs + ): + """Serialize data into a string according to type. + + :param object target_obj: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, dict + :raises SerializationError: if serialization fails. + :returns: The serialized data. + """ + key_transformer = kwargs.get("key_transformer", self.key_transformer) + keep_readonly = kwargs.get("keep_readonly", False) + if target_obj is None: + return None + + attr_name = None + class_name = target_obj.__class__.__name__ + + if data_type: + return self.serialize_data(target_obj, data_type, **kwargs) + + if not hasattr(target_obj, "_attribute_map"): + data_type = type(target_obj).__name__ + if data_type in self.basic_types.values(): + return self.serialize_data(target_obj, data_type, **kwargs) + + # Force "is_xml" kwargs if we detect a XML model + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + is_xml_model_serialization = kwargs.setdefault("is_xml", target_obj.is_xml_model()) + + serialized = {} + if is_xml_model_serialization: + serialized = target_obj._create_xml_node() # pylint: disable=protected-access + try: + attributes = target_obj._attribute_map # pylint: disable=protected-access + for attr, attr_desc in attributes.items(): + attr_name = attr + if not keep_readonly and target_obj._validation.get( # pylint: disable=protected-access + attr_name, {} + ).get("readonly", False): + continue + + if attr_name == "additional_properties" and attr_desc["key"] == "": + if target_obj.additional_properties is not None: + serialized |= target_obj.additional_properties + continue + try: + + orig_attr = getattr(target_obj, attr) + if is_xml_model_serialization: + pass # Don't provide "transformer" for XML for now. Keep "orig_attr" + else: # JSON + keys, orig_attr = key_transformer(attr, attr_desc.copy(), orig_attr) + keys = keys if isinstance(keys, list) else [keys] + + kwargs["serialization_ctxt"] = attr_desc + new_attr = self.serialize_data(orig_attr, attr_desc["type"], **kwargs) + + if is_xml_model_serialization: + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + xml_prefix = xml_desc.get("prefix", None) + xml_ns = xml_desc.get("ns", None) + if xml_desc.get("attr", False): + if xml_ns: + ET.register_namespace(xml_prefix, xml_ns) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + serialized.set(xml_name, new_attr) # type: ignore + continue + if xml_desc.get("text", False): + serialized.text = new_attr # type: ignore + continue + if isinstance(new_attr, list): + serialized.extend(new_attr) # type: ignore + elif isinstance(new_attr, ET.Element): + # If the down XML has no XML/Name, + # we MUST replace the tag with the local tag. But keeping the namespaces. + if "name" not in getattr(orig_attr, "_xml_map", {}): + splitted_tag = new_attr.tag.split("}") + if len(splitted_tag) == 2: # Namespace + new_attr.tag = "}".join([splitted_tag[0], xml_name]) + else: + new_attr.tag = xml_name + serialized.append(new_attr) # type: ignore + else: # That's a basic type + # Integrate namespace if necessary + local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) + local_node.text = str(new_attr) + serialized.append(local_node) # type: ignore + else: # JSON + for k in reversed(keys): # type: ignore + new_attr = {k: new_attr} + + _new_attr = new_attr + _serialized = serialized + for k in keys: # type: ignore + if k not in _serialized: + _serialized.update(_new_attr) # type: ignore + _new_attr = _new_attr[k] # type: ignore + _serialized = _serialized[k] + except ValueError as err: + if isinstance(err, SerializationError): + raise + + except (AttributeError, KeyError, TypeError) as err: + msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) + raise SerializationError(msg) from err + return serialized + + def body(self, data, data_type, **kwargs): + """Serialize data intended for a request body. + + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: dict + :raises SerializationError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized request body + """ + + # Just in case this is a dict + internal_data_type_str = data_type.strip("[]{}") + internal_data_type = self.dependencies.get(internal_data_type_str, None) + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + if internal_data_type and issubclass(internal_data_type, Model): + is_xml_model_serialization = kwargs.setdefault("is_xml", internal_data_type.is_xml_model()) + else: + is_xml_model_serialization = False + if internal_data_type and not isinstance(internal_data_type, Enum): + try: + deserializer = Deserializer(self.dependencies) + # Since it's on serialization, it's almost sure that format is not JSON REST + # We're not able to deal with additional properties for now. + deserializer.additional_properties_detection = False + if is_xml_model_serialization: + deserializer.key_extractors = [ # type: ignore + attribute_key_case_insensitive_extractor, + ] + else: + deserializer.key_extractors = [ + rest_key_case_insensitive_extractor, + attribute_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + data = deserializer._deserialize(data_type, data) # pylint: disable=protected-access + except DeserializationError as err: + raise SerializationError("Unable to build a model: " + str(err)) from err + + return self._serialize(data, data_type, **kwargs) + + def url(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL path. + + :param str name: The name of the URL path parameter. + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :returns: The serialized URL path + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + """ + try: + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + + if kwargs.get("skip_quote") is True: + output = str(output) + output = output.replace("{", quote("{")).replace("}", quote("}")) + else: + output = quote(str(output), safe="") + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return output + + def query(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL query. + + :param str name: The name of the query parameter. + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, list + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized query parameter + """ + try: + # Treat the list aside, since we don't want to encode the div separator + if data_type.startswith("["): + internal_data_type = data_type[1:-1] + do_quote = not kwargs.get("skip_quote", False) + return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs) + + # Not a list, regular serialization + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + if kwargs.get("skip_quote") is True: + output = str(output) + else: + output = quote(str(output), safe="") + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return str(output) + + def header(self, name, data, data_type, **kwargs): + """Serialize data intended for a request header. + + :param str name: The name of the header. + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized header + """ + try: + if data_type in ["[str]"]: + data = ["" if d is None else d for d in data] + + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return str(output) + + def serialize_data(self, data, data_type, **kwargs): + """Serialize generic data according to supplied data type. + + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :raises AttributeError: if required data is None. + :raises ValueError: if data is None + :raises SerializationError: if serialization fails. + :returns: The serialized data. + :rtype: str, int, float, bool, dict, list + """ + if data is None: + raise ValueError("No value for given attribute") + + try: + if data is CoreNull: + return None + if data_type in self.basic_types.values(): + return self.serialize_basic(data, data_type, **kwargs) + + if data_type in self.serialize_type: + return self.serialize_type[data_type](data, **kwargs) + + # If dependencies is empty, try with current data class + # It has to be a subclass of Enum anyway + enum_type = self.dependencies.get(data_type, cast(type, data.__class__)) + if issubclass(enum_type, Enum): + return Serializer.serialize_enum(data, enum_obj=enum_type) + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.serialize_type: + return self.serialize_type[iter_type](data, data_type[1:-1], **kwargs) + + except (ValueError, TypeError) as err: + msg = "Unable to serialize value: {!r} as type: {!r}." + raise SerializationError(msg.format(data, data_type)) from err + return self._serialize(data, **kwargs) + + @classmethod + def _get_custom_serializers(cls, data_type, **kwargs): # pylint: disable=inconsistent-return-statements + custom_serializer = kwargs.get("basic_types_serializers", {}).get(data_type) + if custom_serializer: + return custom_serializer + if kwargs.get("is_xml", False): + return cls._xml_basic_types_serializers.get(data_type) + + @classmethod + def serialize_basic(cls, data, data_type, **kwargs): + """Serialize basic builting data type. + Serializes objects to str, int, float or bool. + + Possible kwargs: + - basic_types_serializers dict[str, callable] : If set, use the callable as serializer + - is_xml bool : If set, use xml_basic_types_serializers + + :param obj data: Object to be serialized. + :param str data_type: Type of object in the iterable. + :rtype: str, int, float, bool + :return: serialized object + :raises TypeError: raise if data_type is not one of str, int, float, bool. + """ + custom_serializer = cls._get_custom_serializers(data_type, **kwargs) + if custom_serializer: + return custom_serializer(data) + if data_type == "str": + return cls.serialize_unicode(data) + if data_type == "int": + return int(data) + if data_type == "float": + return float(data) + if data_type == "bool": + return bool(data) + raise TypeError("Unknown basic data type: {}".format(data_type)) + + @classmethod + def serialize_unicode(cls, data): + """Special handling for serializing unicode strings in Py2. + Encode to UTF-8 if unicode, otherwise handle as a str. + + :param str data: Object to be serialized. + :rtype: str + :return: serialized object + """ + try: # If I received an enum, return its value + return data.value + except AttributeError: + pass + + try: + if isinstance(data, unicode): # type: ignore + # Don't change it, JSON and XML ElementTree are totally able + # to serialize correctly u'' strings + return data + except NameError: + return str(data) + return str(data) + + def serialize_iter(self, data, iter_type, div=None, **kwargs): + """Serialize iterable. + + Supported kwargs: + - serialization_ctxt dict : The current entry of _attribute_map, or same format. + serialization_ctxt['type'] should be same as data_type. + - is_xml bool : If set, serialize as XML + + :param list data: Object to be serialized. + :param str iter_type: Type of object in the iterable. + :param str div: If set, this str will be used to combine the elements + in the iterable into a combined string. Default is 'None'. + Defaults to False. + :rtype: list, str + :return: serialized iterable + """ + if isinstance(data, str): + raise SerializationError("Refuse str type as a valid iter type.") + + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + is_xml = kwargs.get("is_xml", False) + + serialized = [] + for d in data: + try: + serialized.append(self.serialize_data(d, iter_type, **kwargs)) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized.append(None) + + if kwargs.get("do_quote", False): + serialized = ["" if s is None else quote(str(s), safe="") for s in serialized] + + if div: + serialized = ["" if s is None else str(s) for s in serialized] + serialized = div.join(serialized) + + if "xml" in serialization_ctxt or is_xml: + # XML serialization is more complicated + xml_desc = serialization_ctxt.get("xml", {}) + xml_name = xml_desc.get("name") + if not xml_name: + xml_name = serialization_ctxt["key"] + + # Create a wrap node if necessary (use the fact that Element and list have "append") + is_wrapped = xml_desc.get("wrapped", False) + node_name = xml_desc.get("itemsName", xml_name) + if is_wrapped: + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + else: + final_result = [] + # All list elements to "local_node" + for el in serialized: + if isinstance(el, ET.Element): + el_node = el + else: + el_node = _create_xml_node(node_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + if el is not None: # Otherwise it writes "None" :-p + el_node.text = str(el) + final_result.append(el_node) + return final_result + return serialized + + def serialize_dict(self, attr, dict_type, **kwargs): + """Serialize a dictionary of objects. + + :param dict attr: Object to be serialized. + :param str dict_type: Type of object in the dictionary. + :rtype: dict + :return: serialized dictionary + """ + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized[self.serialize_unicode(key)] = None + + if "xml" in serialization_ctxt: + # XML serialization is more complicated + xml_desc = serialization_ctxt["xml"] + xml_name = xml_desc["name"] + + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + for key, value in serialized.items(): + ET.SubElement(final_result, key).text = value + return final_result + + return serialized + + def serialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements + """Serialize a generic object. + This will be handled as a dictionary. If object passed in is not + a basic type (str, int, float, dict, list) it will simply be + cast to str. + + :param dict attr: Object to be serialized. + :rtype: dict or str + :return: serialized object + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + return attr + obj_type = type(attr) + if obj_type in self.basic_types: + return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) + if obj_type is _long_type: + return self.serialize_long(attr) + if obj_type is str: + return self.serialize_unicode(attr) + if obj_type is datetime.datetime: + return self.serialize_iso(attr) + if obj_type is datetime.date: + return self.serialize_date(attr) + if obj_type is datetime.time: + return self.serialize_time(attr) + if obj_type is datetime.timedelta: + return self.serialize_duration(attr) + if obj_type is decimal.Decimal: + return self.serialize_decimal(attr) + + # If it's a model or I know this dependency, serialize as a Model + if obj_type in self.dependencies.values() or isinstance(attr, Model): + return self._serialize(attr) + + if obj_type == dict: + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_object(value, **kwargs) + except ValueError: + serialized[self.serialize_unicode(key)] = None + return serialized + + if obj_type == list: + serialized = [] + for obj in attr: + try: + serialized.append(self.serialize_object(obj, **kwargs)) + except ValueError: + pass + return serialized + return str(attr) + + @staticmethod + def serialize_enum(attr, enum_obj=None): + try: + result = attr.value + except AttributeError: + result = attr + try: + enum_obj(result) # type: ignore + return result + except ValueError as exc: + for enum_value in enum_obj: # type: ignore + if enum_value.value.lower() == str(attr).lower(): + return enum_value.value + error = "{!r} is not valid value for enum {!r}" + raise SerializationError(error.format(attr, enum_obj)) from exc + + @staticmethod + def serialize_bytearray(attr, **kwargs): # pylint: disable=unused-argument + """Serialize bytearray into base-64 string. + + :param str attr: Object to be serialized. + :rtype: str + :return: serialized base64 + """ + return b64encode(attr).decode() + + @staticmethod + def serialize_base64(attr, **kwargs): # pylint: disable=unused-argument + """Serialize str into base-64 string. + + :param str attr: Object to be serialized. + :rtype: str + :return: serialized base64 + """ + encoded = b64encode(attr).decode("ascii") + return encoded.strip("=").replace("+", "-").replace("/", "_") + + @staticmethod + def serialize_decimal(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Decimal object to float. + + :param decimal attr: Object to be serialized. + :rtype: float + :return: serialized decimal + """ + return float(attr) + + @staticmethod + def serialize_long(attr, **kwargs): # pylint: disable=unused-argument + """Serialize long (Py2) or int (Py3). + + :param int attr: Object to be serialized. + :rtype: int/long + :return: serialized long + """ + return _long_type(attr) + + @staticmethod + def serialize_date(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Date object into ISO-8601 formatted string. + + :param Date attr: Object to be serialized. + :rtype: str + :return: serialized date + """ + if isinstance(attr, str): + attr = isodate.parse_date(attr) + t = "{:04}-{:02}-{:02}".format(attr.year, attr.month, attr.day) + return t + + @staticmethod + def serialize_time(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Time object into ISO-8601 formatted string. + + :param datetime.time attr: Object to be serialized. + :rtype: str + :return: serialized time + """ + if isinstance(attr, str): + attr = isodate.parse_time(attr) + t = "{:02}:{:02}:{:02}".format(attr.hour, attr.minute, attr.second) + if attr.microsecond: + t += ".{:02}".format(attr.microsecond) + return t + + @staticmethod + def serialize_duration(attr, **kwargs): # pylint: disable=unused-argument + """Serialize TimeDelta object into ISO-8601 formatted string. + + :param TimeDelta attr: Object to be serialized. + :rtype: str + :return: serialized duration + """ + if isinstance(attr, str): + attr = isodate.parse_duration(attr) + return isodate.duration_isoformat(attr) + + @staticmethod + def _serialize_duration_numeric(attr, scale, as_int): + """Serialize a TimeDelta into a numeric value scaled to the wire unit. + + :param TimeDelta attr: Object to be serialized. + :param int scale: Multiplier applied to total seconds (1 for seconds, 1000 for milliseconds). + :param bool as_int: Whether to truncate the result to an int. + :rtype: int or float + :return: serialized duration + """ + if isinstance(attr, str): + attr = isodate.parse_duration(attr) + value = attr.total_seconds() * scale if isinstance(attr, datetime.timedelta) else attr + return int(value) if as_int else float(value) + + @staticmethod + def serialize_duration_seconds_int(attr, **kwargs): # pylint: disable=unused-argument + """Serialize TimeDelta object into an integer number of seconds. + + :param TimeDelta attr: Object to be serialized. + :rtype: int + :return: serialized duration + """ + return Serializer._serialize_duration_numeric(attr, 1, True) + + @staticmethod + def serialize_duration_seconds_float(attr, **kwargs): # pylint: disable=unused-argument + """Serialize TimeDelta object into a floating point number of seconds. + + :param TimeDelta attr: Object to be serialized. + :rtype: float + :return: serialized duration + """ + return Serializer._serialize_duration_numeric(attr, 1, False) + + @staticmethod + def serialize_duration_milliseconds_int(attr, **kwargs): # pylint: disable=unused-argument + """Serialize TimeDelta object into an integer number of milliseconds. + + :param TimeDelta attr: Object to be serialized. + :rtype: int + :return: serialized duration + """ + return Serializer._serialize_duration_numeric(attr, 1000, True) + + @staticmethod + def serialize_duration_milliseconds_float(attr, **kwargs): # pylint: disable=unused-argument + """Serialize TimeDelta object into a floating point number of milliseconds. + + :param TimeDelta attr: Object to be serialized. + :rtype: float + :return: serialized duration + """ + return Serializer._serialize_duration_numeric(attr, 1000, False) + + @staticmethod + def serialize_rfc(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Datetime object into RFC-1123 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises TypeError: if format invalid. + :return: serialized rfc + """ + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + except AttributeError as exc: + raise TypeError("RFC1123 object must be valid Datetime object.") from exc + + return "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT".format( + Serializer.days[utc.tm_wday], + utc.tm_mday, + Serializer.months[utc.tm_mon], + utc.tm_year, + utc.tm_hour, + utc.tm_min, + utc.tm_sec, + ) + + @staticmethod + def serialize_iso(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Datetime object into ISO-8601 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises SerializationError: if format invalid. + :return: serialized iso + """ + if isinstance(attr, str): + attr = isodate.parse_datetime(attr) + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + if utc.tm_year > 9999 or utc.tm_year < 1: + raise OverflowError("Hit max or min date") + + microseconds = str(attr.microsecond).rjust(6, "0").rstrip("0").ljust(3, "0") + if microseconds: + microseconds = "." + microseconds + date = "{:04}-{:02}-{:02}T{:02}:{:02}:{:02}".format( + utc.tm_year, utc.tm_mon, utc.tm_mday, utc.tm_hour, utc.tm_min, utc.tm_sec + ) + return date + microseconds + "Z" + except (ValueError, OverflowError) as err: + msg = "Unable to serialize datetime object." + raise SerializationError(msg) from err + except AttributeError as err: + msg = "ISO-8601 object must be valid Datetime object." + raise TypeError(msg) from err + + @staticmethod + def serialize_unix(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param Datetime attr: Object to be serialized. + :rtype: int + :raises SerializationError: if format invalid + :return: serialied unix + """ + if isinstance(attr, int): + return attr + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + return int(calendar.timegm(attr.utctimetuple())) + except AttributeError as exc: + raise TypeError("Unix time object must be valid Datetime object.") from exc + + +def rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + key = attr_desc["key"] + working_data = data + + while "." in key: + # Need the cast, as for some reasons "split" is typed as list[str | Any] + dict_keys = cast(list[str], _FLATTEN.split(key)) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = working_data.get(working_key, data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + return working_data.get(key) + + +def rest_key_case_insensitive_extractor( # pylint: disable=unused-argument, inconsistent-return-statements + attr, attr_desc, data +): + key = attr_desc["key"] + working_data = data + + while "." in key: + dict_keys = _FLATTEN.split(key) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = attribute_key_case_insensitive_extractor(working_key, None, working_data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + if working_data: + return attribute_key_case_insensitive_extractor(key, None, working_data) + + +def last_rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + """Extract the attribute in "data" based on the last part of the JSON path key. + + :param str attr: The attribute to extract + :param dict attr_desc: The attribute description + :param dict data: The data to extract from + :rtype: object + :returns: The extracted attribute + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_extractor(dict_keys[-1], None, data) + + +def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + """Extract the attribute in "data" based on the last part of the JSON path key. + + This is the case insensitive version of "last_rest_key_extractor" + :param str attr: The attribute to extract + :param dict attr_desc: The attribute description + :param dict data: The data to extract from + :rtype: object + :returns: The extracted attribute + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_case_insensitive_extractor(dict_keys[-1], None, data) + + +def attribute_key_extractor(attr, _, data): + return data.get(attr) + + +def attribute_key_case_insensitive_extractor(attr, _, data): + found_key = None + lower_attr = attr.lower() + for key in data: + if lower_attr == key.lower(): + found_key = key + break + + return data.get(found_key) + + +def _extract_name_from_internal_type(internal_type): + """Given an internal type XML description, extract correct XML name with namespace. + + :param dict internal_type: An model type + :rtype: tuple + :returns: A tuple XML name + namespace dict + """ + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + xml_name = internal_type_xml_map.get("name", internal_type.__name__) + xml_ns = internal_type_xml_map.get("ns", None) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + return xml_name + + +def xml_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument,too-many-return-statements + if isinstance(data, dict): + return None + + # Test if this model is XML ready first + if not isinstance(data, ET.Element): + return None + + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + + # Look for a children + is_iter_type = attr_desc["type"].startswith("[") + is_wrapped = xml_desc.get("wrapped", False) + internal_type = attr_desc.get("internalType", None) + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + + # Integrate namespace if necessary + xml_ns = xml_desc.get("ns", internal_type_xml_map.get("ns", None)) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + + # If it's an attribute, that's simple + if xml_desc.get("attr", False): + return data.get(xml_name) + + # If it's x-ms-text, that's simple too + if xml_desc.get("text", False): + return data.text + + # Scenario where I take the local name: + # - Wrapped node + # - Internal type is an enum (considered basic types) + # - Internal type has no XML/Name node + if is_wrapped or (internal_type and (issubclass(internal_type, Enum) or "name" not in internal_type_xml_map)): + children = data.findall(xml_name) + # If internal type has a local name and it's not a list, I use that name + elif not is_iter_type and internal_type and "name" in internal_type_xml_map: + xml_name = _extract_name_from_internal_type(internal_type) + children = data.findall(xml_name) + # That's an array + else: + if internal_type: # Complex type, ignore itemsName and use the complex type name + items_name = _extract_name_from_internal_type(internal_type) + else: + items_name = xml_desc.get("itemsName", xml_name) + children = data.findall(items_name) + + if len(children) == 0: + if is_iter_type: + if is_wrapped: + return None # is_wrapped no node, we want None + return [] # not wrapped, assume empty list + return None # Assume it's not there, maybe an optional node. + + # If is_iter_type and not wrapped, return all found children + if is_iter_type: + if not is_wrapped: + return children + # Iter and wrapped, should have found one node only (the wrap one) + if len(children) != 1: + raise DeserializationError( + "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format( + xml_name + ) + ) + return list(children[0]) # Might be empty list and that's ok. + + # Here it's not a itertype, we should have found one element only or empty + if len(children) > 1: + raise DeserializationError("Find several XML '{}' where it was not expected".format(xml_name)) + return children[0] + + +class Deserializer: + """Response object model deserializer. + + :param dict classes: Class type dictionary for deserializing complex types. + :ivar list key_extractors: Ordered list of extractors to be used by this deserializer. + """ + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") + + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: + self.deserialize_type = { + "iso-8601": Deserializer.deserialize_iso, + "rfc-1123": Deserializer.deserialize_rfc, + "unix-time": Deserializer.deserialize_unix, + "duration": Deserializer.deserialize_duration, + "duration-seconds-int": Deserializer.deserialize_duration_seconds, + "duration-seconds-float": Deserializer.deserialize_duration_seconds, + "duration-milliseconds-int": Deserializer.deserialize_duration_milliseconds, + "duration-milliseconds-float": Deserializer.deserialize_duration_milliseconds, + "date": Deserializer.deserialize_date, + "time": Deserializer.deserialize_time, + "decimal": Deserializer.deserialize_decimal, + "long": Deserializer.deserialize_long, + "bytearray": Deserializer.deserialize_bytearray, + "base64": Deserializer.deserialize_base64, + "object": self.deserialize_object, + "[]": self.deserialize_iter, + "{}": self.deserialize_dict, + } + self.deserialize_expected_types = { + "duration": (isodate.Duration, datetime.timedelta), + "duration-seconds-int": (isodate.Duration, datetime.timedelta), + "duration-seconds-float": (isodate.Duration, datetime.timedelta), + "duration-milliseconds-int": (isodate.Duration, datetime.timedelta), + "duration-milliseconds-float": (isodate.Duration, datetime.timedelta), + "iso-8601": (datetime.datetime), + } + self.dependencies: dict[str, type] = dict(classes) if classes else {} + self.key_extractors = [rest_key_extractor, xml_key_extractor] + # Additional properties only works if the "rest_key_extractor" is used to + # extract the keys. Making it to work whatever the key extractor is too much + # complicated, with no real scenario for now. + # So adding a flag to disable additional properties detection. This flag should be + # used if your expect the deserialization to NOT come from a JSON REST syntax. + # Otherwise, result are unexpected + self.additional_properties_detection = True + + def __call__(self, target_obj, response_data, content_type=None): # pylint: disable=too-many-return-statements + """Call the deserializer to process a REST response. + + :param str target_obj: Target data type to deserialize to. + :param requests.Response response_data: REST response object. + :param str content_type: Swagger "produces" if available. + :raises DeserializationError: if deserialization fails. + :return: Deserialized object. + :rtype: object + """ + # Fast path for header deserialization: response_data is a plain str or None + # and target_obj is a simple scalar type. This avoids the expensive + # _unpack_content → _deserialize → _classify_target → deserialize_data chain. + if response_data is None: + return None + if target_obj == "str" and isinstance(response_data, str): + return response_data + if isinstance(response_data, str): + if target_obj == "int": + return int(response_data) + if target_obj == "bool": + if response_data in ("true", "1", "True"): + return True + if response_data in ("false", "0", "False"): + return False + return bool(response_data) + if target_obj == "rfc-1123": + return Deserializer.deserialize_rfc(response_data) + if target_obj == "bytearray": + return Deserializer.deserialize_bytearray(response_data) + + data = self._unpack_content(response_data, content_type) + return self._deserialize(target_obj, data) + + def _deserialize(self, target_obj, data): # pylint: disable=inconsistent-return-statements + """Call the deserializer on a model. + + Data needs to be already deserialized as JSON or XML ElementTree + + :param str target_obj: Target data type to deserialize to. + :param object data: Object to deserialize. + :raises DeserializationError: if deserialization fails. + :return: Deserialized object. + :rtype: object + """ + # This is already a model, go recursive just in case + if hasattr(data, "_attribute_map"): + constants = [name for name, config in getattr(data, "_validation", {}).items() if config.get("constant")] + try: + for attr, mapconfig in data._attribute_map.items(): # pylint: disable=protected-access + if attr in constants: + continue + value = getattr(data, attr) + if value is None: + continue + local_type = mapconfig["type"] + internal_data_type = local_type.strip("[]{}") + if internal_data_type not in self.dependencies or isinstance(internal_data_type, Enum): + continue + setattr(data, attr, self._deserialize(local_type, value)) + return data + except AttributeError: + return + + response, class_name = self._classify_target(target_obj, data) + + if isinstance(response, str): + return self.deserialize_data(data, response) + if isinstance(response, type) and issubclass(response, Enum): + return self.deserialize_enum(data, response) + + if data is None or data is CoreNull: + return data + try: + attributes = response._attribute_map # type: ignore # pylint: disable=protected-access + d_attrs = {} + for attr, attr_desc in attributes.items(): + # Check empty string. If it's not empty, someone has a real "additionalProperties"... + if attr == "additional_properties" and attr_desc["key"] == "": + continue + raw_value = None + # Enhance attr_desc with some dynamic data + attr_desc = attr_desc.copy() # Do a copy, do not change the real one + internal_data_type = attr_desc["type"].strip("[]{}") + if internal_data_type in self.dependencies: + attr_desc["internalType"] = self.dependencies[internal_data_type] + + for key_extractor in self.key_extractors: + found_value = key_extractor(attr, attr_desc, data) + if found_value is not None: + if raw_value is not None and raw_value != found_value: + msg = ( + "Ignoring extracted value '%s' from %s for key '%s'" + " (duplicate extraction, follow extractors order)" + ) + _LOGGER.warning(msg, found_value, key_extractor, attr) + continue + raw_value = found_value + + value = self.deserialize_data(raw_value, attr_desc["type"]) + d_attrs[attr] = value + except (AttributeError, TypeError, KeyError) as err: + msg = "Unable to deserialize to object: " + class_name # type: ignore + raise DeserializationError(msg) from err + additional_properties = self._build_additional_properties(attributes, data) + return self._instantiate_model(response, d_attrs, additional_properties) + + def _build_additional_properties(self, attribute_map, data): + if not self.additional_properties_detection: + return None + if "additional_properties" in attribute_map and attribute_map.get("additional_properties", {}).get("key") != "": + # Check empty string. If it's not empty, someone has a real "additionalProperties" + return None + if isinstance(data, ET.Element): + data = {el.tag: el.text for el in data} + + known_keys = { + _decode_attribute_map_key(_FLATTEN.split(desc["key"])[0]) + for desc in attribute_map.values() + if desc["key"] != "" + } + present_keys = set(data.keys()) + missing_keys = present_keys - known_keys + return {key: data[key] for key in missing_keys} + + def _classify_target(self, target, data): + """Check to see whether the deserialization target object can + be classified into a subclass. + Once classification has been determined, initialize object. + + :param str target: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :return: The classified target object and its class name. + :rtype: tuple + """ + if target is None: + return None, None + + if isinstance(target, str): + try: + target = self.dependencies[target] + except KeyError: + return target, target + + try: + target = target._classify(data, self.dependencies) # type: ignore # pylint: disable=protected-access + except AttributeError: + pass # Target is not a Model, no classify + return target, target.__class__.__name__ # type: ignore + + def failsafe_deserialize(self, target_obj, data, content_type=None): + """Ignores any errors encountered in deserialization, + and falls back to not deserializing the object. Recommended + for use in error deserialization, as we want to return the + HttpResponseError to users, and not have them deal with + a deserialization error. + + :param str target_obj: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :param str content_type: Swagger "produces" if available. + :return: Deserialized object. + :rtype: object + """ + try: + return self(target_obj, data, content_type=content_type) + except: # pylint: disable=bare-except + _LOGGER.debug( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + @staticmethod + def _unpack_content(raw_data, content_type=None): + """Extract the correct structure for deserialization. + + If raw_data is a PipelineResponse, try to extract the result of RawDeserializer. + if we can't, raise. Your Pipeline should have a RawDeserializer. + + If not a pipeline response and raw_data is bytes or string, use content-type + to decode it. If no content-type, try JSON. + + If raw_data is something else, bypass all logic and return it directly. + + :param obj raw_data: Data to be processed. + :param str content_type: How to parse if raw_data is a string/bytes. + :raises JSONDecodeError: If JSON is requested and parsing is impossible. + :raises UnicodeDecodeError: If bytes is not UTF8 + :rtype: object + :return: Unpacked content. + """ + # Assume this is enough to detect a Pipeline Response without importing it + context = getattr(raw_data, "context", {}) + if context: + if RawDeserializer.CONTEXT_NAME in context: + return context[RawDeserializer.CONTEXT_NAME] + raise ValueError("This pipeline didn't have the RawDeserializer policy; can't deserialize") + + # Assume this is enough to recognize universal_http.ClientResponse without importing it + if hasattr(raw_data, "body"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text(), raw_data.headers) + + # Assume this enough to recognize requests.Response without importing it. + if hasattr(raw_data, "_content_consumed"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) + + if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"): + return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore + return raw_data + + def _instantiate_model(self, response, attrs, additional_properties=None): + """Instantiate a response model passing in deserialized args. + + :param Response response: The response model class. + :param dict attrs: The deserialized response attributes. + :param dict additional_properties: Additional properties to be set. + :rtype: Response + :return: The instantiated response model. + """ + if callable(response): + subtype = getattr(response, "_subtype_map", {}) + try: + readonly = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + if v.get("readonly") + ] + const = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + if v.get("constant") + ] + kwargs = {k: v for k, v in attrs.items() if k not in subtype and k not in readonly + const} + response_obj = response(**kwargs) + for attr in readonly: + setattr(response_obj, attr, attrs.get(attr)) + if additional_properties: + response_obj.additional_properties = additional_properties # type: ignore + return response_obj + except TypeError as err: + msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore + raise DeserializationError(msg + str(err)) from err + else: + try: + for attr, value in attrs.items(): + setattr(response, attr, value) + return response + except Exception as exp: + msg = "Unable to populate response model. " + msg += "Type: {}, Error: {}".format(type(response), exp) + raise DeserializationError(msg) from exp + + def deserialize_data(self, data, data_type): # pylint: disable=too-many-return-statements + """Process data for deserialization according to data type. + + :param str data: The response string to be deserialized. + :param str data_type: The type to deserialize to. + :raises DeserializationError: if deserialization fails. + :return: Deserialized object. + :rtype: object + """ + if data is None: + return data + + try: + if not data_type: + return data + if data_type in self.basic_types.values(): + return self.deserialize_basic(data, data_type) + if data_type in self.deserialize_type: + if isinstance(data, self.deserialize_expected_types.get(data_type, tuple())): + return data + + is_a_text_parsing_type = lambda x: x not in [ # pylint: disable=unnecessary-lambda-assignment + "object", + "[]", + r"{}", + ] + if isinstance(data, ET.Element) and is_a_text_parsing_type(data_type) and not data.text: + return None + data_val = self.deserialize_type[data_type](data) + return data_val + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.deserialize_type: + return self.deserialize_type[iter_type](data, data_type[1:-1]) + + obj_type = self.dependencies[data_type] + if issubclass(obj_type, Enum): + if isinstance(data, ET.Element): + data = data.text + return self.deserialize_enum(data, obj_type) + + except (ValueError, TypeError, AttributeError) as err: + msg = "Unable to deserialize response data." + msg += " Data: {}, {}".format(data, data_type) + raise DeserializationError(msg) from err + return self._deserialize(obj_type, data) + + def deserialize_iter(self, attr, iter_type): + """Deserialize an iterable. + + :param list attr: Iterable to be deserialized. + :param str iter_type: The type of object in the iterable. + :return: Deserialized iterable. + :rtype: list + """ + if attr is None: + return None + if isinstance(attr, ET.Element): # If I receive an element here, get the children + attr = list(attr) + if not isinstance(attr, (list, set)): + raise DeserializationError("Cannot deserialize as [{}] an object of type {}".format(iter_type, type(attr))) + return [self.deserialize_data(a, iter_type) for a in attr] + + def deserialize_dict(self, attr, dict_type): + """Deserialize a dictionary. + + :param dict/list attr: Dictionary to be deserialized. Also accepts + a list of key, value pairs. + :param str dict_type: The object type of the items in the dictionary. + :return: Deserialized dictionary. + :rtype: dict + """ + if isinstance(attr, list): + return {x["key"]: self.deserialize_data(x["value"], dict_type) for x in attr} + + if isinstance(attr, ET.Element): + # Transform value into {"Key": "value"} + attr = {el.tag: el.text for el in attr} + return {k: self.deserialize_data(v, dict_type) for k, v in attr.items()} + + def deserialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements + """Deserialize a generic object. + This will be handled as a dictionary. + + :param dict attr: Dictionary to be deserialized. + :return: Deserialized object. + :rtype: dict + :raises TypeError: if non-builtin datatype encountered. + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + # Do no recurse on XML, just return the tree as-is + return attr + if isinstance(attr, str): + return self.deserialize_basic(attr, "str") + obj_type = type(attr) + if obj_type in self.basic_types: + return self.deserialize_basic(attr, self.basic_types[obj_type]) + if obj_type is _long_type: + return self.deserialize_long(attr) + + if obj_type == dict: + deserialized = {} + for key, value in attr.items(): + try: + deserialized[key] = self.deserialize_object(value, **kwargs) + except ValueError: + deserialized[key] = None + return deserialized + + if obj_type == list: + deserialized = [] + for obj in attr: + try: + deserialized.append(self.deserialize_object(obj, **kwargs)) + except ValueError: + pass + return deserialized + + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) + + def deserialize_basic(self, attr, data_type): # pylint: disable=too-many-return-statements + """Deserialize basic builtin data type from string. + Will attempt to convert to str, int, float and bool. + This function will also accept '1', '0', 'true' and 'false' as + valid bool values. + + :param str attr: response string to be deserialized. + :param str data_type: deserialization data type. + :return: Deserialized basic type. + :rtype: str, int, float or bool + :raises TypeError: if string format is not valid or data_type is not one of str, int, float, bool. + """ + # If we're here, data is supposed to be a basic type. + # If it's still an XML node, take the text + if isinstance(attr, ET.Element): + attr = attr.text + if not attr: + if data_type == "str": + # None or '', node is empty string. + return "" + # None or '', node with a strong type is None. + # Don't try to model "empty bool" or "empty int" + return None + + if data_type == "bool": + if attr in [True, False, 1, 0]: + return bool(attr) + if isinstance(attr, str): + if attr.lower() in ["true", "1"]: + return True + if attr.lower() in ["false", "0"]: + return False + raise TypeError("Invalid boolean value: {}".format(attr)) + + if data_type == "str": + return self.deserialize_unicode(attr) + if data_type == "int": + return int(attr) + if data_type == "float": + return float(attr) + raise TypeError("Unknown basic data type: {}".format(data_type)) + + @staticmethod + def deserialize_unicode(data): + """Preserve unicode objects in Python 2, otherwise return data + as a string. + + :param str data: response string to be deserialized. + :return: Deserialized string. + :rtype: str or unicode + """ + # We might be here because we have an enum modeled as string, + # and we try to deserialize a partial dict with enum inside + if isinstance(data, Enum): + return data + + # Consider this is real string + try: + if isinstance(data, unicode): # type: ignore + return data + except NameError: + return str(data) + return str(data) + + @staticmethod + def deserialize_enum(data, enum_obj): + """Deserialize string into enum object. + + If the string is not a valid enum value it will be returned as-is + and a warning will be logged. + + :param str data: Response string to be deserialized. If this value is + None or invalid it will be returned as-is. + :param Enum enum_obj: Enum object to deserialize to. + :return: Deserialized enum object. + :rtype: Enum + """ + if isinstance(data, enum_obj) or data is None: + return data + if isinstance(data, Enum): + data = data.value + if isinstance(data, int): + # Workaround. We might consider remove it in the future. + try: + return list(enum_obj.__members__.values())[data] + except IndexError as exc: + error = "{!r} is not a valid index for enum {!r}" + raise DeserializationError(error.format(data, enum_obj)) from exc + try: + return enum_obj(str(data)) + except ValueError: + for enum_value in enum_obj: + if enum_value.value.lower() == str(data).lower(): + return enum_value + # We don't fail anymore for unknown value, we deserialize as a string + _LOGGER.warning("Deserializer is not able to find %s as valid enum in %s", data, enum_obj) + return Deserializer.deserialize_unicode(data) + + @staticmethod + def deserialize_bytearray(attr): + """Deserialize string into bytearray. + + :param str attr: response string to be deserialized. + :return: Deserialized bytearray + :rtype: bytearray + :raises TypeError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return bytearray(b64decode(attr)) # type: ignore + + @staticmethod + def deserialize_base64(attr): + """Deserialize base64 encoded string into string. + + :param str attr: response string to be deserialized. + :return: Deserialized base64 string + :rtype: bytearray + :raises TypeError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return b64decode(encoded) + + @staticmethod + def deserialize_decimal(attr): + """Deserialize string into Decimal object. + + :param str attr: response string to be deserialized. + :return: Deserialized decimal + :raises DeserializationError: if string format invalid. + :rtype: decimal + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + return decimal.Decimal(str(attr)) # type: ignore + except decimal.DecimalException as err: + msg = "Invalid decimal {}".format(attr) + raise DeserializationError(msg) from err + + @staticmethod + def deserialize_long(attr): + """Deserialize string into long (Py2) or int (Py3). + + :param str attr: response string to be deserialized. + :return: Deserialized int + :rtype: long or int + :raises ValueError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return _long_type(attr) # type: ignore + + @staticmethod + def deserialize_duration(attr): + """Deserialize ISO-8601 formatted string into TimeDelta object. + + :param str attr: response string to be deserialized. + :return: Deserialized duration + :rtype: TimeDelta + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + duration = isodate.parse_duration(attr) + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize duration object." + raise DeserializationError(msg) from err + return duration + + @staticmethod + def _deserialize_duration_numeric(attr, unit): + """Deserialize a numeric duration value into a TimeDelta object. + + :param float attr: response value to be deserialized. + :param str unit: The wire unit, used as the ``timedelta`` keyword + (``"seconds"`` or ``"milliseconds"``). + :return: Deserialized duration + :rtype: TimeDelta + :raises DeserializationError: if value is invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + duration = datetime.timedelta(**{unit: float(attr)}) # type: ignore + except (ValueError, OverflowError, TypeError) as err: + msg = "Cannot deserialize duration object." + raise DeserializationError(msg) from err + return duration + + @staticmethod + def deserialize_duration_seconds(attr): + """Deserialize a numeric number of seconds into a TimeDelta object. + + :param float attr: response value to be deserialized. + :return: Deserialized duration + :rtype: TimeDelta + :raises DeserializationError: if value is invalid. + """ + return Deserializer._deserialize_duration_numeric(attr, "seconds") + + @staticmethod + def deserialize_duration_milliseconds(attr): + """Deserialize a numeric number of milliseconds into a TimeDelta object. + + :param float attr: response value to be deserialized. + :return: Deserialized duration + :rtype: TimeDelta + :raises DeserializationError: if value is invalid. + """ + return Deserializer._deserialize_duration_numeric(attr, "milliseconds") + + @staticmethod + def deserialize_date(attr): + """Deserialize ISO-8601 formatted string into Date object. + + :param str attr: response string to be deserialized. + :return: Deserialized date + :rtype: Date + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + return isodate.parse_date(attr, defaultmonth=0, defaultday=0) + + @staticmethod + def deserialize_time(attr): + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :return: Deserialized time + :rtype: datetime.time + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + return isodate.parse_time(attr) + + @staticmethod + def deserialize_rfc(attr): + """Deserialize RFC-1123 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :return: Deserialized RFC datetime + :rtype: Datetime + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + parsed_date = email.utils.parsedate_tz(attr) # type: ignore + date_obj = datetime.datetime( + *parsed_date[:6], tzinfo=datetime.timezone(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60)) + ) + if not date_obj.tzinfo: + date_obj = date_obj.astimezone(tz=TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to rfc datetime object." + raise DeserializationError(msg) from err + return date_obj + + @staticmethod + def deserialize_iso(attr): + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :return: Deserialized ISO datetime + :rtype: Datetime + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + attr = attr.upper() # type: ignore + match = Deserializer.valid_date.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize datetime object." + raise DeserializationError(msg) from err + return date_obj + + @staticmethod + def deserialize_unix(attr): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param int attr: Object to be serialized. + :return: Deserialized datetime + :rtype: Datetime + :raises DeserializationError: if format invalid + """ + if isinstance(attr, ET.Element): + attr = int(attr.text) # type: ignore + try: + attr = int(attr) + date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to unix datetime object." + raise DeserializationError(msg) from err + return date_obj diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/utils.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/utils.py new file mode 100644 index 000000000000..927adb7c8ae2 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/utils.py @@ -0,0 +1,57 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from abc import ABC +from typing import Generic, Optional, TYPE_CHECKING, TypeVar + +from azure.core import MatchConditions + +if TYPE_CHECKING: + from .serialization import Deserializer, Serializer + + +TClient = TypeVar("TClient") +TConfig = TypeVar("TConfig") + + +class ClientMixinABC(ABC, Generic[TClient, TConfig]): + """DO NOT use this class. It is for internal typing use only.""" + + _client: TClient + _config: TConfig + _serialize: "Serializer" + _deserialize: "Deserializer" + + +def quote_etag(etag: Optional[str]) -> Optional[str]: + if not etag or etag == "*": + return etag + if etag.startswith("W/"): + return etag + if etag.startswith('"') and etag.endswith('"'): + return etag + if etag.startswith("'") and etag.endswith("'"): + return etag + return '"' + etag + '"' + + +def prep_if_match(etag: Optional[str], match_condition: Optional[MatchConditions]) -> Optional[str]: + if match_condition == MatchConditions.IfNotModified: + if_match = quote_etag(etag) if etag else None + return if_match + if match_condition == MatchConditions.IfPresent: + return "*" + return None + + +def prep_if_none_match(etag: Optional[str], match_condition: Optional[MatchConditions]) -> Optional[str]: + if match_condition == MatchConditions.IfModified: + if_none_match = quote_etag(etag) if etag else None + return if_none_match + if match_condition == MatchConditions.IfMissing: + return "*" + return None diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_version.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_version.py new file mode 100644 index 000000000000..be71c81bd282 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_version.py @@ -0,0 +1,9 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +VERSION = "1.0.0b1" diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/__init__.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/__init__.py new file mode 100644 index 000000000000..3b3441429572 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/__init__.py @@ -0,0 +1,29 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._client import WebPubSubChatServiceClient # type: ignore + +try: + from ._patch import __all__ as _patch_all + from ._patch import * +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "WebPubSubChatServiceClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore + +_patch_sdk() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_client.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_client.py new file mode 100644 index 000000000000..2f3347e5fecb --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_client.py @@ -0,0 +1,112 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +import sys +from typing import Any, Awaitable, TYPE_CHECKING + +from azure.core import AsyncPipelineClient +from azure.core.pipeline import policies +from azure.core.rest import AsyncHttpResponse, HttpRequest + +from .._utils.serialization import Deserializer, Serializer +from ._configuration import WebPubSubChatServiceClientConfiguration +from ._operations import _WebPubSubChatServiceClientOperationsMixin + +if sys.version_info >= (3, 11): + from typing import Self +else: + from typing_extensions import Self # type: ignore + +if TYPE_CHECKING: + from azure.core.credentials_async import AsyncTokenCredential + + +class WebPubSubChatServiceClient(_WebPubSubChatServiceClientOperationsMixin): + """WebPubSubChatServiceClient. + + :param endpoint: HTTP or HTTPS endpoint for the Web PubSub service instance. Required. + :type endpoint: str + :param credential: Credential used to authenticate requests to the service. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential + :param hub: Target hub name, which should start with alphabetic characters and only contain + alpha-numeric characters or underscore. Required. + :type hub: str + :keyword api_version: The API version to use for this operation. Known values are + "2026-02-01-preview" and None. Default value is None. If not set, the operation's default API + version will be used. Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "AsyncTokenCredential", hub: str, **kwargs: Any) -> None: + _endpoint = "{endpoint}" + self._config = WebPubSubChatServiceClientConfiguration( + endpoint=endpoint, credential=credential, hub=hub, **kwargs + ) + + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + def send_request( + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = await client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.AsyncHttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + async def close(self) -> None: + await self._client.close() + + async def __aenter__(self) -> Self: + await self._client.__aenter__() + return self + + async def __aexit__(self, *exc_details: Any) -> None: + await self._client.__aexit__(*exc_details) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_configuration.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_configuration.py new file mode 100644 index 000000000000..a44ca77c4856 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_configuration.py @@ -0,0 +1,71 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, TYPE_CHECKING + +from azure.core.pipeline import policies + +from .._version import VERSION + +if TYPE_CHECKING: + from azure.core.credentials_async import AsyncTokenCredential + + +class WebPubSubChatServiceClientConfiguration: # pylint: disable=too-many-instance-attributes + """Configuration for WebPubSubChatServiceClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: HTTP or HTTPS endpoint for the Web PubSub service instance. Required. + :type endpoint: str + :param credential: Credential used to authenticate requests to the service. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential + :param hub: Target hub name, which should start with alphabetic characters and only contain + alpha-numeric characters or underscore. Required. + :type hub: str + :keyword api_version: The API version to use for this operation. Known values are + "2026-02-01-preview" and None. Default value is None. If not set, the operation's default API + version will be used. Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "AsyncTokenCredential", hub: str, **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2026-02-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + if hub is None: + raise ValueError("Parameter 'hub' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.hub = hub + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://webpubsub.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "messaging-webpubsubchatservice/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.AsyncBearerTokenCredentialPolicy( + self.credential, *self.credential_scopes, **kwargs + ) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_operations/__init__.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_operations/__init__.py new file mode 100644 index 000000000000..72deab389c50 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_operations/__init__.py @@ -0,0 +1,23 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._operations import _WebPubSubChatServiceClientOperationsMixin # type: ignore # pylint: disable=unused-import + +from ._patch import __all__ as _patch_all +from ._patch import * +from ._patch import patch_sdk as _patch_sdk + +__all__ = [] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore +_patch_sdk() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_operations/_operations.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_operations/_operations.py new file mode 100644 index 000000000000..571977fcedd3 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_operations/_operations.py @@ -0,0 +1,2019 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from collections.abc import MutableMapping +from io import IOBase +import json +from typing import Any, Callable, IO, Optional, TypeVar, Union, overload +import urllib.parse + +from azure.core import AsyncPipelineClient, MatchConditions +from azure.core.async_paging import AsyncItemPaged, AsyncList +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceModifiedError, + ResourceNotFoundError, + ResourceNotModifiedError, + StreamClosedError, + StreamConsumedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.rest import AsyncHttpResponse, HttpRequest +from azure.core.tracing.decorator import distributed_trace +from azure.core.tracing.decorator_async import distributed_trace_async +from azure.core.utils import case_insensitive_dict + +from ... import models as _models, types as _types +from ..._operations._operations import ( + build_web_pub_sub_chat_service_create_or_replace_role_request, + build_web_pub_sub_chat_service_create_or_replace_room_member_request, + build_web_pub_sub_chat_service_create_or_replace_room_request, + build_web_pub_sub_chat_service_create_or_replace_user_request, + build_web_pub_sub_chat_service_delete_message_request, + build_web_pub_sub_chat_service_delete_role_request, + build_web_pub_sub_chat_service_delete_room_member_request, + build_web_pub_sub_chat_service_delete_room_request, + build_web_pub_sub_chat_service_delete_user_request, + build_web_pub_sub_chat_service_get_conversation_request, + build_web_pub_sub_chat_service_get_role_request, + build_web_pub_sub_chat_service_get_room_request, + build_web_pub_sub_chat_service_get_user_request, + build_web_pub_sub_chat_service_list_messages_request, + build_web_pub_sub_chat_service_list_roles_request, + build_web_pub_sub_chat_service_list_room_members_request, + build_web_pub_sub_chat_service_update_message_request, +) +from ..._utils.model_base import SdkJSONEncoder, _deserialize +from ..._utils.utils import ClientMixinABC +from .._configuration import WebPubSubChatServiceClientConfiguration + +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, dict[str, Any]], Any]] + + +class _WebPubSubChatServiceClientOperationsMixin( + ClientMixinABC[AsyncPipelineClient[HttpRequest, AsyncHttpResponse], WebPubSubChatServiceClientConfiguration] +): + + @distributed_trace_async + async def get_conversation(self, conversation_id: str, **kwargs: Any) -> _models.ChatConversation: + """Get conversation information. + + Get conversation information. + + :param conversation_id: Conversation identifier. Required. + :type conversation_id: str + :return: ChatConversation. The ChatConversation is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatConversation + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.ChatConversation] = kwargs.pop("cls", None) + + _request = build_web_pub_sub_chat_service_get_conversation_request( + conversation_id=conversation_id, + hub=self._config.hub, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.ChatConversation, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_messages( + self, + conversation_id: str, + *, + latest_message_id: Optional[str] = None, + earliest_message_id: Optional[str] = None, + **kwargs: Any + ) -> AsyncItemPaged["_models.ChatMessage"]: + """Query messages in a conversation from latest to earliest. + + Query messages in a conversation from latest to earliest. + + :param conversation_id: Conversation identifier. Required. + :type conversation_id: str + :keyword latest_message_id: Latest message ID (exclusive) for pagination. Default value is + None. + :paramtype latest_message_id: str + :keyword earliest_message_id: Earliest message ID (exclusive) for pagination. Default value is + None. + :paramtype earliest_message_id: str + :return: An iterator like instance of ChatMessage + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.messaging.webpubsubservice.chat.models.ChatMessage] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + maxpagesize = kwargs.pop("maxpagesize", None) + cls: ClsType[list[_models.ChatMessage]] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_web_pub_sub_chat_service_list_messages_request( + conversation_id=conversation_id, + hub=self._config.hub, + latest_message_id=latest_message_id, + earliest_message_id=earliest_message_id, + maxpagesize=maxpagesize, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", + urllib.parse.urljoin(next_link, _parsed_next_link.path), + headers=_headers, + params=_next_request_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + async def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize( + list[_models.ChatMessage], + deserialized.get("value", []), + ) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + @distributed_trace_async + async def delete_message( + self, + conversation_id: str, + message_id: str, + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> None: + """Delete a message. + + Delete a message. + + :param conversation_id: Conversation identifier. Required. + :type conversation_id: str + :param message_id: Message identifier. Required. + :type message_id: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + if match_condition == MatchConditions.IfNotModified: + error_map[412] = ResourceModifiedError + elif match_condition == MatchConditions.IfPresent: + error_map[412] = ResourceNotFoundError + elif match_condition == MatchConditions.IfMissing: + error_map[412] = ResourceExistsError + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_web_pub_sub_chat_service_delete_message_request( + conversation_id=conversation_id, + message_id=message_id, + hub=self._config.hub, + etag=etag, + match_condition=match_condition, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + async def update_message( + self, + conversation_id: str, + message_id: str, + resource: _models.ChatMessage, + *, + content_type: str = "application/merge-patch+json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatMessage: + """Update a message. + + Update a message. + + :param conversation_id: Conversation identifier. Required. + :type conversation_id: str + :param message_id: Message identifier. Required. + :type message_id: str + :param resource: The resource instance. Required. + :type resource: ~azure.messaging.webpubsubservice.chat.models.ChatMessage + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatMessage. The ChatMessage is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatMessage + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def update_message( + self, + conversation_id: str, + message_id: str, + resource: _types.ChatMessage, + *, + content_type: str = "application/merge-patch+json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatMessage: + """Update a message. + + Update a message. + + :param conversation_id: Conversation identifier. Required. + :type conversation_id: str + :param message_id: Message identifier. Required. + :type message_id: str + :param resource: The resource instance. Required. + :type resource: ~azure.messaging.webpubsubservice.chat.types.ChatMessage + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatMessage. The ChatMessage is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatMessage + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def update_message( + self, + conversation_id: str, + message_id: str, + resource: IO[bytes], + *, + content_type: str = "application/merge-patch+json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatMessage: + """Update a message. + + Update a message. + + :param conversation_id: Conversation identifier. Required. + :type conversation_id: str + :param message_id: Message identifier. Required. + :type message_id: str + :param resource: The resource instance. Required. + :type resource: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatMessage. The ChatMessage is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatMessage + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def update_message( + self, + conversation_id: str, + message_id: str, + resource: Union[_models.ChatMessage, _types.ChatMessage, IO[bytes]], + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatMessage: + """Update a message. + + Update a message. + + :param conversation_id: Conversation identifier. Required. + :type conversation_id: str + :param message_id: Message identifier. Required. + :type message_id: str + :param resource: The resource instance. Is either a ChatMessage type or a IO[bytes] type. + Required. + :type resource: ~azure.messaging.webpubsubservice.chat.models.ChatMessage or + ~azure.messaging.webpubsubservice.chat.types.ChatMessage or IO[bytes] + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatMessage. The ChatMessage is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatMessage + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + if match_condition == MatchConditions.IfNotModified: + error_map[412] = ResourceModifiedError + elif match_condition == MatchConditions.IfPresent: + error_map[412] = ResourceNotFoundError + elif match_condition == MatchConditions.IfMissing: + error_map[412] = ResourceExistsError + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.ChatMessage] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(resource, (IOBase, bytes)): + _content = resource + else: + _content = json.dumps(resource, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_web_pub_sub_chat_service_update_message_request( + conversation_id=conversation_id, + message_id=message_id, + hub=self._config.hub, + etag=etag, + match_condition=match_condition, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["ETag"] = self._deserialize("str", response.headers.get("ETag")) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.ChatMessage, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_roles( + self, *, continuation_token_parameter: Optional[str] = None, **kwargs: Any + ) -> AsyncItemPaged["_models.ChatRole"]: + """Query roles in a hub. + + Query roles in a hub. + + :keyword continuation_token_parameter: Continuation token for pagination. Default value is + None. + :paramtype continuation_token_parameter: str + :return: An iterator like instance of ChatRole + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.messaging.webpubsubservice.chat.models.ChatRole] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + maxpagesize = kwargs.pop("maxpagesize", None) + cls: ClsType[list[_models.ChatRole]] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_web_pub_sub_chat_service_list_roles_request( + hub=self._config.hub, + maxpagesize=maxpagesize, + continuation_token_parameter=continuation_token_parameter, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", + urllib.parse.urljoin(next_link, _parsed_next_link.path), + headers=_headers, + params=_next_request_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + async def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize( + list[_models.ChatRole], + deserialized.get("value", []), + ) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + @distributed_trace_async + async def get_role(self, role_name: str, **kwargs: Any) -> _models.ChatRole: + """Get role information. + + Get role information. + + :param role_name: Role name. Must start with 'user.' or 'room.' prefix. Required. + :type role_name: str + :return: ChatRole. The ChatRole is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRole + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.ChatRole] = kwargs.pop("cls", None) + + _request = build_web_pub_sub_chat_service_get_role_request( + role_name=role_name, + hub=self._config.hub, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.ChatRole, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def create_or_replace_role( + self, + role_name: str, + resource: _models.ChatRole, + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRole: + """Create or replace a role. + + Create or replace a role. + + :param role_name: Role name. Must start with 'user.' or 'room.' prefix. Required. + :type role_name: str + :param resource: The resource instance. Required. + :type resource: ~azure.messaging.webpubsubservice.chat.models.ChatRole + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRole. The ChatRole is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRole + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def create_or_replace_role( + self, + role_name: str, + resource: _types.ChatRole, + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRole: + """Create or replace a role. + + Create or replace a role. + + :param role_name: Role name. Must start with 'user.' or 'room.' prefix. Required. + :type role_name: str + :param resource: The resource instance. Required. + :type resource: ~azure.messaging.webpubsubservice.chat.types.ChatRole + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRole. The ChatRole is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRole + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def create_or_replace_role( + self, + role_name: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRole: + """Create or replace a role. + + Create or replace a role. + + :param role_name: Role name. Must start with 'user.' or 'room.' prefix. Required. + :type role_name: str + :param resource: The resource instance. Required. + :type resource: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRole. The ChatRole is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRole + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def create_or_replace_role( + self, + role_name: str, + resource: Union[_models.ChatRole, _types.ChatRole, IO[bytes]], + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRole: + """Create or replace a role. + + Create or replace a role. + + :param role_name: Role name. Must start with 'user.' or 'room.' prefix. Required. + :type role_name: str + :param resource: The resource instance. Is either a ChatRole type or a IO[bytes] type. + Required. + :type resource: ~azure.messaging.webpubsubservice.chat.models.ChatRole or + ~azure.messaging.webpubsubservice.chat.types.ChatRole or IO[bytes] + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRole. The ChatRole is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRole + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + if match_condition == MatchConditions.IfNotModified: + error_map[412] = ResourceModifiedError + elif match_condition == MatchConditions.IfPresent: + error_map[412] = ResourceNotFoundError + elif match_condition == MatchConditions.IfMissing: + error_map[412] = ResourceExistsError + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.ChatRole] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(resource, (IOBase, bytes)): + _content = resource + else: + _content = json.dumps(resource, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_web_pub_sub_chat_service_create_or_replace_role_request( + role_name=role_name, + hub=self._config.hub, + etag=etag, + match_condition=match_condition, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["ETag"] = self._deserialize("str", response.headers.get("ETag")) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.ChatRole, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def delete_role( + self, + role_name: str, + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> None: + """Delete a role. + + Delete a role. + + :param role_name: Role name. Must start with 'user.' or 'room.' prefix. Required. + :type role_name: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + if match_condition == MatchConditions.IfNotModified: + error_map[412] = ResourceModifiedError + elif match_condition == MatchConditions.IfPresent: + error_map[412] = ResourceNotFoundError + elif match_condition == MatchConditions.IfMissing: + error_map[412] = ResourceExistsError + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_web_pub_sub_chat_service_delete_role_request( + role_name=role_name, + hub=self._config.hub, + etag=etag, + match_condition=match_condition, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @overload + async def create_or_replace_room( + self, + room_id: str, + resource: _models.ChatRoom, + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRoom: + """Create or replace a room. + + Create or replace a room with a client-specified ID. + + :param room_id: Room identifier. Required. + :type room_id: str + :param resource: The resource instance. Required. + :type resource: ~azure.messaging.webpubsubservice.chat.models.ChatRoom + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRoom. The ChatRoom is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRoom + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def create_or_replace_room( + self, + room_id: str, + resource: _types.ChatRoom, + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRoom: + """Create or replace a room. + + Create or replace a room with a client-specified ID. + + :param room_id: Room identifier. Required. + :type room_id: str + :param resource: The resource instance. Required. + :type resource: ~azure.messaging.webpubsubservice.chat.types.ChatRoom + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRoom. The ChatRoom is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRoom + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def create_or_replace_room( + self, + room_id: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRoom: + """Create or replace a room. + + Create or replace a room with a client-specified ID. + + :param room_id: Room identifier. Required. + :type room_id: str + :param resource: The resource instance. Required. + :type resource: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRoom. The ChatRoom is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRoom + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def create_or_replace_room( + self, + room_id: str, + resource: Union[_models.ChatRoom, _types.ChatRoom, IO[bytes]], + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRoom: + """Create or replace a room. + + Create or replace a room with a client-specified ID. + + :param room_id: Room identifier. Required. + :type room_id: str + :param resource: The resource instance. Is either a ChatRoom type or a IO[bytes] type. + Required. + :type resource: ~azure.messaging.webpubsubservice.chat.models.ChatRoom or + ~azure.messaging.webpubsubservice.chat.types.ChatRoom or IO[bytes] + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRoom. The ChatRoom is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRoom + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + if match_condition == MatchConditions.IfNotModified: + error_map[412] = ResourceModifiedError + elif match_condition == MatchConditions.IfPresent: + error_map[412] = ResourceNotFoundError + elif match_condition == MatchConditions.IfMissing: + error_map[412] = ResourceExistsError + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.ChatRoom] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(resource, (IOBase, bytes)): + _content = resource + else: + _content = json.dumps(resource, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_web_pub_sub_chat_service_create_or_replace_room_request( + room_id=room_id, + hub=self._config.hub, + etag=etag, + match_condition=match_condition, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["ETag"] = self._deserialize("str", response.headers.get("ETag")) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.ChatRoom, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_room(self, room_id: str, **kwargs: Any) -> _models.ChatRoom: + """Get room information. + + Get room information. + + :param room_id: Room identifier. Required. + :type room_id: str + :return: ChatRoom. The ChatRoom is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRoom + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.ChatRoom] = kwargs.pop("cls", None) + + _request = build_web_pub_sub_chat_service_get_room_request( + room_id=room_id, + hub=self._config.hub, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.ChatRoom, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def delete_room( + self, + room_id: str, + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> None: + """Delete a room. + + Delete a room. + + :param room_id: Room identifier. Required. + :type room_id: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + if match_condition == MatchConditions.IfNotModified: + error_map[412] = ResourceModifiedError + elif match_condition == MatchConditions.IfPresent: + error_map[412] = ResourceNotFoundError + elif match_condition == MatchConditions.IfMissing: + error_map[412] = ResourceExistsError + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_web_pub_sub_chat_service_delete_room_request( + room_id=room_id, + hub=self._config.hub, + etag=etag, + match_condition=match_condition, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace + def list_room_members( + self, room_id: str, *, continuation_token_parameter: Optional[str] = None, **kwargs: Any + ) -> AsyncItemPaged["_models.ChatRoomMember"]: + """Get room members. + + Get room members. + + :param room_id: Room identifier. Required. + :type room_id: str + :keyword continuation_token_parameter: Continuation token for pagination. Default value is + None. + :paramtype continuation_token_parameter: str + :return: An iterator like instance of ChatRoomMember + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.messaging.webpubsubservice.chat.models.ChatRoomMember] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + maxpagesize = kwargs.pop("maxpagesize", None) + cls: ClsType[list[_models.ChatRoomMember]] = kwargs.pop("cls", None) + + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_web_pub_sub_chat_service_list_room_members_request( + room_id=room_id, + hub=self._config.hub, + maxpagesize=maxpagesize, + continuation_token_parameter=continuation_token_parameter, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", + urllib.parse.urljoin(next_link, _parsed_next_link.path), + headers=_headers, + params=_next_request_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + async def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize( + list[_models.ChatRoomMember], + deserialized.get("value", []), + ) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + @overload + async def create_or_replace_room_member( + self, + room_id: str, + user_id: str, + resource: _models.ChatRoomMember, + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRoomMember: + """Create or replace a room member. + + Create or replace a room member. + + :param room_id: Room identifier. Required. + :type room_id: str + :param user_id: User ID of the member. Required. + :type user_id: str + :param resource: The resource instance. Required. + :type resource: ~azure.messaging.webpubsubservice.chat.models.ChatRoomMember + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRoomMember. The ChatRoomMember is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRoomMember + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def create_or_replace_room_member( + self, + room_id: str, + user_id: str, + resource: _types.ChatRoomMember, + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRoomMember: + """Create or replace a room member. + + Create or replace a room member. + + :param room_id: Room identifier. Required. + :type room_id: str + :param user_id: User ID of the member. Required. + :type user_id: str + :param resource: The resource instance. Required. + :type resource: ~azure.messaging.webpubsubservice.chat.types.ChatRoomMember + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRoomMember. The ChatRoomMember is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRoomMember + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def create_or_replace_room_member( + self, + room_id: str, + user_id: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRoomMember: + """Create or replace a room member. + + Create or replace a room member. + + :param room_id: Room identifier. Required. + :type room_id: str + :param user_id: User ID of the member. Required. + :type user_id: str + :param resource: The resource instance. Required. + :type resource: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRoomMember. The ChatRoomMember is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRoomMember + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def create_or_replace_room_member( + self, + room_id: str, + user_id: str, + resource: Union[_models.ChatRoomMember, _types.ChatRoomMember, IO[bytes]], + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatRoomMember: + """Create or replace a room member. + + Create or replace a room member. + + :param room_id: Room identifier. Required. + :type room_id: str + :param user_id: User ID of the member. Required. + :type user_id: str + :param resource: The resource instance. Is either a ChatRoomMember type or a IO[bytes] type. + Required. + :type resource: ~azure.messaging.webpubsubservice.chat.models.ChatRoomMember or + ~azure.messaging.webpubsubservice.chat.types.ChatRoomMember or IO[bytes] + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatRoomMember. The ChatRoomMember is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatRoomMember + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + if match_condition == MatchConditions.IfNotModified: + error_map[412] = ResourceModifiedError + elif match_condition == MatchConditions.IfPresent: + error_map[412] = ResourceNotFoundError + elif match_condition == MatchConditions.IfMissing: + error_map[412] = ResourceExistsError + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.ChatRoomMember] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(resource, (IOBase, bytes)): + _content = resource + else: + _content = json.dumps(resource, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_web_pub_sub_chat_service_create_or_replace_room_member_request( + room_id=room_id, + user_id=user_id, + hub=self._config.hub, + etag=etag, + match_condition=match_condition, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["ETag"] = self._deserialize("str", response.headers.get("ETag")) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.ChatRoomMember, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def delete_room_member( + self, + room_id: str, + user_id: str, + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> None: + """Delete a room member. + + Delete a room member. + + :param room_id: Room identifier. Required. + :type room_id: str + :param user_id: User ID of the member. Required. + :type user_id: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + if match_condition == MatchConditions.IfNotModified: + error_map[412] = ResourceModifiedError + elif match_condition == MatchConditions.IfPresent: + error_map[412] = ResourceNotFoundError + elif match_condition == MatchConditions.IfMissing: + error_map[412] = ResourceExistsError + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_web_pub_sub_chat_service_delete_room_member_request( + room_id=room_id, + user_id=user_id, + hub=self._config.hub, + etag=etag, + match_condition=match_condition, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace_async + async def get_user(self, user_id: str, **kwargs: Any) -> _models.ChatUser: + """Get a user's profile. + + Get a user's profile. The response is a polymorphic ``ChatUser`` (e.g. ``HumanChatUser``) + selected by the ``kind`` discriminator. + + :param user_id: User identifier. Required. + :type user_id: str + :return: ChatUser. The ChatUser is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatUser + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.ChatUser] = kwargs.pop("cls", None) + + _request = build_web_pub_sub_chat_service_get_user_request( + user_id=user_id, + hub=self._config.hub, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.ChatUser, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def create_or_replace_user( + self, + user_id: str, + resource: _models.ChatUser, + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatUser: + """Create or replace a user. + + Create or replace a user. The request body is a polymorphic ``ChatUser`` (e.g. + ``HumanChatUser``) selected by the ``kind`` discriminator. + + :param user_id: User identifier. Required. + :type user_id: str + :param resource: The resource instance. Required. + :type resource: ~azure.messaging.webpubsubservice.chat.models.ChatUser + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatUser. The ChatUser is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatUser + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def create_or_replace_user( + self, + user_id: str, + resource: _types.ChatUser, + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatUser: + """Create or replace a user. + + Create or replace a user. The request body is a polymorphic ``ChatUser`` (e.g. + ``HumanChatUser``) selected by the ``kind`` discriminator. + + :param user_id: User identifier. Required. + :type user_id: str + :param resource: The resource instance. Required. + :type resource: ~azure.messaging.webpubsubservice.chat.types.ChatUser + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatUser. The ChatUser is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatUser + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def create_or_replace_user( + self, + user_id: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatUser: + """Create or replace a user. + + Create or replace a user. The request body is a polymorphic ``ChatUser`` (e.g. + ``HumanChatUser``) selected by the ``kind`` discriminator. + + :param user_id: User identifier. Required. + :type user_id: str + :param resource: The resource instance. Required. + :type resource: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatUser. The ChatUser is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatUser + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def create_or_replace_user( + self, + user_id: str, + resource: Union[_models.ChatUser, _types.ChatUser, IO[bytes]], + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.ChatUser: + """Create or replace a user. + + Create or replace a user. The request body is a polymorphic ``ChatUser`` (e.g. + ``HumanChatUser``) selected by the ``kind`` discriminator. + + :param user_id: User identifier. Required. + :type user_id: str + :param resource: The resource instance. Is either a ChatUser type or a IO[bytes] type. + Required. + :type resource: ~azure.messaging.webpubsubservice.chat.models.ChatUser or + ~azure.messaging.webpubsubservice.chat.types.ChatUser or IO[bytes] + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: ChatUser. The ChatUser is compatible with MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models.ChatUser + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + if match_condition == MatchConditions.IfNotModified: + error_map[412] = ResourceModifiedError + elif match_condition == MatchConditions.IfPresent: + error_map[412] = ResourceNotFoundError + elif match_condition == MatchConditions.IfMissing: + error_map[412] = ResourceExistsError + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.ChatUser] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(resource, (IOBase, bytes)): + _content = resource + else: + _content = json.dumps(resource, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_web_pub_sub_chat_service_create_or_replace_user_request( + user_id=user_id, + hub=self._config.hub, + etag=etag, + match_condition=match_condition, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["ETag"] = self._deserialize("str", response.headers.get("ETag")) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.ChatUser, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def delete_user( + self, + user_id: str, + *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> None: + """Delete a user. + + Delete a user. + + :param user_id: User identifier. Required. + :type user_id: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + if match_condition == MatchConditions.IfNotModified: + error_map[412] = ResourceModifiedError + elif match_condition == MatchConditions.IfPresent: + error_map[412] = ResourceNotFoundError + elif match_condition == MatchConditions.IfMissing: + error_map[412] = ResourceExistsError + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_web_pub_sub_chat_service_delete_user_request( + user_id=user_id, + hub=self._config.hub, + etag=etag, + match_condition=match_condition, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_operations/_patch.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_operations/_patch.py new file mode 100644 index 000000000000..87676c65a8f0 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_operations/_patch.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" + + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_patch.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_patch.py new file mode 100644 index 000000000000..87676c65a8f0 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_patch.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" + + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/__init__.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/__init__.py new file mode 100644 index 000000000000..6472dca37389 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/__init__.py @@ -0,0 +1,46 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + + +from ._models import ( # type: ignore + ChatConversation, + ChatMessage, + ChatRole, + ChatRoom, + ChatRoomMember, + ChatUser, + HumanChatUser, + MessageContent, +) + +from ._enums import ( # type: ignore + ChatUserKind, +) +from ._patch import __all__ as _patch_all +from ._patch import * +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "ChatConversation", + "ChatMessage", + "ChatRole", + "ChatRoom", + "ChatRoomMember", + "ChatUser", + "HumanChatUser", + "MessageContent", + "ChatUserKind", +] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore +_patch_sdk() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_enums.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_enums.py new file mode 100644 index 000000000000..5c2004cdae61 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_enums.py @@ -0,0 +1,17 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from enum import Enum +from azure.core import CaseInsensitiveEnumMeta + + +class ChatUserKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Discriminator for the kind of chat user.""" + + HUMAN = "Human" + """A human end-user.""" diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_models.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_models.py new file mode 100644 index 000000000000..c197573a2f29 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_models.py @@ -0,0 +1,333 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=useless-super-delegation + +import datetime +from typing import Any, Literal, Mapping, Optional, TYPE_CHECKING, overload + +from .._utils.model_base import Model as _Model, rest_discriminator, rest_field +from ._enums import ChatUserKind + +if TYPE_CHECKING: + from .. import models as _models + + +class ChatConversation(_Model): + """Represents a chat conversation. + + :ivar id: Conversation identifier. Required. + :vartype id: str + :ivar parent_room: Parent room identifier. Required. + :vartype parent_room: str + :ivar etag: The entity tag for this resource. Required. + :vartype etag: str + """ + + id: str = rest_field(visibility=["read"]) + """Conversation identifier. Required.""" + parent_room: str = rest_field(name="parentRoom", visibility=["read", "create", "update", "delete", "query"]) + """Parent room identifier. Required.""" + etag: str = rest_field(visibility=["read"]) + """The entity tag for this resource. Required.""" + + @overload + def __init__( + self, + *, + parent_room: str, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class ChatMessage(_Model): + """Represents a chat message. + + :ivar id: Message identifier. Required. + :vartype id: str + :ivar created_by: User who created the message. Required. + :vartype created_by: str + :ivar content: Message content. Required. + :vartype content: ~azure.messaging.webpubsubservice.chat.models.MessageContent + :ivar created_at: Timestamp when the message was created. Required. + :vartype created_at: ~datetime.datetime + :ivar etag: The entity tag for this resource. Required. + :vartype etag: str + """ + + id: str = rest_field(visibility=["read"]) + """Message identifier. Required.""" + created_by: str = rest_field(name="createdBy", visibility=["read", "create", "update", "delete", "query"]) + """User who created the message. Required.""" + content: "_models.MessageContent" = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Message content. Required.""" + created_at: datetime.datetime = rest_field(name="createdAt", visibility=["read"], format="rfc3339") + """Timestamp when the message was created. Required.""" + etag: str = rest_field(visibility=["read"]) + """The entity tag for this resource. Required.""" + + @overload + def __init__( + self, + *, + created_by: str, + content: "_models.MessageContent", + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class ChatRole(_Model): + """Represents a chat role. A role name must start with 'user.' or 'room.' prefix. A role must + contain either user permissions or room permissions, but not both. + + :ivar name: Role name. Must start with 'user.' or 'room.' prefix. Required. + :vartype name: str + :ivar permissions: Permissions associated with the role. Do not mix user permissions and room + permissions in one role. Required. + :vartype permissions: list[str] + :ivar etag: The entity tag for this resource. Required. + :vartype etag: str + """ + + name: str = rest_field(visibility=["read"]) + """Role name. Must start with 'user.' or 'room.' prefix. Required.""" + permissions: list[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Permissions associated with the role. Do not mix user permissions and room permissions in one + role. Required.""" + etag: str = rest_field(visibility=["read"]) + """The entity tag for this resource. Required.""" + + @overload + def __init__( + self, + *, + permissions: list[str], + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class ChatRoom(_Model): + """Represents a chat room. + + :ivar id: Room identifier. Required. + :vartype id: str + :ivar title: Room title. Required. + :vartype title: str + :ivar default_conversation: Default conversation ID for this room. Required. + :vartype default_conversation: str + :ivar etag: The entity tag for this resource. Required. + :vartype etag: str + """ + + id: str = rest_field(visibility=["read"]) + """Room identifier. Required.""" + title: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Room title. Required.""" + default_conversation: str = rest_field(name="defaultConversation", visibility=["read"]) + """Default conversation ID for this room. Required.""" + etag: str = rest_field(visibility=["read"]) + """The entity tag for this resource. Required.""" + + @overload + def __init__( + self, + *, + title: str, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class ChatRoomMember(_Model): + """Represents a room member. + + :ivar user_id: User ID of the member. Required. + :vartype user_id: str + :ivar role_name: Room role assigned to the user within this room. Required. + :vartype role_name: str + :ivar etag: The entity tag for this resource. Required. + :vartype etag: str + """ + + user_id: str = rest_field(name="userId", visibility=["read"]) + """User ID of the member. Required.""" + role_name: str = rest_field(name="roleName", visibility=["read", "create", "update", "delete", "query"]) + """Room role assigned to the user within this room. Required.""" + etag: str = rest_field(visibility=["read"]) + """The entity tag for this resource. Required.""" + + @overload + def __init__( + self, + *, + role_name: str, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class ChatUser(_Model): + """Represents a user profile in the chat system. This is a discriminated base type; concrete + payloads are selected by the ``kind`` field (e.g. ``HumanChatUser``). + + You probably want to use the sub-classes and not this class directly. Known sub-classes are: + HumanChatUser + + :ivar kind: The kind of user. Required. "Human" + :vartype kind: str or ~azure.messaging.webpubsubservice.chat.models.ChatUserKind + :ivar id: User identifier. Required. + :vartype id: str + :ivar nickname: User's display nickname. Required. + :vartype nickname: str + :ivar etag: The entity tag for this resource. Required. + :vartype etag: str + """ + + __mapping__: dict[str, _Model] = {} + kind: str = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) + """The kind of user. Required. \"Human\"""" + id: str = rest_field(visibility=["read"]) + """User identifier. Required.""" + nickname: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """User's display nickname. Required.""" + etag: str = rest_field(visibility=["read"]) + """The entity tag for this resource. Required.""" + + @overload + def __init__( + self, + *, + kind: str, + nickname: str, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class HumanChatUser(ChatUser, discriminator="Human"): + """A human end-user, identified by a user role. + + :ivar id: User identifier. Required. + :vartype id: str + :ivar nickname: User's display nickname. Required. + :vartype nickname: str + :ivar etag: The entity tag for this resource. Required. + :vartype etag: str + :ivar kind: Required. A human end-user. + :vartype kind: str or ~azure.messaging.webpubsubservice.chat.models.HUMAN + :ivar role_name: Global user role assigned to the user. Must start with ``user.``. Required. + :vartype role_name: str + """ + + kind: Literal[ChatUserKind.HUMAN] = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """Required. A human end-user.""" + role_name: str = rest_field(name="roleName", visibility=["read", "create", "update", "delete", "query"]) + """Global user role assigned to the user. Must start with ``user.``. Required.""" + + @overload + def __init__( + self, + *, + nickname: str, + role_name: str, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind = ChatUserKind.HUMAN # type: ignore + + +class MessageContent(_Model): + """Message content body. + + :ivar text: Text content. + :vartype text: str + :ivar binary: Binary content (base64 encoded). + :vartype binary: bytes + """ + + text: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Text content.""" + binary: Optional[bytes] = rest_field(visibility=["read", "create", "update", "delete", "query"], format="base64") + """Binary content (base64 encoded).""" + + @overload + def __init__( + self, + *, + text: Optional[str] = None, + binary: Optional[bytes] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_patch.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_patch.py new file mode 100644 index 000000000000..87676c65a8f0 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_patch.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" + + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/py.typed b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/py.typed new file mode 100644 index 000000000000..e5aff4f83af8 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/py.typed @@ -0,0 +1 @@ +# Marker file for PEP 561. \ No newline at end of file diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/types.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/types.py new file mode 100644 index 000000000000..a45d3e8a7b18 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/types.py @@ -0,0 +1,167 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Literal, Union +from typing_extensions import Required, TypedDict + +from .models._enums import ChatUserKind + + +class ChatConversation(TypedDict, total=False): + """Represents a chat conversation. + + :ivar id: Conversation identifier. Required. + :vartype id: str + :ivar parent_room: Parent room identifier. Required. + :vartype parent_room: str + :ivar etag: The entity tag for this resource. Required. + :vartype etag: str + """ + + id: Required[str] + """Conversation identifier. Required.""" + parentRoom: Required[str] + """Parent room identifier. Required.""" + etag: Required[str] + """The entity tag for this resource. Required.""" + + +class ChatMessage(TypedDict, total=False): + """Represents a chat message. + + :ivar id: Message identifier. Required. + :vartype id: str + :ivar created_by: User who created the message. Required. + :vartype created_by: str + :ivar content: Message content. Required. + :vartype content: "MessageContent" + :ivar created_at: Timestamp when the message was created. Required. + :vartype created_at: str + :ivar etag: The entity tag for this resource. Required. + :vartype etag: str + """ + + id: Required[str] + """Message identifier. Required.""" + createdBy: Required[str] + """User who created the message. Required.""" + content: Required["MessageContent"] + """Message content. Required.""" + createdAt: Required[str] + """Timestamp when the message was created. Required.""" + etag: Required[str] + """The entity tag for this resource. Required.""" + + +class ChatRole(TypedDict, total=False): + """Represents a chat role. A role name must start with 'user.' or 'room.' prefix. A role must + contain either user permissions or room permissions, but not both. + + :ivar name: Role name. Must start with 'user.' or 'room.' prefix. Required. + :vartype name: str + :ivar permissions: Permissions associated with the role. Do not mix user permissions and room + permissions in one role. Required. + :vartype permissions: list[str] + :ivar etag: The entity tag for this resource. Required. + :vartype etag: str + """ + + name: Required[str] + """Role name. Must start with 'user.' or 'room.' prefix. Required.""" + permissions: Required[list[str]] + """Permissions associated with the role. Do not mix user permissions and room permissions in one + role. Required.""" + etag: Required[str] + """The entity tag for this resource. Required.""" + + +class ChatRoom(TypedDict, total=False): + """Represents a chat room. + + :ivar id: Room identifier. Required. + :vartype id: str + :ivar title: Room title. Required. + :vartype title: str + :ivar default_conversation: Default conversation ID for this room. Required. + :vartype default_conversation: str + :ivar etag: The entity tag for this resource. Required. + :vartype etag: str + """ + + id: Required[str] + """Room identifier. Required.""" + title: Required[str] + """Room title. Required.""" + defaultConversation: Required[str] + """Default conversation ID for this room. Required.""" + etag: Required[str] + """The entity tag for this resource. Required.""" + + +class ChatRoomMember(TypedDict, total=False): + """Represents a room member. + + :ivar user_id: User ID of the member. Required. + :vartype user_id: str + :ivar role_name: Room role assigned to the user within this room. Required. + :vartype role_name: str + :ivar etag: The entity tag for this resource. Required. + :vartype etag: str + """ + + userId: Required[str] + """User ID of the member. Required.""" + roleName: Required[str] + """Room role assigned to the user within this room. Required.""" + etag: Required[str] + """The entity tag for this resource. Required.""" + + +class HumanChatUser(TypedDict, total=False): + """A human end-user, identified by a user role. + + :ivar id: User identifier. Required. + :vartype id: str + :ivar nickname: User's display nickname. Required. + :vartype nickname: str + :ivar etag: The entity tag for this resource. Required. + :vartype etag: str + :ivar kind: Required. A human end-user. + :vartype kind: Literal[ChatUserKind.HUMAN] + :ivar role_name: Global user role assigned to the user. Must start with ``user.``. Required. + :vartype role_name: str + """ + + id: Required[str] + """User identifier. Required.""" + nickname: Required[str] + """User's display nickname. Required.""" + etag: Required[str] + """The entity tag for this resource. Required.""" + kind: Required[Literal[ChatUserKind.HUMAN]] + """Required. A human end-user.""" + roleName: Required[str] + """Global user role assigned to the user. Must start with ``user.``. Required.""" + + +class MessageContent(TypedDict, total=False): + """Message content body. + + :ivar text: Text content. + :vartype text: str + :ivar binary: Binary content (base64 encoded). + :vartype binary: str + """ + + text: str + """Text content.""" + binary: str + """Binary content (base64 encoded).""" + + +ChatUser = Union[HumanChatUser] diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/dev_requirements.txt b/sdk/webpubsub/azure-messaging-webpubsubchatservice/dev_requirements.txt new file mode 100644 index 000000000000..ad0907b03b93 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/dev_requirements.txt @@ -0,0 +1,4 @@ +-e ../../../eng/tools/azure-sdk-tools +../../core/azure-core +../../identity/azure-identity +aiohttp \ No newline at end of file diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/create_or_replace_role.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/create_or_replace_role.py new file mode 100644 index 000000000000..cc17ab50b470 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/create_or_replace_role.py @@ -0,0 +1,45 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-messaging-webpubsubchatservice +# USAGE + python create_or_replace_role.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = WebPubSubChatServiceClient( + endpoint="ENDPOINT", + credential=DefaultAzureCredential(), + hub="HUB", + ) + + response = client.create_or_replace_role( + role_name="room.moderator", + resource={ + "permissions": ["room.history", "room.mute", "room.freeze", "room.remove_user", "room.publish_message"] + }, + ) + print(response) + + +# x-ms-original-file: 2026-02-01-preview/CreateOrReplaceRole.json +if __name__ == "__main__": + main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/create_or_replace_room.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/create_or_replace_room.py new file mode 100644 index 000000000000..3d4bbbf2f8a8 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/create_or_replace_room.py @@ -0,0 +1,43 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-messaging-webpubsubchatservice +# USAGE + python create_or_replace_room.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = WebPubSubChatServiceClient( + endpoint="ENDPOINT", + credential=DefaultAzureCredential(), + hub="HUB", + ) + + response = client.create_or_replace_room( + room_id="room1", + resource={"title": "General Chat"}, + ) + print(response) + + +# x-ms-original-file: 2026-02-01-preview/CreateOrReplaceRoom.json +if __name__ == "__main__": + main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/create_or_replace_room_member.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/create_or_replace_room_member.py new file mode 100644 index 000000000000..436633ec905b --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/create_or_replace_room_member.py @@ -0,0 +1,44 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-messaging-webpubsubchatservice +# USAGE + python create_or_replace_room_member.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = WebPubSubChatServiceClient( + endpoint="ENDPOINT", + credential=DefaultAzureCredential(), + hub="HUB", + ) + + response = client.create_or_replace_room_member( + room_id="room1", + user_id="user1", + resource={"roleName": "room.member"}, + ) + print(response) + + +# x-ms-original-file: 2026-02-01-preview/CreateOrReplaceRoomMember.json +if __name__ == "__main__": + main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/create_or_replace_user.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/create_or_replace_user.py new file mode 100644 index 000000000000..68ac6e17dafd --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/create_or_replace_user.py @@ -0,0 +1,43 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-messaging-webpubsubchatservice +# USAGE + python create_or_replace_user.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = WebPubSubChatServiceClient( + endpoint="ENDPOINT", + credential=DefaultAzureCredential(), + hub="HUB", + ) + + response = client.create_or_replace_user( + user_id="user1", + resource={"kind": "Human", "nickname": "John", "roleName": "user.normal"}, + ) + print(response) + + +# x-ms-original-file: 2026-02-01-preview/CreateOrReplaceUser.json +if __name__ == "__main__": + main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/delete_message.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/delete_message.py new file mode 100644 index 000000000000..1a3b15964307 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/delete_message.py @@ -0,0 +1,42 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-messaging-webpubsubchatservice +# USAGE + python delete_message.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = WebPubSubChatServiceClient( + endpoint="ENDPOINT", + credential=DefaultAzureCredential(), + hub="HUB", + ) + + client.delete_message( + conversation_id="c.room1.abcd1234", + message_id="123", + ) + + +# x-ms-original-file: 2026-02-01-preview/DeleteMessage.json +if __name__ == "__main__": + main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/delete_role.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/delete_role.py new file mode 100644 index 000000000000..7e39dbf3a79a --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/delete_role.py @@ -0,0 +1,41 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-messaging-webpubsubchatservice +# USAGE + python delete_role.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = WebPubSubChatServiceClient( + endpoint="ENDPOINT", + credential=DefaultAzureCredential(), + hub="HUB", + ) + + client.delete_role( + role_name="room.moderator", + ) + + +# x-ms-original-file: 2026-02-01-preview/DeleteRole.json +if __name__ == "__main__": + main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/delete_room.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/delete_room.py new file mode 100644 index 000000000000..d0e5d24cb9ad --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/delete_room.py @@ -0,0 +1,41 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-messaging-webpubsubchatservice +# USAGE + python delete_room.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = WebPubSubChatServiceClient( + endpoint="ENDPOINT", + credential=DefaultAzureCredential(), + hub="HUB", + ) + + client.delete_room( + room_id="room1", + ) + + +# x-ms-original-file: 2026-02-01-preview/DeleteRoom.json +if __name__ == "__main__": + main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/delete_room_member.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/delete_room_member.py new file mode 100644 index 000000000000..65a32d69f882 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/delete_room_member.py @@ -0,0 +1,42 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-messaging-webpubsubchatservice +# USAGE + python delete_room_member.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = WebPubSubChatServiceClient( + endpoint="ENDPOINT", + credential=DefaultAzureCredential(), + hub="HUB", + ) + + client.delete_room_member( + room_id="room1", + user_id="user1", + ) + + +# x-ms-original-file: 2026-02-01-preview/DeleteRoomMember.json +if __name__ == "__main__": + main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/delete_user.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/delete_user.py new file mode 100644 index 000000000000..e064446b4cce --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/delete_user.py @@ -0,0 +1,41 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-messaging-webpubsubchatservice +# USAGE + python delete_user.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = WebPubSubChatServiceClient( + endpoint="ENDPOINT", + credential=DefaultAzureCredential(), + hub="HUB", + ) + + client.delete_user( + user_id="user1", + ) + + +# x-ms-original-file: 2026-02-01-preview/DeleteUser.json +if __name__ == "__main__": + main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/get_conversation.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/get_conversation.py new file mode 100644 index 000000000000..f82dd3259e98 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/get_conversation.py @@ -0,0 +1,42 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-messaging-webpubsubchatservice +# USAGE + python get_conversation.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = WebPubSubChatServiceClient( + endpoint="ENDPOINT", + credential=DefaultAzureCredential(), + hub="HUB", + ) + + response = client.get_conversation( + conversation_id="c.room1.abcd1234", + ) + print(response) + + +# x-ms-original-file: 2026-02-01-preview/GetConversation.json +if __name__ == "__main__": + main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/get_role.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/get_role.py new file mode 100644 index 000000000000..f180bf297fe7 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/get_role.py @@ -0,0 +1,42 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-messaging-webpubsubchatservice +# USAGE + python get_role.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = WebPubSubChatServiceClient( + endpoint="ENDPOINT", + credential=DefaultAzureCredential(), + hub="HUB", + ) + + response = client.get_role( + role_name="room.operator", + ) + print(response) + + +# x-ms-original-file: 2026-02-01-preview/GetRole.json +if __name__ == "__main__": + main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/get_room.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/get_room.py new file mode 100644 index 000000000000..ed31751e6aeb --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/get_room.py @@ -0,0 +1,42 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-messaging-webpubsubchatservice +# USAGE + python get_room.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = WebPubSubChatServiceClient( + endpoint="ENDPOINT", + credential=DefaultAzureCredential(), + hub="HUB", + ) + + response = client.get_room( + room_id="room1", + ) + print(response) + + +# x-ms-original-file: 2026-02-01-preview/GetRoom.json +if __name__ == "__main__": + main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/get_user.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/get_user.py new file mode 100644 index 000000000000..b46e5c7dd356 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/get_user.py @@ -0,0 +1,42 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-messaging-webpubsubchatservice +# USAGE + python get_user.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = WebPubSubChatServiceClient( + endpoint="ENDPOINT", + credential=DefaultAzureCredential(), + hub="HUB", + ) + + response = client.get_user( + user_id="user1", + ) + print(response) + + +# x-ms-original-file: 2026-02-01-preview/GetUser.json +if __name__ == "__main__": + main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/list_messages.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/list_messages.py new file mode 100644 index 000000000000..090fa9072a49 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/list_messages.py @@ -0,0 +1,43 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-messaging-webpubsubchatservice +# USAGE + python list_messages.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = WebPubSubChatServiceClient( + endpoint="ENDPOINT", + credential=DefaultAzureCredential(), + hub="HUB", + ) + + response = client.list_messages( + conversation_id="c.room1.abcd1234", + ) + for item in response: + print(item) + + +# x-ms-original-file: 2026-02-01-preview/ListMessages.json +if __name__ == "__main__": + main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/list_roles.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/list_roles.py new file mode 100644 index 000000000000..e63c66c3004a --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/list_roles.py @@ -0,0 +1,41 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-messaging-webpubsubchatservice +# USAGE + python list_roles.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = WebPubSubChatServiceClient( + endpoint="ENDPOINT", + credential=DefaultAzureCredential(), + hub="HUB", + ) + + response = client.list_roles() + for item in response: + print(item) + + +# x-ms-original-file: 2026-02-01-preview/ListRoles.json +if __name__ == "__main__": + main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/list_room_members.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/list_room_members.py new file mode 100644 index 000000000000..47fd00c5d418 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/list_room_members.py @@ -0,0 +1,43 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-messaging-webpubsubchatservice +# USAGE + python list_room_members.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = WebPubSubChatServiceClient( + endpoint="ENDPOINT", + credential=DefaultAzureCredential(), + hub="HUB", + ) + + response = client.list_room_members( + room_id="room1", + ) + for item in response: + print(item) + + +# x-ms-original-file: 2026-02-01-preview/ListRoomMembers.json +if __name__ == "__main__": + main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/update_message.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/update_message.py new file mode 100644 index 000000000000..9043fc59b61b --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/update_message.py @@ -0,0 +1,44 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.identity import DefaultAzureCredential + +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + +""" +# PREREQUISITES + pip install azure-identity + pip install azure-messaging-webpubsubchatservice +# USAGE + python update_message.py + + Before run the sample, please set the values of the client ID, tenant ID and client secret + of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, + AZURE_CLIENT_SECRET. For more info about how to get the value, please see: + https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal +""" + + +def main(): + client = WebPubSubChatServiceClient( + endpoint="ENDPOINT", + credential=DefaultAzureCredential(), + hub="HUB", + ) + + response = client.update_message( + conversation_id="c.room1.abcd1234", + message_id="123", + resource={"content": {"text": "Updated message text"}, "createdBy": "user1"}, + ) + print(response) + + +# x-ms-original-file: 2026-02-01-preview/UpdateMessage.json +if __name__ == "__main__": + main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/conftest.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/conftest.py new file mode 100644 index 000000000000..7ca6a594c872 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/conftest.py @@ -0,0 +1,45 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import os +import pytest +from dotenv import load_dotenv +from devtools_testutils import ( + test_proxy, + add_general_regex_sanitizer, + add_body_key_sanitizer, + add_header_regex_sanitizer, +) + +load_dotenv() + + +# For security, please avoid record sensitive identity information in recordings +@pytest.fixture(scope="session", autouse=True) +def add_sanitizers(test_proxy): + webpubsubchatservice_subscription_id = os.environ.get( + "WEBPUBSUBCHATSERVICE_SUBSCRIPTION_ID", "00000000-0000-0000-0000-000000000000" + ) + webpubsubchatservice_tenant_id = os.environ.get( + "WEBPUBSUBCHATSERVICE_TENANT_ID", "00000000-0000-0000-0000-000000000000" + ) + webpubsubchatservice_client_id = os.environ.get( + "WEBPUBSUBCHATSERVICE_CLIENT_ID", "00000000-0000-0000-0000-000000000000" + ) + webpubsubchatservice_client_secret = os.environ.get( + "WEBPUBSUBCHATSERVICE_CLIENT_SECRET", "00000000-0000-0000-0000-000000000000" + ) + add_general_regex_sanitizer( + regex=webpubsubchatservice_subscription_id, value="00000000-0000-0000-0000-000000000000" + ) + add_general_regex_sanitizer(regex=webpubsubchatservice_tenant_id, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=webpubsubchatservice_client_id, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=webpubsubchatservice_client_secret, value="00000000-0000-0000-0000-000000000000") + + add_header_regex_sanitizer(key="Set-Cookie", value="[set-cookie;]") + add_header_regex_sanitizer(key="Cookie", value="cookie;") + add_body_key_sanitizer(json_path="$..access_token", value="access_token") diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/test_web_pub_sub_chat_service.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/test_web_pub_sub_chat_service.py new file mode 100644 index 000000000000..12a168e8992f --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/test_web_pub_sub_chat_service.py @@ -0,0 +1,213 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils import recorded_by_proxy +from testpreparer import WebPubSubChatServiceClientTestBase, WebPubSubChatServicePreparer + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestWebPubSubChatService(WebPubSubChatServiceClientTestBase): + @WebPubSubChatServicePreparer() + @recorded_by_proxy + def test_get_conversation(self, webpubsubchatservice_endpoint): + client = self.create_client(endpoint=webpubsubchatservice_endpoint) + response = client.get_conversation( + conversation_id="str", + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy + def test_list_messages(self, webpubsubchatservice_endpoint): + client = self.create_client(endpoint=webpubsubchatservice_endpoint) + response = client.list_messages( + conversation_id="str", + ) + result = [r for r in response] + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy + def test_delete_message(self, webpubsubchatservice_endpoint): + client = self.create_client(endpoint=webpubsubchatservice_endpoint) + response = client.delete_message( + conversation_id="str", + message_id="str", + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy + def test_update_message(self, webpubsubchatservice_endpoint): + client = self.create_client(endpoint=webpubsubchatservice_endpoint) + response = client.update_message( + conversation_id="str", + message_id="str", + resource={ + "content": {"binary": bytes("bytes", encoding="utf-8"), "text": "str"}, + "createdAt": "2020-02-20 00:00:00", + "createdBy": "str", + "etag": "str", + "id": "str", + }, + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy + def test_list_roles(self, webpubsubchatservice_endpoint): + client = self.create_client(endpoint=webpubsubchatservice_endpoint) + response = client.list_roles() + result = [r for r in response] + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy + def test_get_role(self, webpubsubchatservice_endpoint): + client = self.create_client(endpoint=webpubsubchatservice_endpoint) + response = client.get_role( + role_name="str", + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy + def test_create_or_replace_role(self, webpubsubchatservice_endpoint): + client = self.create_client(endpoint=webpubsubchatservice_endpoint) + response = client.create_or_replace_role( + role_name="str", + resource={"etag": "str", "name": "str", "permissions": ["str"]}, + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy + def test_delete_role(self, webpubsubchatservice_endpoint): + client = self.create_client(endpoint=webpubsubchatservice_endpoint) + response = client.delete_role( + role_name="str", + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy + def test_create_or_replace_room(self, webpubsubchatservice_endpoint): + client = self.create_client(endpoint=webpubsubchatservice_endpoint) + response = client.create_or_replace_room( + room_id="str", + resource={"defaultConversation": "str", "etag": "str", "id": "str", "title": "str"}, + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy + def test_get_room(self, webpubsubchatservice_endpoint): + client = self.create_client(endpoint=webpubsubchatservice_endpoint) + response = client.get_room( + room_id="str", + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy + def test_delete_room(self, webpubsubchatservice_endpoint): + client = self.create_client(endpoint=webpubsubchatservice_endpoint) + response = client.delete_room( + room_id="str", + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy + def test_list_room_members(self, webpubsubchatservice_endpoint): + client = self.create_client(endpoint=webpubsubchatservice_endpoint) + response = client.list_room_members( + room_id="str", + ) + result = [r for r in response] + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy + def test_create_or_replace_room_member(self, webpubsubchatservice_endpoint): + client = self.create_client(endpoint=webpubsubchatservice_endpoint) + response = client.create_or_replace_room_member( + room_id="str", + user_id="str", + resource={"etag": "str", "roleName": "str", "userId": "str"}, + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy + def test_delete_room_member(self, webpubsubchatservice_endpoint): + client = self.create_client(endpoint=webpubsubchatservice_endpoint) + response = client.delete_room_member( + room_id="str", + user_id="str", + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy + def test_get_user(self, webpubsubchatservice_endpoint): + client = self.create_client(endpoint=webpubsubchatservice_endpoint) + response = client.get_user( + user_id="str", + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy + def test_create_or_replace_user(self, webpubsubchatservice_endpoint): + client = self.create_client(endpoint=webpubsubchatservice_endpoint) + response = client.create_or_replace_user( + user_id="str", + resource={"etag": "str", "id": "str", "kind": "Human", "nickname": "str", "roleName": "str"}, + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy + def test_delete_user(self, webpubsubchatservice_endpoint): + client = self.create_client(endpoint=webpubsubchatservice_endpoint) + response = client.delete_user( + user_id="str", + ) + + # please add some check logic here by yourself + # ... diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/test_web_pub_sub_chat_service_async.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/test_web_pub_sub_chat_service_async.py new file mode 100644 index 000000000000..d523fbf6b6df --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/test_web_pub_sub_chat_service_async.py @@ -0,0 +1,214 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils.aio import recorded_by_proxy_async +from testpreparer import WebPubSubChatServicePreparer +from testpreparer_async import WebPubSubChatServiceClientTestBaseAsync + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestWebPubSubChatServiceAsync(WebPubSubChatServiceClientTestBaseAsync): + @WebPubSubChatServicePreparer() + @recorded_by_proxy_async + async def test_get_conversation(self, webpubsubchatservice_endpoint): + client = self.create_async_client(endpoint=webpubsubchatservice_endpoint) + response = await client.get_conversation( + conversation_id="str", + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy_async + async def test_list_messages(self, webpubsubchatservice_endpoint): + client = self.create_async_client(endpoint=webpubsubchatservice_endpoint) + response = client.list_messages( + conversation_id="str", + ) + result = [r async for r in response] + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy_async + async def test_delete_message(self, webpubsubchatservice_endpoint): + client = self.create_async_client(endpoint=webpubsubchatservice_endpoint) + response = await client.delete_message( + conversation_id="str", + message_id="str", + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy_async + async def test_update_message(self, webpubsubchatservice_endpoint): + client = self.create_async_client(endpoint=webpubsubchatservice_endpoint) + response = await client.update_message( + conversation_id="str", + message_id="str", + resource={ + "content": {"binary": bytes("bytes", encoding="utf-8"), "text": "str"}, + "createdAt": "2020-02-20 00:00:00", + "createdBy": "str", + "etag": "str", + "id": "str", + }, + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy_async + async def test_list_roles(self, webpubsubchatservice_endpoint): + client = self.create_async_client(endpoint=webpubsubchatservice_endpoint) + response = client.list_roles() + result = [r async for r in response] + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy_async + async def test_get_role(self, webpubsubchatservice_endpoint): + client = self.create_async_client(endpoint=webpubsubchatservice_endpoint) + response = await client.get_role( + role_name="str", + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy_async + async def test_create_or_replace_role(self, webpubsubchatservice_endpoint): + client = self.create_async_client(endpoint=webpubsubchatservice_endpoint) + response = await client.create_or_replace_role( + role_name="str", + resource={"etag": "str", "name": "str", "permissions": ["str"]}, + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy_async + async def test_delete_role(self, webpubsubchatservice_endpoint): + client = self.create_async_client(endpoint=webpubsubchatservice_endpoint) + response = await client.delete_role( + role_name="str", + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy_async + async def test_create_or_replace_room(self, webpubsubchatservice_endpoint): + client = self.create_async_client(endpoint=webpubsubchatservice_endpoint) + response = await client.create_or_replace_room( + room_id="str", + resource={"defaultConversation": "str", "etag": "str", "id": "str", "title": "str"}, + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy_async + async def test_get_room(self, webpubsubchatservice_endpoint): + client = self.create_async_client(endpoint=webpubsubchatservice_endpoint) + response = await client.get_room( + room_id="str", + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy_async + async def test_delete_room(self, webpubsubchatservice_endpoint): + client = self.create_async_client(endpoint=webpubsubchatservice_endpoint) + response = await client.delete_room( + room_id="str", + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy_async + async def test_list_room_members(self, webpubsubchatservice_endpoint): + client = self.create_async_client(endpoint=webpubsubchatservice_endpoint) + response = client.list_room_members( + room_id="str", + ) + result = [r async for r in response] + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy_async + async def test_create_or_replace_room_member(self, webpubsubchatservice_endpoint): + client = self.create_async_client(endpoint=webpubsubchatservice_endpoint) + response = await client.create_or_replace_room_member( + room_id="str", + user_id="str", + resource={"etag": "str", "roleName": "str", "userId": "str"}, + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy_async + async def test_delete_room_member(self, webpubsubchatservice_endpoint): + client = self.create_async_client(endpoint=webpubsubchatservice_endpoint) + response = await client.delete_room_member( + room_id="str", + user_id="str", + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy_async + async def test_get_user(self, webpubsubchatservice_endpoint): + client = self.create_async_client(endpoint=webpubsubchatservice_endpoint) + response = await client.get_user( + user_id="str", + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy_async + async def test_create_or_replace_user(self, webpubsubchatservice_endpoint): + client = self.create_async_client(endpoint=webpubsubchatservice_endpoint) + response = await client.create_or_replace_user( + user_id="str", + resource={"etag": "str", "id": "str", "kind": "Human", "nickname": "str", "roleName": "str"}, + ) + + # please add some check logic here by yourself + # ... + + @WebPubSubChatServicePreparer() + @recorded_by_proxy_async + async def test_delete_user(self, webpubsubchatservice_endpoint): + client = self.create_async_client(endpoint=webpubsubchatservice_endpoint) + response = await client.delete_user( + user_id="str", + ) + + # please add some check logic here by yourself + # ... diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/testpreparer.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/testpreparer.py new file mode 100644 index 000000000000..f44330002f27 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/testpreparer.py @@ -0,0 +1,28 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient +from devtools_testutils import AzureRecordedTestCase, PowerShellPreparer +import functools + + +class WebPubSubChatServiceClientTestBase(AzureRecordedTestCase): + + def create_client(self, endpoint): + credential = self.get_credential(WebPubSubChatServiceClient) + return self.create_client_from_credential( + WebPubSubChatServiceClient, + credential=credential, + endpoint=endpoint, + ) + + +WebPubSubChatServicePreparer = functools.partial( + PowerShellPreparer, + "webpubsubchatservice", + webpubsubchatservice_endpoint="https://fake_webpubsubchatservice_endpoint.com", +) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/testpreparer_async.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/testpreparer_async.py new file mode 100644 index 000000000000..71b0b47d0798 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/testpreparer_async.py @@ -0,0 +1,20 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from azure.messaging.webpubsubservice.chat.aio import WebPubSubChatServiceClient +from devtools_testutils import AzureRecordedTestCase + + +class WebPubSubChatServiceClientTestBaseAsync(AzureRecordedTestCase): + + def create_async_client(self, endpoint): + credential = self.get_credential(WebPubSubChatServiceClient, is_async=True) + return self.create_client_from_credential( + WebPubSubChatServiceClient, + credential=credential, + endpoint=endpoint, + ) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/setup.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/setup.py new file mode 100644 index 000000000000..d36d5bf56bad --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/setup.py @@ -0,0 +1,73 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + + +import os +import re +from setuptools import setup, find_packages + + +PACKAGE_NAME = "azure-messaging-webpubsubchatservice" +PACKAGE_PPRINT_NAME = "Azure Web PubSub Chat Service" +PACKAGE_NAMESPACE = "azure.messaging.webpubsubservice.chat" + +# a.b.c => a/b/c +package_folder_path = PACKAGE_NAMESPACE.replace(".", "/") + +# Version extraction inspired from 'requests' +with open(os.path.join(package_folder_path, "_version.py"), "r") as fd: + version = re.search(r'^VERSION\s*=\s*[\'"]([^\'"]*)[\'"]', fd.read(), re.MULTILINE).group(1) + +if not version: + raise RuntimeError("Cannot find version information") + + +setup( + name=PACKAGE_NAME, + version=version, + description="Microsoft Corporation {} Client Library for Python".format(PACKAGE_PPRINT_NAME), + long_description=open("README.md", "r").read(), + long_description_content_type="text/markdown", + license="MIT License", + author="Microsoft Corporation", + author_email="azpysdkhelp@microsoft.com", + url="https://github.com/Azure/azure-sdk-for-python/tree/main/sdk", + keywords="azure, azure sdk", + classifiers=[ + "Development Status :: 4 - Beta", + "Programming Language :: Python", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", + "Programming Language :: Python :: 3.14", + "License :: OSI Approved :: MIT License", + ], + zip_safe=False, + packages=find_packages( + exclude=[ + "tests", + # Exclude packages that will be covered by PEP420 or nspkg + "azure", + "azure.messaging", + "azure.messaging.webpubsubservice", + ] + ), + include_package_data=True, + package_data={ + "azure.messaging.webpubsubservice.chat": ["py.typed"], + }, + install_requires=[ + "isodate>=0.6.1", + "azure-core>=1.37.0", + "typing-extensions>=4.6.0", + ], + python_requires=">=3.10", +) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tsp-location.yaml b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tsp-location.yaml new file mode 100644 index 000000000000..f99f61605125 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tsp-location.yaml @@ -0,0 +1,5 @@ +directory: specification/webpubsub/data-plane/WebPubSubChat +commit: f58a62e4a14eb2fdb76a6826646e08fc18aac208 +repo: Azure/azure-rest-api-specs +additionalDirectories: [] +entrypointFile: client.tsp From 5ce9244102ee009b126291821676b9e0f5ff89f8 Mon Sep 17 00:00:00 2001 From: Zitong Yang Date: Mon, 17 Aug 2026 17:19:26 +1000 Subject: [PATCH 2/6] Add Web PubSub Chat SDK customization --- ...webpubsub-chat-customization-2026-08-17.md | 7 + .../CHANGELOG.md | 3 + .../README.md | 144 ++- .../api.md | 923 ++++++++++++++++++ .../api.metadata.yml | 3 + .../assets.json | 6 + .../webpubsubservice/chat/_constants.py | 31 + .../messaging/webpubsubservice/chat/_patch.py | 128 ++- .../webpubsubservice/chat/aio/_patch.py | 117 ++- .../dev_requirements.txt | 1 + .../samples/sample_authentication.py | 64 ++ .../samples/sample_client_access.py | 31 + .../samples/sample_client_access_async.py | 29 + .../samples/sample_message_history.py | 26 + .../samples/sample_message_history_async.py | 30 + .../samples/sample_message_management.py | 41 + .../samples/sample_resource_management.py | 60 ++ .../sample_resource_management_async.py | 60 ++ .../samples/sample_roles_and_permissions.py | 16 + .../setup.py | 2 + .../test-resources.bicep | 128 +++ .../tests.yml | 13 + .../tests/conftest.py | 30 + .../tests/test_client.py | 228 +++++ .../tests/test_client_async.py | 144 +++ .../tests/test_live.py | 97 ++ .../tests/test_live_async.py | 60 ++ .../tests/testcase.py | 42 + sdk/webpubsub/ci.yml | 4 +- 29 files changed, 2434 insertions(+), 34 deletions(-) create mode 100644 .chronus/changes/webpubsub-chat-customization-2026-08-17.md create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/api.md create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/api.metadata.yml create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/assets.json create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_constants.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_authentication.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_client_access.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_client_access_async.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_message_history.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_message_history_async.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_message_management.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_resource_management.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_resource_management_async.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_roles_and_permissions.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/test-resources.bicep create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/tests.yml create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/conftest.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_client.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_client_async.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live_async.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/testcase.py diff --git a/.chronus/changes/webpubsub-chat-customization-2026-08-17.md b/.chronus/changes/webpubsub-chat-customization-2026-08-17.md new file mode 100644 index 000000000000..1bf03f000c91 --- /dev/null +++ b/.chronus/changes/webpubsub-chat-customization-2026-08-17.md @@ -0,0 +1,7 @@ +--- +changeKind: feature +packages: + - azure-messaging-webpubsubchatservice +--- + +Add authentication options, client access token generation, built-in Chat constants, tests, samples, and live-test pipeline support. diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/CHANGELOG.md b/sdk/webpubsub/azure-messaging-webpubsubchatservice/CHANGELOG.md index 24a1b4c4f4da..d901a81315d4 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/CHANGELOG.md +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/CHANGELOG.md @@ -5,6 +5,9 @@ ### Features Added - Initial preview release of the Azure Web PubSub Chat Service client library for Python + - Added connection string, access key, and Microsoft Entra ID authentication + - Added client access token generation for connected Chat clients + - Added built-in Chat role and permission constants - Support for room management (create, get, update, delete rooms) - Support for user management (create, get, delete users) - Support for room membership management (add, list, delete room members) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/README.md b/sdk/webpubsub/azure-messaging-webpubsubchatservice/README.md index 73cf59ab5098..7e758a45a22f 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/README.md +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/README.md @@ -1,5 +1,6 @@ -# "Azure Web PubSub Chat Service" client library for Python - +# Azure Web PubSub Chat service client library for Python + +Use this client library to manage server-side Chat resources hosted by Azure Web PubSub. Applications use the service client to manage roles, rooms, users, room membership, and persisted message history. Connected clients send real-time messages separately over WebSockets. ## Getting started @@ -9,52 +10,136 @@ python -m pip install azure-messaging-webpubsubchatservice ``` -#### Prequisites +### Prerequisites - Python 3.10 or later is required to use this package. -- You need an [Azure subscription][azure_sub] to use this package. -- An existing "Azure Web PubSub Chat Service" instance. +- An [Azure subscription][azure_sub]. +- An [Azure Web PubSub resource][webpubsub_docs] with Chat enabled for the target hub. ### Use with AI tools AI coding tools such as VS Code and GitHub Copilot can help you write and debug code that uses this library. See [Using the Azure SDK for Python with AI tools](https://aka.ms/azsdk/python/ai) for available integrations. -#### Create with an Azure Active Directory Credential -To use an [Azure Active Directory (AAD) token credential][authenticate_with_token], -provide an instance of the desired credential type obtained from the -[azure-identity][azure_identity_credentials] library. +### Create and authenticate the client + +Use a connection string: + + + +```python +import os +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + +hub = os.environ.get("WPS_CHAT_HUB", "test_hub") +with WebPubSubChatServiceClient.from_connection_string( + os.environ["WPS_CHAT_CONNECTION_STRING"], hub +) as connection_string_client: + print(type(connection_string_client).__name__) +``` + + -To authenticate with AAD, you must first [pip][pip] install [`azure-identity`][azure_identity_pip] +Use an access key: -After setup, you can choose which type of [credential][azure_identity_credentials] from azure.identity to use. -As an example, [DefaultAzureCredential][default_azure_credential] can be used to authenticate the client: + -Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: -`AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET` +```python +import os +from azure.core.credentials import AzureKeyCredential +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + +endpoint = os.environ["WPS_CHAT_ENDPOINT"] +hub = os.environ.get("WPS_CHAT_HUB", "test_hub") +with WebPubSubChatServiceClient( + endpoint, + hub, + AzureKeyCredential(os.environ["WPS_CHAT_ACCESS_KEY"]), +) as key_client: + print(type(key_client).__name__) +``` + + + +Use Microsoft Entra ID after installing `azure-identity` and assigning the appropriate Web PubSub data-plane role: -Use the returned token credential to authenticate the client: + ```python ->>> from azure.messaging.webpubsubservice.chat import WebPubSubChatClient ->>> from azure.identity import DefaultAzureCredential ->>> client = WebPubSubChatClient(endpoint='', credential=DefaultAzureCredential()) +import os +from azure.identity import DefaultAzureCredential +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + +endpoint = os.environ["WPS_CHAT_ENDPOINT"] +hub = os.environ.get("WPS_CHAT_HUB", "test_hub") +with WebPubSubChatServiceClient(endpoint, hub, DefaultAzureCredential()) as entra_client: + print(type(entra_client).__name__) ``` + + +## Key concepts + +- **Role**: A named set of user or room permissions. +- **User**: A Chat profile assigned to a user role. +- **Room**: A server-side Chat room with a default persisted conversation. +- **Room member**: A user assigned a room role within a room. +- **Message history**: Messages sent by connected WebSocket clients and persisted by the Chat service. The REST API lists, updates, and deletes messages; it does not create them. + ## Examples +### Generate client access credentials + + + +```python +import os +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + +connection_string = os.environ["WPS_CHAT_CONNECTION_STRING"] +with WebPubSubChatServiceClient.from_connection_string( + connection_string, + os.environ.get("WPS_CHAT_HUB", "test_hub"), +) as client: + access = client.get_client_access_token(user_id="sample-user") + print(access["url"]) +``` + + + +### Create a custom role + ```python ->>> from azure.messaging.webpubsubservice.chat import WebPubSubChatClient ->>> from azure.identity import DefaultAzureCredential ->>> from azure.core.exceptions import HttpResponseError +from azure.messaging.webpubsubservice.chat import UserPermissions +from azure.messaging.webpubsubservice.chat.models import ChatRole + +client.create_or_replace_role( + "user.moderator", + ChatRole(permissions=[UserPermissions.CREATE_ROOM]), +) +for role in client.list_roles(): + print(role.name, role.permissions) +client.delete_role("user.moderator") +``` + +### Handle service errors ->>> client = WebPubSubChatClient(endpoint='', credential=DefaultAzureCredential()) ->>> try: - - except HttpResponseError as e: - print('service responds error: {}'.format(e.response.json())) +```python +from azure.core.exceptions import HttpResponseError +try: + room = client.get_room("room-id") +except HttpResponseError as error: + print(f"Chat service request failed: {error}") ``` +See the executable [package samples][samples] for authentication, sync and async resource management, built-in constants, client access generation, and message history. + +## Troubleshooting + +Enable SDK logging by passing `logging_enable=True` when creating the client. HTTP headers and bodies can contain sensitive information; do not enable detailed logging in production without reviewing the output. + +The client access API returns a WebSocket URL containing an access token. Do not log or persist that URL. Connection strings and access keys must also be treated as secrets. + ## Contributing This project welcomes contributions and suggestions. Most contributions require @@ -74,9 +159,6 @@ additional questions or comments. [code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ -[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token -[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials -[azure_identity_pip]: https://pypi.org/project/azure-identity/ -[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential -[pip]: https://pypi.org/project/pip/ [azure_sub]: https://azure.microsoft.com/free/ +[webpubsub_docs]: https://learn.microsoft.com/azure/azure-web-pubsub/overview +[samples]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/api.md b/sdk/webpubsub/azure-messaging-webpubsubchatservice/api.md new file mode 100644 index 000000000000..752abd7e3dc8 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/api.md @@ -0,0 +1,923 @@ +```py +namespace azure.messaging.webpubsubservice.chat + + class azure.messaging.webpubsubservice.chat.ChatRoles: + ROOM_MEMBER = room.member + ROOM_OPERATOR = room.operator + USER_NORMAL = user.normal + + + class azure.messaging.webpubsubservice.chat.RoomPermissions: + INVITE_USER = room.invite + PUBLISH_MESSAGE = room.publish_message + READ_HISTORY = room.history + REMOVE_USER = room.remove_user + + + class azure.messaging.webpubsubservice.chat.UserPermissions: + CREATE_ROOM = user.create_room + FETCH_ALL_ROOMS = user.fetch_all_rooms + + + class azure.messaging.webpubsubservice.chat.WebPubSubChatServiceClient(WebPubSubChatServiceClientGenerated): implements ContextManager + + def __init__( + self, + endpoint: str, + hub: str, + credential: Union[TokenCredential, AzureKeyCredential], + *, + api_version: Optional[str] = ..., + **kwargs: Any + ) -> None: ... + + @classmethod + def from_connection_string( + cls, + connection_string: str, + hub: str, + **kwargs: Any + ) -> WebPubSubChatServiceClient: ... + + def close(self) -> None: ... + + @overload + def create_or_replace_role( + self, + role_name: str, + resource: ChatRole, + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatRole: ... + + @overload + def create_or_replace_role( + self, + role_name: str, + resource: ChatRole, + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatRole: ... + + @overload + def create_or_replace_role( + self, + role_name: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatRole: ... + + @overload + def create_or_replace_room( + self, + room_id: str, + resource: ChatRoom, + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatRoom: ... + + @overload + def create_or_replace_room( + self, + room_id: str, + resource: ChatRoom, + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatRoom: ... + + @overload + def create_or_replace_room( + self, + room_id: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatRoom: ... + + @overload + def create_or_replace_room_member( + self, + room_id: str, + user_id: str, + resource: ChatRoomMember, + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatRoomMember: ... + + @overload + def create_or_replace_room_member( + self, + room_id: str, + user_id: str, + resource: ChatRoomMember, + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatRoomMember: ... + + @overload + def create_or_replace_room_member( + self, + room_id: str, + user_id: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatRoomMember: ... + + @overload + def create_or_replace_user( + self, + user_id: str, + resource: ChatUser, + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatUser: ... + + @overload + def create_or_replace_user( + self, + user_id: str, + resource: ChatUser, + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatUser: ... + + @overload + def create_or_replace_user( + self, + user_id: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatUser: ... + + @distributed_trace + def delete_message( + self, + conversation_id: str, + message_id: str, + *, + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> None: ... + + @distributed_trace + def delete_role( + self, + role_name: str, + *, + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> None: ... + + @distributed_trace + def delete_room( + self, + room_id: str, + *, + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> None: ... + + @distributed_trace + def delete_room_member( + self, + room_id: str, + user_id: str, + *, + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> None: ... + + @distributed_trace + def delete_user( + self, + user_id: str, + *, + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> None: ... + + @distributed_trace + def get_client_access_token( + self, + *, + minutes_to_expire: int = 60, + user_id: Optional[str] = ..., + **kwargs: Any + ) -> Dict[str, Any]: ... + + @distributed_trace + def get_conversation( + self, + conversation_id: str, + **kwargs: Any + ) -> ChatConversation: ... + + @distributed_trace + def get_role( + self, + role_name: str, + **kwargs: Any + ) -> ChatRole: ... + + @distributed_trace + def get_room( + self, + room_id: str, + **kwargs: Any + ) -> ChatRoom: ... + + @distributed_trace + def get_user( + self, + user_id: str, + **kwargs: Any + ) -> ChatUser: ... + + @distributed_trace + def list_messages( + self, + conversation_id: str, + *, + earliest_message_id: Optional[str] = ..., + latest_message_id: Optional[str] = ..., + **kwargs: Any + ) -> ItemPaged[ChatMessage]: ... + + @distributed_trace + def list_roles( + self, + *, + continuation_token_parameter: Optional[str] = ..., + **kwargs: Any + ) -> ItemPaged[ChatRole]: ... + + @distributed_trace + def list_room_members( + self, + room_id: str, + *, + continuation_token_parameter: Optional[str] = ..., + **kwargs: Any + ) -> ItemPaged[ChatRoomMember]: ... + + def send_request( + self, + request: HttpRequest, + *, + stream: bool = False, + **kwargs: Any + ) -> HttpResponse: ... + + @overload + def update_message( + self, + conversation_id: str, + message_id: str, + resource: ChatMessage, + *, + content_type: str = "application/merge-patch+json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatMessage: ... + + @overload + def update_message( + self, + conversation_id: str, + message_id: str, + resource: ChatMessage, + *, + content_type: str = "application/merge-patch+json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatMessage: ... + + @overload + def update_message( + self, + conversation_id: str, + message_id: str, + resource: IO[bytes], + *, + content_type: str = "application/merge-patch+json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatMessage: ... + + +namespace azure.messaging.webpubsubservice.chat.aio + + class azure.messaging.webpubsubservice.chat.aio.WebPubSubChatServiceClient(WebPubSubChatServiceClientGenerated): implements AsyncContextManager + + def __init__( + self, + endpoint: str, + hub: str, + credential: Union[AsyncTokenCredential, AzureKeyCredential], + *, + api_version: Optional[str] = ..., + **kwargs: Any + ) -> None: ... + + @classmethod + def from_connection_string( + cls, + connection_string: str, + hub: str, + **kwargs: Any + ) -> WebPubSubChatServiceClient: ... + + async def close(self) -> None: ... + + @overload + async def create_or_replace_role( + self, + role_name: str, + resource: ChatRole, + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatRole: ... + + @overload + async def create_or_replace_role( + self, + role_name: str, + resource: ChatRole, + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatRole: ... + + @overload + async def create_or_replace_role( + self, + role_name: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatRole: ... + + @overload + async def create_or_replace_room( + self, + room_id: str, + resource: ChatRoom, + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatRoom: ... + + @overload + async def create_or_replace_room( + self, + room_id: str, + resource: ChatRoom, + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatRoom: ... + + @overload + async def create_or_replace_room( + self, + room_id: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatRoom: ... + + @overload + async def create_or_replace_room_member( + self, + room_id: str, + user_id: str, + resource: ChatRoomMember, + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatRoomMember: ... + + @overload + async def create_or_replace_room_member( + self, + room_id: str, + user_id: str, + resource: ChatRoomMember, + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatRoomMember: ... + + @overload + async def create_or_replace_room_member( + self, + room_id: str, + user_id: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatRoomMember: ... + + @overload + async def create_or_replace_user( + self, + user_id: str, + resource: ChatUser, + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatUser: ... + + @overload + async def create_or_replace_user( + self, + user_id: str, + resource: ChatUser, + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatUser: ... + + @overload + async def create_or_replace_user( + self, + user_id: str, + resource: IO[bytes], + *, + content_type: str = "application/json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatUser: ... + + @distributed_trace_async + async def delete_message( + self, + conversation_id: str, + message_id: str, + *, + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> None: ... + + @distributed_trace_async + async def delete_role( + self, + role_name: str, + *, + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> None: ... + + @distributed_trace_async + async def delete_room( + self, + room_id: str, + *, + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> None: ... + + @distributed_trace_async + async def delete_room_member( + self, + room_id: str, + user_id: str, + *, + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> None: ... + + @distributed_trace_async + async def delete_user( + self, + user_id: str, + *, + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> None: ... + + @distributed_trace_async + async def get_client_access_token( + self, + *, + minutes_to_expire: int = 60, + user_id: Optional[str] = ..., + **kwargs: Any + ) -> Dict[str, Any]: ... + + @distributed_trace_async + async def get_conversation( + self, + conversation_id: str, + **kwargs: Any + ) -> ChatConversation: ... + + @distributed_trace_async + async def get_role( + self, + role_name: str, + **kwargs: Any + ) -> ChatRole: ... + + @distributed_trace_async + async def get_room( + self, + room_id: str, + **kwargs: Any + ) -> ChatRoom: ... + + @distributed_trace_async + async def get_user( + self, + user_id: str, + **kwargs: Any + ) -> ChatUser: ... + + @distributed_trace + def list_messages( + self, + conversation_id: str, + *, + earliest_message_id: Optional[str] = ..., + latest_message_id: Optional[str] = ..., + **kwargs: Any + ) -> AsyncItemPaged[ChatMessage]: ... + + @distributed_trace + def list_roles( + self, + *, + continuation_token_parameter: Optional[str] = ..., + **kwargs: Any + ) -> AsyncItemPaged[ChatRole]: ... + + @distributed_trace + def list_room_members( + self, + room_id: str, + *, + continuation_token_parameter: Optional[str] = ..., + **kwargs: Any + ) -> AsyncItemPaged[ChatRoomMember]: ... + + def send_request( + self, + request: HttpRequest, + *, + stream: bool = False, + **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: ... + + @overload + async def update_message( + self, + conversation_id: str, + message_id: str, + resource: ChatMessage, + *, + content_type: str = "application/merge-patch+json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatMessage: ... + + @overload + async def update_message( + self, + conversation_id: str, + message_id: str, + resource: ChatMessage, + *, + content_type: str = "application/merge-patch+json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatMessage: ... + + @overload + async def update_message( + self, + conversation_id: str, + message_id: str, + resource: IO[bytes], + *, + content_type: str = "application/merge-patch+json", + etag: Optional[str] = ..., + match_condition: Optional[MatchConditions] = ..., + **kwargs: Any + ) -> ChatMessage: ... + + +namespace azure.messaging.webpubsubservice.chat.models + + class azure.messaging.webpubsubservice.chat.models.ChatConversation(_Model): + etag: str + id: str + parent_room: str + + @overload + def __init__( + self, + *, + parent_room: str + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.messaging.webpubsubservice.chat.models.ChatMessage(_Model): + content: MessageContent + created_at: datetime + created_by: str + etag: str + id: str + + @overload + def __init__( + self, + *, + content: MessageContent, + created_by: str + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.messaging.webpubsubservice.chat.models.ChatRole(_Model): + etag: str + name: str + permissions: list[str] + + @overload + def __init__( + self, + *, + permissions: list[str] + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.messaging.webpubsubservice.chat.models.ChatRoom(_Model): + default_conversation: str + etag: str + id: str + title: str + + @overload + def __init__( + self, + *, + title: str + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.messaging.webpubsubservice.chat.models.ChatRoomMember(_Model): + etag: str + role_name: str + user_id: str + + @overload + def __init__( + self, + *, + role_name: str + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.messaging.webpubsubservice.chat.models.ChatUser(_Model): + etag: str + id: str + kind: str + nickname: str + + @overload + def __init__( + self, + *, + kind: str, + nickname: str + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.messaging.webpubsubservice.chat.models.ChatUserKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): + HUMAN = "Human" + + + class azure.messaging.webpubsubservice.chat.models.HumanChatUser(ChatUser, discriminator='Human'): + etag: str + id: str + kind: Literal[ChatUserKind.HUMAN] + nickname: str + role_name: str + + @overload + def __init__( + self, + *, + nickname: str, + role_name: str + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.messaging.webpubsubservice.chat.models.MessageContent(_Model): + binary: Optional[bytes] + text: Optional[str] + + @overload + def __init__( + self, + *, + binary: Optional[bytes] = ..., + text: Optional[str] = ... + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + +namespace azure.messaging.webpubsubservice.chat.types + + class azure.messaging.webpubsubservice.chat.types.ChatConversation(TypedDict, total=False): + key "etag": Required[str] + key "id": Required[str] + key "parentRoom": Required[str] + etag: str + id: str + parent_room: str + + + class azure.messaging.webpubsubservice.chat.types.ChatMessage(TypedDict, total=False): + key "content": Required[MessageContent] + key "createdAt": Required[str] + key "createdBy": Required[str] + key "etag": Required[str] + key "id": Required[str] + content: MessageContent + created_at: str + created_by: str + etag: str + id: str + + + class azure.messaging.webpubsubservice.chat.types.ChatRole(TypedDict, total=False): + key "etag": Required[str] + key "name": Required[str] + key "permissions": Required[list[str]] + etag: str + name: str + permissions: list[str] + + + class azure.messaging.webpubsubservice.chat.types.ChatRoom(TypedDict, total=False): + key "defaultConversation": Required[str] + key "etag": Required[str] + key "id": Required[str] + key "title": Required[str] + default_conversation: str + etag: str + id: str + title: str + + + class azure.messaging.webpubsubservice.chat.types.ChatRoomMember(TypedDict, total=False): + key "etag": Required[str] + key "roleName": Required[str] + key "userId": Required[str] + etag: str + role_name: str + user_id: str + + + class azure.messaging.webpubsubservice.chat.types.ChatUser(TypedDict, total=False): + key "etag": Required[str] + key "id": Required[str] + key "kind": Required[Literal[ChatUserKind.HUMAN]] + key "nickname": Required[str] + key "roleName": Required[str] + etag: str + id: str + kind: Literal[ChatUserKind.HUMAN] + nickname: str + role_name: str + + + class azure.messaging.webpubsubservice.chat.types.ChatUserKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): + HUMAN = "Human" + + + class azure.messaging.webpubsubservice.chat.types.HumanChatUser(TypedDict, total=False): + key "etag": Required[str] + key "id": Required[str] + key "kind": Required[Literal[ChatUserKind.HUMAN]] + key "nickname": Required[str] + key "roleName": Required[str] + etag: str + id: str + kind: Literal[ChatUserKind.HUMAN] + nickname: str + role_name: str + + + class azure.messaging.webpubsubservice.chat.types.MessageContent(TypedDict, total=False): + key "binary": str + key "text": str + binary: str + text: str + + +``` \ No newline at end of file diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/api.metadata.yml b/sdk/webpubsub/azure-messaging-webpubsubchatservice/api.metadata.yml new file mode 100644 index 000000000000..40c924bd82b7 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/api.metadata.yml @@ -0,0 +1,3 @@ +apiMdSha256: 0736530dbfe716aa62d4b37329474ed288037c39383e54e30144dca83e2b940a +parserVersion: 0.3.31 +pythonVersion: 3.12.13 diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/assets.json b/sdk/webpubsub/azure-messaging-webpubsubchatservice/assets.json new file mode 100644 index 000000000000..300edc2b5fcf --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/assets.json @@ -0,0 +1,6 @@ +{ + "AssetsRepo": "Azure/azure-sdk-assets", + "AssetsRepoPrefixPath": "python", + "TagPrefix": "python/webpubsub/azure-messaging-webpubsubchatservice", + "Tag": "" +} diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_constants.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_constants.py new file mode 100644 index 000000000000..745066efdf4b --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_constants.py @@ -0,0 +1,31 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- + + +class ChatRoles: + """Built-in Web PubSub Chat roles.""" + + USER_NORMAL = "user.normal" + ROOM_MEMBER = "room.member" + ROOM_OPERATOR = "room.operator" + + +class UserPermissions: + """Built-in Web PubSub Chat user permissions.""" + + CREATE_ROOM = "user.create_room" + FETCH_ALL_ROOMS = "user.fetch_all_rooms" + + +class RoomPermissions: + """Built-in Web PubSub Chat room permissions.""" + + INVITE_USER = "room.invite" + REMOVE_USER = "room.remove_user" + READ_HISTORY = "room.history" + PUBLISH_MESSAGE = "room.publish_message" + + +__all__ = ["ChatRoles", "RoomPermissions", "UserPermissions"] diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_patch.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_patch.py index 87676c65a8f0..df9f66e25c08 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_patch.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_patch.py @@ -7,9 +7,135 @@ Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ +from typing import Any, Dict, Optional, TYPE_CHECKING, Union +from azure.core.credentials import AzureKeyCredential +from azure.core.tracing.decorator import distributed_trace -__all__: list[str] = [] # Add all objects you want publicly available to users at this package level +from azure.messaging.webpubsubservice._patch import ( + ApiManagementProxy, + JwtCredentialPolicy, + WebPubSubServiceClient, + _parse_connection_string, +) + +from ._client import WebPubSubChatServiceClient as WebPubSubChatServiceClientGenerated +from ._constants import ChatRoles, RoomPermissions, UserPermissions + +if TYPE_CHECKING: + from azure.core.credentials import TokenCredential + + +_CHAT_CLIENT_ROLES = ["webpubsub.getGroupState", "webpubsub.setGroupState"] + + +class WebPubSubChatServiceClient(WebPubSubChatServiceClientGenerated): + """Client for managing Azure Web PubSub Chat resources. + + :param endpoint: HTTP or HTTPS endpoint for the Web PubSub service instance. + :type endpoint: str + :param hub: Target hub name. + :type hub: str + :param credential: Credential used to authenticate requests to the service. + :type credential: ~azure.core.credentials.TokenCredential or ~azure.core.credentials.AzureKeyCredential + :keyword api_version: The API version to use for Chat service operations. + :paramtype api_version: str + """ + + def __init__( + self, + endpoint: str, + hub: str, + credential: Union["TokenCredential", AzureKeyCredential], + *, + api_version: Optional[str] = None, + **kwargs: Any, + ) -> None: + if not endpoint: + raise ValueError("Parameter 'endpoint' must not be empty.") + if not hub: + raise ValueError("Parameter 'hub' must not be empty.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + service_client_kwargs = { + name: kwargs[name] for name in ("reverse_proxy_endpoint", "transport") if name in kwargs + } + port = kwargs.pop("port", None) + if port: + endpoint = f"{endpoint.rstrip('/')}:{port}" + kwargs["origin_endpoint"] = endpoint + if isinstance(credential, AzureKeyCredential): + kwargs["authentication_policy"] = JwtCredentialPolicy( + credential, + origin_endpoint=endpoint, + reverse_proxy_endpoint=kwargs.get("reverse_proxy_endpoint"), + ) + if "proxy_policy" not in kwargs: + kwargs["proxy_policy"] = ApiManagementProxy(**kwargs) + if api_version is not None: + kwargs["api_version"] = api_version + super().__init__(endpoint=endpoint, hub=hub, credential=credential, **kwargs) + self._web_pub_sub_service_client = WebPubSubServiceClient( + endpoint=endpoint, + hub=hub, + credential=credential, + **service_client_kwargs, + ) + + @classmethod + def from_connection_string(cls, connection_string: str, hub: str, **kwargs: Any) -> "WebPubSubChatServiceClient": + """Create a client from a Web PubSub connection string. + + :param connection_string: Web PubSub connection string. + :type connection_string: str + :param hub: Target hub name. + :type hub: str + :return: A Web PubSub Chat service client. + :rtype: ~azure.messaging.webpubsubservice.chat.WebPubSubChatServiceClient + """ + if not connection_string: + raise ValueError("Parameter 'connection_string' must not be empty.") + parsed = _parse_connection_string(connection_string, **kwargs) + credential = AzureKeyCredential(parsed.pop("accesskey")) + return cls(hub=hub, credential=credential, **parsed) + + @distributed_trace + def get_client_access_token( + self, + *, + user_id: Optional[str] = None, + minutes_to_expire: int = 60, + **kwargs: Any, + ) -> Dict[str, Any]: + """Generate credentials for a client to connect to Azure Web PubSub. + + :keyword user_id: Optional user ID for the connection. + :paramtype user_id: str + :keyword minutes_to_expire: Token lifetime in minutes. Defaults to 60. + :paramtype minutes_to_expire: int + :return: The Web PubSub client endpoint, token, and connection URL. + :rtype: dict[str, Any] + """ + return self._web_pub_sub_service_client.get_client_access_token( # pylint: disable=no-member + user_id=user_id, + roles=list(_CHAT_CLIENT_ROLES), + minutes_to_expire=minutes_to_expire, + groups=[], + client_protocol="Default", + **kwargs, + ) + + def close(self) -> None: + self._web_pub_sub_service_client.close() + super().close() + + +__all__: list[str] = [ + "ChatRoles", + "RoomPermissions", + "UserPermissions", + "WebPubSubChatServiceClient", +] def patch_sdk(): diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_patch.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_patch.py index 87676c65a8f0..a8a504ca8d5f 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_patch.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_patch.py @@ -7,9 +7,124 @@ Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ +from typing import Any, Dict, Optional, TYPE_CHECKING, Union +from azure.core.credentials import AzureKeyCredential +from azure.core.tracing.decorator_async import distributed_trace_async -__all__: list[str] = [] # Add all objects you want publicly available to users at this package level +from azure.messaging.webpubsubservice._patch import ApiManagementProxy, JwtCredentialPolicy, _parse_connection_string +from azure.messaging.webpubsubservice.aio._patch import WebPubSubServiceClient + +from .._patch import _CHAT_CLIENT_ROLES +from ._client import WebPubSubChatServiceClient as WebPubSubChatServiceClientGenerated + +if TYPE_CHECKING: + from azure.core.credentials_async import AsyncTokenCredential + + +class WebPubSubChatServiceClient(WebPubSubChatServiceClientGenerated): + """Async client for managing Azure Web PubSub Chat resources. + + :param endpoint: HTTP or HTTPS endpoint for the Web PubSub service instance. + :type endpoint: str + :param hub: Target hub name. + :type hub: str + :param credential: Credential used to authenticate requests to the service. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential or + ~azure.core.credentials.AzureKeyCredential + :keyword api_version: The API version to use for Chat service operations. + :paramtype api_version: str + """ + + def __init__( + self, + endpoint: str, + hub: str, + credential: Union["AsyncTokenCredential", AzureKeyCredential], + *, + api_version: Optional[str] = None, + **kwargs: Any, + ) -> None: + if not endpoint: + raise ValueError("Parameter 'endpoint' must not be empty.") + if not hub: + raise ValueError("Parameter 'hub' must not be empty.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + service_client_kwargs = { + name: kwargs[name] for name in ("reverse_proxy_endpoint", "transport") if name in kwargs + } + port = kwargs.pop("port", None) + if port: + endpoint = f"{endpoint.rstrip('/')}:{port}" + kwargs["origin_endpoint"] = endpoint + if isinstance(credential, AzureKeyCredential): + kwargs["authentication_policy"] = JwtCredentialPolicy( + credential, + origin_endpoint=endpoint, + reverse_proxy_endpoint=kwargs.get("reverse_proxy_endpoint"), + ) + if "proxy_policy" not in kwargs: + kwargs["proxy_policy"] = ApiManagementProxy(**kwargs) + if api_version is not None: + kwargs["api_version"] = api_version + super().__init__(endpoint=endpoint, hub=hub, credential=credential, **kwargs) + self._web_pub_sub_service_client = WebPubSubServiceClient( + endpoint=endpoint, + hub=hub, + credential=credential, + **service_client_kwargs, + ) + + @classmethod + def from_connection_string(cls, connection_string: str, hub: str, **kwargs: Any) -> "WebPubSubChatServiceClient": + """Create an async client from a Web PubSub connection string. + + :param connection_string: Web PubSub connection string. + :type connection_string: str + :param hub: Target hub name. + :type hub: str + :return: An async Web PubSub Chat service client. + :rtype: ~azure.messaging.webpubsubservice.chat.aio.WebPubSubChatServiceClient + """ + if not connection_string: + raise ValueError("Parameter 'connection_string' must not be empty.") + parsed = _parse_connection_string(connection_string, **kwargs) + credential = AzureKeyCredential(parsed.pop("accesskey")) + return cls(hub=hub, credential=credential, **parsed) + + @distributed_trace_async + async def get_client_access_token( + self, + *, + user_id: Optional[str] = None, + minutes_to_expire: int = 60, + **kwargs: Any, + ) -> Dict[str, Any]: + """Generate credentials for a client to connect to Azure Web PubSub. + + :keyword user_id: Optional user ID for the connection. + :paramtype user_id: str + :keyword minutes_to_expire: Token lifetime in minutes. Defaults to 60. + :paramtype minutes_to_expire: int + :return: The Web PubSub client endpoint, token, and connection URL. + :rtype: dict[str, Any] + """ + return await self._web_pub_sub_service_client.get_client_access_token( # pylint: disable=no-member + user_id=user_id, + roles=list(_CHAT_CLIENT_ROLES), + minutes_to_expire=minutes_to_expire, + groups=[], + client_protocol="Default", + **kwargs, + ) + + async def close(self) -> None: + await self._web_pub_sub_service_client.close() + await super().close() + + +__all__: list[str] = ["WebPubSubChatServiceClient"] def patch_sdk(): diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/dev_requirements.txt b/sdk/webpubsub/azure-messaging-webpubsubchatservice/dev_requirements.txt index ad0907b03b93..49b469b621e4 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/dev_requirements.txt +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/dev_requirements.txt @@ -1,4 +1,5 @@ -e ../../../eng/tools/azure-sdk-tools ../../core/azure-core ../../identity/azure-identity +../azure-messaging-webpubsubservice aiohttp \ No newline at end of file diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_authentication.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_authentication.py new file mode 100644 index 000000000000..3be4787b4fe1 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_authentication.py @@ -0,0 +1,64 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +import os + + +def connection_string_auth(): + # [START connection_string_auth] + import os + from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + + hub = os.environ.get("WPS_CHAT_HUB", "test_hub") + with WebPubSubChatServiceClient.from_connection_string( + os.environ["WPS_CHAT_CONNECTION_STRING"], hub + ) as connection_string_client: + print(type(connection_string_client).__name__) + # [END connection_string_auth] + + +def key_auth(): + # [START key_auth] + import os + from azure.core.credentials import AzureKeyCredential + from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + + endpoint = os.environ["WPS_CHAT_ENDPOINT"] + hub = os.environ.get("WPS_CHAT_HUB", "test_hub") + with WebPubSubChatServiceClient( + endpoint, + hub, + AzureKeyCredential(os.environ["WPS_CHAT_ACCESS_KEY"]), + ) as key_client: + print(type(key_client).__name__) + # [END key_auth] + + +def entra_auth(): + # [START entra_auth] + import os + from azure.identity import DefaultAzureCredential + from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + + endpoint = os.environ["WPS_CHAT_ENDPOINT"] + hub = os.environ.get("WPS_CHAT_HUB", "test_hub") + with WebPubSubChatServiceClient(endpoint, hub, DefaultAzureCredential()) as entra_client: + print(type(entra_client).__name__) + # [END entra_auth] + + +def main(): + required = ("WPS_CHAT_ENDPOINT", "WPS_CHAT_CONNECTION_STRING", "WPS_CHAT_ACCESS_KEY") + missing = [name for name in required if not os.environ.get(name)] + if missing: + print(f"Set {', '.join(missing)} to run this sample.") + return + + connection_string_auth() + key_auth() + entra_auth() + + +if __name__ == "__main__": + main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_client_access.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_client_access.py new file mode 100644 index 000000000000..feadac382427 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_client_access.py @@ -0,0 +1,31 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +import os + + +def client_access(): + # [START client_access] + import os + from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + + connection_string = os.environ["WPS_CHAT_CONNECTION_STRING"] + with WebPubSubChatServiceClient.from_connection_string( + connection_string, + os.environ.get("WPS_CHAT_HUB", "test_hub"), + ) as client: + access = client.get_client_access_token(user_id="sample-user") + print(access["url"]) + # [END client_access] + + +def main(): + if not os.environ.get("WPS_CHAT_CONNECTION_STRING"): + print("Set WPS_CHAT_CONNECTION_STRING to run this sample.") + return + client_access() + + +if __name__ == "__main__": + main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_client_access_async.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_client_access_async.py new file mode 100644 index 000000000000..ab7296ca6c90 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_client_access_async.py @@ -0,0 +1,29 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +import asyncio +import os + + +async def main(): + connection_string = os.environ.get("WPS_CHAT_CONNECTION_STRING") + if not connection_string: + print("Set WPS_CHAT_CONNECTION_STRING to run this sample.") + return + + from azure.messaging.webpubsubservice.chat.aio import WebPubSubChatServiceClient + + client = WebPubSubChatServiceClient.from_connection_string( + connection_string, + os.environ.get("WPS_CHAT_HUB", "test_hub"), + ) + try: + access = await client.get_client_access_token(user_id="sample-user") + print(access["url"]) + finally: + await client.close() + + +if __name__ == "__main__": + asyncio.run(main()) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_message_history.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_message_history.py new file mode 100644 index 000000000000..9813d91a539a --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_message_history.py @@ -0,0 +1,26 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +import os + +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient + + +def main(): + required = ("WPS_CHAT_CONNECTION_STRING", "WPS_CHAT_CONVERSATION_ID") + missing = [name for name in required if not os.environ.get(name)] + if missing: + print(f"Set {', '.join(missing)} to run this sample.") + return + + with WebPubSubChatServiceClient.from_connection_string( + os.environ["WPS_CHAT_CONNECTION_STRING"], + os.environ.get("WPS_CHAT_HUB", "test_hub"), + ) as client: + for message in client.list_messages(os.environ["WPS_CHAT_CONVERSATION_ID"]): + print(message.id, message.created_by, message.content.text) + + +if __name__ == "__main__": + main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_message_history_async.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_message_history_async.py new file mode 100644 index 000000000000..d31efb926f1d --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_message_history_async.py @@ -0,0 +1,30 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +import asyncio +import os + + +async def main(): + required = ("WPS_CHAT_CONNECTION_STRING", "WPS_CHAT_CONVERSATION_ID") + missing = [name for name in required if not os.environ.get(name)] + if missing: + print(f"Set {', '.join(missing)} to run this sample.") + return + + from azure.messaging.webpubsubservice.chat.aio import WebPubSubChatServiceClient + + client = WebPubSubChatServiceClient.from_connection_string( + os.environ["WPS_CHAT_CONNECTION_STRING"], + os.environ.get("WPS_CHAT_HUB", "test_hub"), + ) + try: + async for message in client.list_messages(os.environ["WPS_CHAT_CONVERSATION_ID"]): + print(message.id, message.created_by, message.content.text) + finally: + await client.close() + + +if __name__ == "__main__": + asyncio.run(main()) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_message_management.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_message_management.py new file mode 100644 index 000000000000..6607b032cad4 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_message_management.py @@ -0,0 +1,41 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +import os + +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient +from azure.messaging.webpubsubservice.chat.models import ChatMessage, MessageContent + + +def main(): + required = ( + "WPS_CHAT_CONNECTION_STRING", + "WPS_CHAT_CONVERSATION_ID", + "WPS_CHAT_MESSAGE_ID", + "WPS_CHAT_USER_ID", + ) + missing = [name for name in required if not os.environ.get(name)] + if missing: + print(f"Set {', '.join(missing)} to run this sample.") + return + + with WebPubSubChatServiceClient.from_connection_string( + os.environ["WPS_CHAT_CONNECTION_STRING"], + os.environ.get("WPS_CHAT_HUB", "test_hub"), + ) as client: + conversation_id = os.environ["WPS_CHAT_CONVERSATION_ID"] + message_id = os.environ["WPS_CHAT_MESSAGE_ID"] + client.update_message( + conversation_id, + message_id, + ChatMessage( + created_by=os.environ["WPS_CHAT_USER_ID"], + content=MessageContent(text="Updated message"), + ), + ) + client.delete_message(conversation_id, message_id) + + +if __name__ == "__main__": + main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_resource_management.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_resource_management.py new file mode 100644 index 000000000000..ff8b626faaf3 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_resource_management.py @@ -0,0 +1,60 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +import os +import uuid + +from azure.core.exceptions import HttpResponseError +from azure.messaging.webpubsubservice.chat import RoomPermissions, UserPermissions, WebPubSubChatServiceClient +from azure.messaging.webpubsubservice.chat.models import ChatRole, ChatRoom, ChatRoomMember, HumanChatUser + + +def main(): + connection_string = os.environ.get("WPS_CHAT_CONNECTION_STRING") + if not connection_string: + print("Set WPS_CHAT_CONNECTION_STRING to run this sample.") + return + + suffix = uuid.uuid4().hex[:8] + user_role = f"user.sample_{suffix}" + room_role = f"room.sample_{suffix}" + user_id = f"sample-user-{suffix}" + room_id = f"sample-room-{suffix}" + with WebPubSubChatServiceClient.from_connection_string( + connection_string, + os.environ.get("WPS_CHAT_HUB", "test_hub"), + ) as client: + try: + client.create_or_replace_role(user_role, ChatRole(permissions=[UserPermissions.CREATE_ROOM])) + client.create_or_replace_role(room_role, ChatRole(permissions=[RoomPermissions.PUBLISH_MESSAGE])) + client.create_or_replace_user( + user_id, + HumanChatUser(nickname="Sample User", role_name=user_role), + ) + client.create_or_replace_room(room_id, ChatRoom(title="Sample Room")) + client.create_or_replace_room_member( + room_id, + user_id, + ChatRoomMember(role_name=room_role), + ) + for member in client.list_room_members(room_id): + print(member.user_id, member.role_name) + except HttpResponseError as error: + print(f"Chat service request failed: {error}") + raise + finally: + for action, args in ( + (client.delete_room, (room_id,)), + (client.delete_user, (user_id,)), + (client.delete_role, (user_role,)), + (client.delete_role, (room_role,)), + ): + try: + action(*args) + except HttpResponseError: + pass + + +if __name__ == "__main__": + main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_resource_management_async.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_resource_management_async.py new file mode 100644 index 000000000000..bc0f7c7c1bb8 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_resource_management_async.py @@ -0,0 +1,60 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +import asyncio +import os +import uuid + +from azure.core.exceptions import HttpResponseError +from azure.messaging.webpubsubservice.chat import RoomPermissions, UserPermissions +from azure.messaging.webpubsubservice.chat.aio import WebPubSubChatServiceClient +from azure.messaging.webpubsubservice.chat.models import ChatRole, ChatRoom, ChatRoomMember, HumanChatUser + + +async def main(): + connection_string = os.environ.get("WPS_CHAT_CONNECTION_STRING") + if not connection_string: + print("Set WPS_CHAT_CONNECTION_STRING to run this sample.") + return + + suffix = uuid.uuid4().hex[:8] + user_role = f"user.async_sample_{suffix}" + room_role = f"room.async_sample_{suffix}" + user_id = f"async-sample-user-{suffix}" + room_id = f"async-sample-room-{suffix}" + client = WebPubSubChatServiceClient.from_connection_string( + connection_string, + os.environ.get("WPS_CHAT_HUB", "test_hub"), + ) + try: + await client.create_or_replace_role(user_role, ChatRole(permissions=[UserPermissions.CREATE_ROOM])) + await client.create_or_replace_role(room_role, ChatRole(permissions=[RoomPermissions.PUBLISH_MESSAGE])) + await client.create_or_replace_user( + user_id, + HumanChatUser(nickname="Async Sample User", role_name=user_role), + ) + await client.create_or_replace_room(room_id, ChatRoom(title="Async Sample Room")) + await client.create_or_replace_room_member( + room_id, + user_id, + ChatRoomMember(role_name=room_role), + ) + async for member in client.list_room_members(room_id): + print(member.user_id, member.role_name) + finally: + for action, args in ( + (client.delete_room, (room_id,)), + (client.delete_user, (user_id,)), + (client.delete_role, (user_role,)), + (client.delete_role, (room_role,)), + ): + try: + await action(*args) + except HttpResponseError: + pass + await client.close() + + +if __name__ == "__main__": + asyncio.run(main()) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_roles_and_permissions.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_roles_and_permissions.py new file mode 100644 index 000000000000..c33d5b8d93ed --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_roles_and_permissions.py @@ -0,0 +1,16 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +from azure.messaging.webpubsubservice.chat import ChatRoles, RoomPermissions, UserPermissions + + +print(ChatRoles.USER_NORMAL) +print(ChatRoles.ROOM_MEMBER) +print(ChatRoles.ROOM_OPERATOR) +print(UserPermissions.CREATE_ROOM) +print(UserPermissions.FETCH_ALL_ROOMS) +print(RoomPermissions.INVITE_USER) +print(RoomPermissions.REMOVE_USER) +print(RoomPermissions.READ_HISTORY) +print(RoomPermissions.PUBLISH_MESSAGE) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/setup.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/setup.py index d36d5bf56bad..73d270253061 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/setup.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/setup.py @@ -67,6 +67,8 @@ install_requires=[ "isodate>=0.6.1", "azure-core>=1.37.0", + "azure-messaging-webpubsubservice>=1.3.0", + "PyJWT>=2.6.0", "typing-extensions>=4.6.0", ], python_requires=">=3.10", diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/test-resources.bicep b/sdk/webpubsub/azure-messaging-webpubsubchatservice/test-resources.bicep new file mode 100644 index 000000000000..6ad5321c8159 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/test-resources.bicep @@ -0,0 +1,128 @@ +param baseName string = resourceGroup().name +param testApplicationOid string +param location string = resourceGroup().location +param supportsSafeSecretStandard bool = false + +var webPubSubName = 'e2e-chat-${baseName}' +var storageAccountName = take('chat${uniqueString(resourceGroup().id)}', 24) +var webPubSubApiVersion = '2024-04-01-preview' +var ownerRoleId = '12cf5a90-567b-43ae-8102-96cf46c7d9b4' +var blobDataContributorRoleId = 'ba92f5b4-2d11-453d-a403-e96b0029c9fe' +var tableDataContributorRoleId = '0a9a7e1f-b9d0-4cc4-a60d-0319b160aaa3' +var queueDataContributorRoleId = '974c5e8b-45b9-4653-ba55-5f855dd0fb88' + +resource webPubSub 'Microsoft.SignalRService/webPubSub@2025-12-01-preview' = { + name: webPubSubName + location: location + kind: 'WebPubSub' + identity: { + type: 'SystemAssigned' + } + sku: { + name: 'Standard_S1' + tier: 'Standard' + capacity: 1 + } + properties: { + tls: { + clientCertEnabled: false + } + networkACLs: { + defaultAction: 'Deny' + publicNetwork: { + allow: [ + 'ServerConnection' + 'ClientConnection' + 'RESTAPI' + 'Trace' + ] + } + privateEndpoints: [] + } + disableLocalAuth: supportsSafeSecretStandard + } +} + +resource storageAccount 'Microsoft.Storage/storageAccounts@2023-05-01' = { + name: storageAccountName + location: location + sku: { + name: 'Standard_LRS' + } + kind: 'StorageV2' + properties: { + allowBlobPublicAccess: false + minimumTlsVersion: 'TLS1_2' + supportsHttpsTrafficOnly: true + } +} + +resource blobDataContributorRoleAssignment 'Microsoft.Authorization/roleAssignments@2022-04-01' = { + name: guid(webPubSub.id, storageAccount.id, blobDataContributorRoleId) + scope: storageAccount + properties: { + roleDefinitionId: subscriptionResourceId('Microsoft.Authorization/roleDefinitions', blobDataContributorRoleId) + principalId: webPubSub.identity.principalId + principalType: 'ServicePrincipal' + } +} + +resource tableDataContributorRoleAssignment 'Microsoft.Authorization/roleAssignments@2022-04-01' = { + name: guid(webPubSub.id, storageAccount.id, tableDataContributorRoleId) + scope: storageAccount + properties: { + roleDefinitionId: subscriptionResourceId('Microsoft.Authorization/roleDefinitions', tableDataContributorRoleId) + principalId: webPubSub.identity.principalId + principalType: 'ServicePrincipal' + } +} + +resource queueDataContributorRoleAssignment 'Microsoft.Authorization/roleAssignments@2022-04-01' = { + name: guid(webPubSub.id, storageAccount.id, queueDataContributorRoleId) + scope: storageAccount + properties: { + roleDefinitionId: subscriptionResourceId('Microsoft.Authorization/roleDefinitions', queueDataContributorRoleId) + principalId: webPubSub.identity.principalId + principalType: 'ServicePrincipal' + } +} + +resource persistentStorage 'Microsoft.SignalRService/webPubSub/persistentStorages@2025-12-01-preview' = { + name: 'chatstorage' + parent: webPubSub + properties: { + storageAccount: { + id: storageAccount.id + } + } + dependsOn: [ + blobDataContributorRoleAssignment + tableDataContributorRoleAssignment + queueDataContributorRoleAssignment + ] +} + +resource chatHub 'Microsoft.SignalRService/webPubSub/hubs@2025-12-01-preview' = { + name: 'test_hub' + parent: webPubSub + properties: { + chat: { + mode: 'Enabled' + persistentStorage: { + id: persistentStorage.id + } + } + } +} + +resource ownerRoleAssignment 'Microsoft.Authorization/roleAssignments@2022-04-01' = { + name: guid(webPubSub.id, testApplicationOid, ownerRoleId) + scope: webPubSub + properties: { + roleDefinitionId: subscriptionResourceId('Microsoft.Authorization/roleDefinitions', ownerRoleId) + principalId: testApplicationOid + } +} + +output WPS_CHAT_ENDPOINT string = 'https://${webPubSub.properties.hostName}' +output WPS_CHAT_CONNECTION_STRING string = listKeys(webPubSub.id, webPubSubApiVersion).primaryConnectionString \ No newline at end of file diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests.yml b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests.yml new file mode 100644 index 000000000000..51ab446efb2a --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests.yml @@ -0,0 +1,13 @@ +trigger: none + +extends: + template: /eng/pipelines/templates/stages/archetype-sdk-tests.yml + parameters: + BuildTargetingString: azure-messaging-webpubsubchatservice + JobName: webpubsubchatservice + ServiceDirectory: webpubsub + Clouds: Public + MatrixReplace: + - TestSamples=.*/true + TestResourceDirectories: + - webpubsub/azure-messaging-webpubsubchatservice/ \ No newline at end of file diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/conftest.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/conftest.py new file mode 100644 index 000000000000..46ae08d235bc --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/conftest.py @@ -0,0 +1,30 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +import os +import re + +import pytest +from dotenv import load_dotenv +from devtools_testutils import add_general_regex_sanitizer, set_custom_default_matcher, test_proxy + + +load_dotenv(os.path.join(os.path.dirname(__file__), ".env"), override=False) + + +@pytest.fixture(scope="session", autouse=True) +def start_proxy(test_proxy): + return + + +@pytest.fixture(scope="session", autouse=True) +def add_sanitizers(test_proxy): + set_custom_default_matcher(ignore_query_ordering=True) + connection_string = os.environ.get("WPS_CHAT_CONNECTION_STRING", "") + access_key_match = re.search(r"(?:^|;)AccessKey=([^;]+)", connection_string, re.IGNORECASE) + if access_key_match: + add_general_regex_sanitizer( + regex=re.escape(access_key_match.group(1)), + value="Kg==", + ) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_client.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_client.py new file mode 100644 index 000000000000..de5845a54e99 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_client.py @@ -0,0 +1,228 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +import time +from unittest.mock import Mock +from urllib.parse import urlparse + +import jwt +import pytest +from azure.core.credentials import AccessToken, AzureKeyCredential + +from azure.messaging.webpubsubservice.chat import ( + ChatRoles, + RoomPermissions, + UserPermissions, + WebPubSubChatServiceClient, +) + + +ACCESS_KEY = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGH" +ENDPOINT = "https://example.webpubsub.azure.com" +HUB = "chat" +CHAT_ROLES = ["webpubsub.getGroupState", "webpubsub.setGroupState"] + + +class RequestCaptured(Exception): + pass + + +class FakeTokenCredential: + def get_token(self, *scopes, **kwargs): + return AccessToken("entra-token", int(time.time()) + 3600) + + +def _capture_list_roles_request(client): + captured = {} + + def capture(pipeline_request): + captured["request"] = pipeline_request.http_request + raise RequestCaptured() + + with pytest.raises(RequestCaptured): + list(client.list_roles(raw_request_hook=capture)) + return captured["request"] + + +@pytest.mark.parametrize( + "endpoint,hub,credential", + [ + (None, HUB, AzureKeyCredential(ACCESS_KEY)), + ("", HUB, AzureKeyCredential(ACCESS_KEY)), + (ENDPOINT, None, AzureKeyCredential(ACCESS_KEY)), + (ENDPOINT, "", AzureKeyCredential(ACCESS_KEY)), + (ENDPOINT, HUB, None), + ], +) +def test_constructor_validation(endpoint, hub, credential): + with pytest.raises(ValueError): + WebPubSubChatServiceClient(endpoint=endpoint, hub=hub, credential=credential) + + +@pytest.mark.parametrize("connection_string", [None, ""]) +def test_connection_string_validation(connection_string): + with pytest.raises(ValueError): + WebPubSubChatServiceClient.from_connection_string(connection_string, HUB) + + +def test_connection_string_parses_endpoint_access_key_and_port(): + client = WebPubSubChatServiceClient.from_connection_string( + f"Endpoint={ENDPOINT};AccessKey={ACCESS_KEY};Port=8443;Version=1.0;", + HUB, + ) + try: + assert client._config.endpoint == f"{ENDPOINT}:8443" + assert client._config.credential.key == ACCESS_KEY + assert client._web_pub_sub_service_client._config.endpoint == f"{ENDPOINT}:8443" + finally: + client.close() + + +def test_key_credential_request_uses_full_uri_audience_and_sixty_second_token(): + client = WebPubSubChatServiceClient(ENDPOINT, HUB, AzureKeyCredential(ACCESS_KEY)) + try: + request = _capture_list_roles_request(client) + token = request.headers["Authorization"].removeprefix("Bearer ") + claims = jwt.decode(token, ACCESS_KEY, algorithms=["HS256"], audience=request.url) + + assert claims["aud"] == request.url + assert "api-version=2026-02-01-preview" in request.url + assert 0 < claims["exp"] - int(time.time()) <= 60 + finally: + client.close() + + +def test_updating_key_credential_changes_subsequent_request_tokens(): + credential = AzureKeyCredential(ACCESS_KEY) + client = WebPubSubChatServiceClient(ENDPOINT, HUB, credential) + try: + first_request = _capture_list_roles_request(client) + first_token = first_request.headers["Authorization"].removeprefix("Bearer ") + + updated_key = "updated-key-updated-key-updated-key-updated-key" + credential.update(updated_key) + second_request = _capture_list_roles_request(client) + second_token = second_request.headers["Authorization"].removeprefix("Bearer ") + + assert first_token != second_token + jwt.decode(first_token, ACCESS_KEY, algorithms=["HS256"], audience=first_request.url) + jwt.decode(second_token, updated_key, algorithms=["HS256"], audience=second_request.url) + finally: + client.close() + + +def test_reverse_proxy_preserves_path_query_and_original_key_audience(): + proxy_endpoint = "https://proxy.contoso.com" + client = WebPubSubChatServiceClient( + ENDPOINT, + HUB, + AzureKeyCredential(ACCESS_KEY), + reverse_proxy_endpoint=proxy_endpoint, + ) + try: + request = _capture_list_roles_request(client) + token = request.headers["Authorization"].removeprefix("Bearer ") + original_url = request.url.replace(proxy_endpoint, ENDPOINT, 1) + claims = jwt.decode(token, ACCESS_KEY, algorithms=["HS256"], audience=original_url) + + assert urlparse(request.url).netloc == "proxy.contoso.com" + assert urlparse(request.url).path == urlparse(original_url).path + assert urlparse(request.url).query == urlparse(original_url).query + assert claims["aud"] == original_url + finally: + client.close() + + +def test_reverse_proxy_with_entra_credential_keeps_bearer_token(): + client = WebPubSubChatServiceClient( + ENDPOINT, + HUB, + FakeTokenCredential(), + reverse_proxy_endpoint="https://proxy.contoso.com", + ) + try: + request = _capture_list_roles_request(client) + assert urlparse(request.url).netloc == "proxy.contoso.com" + assert request.headers["Authorization"] == "Bearer entra-token" + finally: + client.close() + + +def test_client_access_token_delegates_fixed_chat_requirements(): + client = WebPubSubChatServiceClient(ENDPOINT, HUB, AzureKeyCredential(ACCESS_KEY)) + expected = {"baseUrl": "wss://example", "token": "token", "url": "wss://example?access_token=token"} + client._web_pub_sub_service_client.get_client_access_token = Mock(return_value=expected) + try: + result = client.get_client_access_token(user_id="alice") + assert result is expected + client._web_pub_sub_service_client.get_client_access_token.assert_called_once_with( + user_id="alice", + roles=CHAT_ROLES, + minutes_to_expire=60, + groups=[], + client_protocol="Default", + ) + finally: + client.close() + + +def test_entra_client_access_delegation_propagates_reverse_proxy(): + credential = FakeTokenCredential() + proxy_endpoint = "https://proxy.contoso.com" + client = WebPubSubChatServiceClient( + ENDPOINT, + HUB, + credential, + reverse_proxy_endpoint=proxy_endpoint, + ) + expected = {"baseUrl": "wss://example", "token": "token", "url": "wss://example?access_token=token"} + client._web_pub_sub_service_client.get_client_access_token = Mock(return_value=expected) + try: + inner = client._web_pub_sub_service_client + assert inner._config.credential is credential + assert inner._config.proxy_policy._endpoint == ENDPOINT + assert inner._config.proxy_policy._reverse_proxy_endpoint == proxy_endpoint + assert client.get_client_access_token(user_id="alice") is expected + inner.get_client_access_token.assert_called_once_with( + user_id="alice", + roles=CHAT_ROLES, + minutes_to_expire=60, + groups=[], + client_protocol="Default", + ) + finally: + client.close() + + +def test_key_client_access_token_returns_wss_url_and_required_roles(): + client = WebPubSubChatServiceClient(ENDPOINT, HUB, AzureKeyCredential(ACCESS_KEY)) + try: + result = client.get_client_access_token(user_id="alice") + claims = jwt.decode( + result["token"], + ACCESS_KEY, + algorithms=["HS256"], + audience=result["baseUrl"].replace("wss://", "https://"), + ) + + assert result["baseUrl"].startswith("wss://") + assert result["url"] == f'{result["baseUrl"]}?access_token={result["token"]}' + assert claims["sub"] == "alice" + assert claims["role"] == CHAT_ROLES + assert "webpubsub.group" not in claims + assert 3595 <= claims["exp"] - claims["iat"] <= 3605 + finally: + client.close() + + +def test_role_and_permission_constants(): + assert ChatRoles.USER_NORMAL == "user.normal" + assert ChatRoles.ROOM_MEMBER == "room.member" + assert ChatRoles.ROOM_OPERATOR == "room.operator" + assert UserPermissions.CREATE_ROOM == "user.create_room" + assert UserPermissions.FETCH_ALL_ROOMS == "user.fetch_all_rooms" + assert RoomPermissions.INVITE_USER == "room.invite" + assert RoomPermissions.REMOVE_USER == "room.remove_user" + assert RoomPermissions.READ_HISTORY == "room.history" + assert RoomPermissions.PUBLISH_MESSAGE == "room.publish_message" diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_client_async.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_client_async.py new file mode 100644 index 000000000000..3ed14730e195 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_client_async.py @@ -0,0 +1,144 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +import time +from unittest.mock import AsyncMock +from urllib.parse import urlparse + +import jwt +import pytest +from azure.core.credentials import AccessToken, AzureKeyCredential + +from azure.messaging.webpubsubservice.chat.aio import WebPubSubChatServiceClient + + +ACCESS_KEY = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGH" +ENDPOINT = "https://example.webpubsub.azure.com" +HUB = "chat" +CHAT_ROLES = ["webpubsub.getGroupState", "webpubsub.setGroupState"] + + +class RequestCaptured(Exception): + pass + + +class FakeAsyncTokenCredential: + async def get_token(self, *scopes, **kwargs): + return AccessToken("entra-token", int(time.time()) + 3600) + + +async def _capture_list_roles_request(client): + captured = {} + + def capture(pipeline_request): + captured["request"] = pipeline_request.http_request + raise RequestCaptured() + + with pytest.raises(RequestCaptured): + async for _ in client.list_roles(raw_request_hook=capture): + pass + return captured["request"] + + +@pytest.mark.asyncio +async def test_async_connection_string_and_key_request_match_sync_behavior(): + client = WebPubSubChatServiceClient.from_connection_string( + f"Endpoint={ENDPOINT};AccessKey={ACCESS_KEY};Port=8443;Version=1.0;", + HUB, + ) + try: + request = await _capture_list_roles_request(client) + token = request.headers["Authorization"].removeprefix("Bearer ") + claims = jwt.decode(token, ACCESS_KEY, algorithms=["HS256"], audience=request.url) + + assert client._config.endpoint == f"{ENDPOINT}:8443" + assert claims["aud"] == request.url + assert 0 < claims["exp"] - int(time.time()) <= 60 + finally: + await client.close() + + +@pytest.mark.asyncio +async def test_async_reverse_proxy_with_key_uses_original_audience(): + proxy_endpoint = "https://proxy.contoso.com" + client = WebPubSubChatServiceClient( + ENDPOINT, + HUB, + AzureKeyCredential(ACCESS_KEY), + reverse_proxy_endpoint=proxy_endpoint, + ) + try: + request = await _capture_list_roles_request(client) + original_url = request.url.replace(proxy_endpoint, ENDPOINT, 1) + token = request.headers["Authorization"].removeprefix("Bearer ") + claims = jwt.decode(token, ACCESS_KEY, algorithms=["HS256"], audience=original_url) + + assert urlparse(request.url).netloc == "proxy.contoso.com" + assert claims["aud"] == original_url + finally: + await client.close() + + +@pytest.mark.asyncio +async def test_async_reverse_proxy_with_entra_credential_keeps_bearer_token(): + client = WebPubSubChatServiceClient( + ENDPOINT, + HUB, + FakeAsyncTokenCredential(), + reverse_proxy_endpoint="https://proxy.contoso.com", + ) + try: + request = await _capture_list_roles_request(client) + assert urlparse(request.url).netloc == "proxy.contoso.com" + assert request.headers["Authorization"] == "Bearer entra-token" + finally: + await client.close() + + +@pytest.mark.asyncio +async def test_async_client_access_token_delegates_fixed_chat_requirements(): + client = WebPubSubChatServiceClient(ENDPOINT, HUB, AzureKeyCredential(ACCESS_KEY)) + expected = {"baseUrl": "wss://example", "token": "token", "url": "wss://example?access_token=token"} + client._web_pub_sub_service_client.get_client_access_token = AsyncMock(return_value=expected) + try: + result = await client.get_client_access_token(user_id="alice") + assert result is expected + client._web_pub_sub_service_client.get_client_access_token.assert_awaited_once_with( + user_id="alice", + roles=CHAT_ROLES, + minutes_to_expire=60, + groups=[], + client_protocol="Default", + ) + finally: + await client.close() + + +@pytest.mark.asyncio +async def test_async_entra_client_access_delegation_propagates_reverse_proxy(): + credential = FakeAsyncTokenCredential() + proxy_endpoint = "https://proxy.contoso.com" + client = WebPubSubChatServiceClient( + ENDPOINT, + HUB, + credential, + reverse_proxy_endpoint=proxy_endpoint, + ) + expected = {"baseUrl": "wss://example", "token": "token", "url": "wss://example?access_token=token"} + client._web_pub_sub_service_client.get_client_access_token = AsyncMock(return_value=expected) + try: + inner = client._web_pub_sub_service_client + assert inner._config.credential is credential + assert inner._config.proxy_policy._endpoint == ENDPOINT + assert inner._config.proxy_policy._reverse_proxy_endpoint == proxy_endpoint + assert await client.get_client_access_token(user_id="alice") is expected + inner.get_client_access_token.assert_awaited_once_with( + user_id="alice", + roles=CHAT_ROLES, + minutes_to_expire=60, + groups=[], + client_protocol="Default", + ) + finally: + await client.close() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live.py new file mode 100644 index 000000000000..a71b41713ada --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live.py @@ -0,0 +1,97 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +from devtools_testutils import recorded_by_proxy + +from azure.messaging.webpubsubservice.chat import RoomPermissions, UserPermissions +from azure.messaging.webpubsubservice.chat.models import ChatRole, ChatRoom, ChatRoomMember, HumanChatUser + +from testcase import WebPubSubChatPreparer, WebPubSubChatTest + + +class TestWebPubSubChatLive(WebPubSubChatTest): + @WebPubSubChatPreparer() + @recorded_by_proxy + def test_role_lifecycle_and_paging(self, wps_chat_connection_string): + client = self.create_client(wps_chat_connection_string) + role_names = ["user.python_e2e_role_1", "user.python_e2e_role_2"] + try: + for role_name in role_names: + role = client.create_or_replace_role( + role_name, + ChatRole(permissions=[UserPermissions.CREATE_ROOM]), + ) + assert role.name == role_name + assert client.get_role(role_name).permissions == [UserPermissions.CREATE_ROOM] + + listed = list(client.list_roles(maxpagesize=1)) + assert {role.name for role in listed}.issuperset(role_names) + finally: + for role_name in role_names: + self.cleanup(client.delete_role, role_name) + client.close() + + @WebPubSubChatPreparer() + @recorded_by_proxy + def test_room_conversation_and_empty_pages(self, wps_chat_connection_string): + client = self.create_client(wps_chat_connection_string) + room_id = "python-e2e-empty-room" + try: + room = client.create_or_replace_room(room_id, ChatRoom(title="Python E2E Room")) + assert room.id == room_id + assert client.get_room(room_id).title == "Python E2E Room" + + conversation = client.get_conversation(room.default_conversation) + assert conversation.id == room.default_conversation + assert conversation.parent_room == room_id + assert list(client.list_messages(room.default_conversation)) == [] + assert list(client.list_room_members(room_id)) == [] + finally: + self.cleanup(client.delete_room, room_id) + client.close() + + @WebPubSubChatPreparer() + @recorded_by_proxy + def test_user_and_room_member_lifecycle(self, wps_chat_connection_string): + client = self.create_client(wps_chat_connection_string) + user_role = "user.python_e2e_member" + room_role = "room.python_e2e_member" + user_id = "python-e2e-user" + room_id = "python-e2e-member-room" + try: + client.create_or_replace_role(user_role, ChatRole(permissions=[UserPermissions.CREATE_ROOM])) + client.create_or_replace_role(room_role, ChatRole(permissions=[RoomPermissions.PUBLISH_MESSAGE])) + user = client.create_or_replace_user( + user_id, + HumanChatUser(nickname="Python User", role_name=user_role), + ) + assert user.id == user_id + assert client.get_user(user_id).nickname == "Python User" + + client.create_or_replace_room(room_id, ChatRoom(title="Member Room")) + member = client.create_or_replace_room_member( + room_id, + user_id, + ChatRoomMember(role_name=room_role), + ) + assert member.user_id == user_id + assert any(item.user_id == user_id for item in client.list_room_members(room_id)) + client.delete_room_member(room_id, user_id) + finally: + self.cleanup(client.delete_room, room_id) + self.cleanup(client.delete_user, user_id) + self.cleanup(client.delete_role, user_role) + self.cleanup(client.delete_role, room_role) + client.close() + + @WebPubSubChatPreparer() + @recorded_by_proxy + def test_client_access_token(self, wps_chat_connection_string): + client = self.create_client(wps_chat_connection_string) + try: + result = client.get_client_access_token(user_id="python-e2e-access-user") + assert result["baseUrl"].startswith("wss://") + assert "access_token=" in result["url"] + finally: + client.close() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live_async.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live_async.py new file mode 100644 index 000000000000..3f72609ebc88 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live_async.py @@ -0,0 +1,60 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils import recorded_by_proxy + +from azure.messaging.webpubsubservice.chat import RoomPermissions, UserPermissions +from azure.messaging.webpubsubservice.chat.models import ChatRole, ChatRoom, ChatRoomMember, HumanChatUser + +from testcase import WebPubSubChatPreparer, WebPubSubChatTest + + +async def _collect(paged): + return [item async for item in paged] + + +class TestWebPubSubChatLiveAsync(WebPubSubChatTest): + @WebPubSubChatPreparer() + @recorded_by_proxy + @pytest.mark.asyncio + async def test_async_resource_lifecycle(self, wps_chat_connection_string): + client = self.create_async_client(wps_chat_connection_string) + user_role = "user.python_async_e2e" + room_role = "room.python_async_e2e" + user_id = "python-async-e2e-user" + room_id = "python-async-e2e-room" + try: + await client.create_or_replace_role(user_role, ChatRole(permissions=[UserPermissions.CREATE_ROOM])) + await client.create_or_replace_role(room_role, ChatRole(permissions=[RoomPermissions.PUBLISH_MESSAGE])) + assert (await client.get_role(user_role)).name == user_role + assert any(role.name == user_role for role in await _collect(client.list_roles(maxpagesize=1))) + + user = await client.create_or_replace_user( + user_id, + HumanChatUser(nickname="Async Python User", role_name=user_role), + ) + assert user.id == user_id + room = await client.create_or_replace_room(room_id, ChatRoom(title="Async Room")) + member = await client.create_or_replace_room_member( + room_id, + user_id, + ChatRoomMember(role_name=room_role), + ) + assert member.user_id == user_id + assert any(item.user_id == user_id for item in await _collect(client.list_room_members(room_id))) + + conversation = await client.get_conversation(room.default_conversation) + assert conversation.parent_room == room_id + assert await _collect(client.list_messages(room.default_conversation)) == [] + + access = await client.get_client_access_token(user_id=user_id) + assert access["baseUrl"].startswith("wss://") + await client.delete_room_member(room_id, user_id) + finally: + await self.cleanup_async(client.delete_room, room_id) + await self.cleanup_async(client.delete_user, user_id) + await self.cleanup_async(client.delete_role, user_role) + await self.cleanup_async(client.delete_role, room_role) + await client.close() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/testcase.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/testcase.py new file mode 100644 index 000000000000..d6d61852d3a7 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/testcase.py @@ -0,0 +1,42 @@ +# coding: utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +import functools + +from azure.core.exceptions import HttpResponseError +from devtools_testutils import AzureRecordedTestCase, PowerShellPreparer + +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient +from azure.messaging.webpubsubservice.chat.aio import WebPubSubChatServiceClient as AsyncWebPubSubChatServiceClient + + +class WebPubSubChatTest(AzureRecordedTestCase): + def create_client(self, connection_string): + return WebPubSubChatServiceClient.from_connection_string(connection_string, "test_hub") + + def create_async_client(self, connection_string): + return AsyncWebPubSubChatServiceClient.from_connection_string(connection_string, "test_hub") + + @staticmethod + def cleanup(action, *args): + try: + action(*args) + except HttpResponseError: + pass + + @staticmethod + async def cleanup_async(action, *args): + try: + await action(*args) + except HttpResponseError: + pass + + +WebPubSubChatPreparer = functools.partial( + PowerShellPreparer, + "wps_chat", + wps_chat_endpoint="https://myservice.webpubsub.azure.com", + wps_chat_connection_string="Endpoint=https://myservice.webpubsub.azure.com;AccessKey=Kg==;Version=1.0;", +) diff --git a/sdk/webpubsub/ci.yml b/sdk/webpubsub/ci.yml index 9a8e80941b8c..5ef5bea90064 100644 --- a/sdk/webpubsub/ci.yml +++ b/sdk/webpubsub/ci.yml @@ -35,4 +35,6 @@ extends: - name: azure-messaging-webpubsubservice safeName: azuremessagingwebpubsubservice - name: azure-messaging-webpubsubclient - safeName: azuremessagingwebpubsubclient \ No newline at end of file + safeName: azuremessagingwebpubsubclient + - name: azure-messaging-webpubsubchatservice + safeName: azuremessagingwebpubsubchatservice \ No newline at end of file From 6d547e25ec5bbf7780fe413eddf68f617b348ad4 Mon Sep 17 00:00:00 2001 From: Zitong Yang Date: Thu, 3 Sep 2026 22:55:51 +1000 Subject: [PATCH 3/6] Add initial version of Web PubSub Chat service client --- ...webpubsub-chat-customization-2026-08-17.md | 2 +- eng/ignore-links.txt | 5 + .../CHANGELOG.md | 2 +- .../MANIFEST.in | 1 - .../README.md | 271 +++++++++++++--- .../api.md | 54 ++-- .../api.metadata.yml | 2 +- .../apiview-properties.json | 3 +- .../assets.json | 2 +- .../messaging/webpubsubservice/__init__.py | 1 - .../webpubsubservice/chat/_client.py | 6 +- .../webpubsubservice/chat/_configuration.py | 3 +- .../webpubsubservice/chat/_constants.py | 20 +- .../chat/_operations/_operations.py | 181 ++++++++++- .../chat/_operations/_patch.py | 1 - .../messaging/webpubsubservice/chat/_patch.py | 61 ++-- .../webpubsubservice/chat/_shared.py | 149 +++++++++ .../chat/_utils/model_base.py | 81 +++-- .../chat/_utils/serialization.py | 57 +++- .../webpubsubservice/chat/aio/_client.py | 6 +- .../chat/aio/_configuration.py | 3 +- .../chat/aio/_operations/_operations.py | 143 +++++++- .../chat/aio/_operations/_patch.py | 1 - .../webpubsubservice/chat/aio/_patch.py | 60 ++-- .../webpubsubservice/chat/models/__init__.py | 2 + .../webpubsubservice/chat/models/_enums.py | 17 + .../webpubsubservice/chat/models/_models.py | 54 +++- .../webpubsubservice/chat/models/_patch.py | 1 - .../messaging/webpubsubservice/chat/types.py | 50 +-- .../dev_requirements.txt | 1 - .../chat/create_or_replace_role.py | 4 +- .../generated_tests/conftest.py | 18 +- .../test_web_pub_sub_chat_service.py | 20 +- .../test_web_pub_sub_chat_service_async.py | 15 +- .../package-lock.json | 6 + .../pyproject.toml | 63 ++++ .../samples/sample_authentication.py | 6 +- .../samples/sample_resource_management.py | 60 ---- .../samples/sample_roles_and_permissions.py | 70 +++- ... => sample_roles_and_permissions_async.py} | 13 +- .../setup.py | 7 +- .../test-resources.bicep | 3 +- .../tests/chat_message_seed.py | 117 +++++++ .../tests/conftest.py | 20 +- .../tests/test_chat_message_seed.py | 120 +++++++ .../tests/test_client.py | 137 ++++---- .../tests/test_client_async.py | 80 ++--- .../tests/test_live.py | 252 +++++++++++++-- .../tests/test_live_async.py | 304 ++++++++++++++++-- .../tests/testcase.py | 72 ++++- .../tsp-location.yaml | 2 +- .../messaging/webpubsubservice/__init__.py | 4 + sdk/webpubsub/tests.yml | 10 +- 53 files changed, 2123 insertions(+), 520 deletions(-) delete mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/__init__.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_shared.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/package-lock.json create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/pyproject.toml delete mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_resource_management.py rename sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/{sample_resource_management_async.py => sample_roles_and_permissions_async.py} (88%) create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/chat_message_seed.py create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_chat_message_seed.py diff --git a/.chronus/changes/webpubsub-chat-customization-2026-08-17.md b/.chronus/changes/webpubsub-chat-customization-2026-08-17.md index 1bf03f000c91..ce1da2cc592f 100644 --- a/.chronus/changes/webpubsub-chat-customization-2026-08-17.md +++ b/.chronus/changes/webpubsub-chat-customization-2026-08-17.md @@ -4,4 +4,4 @@ packages: - azure-messaging-webpubsubchatservice --- -Add authentication options, client access token generation, built-in Chat constants, tests, samples, and live-test pipeline support. +Add the first version of Web PubSub Chat service client. diff --git a/eng/ignore-links.txt b/eng/ignore-links.txt index 0dd024dbec83..104813679891 100644 --- a/eng/ignore-links.txt +++ b/eng/ignore-links.txt @@ -6,3 +6,8 @@ http://localhost:8000/samples/pyodide_integration https://pypi.org/project/azure-mynewpackage/ https://aka.ms/azsdk/python/migrate/my-new-package https://github.com/Azure/azure-sdk-for-python/compare/main.. +https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/webpubsub/azure-messaging-webpubsubchatservice +https://pypi.org/project/azure-messaging-webpubsubchatservice/ +https://learn.microsoft.com/python/api/overview/azure/messaging-webpubsubchatservice-readme?view=azure-python-preview +https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples +https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/webpubsub/azure-messaging-webpubsubchatservice/CHANGELOG.md diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/CHANGELOG.md b/sdk/webpubsub/azure-messaging-webpubsubchatservice/CHANGELOG.md index d901a81315d4..e290d03c04df 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/CHANGELOG.md +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/CHANGELOG.md @@ -1,6 +1,6 @@ # Release History -## 1.0.0b1 (2026-07-01) +## 1.0.0b1 (Unreleased) ### Features Added diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/MANIFEST.in b/sdk/webpubsub/azure-messaging-webpubsubchatservice/MANIFEST.in index 216566cd1f7e..ccb8abdb144f 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/MANIFEST.in +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/MANIFEST.in @@ -5,4 +5,3 @@ recursive-include tests *.py recursive-include samples *.py *.md include azure/__init__.py include azure/messaging/__init__.py -include azure/messaging/webpubsubservice/__init__.py diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/README.md b/sdk/webpubsub/azure-messaging-webpubsubchatservice/README.md index 7e758a45a22f..6f7a7db56d65 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/README.md +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/README.md @@ -1,28 +1,51 @@ # Azure Web PubSub Chat service client library for Python -Use this client library to manage server-side Chat resources hosted by Azure Web PubSub. Applications use the service client to manage roles, rooms, users, room membership, and persisted message history. Connected clients send real-time messages separately over WebSockets. +[Azure Web PubSub chat][product_docs] is a managed chat capability built on [Azure Web PubSub][webpubsub_docs]. It provides purpose-built client and server APIs for chat scenarios. Applications use the SDKs to communicate with the Azure service and work with chat-native concepts such as rooms, messages, members, and users. The service handles real-time message delivery and ordering, fan-out across a user's devices and browser tabs, room membership, and message persistence and retrieval. + +Use this client library in an application server to: + +- Create and manage chat roles and permissions. +- Create users, rooms, and room memberships. +- Get room conversations and query persisted message history. +- Update and delete persisted messages. +- Generate client access credentials for Chat WebSocket clients. + + +[Source code][source_code] +| [Package (PyPI)][package] +| [API reference documentation][api_reference] +| [Product documentation][product_docs] +| [Samples][samples] +| [Changelog][changelog] ## Getting started -### Install the package +### Prerequisites + +- Python 3.10 or later. +- An [Azure subscription][azure_sub]. +- An [Azure Web PubSub resource][create_instance]. +- A Web PubSub hub with [Chat enabled][enable_chat]. + +### 1. Install the package ```bash python -m pip install azure-messaging-webpubsubchatservice ``` -### Prerequisites +To use Microsoft Entra ID authentication, also install `azure-identity`: -- Python 3.10 or later is required to use this package. -- An [Azure subscription][azure_sub]. -- An [Azure Web PubSub resource][webpubsub_docs] with Chat enabled for the target hub. +```bash +python -m pip install azure-identity +``` -### Use with AI tools +### 2. Create and authenticate a `WebPubSubChatServiceClient` -AI coding tools such as VS Code and GitHub Copilot can help you write and debug code that uses this library. See [Using the Azure SDK for Python with AI tools](https://aka.ms/azsdk/python/ai) for available integrations. +The client supports a connection string, an `AzureKeyCredential`, or a Microsoft Entra ID token credential. The hub passed to the client must have Chat enabled. -### Create and authenticate the client +#### Use a connection string -Use a connection string: +Get the connection string from the Azure portal or Azure CLI, and store it securely. See [Web PubSub authorization][connection_string] for details. @@ -39,7 +62,7 @@ with WebPubSubChatServiceClient.from_connection_string( -Use an access key: +#### Use an access key @@ -60,7 +83,9 @@ with WebPubSubChatServiceClient( -Use Microsoft Entra ID after installing `azure-identity` and assigning the appropriate Web PubSub data-plane role: +#### Use Microsoft Entra ID + +For recommended passwordless authentication, assign an appropriate Web PubSub data-plane role to the principal and use a credential from the [Azure Identity library][azure_identity]. The following example uses `DefaultAzureCredential`: @@ -77,18 +102,54 @@ with WebPubSubChatServiceClient(endpoint, hub, DefaultAzureCredential()) as entr +For more information, see [Authenticate Azure-hosted Python applications][azure_identity_auth] and [Microsoft Entra authorization for Azure Web PubSub][entra_authorization]. + ## Key concepts -- **Role**: A named set of user or room permissions. -- **User**: A Chat profile assigned to a user role. -- **Room**: A server-side Chat room with a default persisted conversation. -- **Room member**: A user assigned a room role within a room. -- **Message history**: Messages sent by connected WebSocket clients and persisted by the Chat service. The REST API lists, updates, and deletes messages; it does not create them. +### Client + +`WebPubSubChatServiceClient` is the entry point for managing Chat resources in one Web PubSub hub. Create one client for each endpoint and hub combination. The client can be used as a context manager and is safe to reuse for multiple operations. + +The asynchronous client is available from the `azure.messaging.webpubsubservice.chat.aio` namespace. + +### Hub + +A hub is a logical collection of WebSocket connections. A standard hub offers event-based real-time messaging through the Web PubSub subprotocol or a custom subprotocol. A chat hub adds built-in rooms, member management, message persistence, and chat-specific APIs. + +This SDK applies only to chat hubs. Chat must be enabled on the target hub before the SDK can manage roles, users, rooms, members, conversations, or messages. + +### Role and permission + +A role is a named collection of Chat permissions. User role names start with `user.`, and room role names start with `room.`. Do not combine user and room permissions in one role. + +User roles control operations such as creating rooms. Room roles control what a member can do in a particular room, such as publishing messages or reading message history. + +### User + +A user represents an application identity that can send and receive messages. In the service API, a user is identified by a user ID and assigned a user role. A human user also has a nickname. Client access credentials associate WebSocket connections with a user ID. + +### Room + +A room groups users together and is the primary organizational unit for chat interactions. Every room has an automatically created default conversation. + +### Room member + +A room member represents a user added to a room. Membership controls which users can receive and send messages in the room. In the service API, each room member is assigned a room role. + +### Conversation and message history + +A conversation is a message thread that belongs to a room. Every room has a default conversation and can contain multiple conversations. + +Messages sent to a conversation are delivered in real time to the room's connected members. The chat service manages ordering and persistence, allowing members to load message history after reconnecting or joining later. The service client can list, update, and delete persisted messages. ## Examples +The following sections show common scenarios. See the [package samples][samples] for complete synchronous and asynchronous programs. + ### Generate client access credentials +Generate credentials that a Chat WebSocket client can use to connect as a specific user: + ```python @@ -106,59 +167,177 @@ with WebPubSubChatServiceClient.from_connection_string( -### Create a custom role +The returned URL contains an access token. Send it only to the intended client, and do not log or persist it in production. + +### Create and list roles ```python -from azure.messaging.webpubsubservice.chat import UserPermissions -from azure.messaging.webpubsubservice.chat.models import ChatRole +from azure.messaging.webpubsubservice.chat.models import ChatPermission, ChatRole + +role_name = "user.moderator" +try: + role = client.create_or_replace_role( + role_name, + ChatRole(permissions=[ChatPermission.USER_CREATE_ROOM]), + ) + print(role.name, role.permissions) + + for listed_role in client.list_roles(): + print(listed_role.name) +finally: + client.delete_role(role_name) +``` + +### Create a user, room, and room membership + +```python +from azure.messaging.webpubsubservice.chat.models import ( + ChatPermission, + ChatRole, + ChatRoom, + ChatRoomMember, + HumanChatUser, +) client.create_or_replace_role( - "user.moderator", - ChatRole(permissions=[UserPermissions.CREATE_ROOM]), + "user.room_creator", + ChatRole(permissions=[ChatPermission.USER_CREATE_ROOM]), ) -for role in client.list_roles(): - print(role.name, role.permissions) -client.delete_role("user.moderator") +client.create_or_replace_role( + "room.contributor", + ChatRole(permissions=[ChatPermission.ROOM_PUBLISH_MESSAGE]), +) +client.create_or_replace_user( + "alice", + HumanChatUser(nickname="Alice", role_name="user.room_creator"), +) +room = client.create_or_replace_room("general", ChatRoom(title="General")) +member = client.create_or_replace_room_member( + room.id, + "alice", + ChatRoomMember(role_name="room.contributor"), +) +print(member.user_id, member.role_name) +``` + +Delete dependent resources in reverse order when they are no longer needed: room, user, and then roles. + +### List persisted messages + +```python +room = client.get_room("general") +for message in client.list_messages(room.default_conversation): + print(message.id, message.created_by, message.content.text) +``` + +### Use the asynchronous client + +```python +from azure.identity.aio import DefaultAzureCredential +from azure.messaging.webpubsubservice.chat.aio import WebPubSubChatServiceClient + +credential = DefaultAzureCredential() +client = WebPubSubChatServiceClient(endpoint, hub, credential) +try: + async for role in client.list_roles(): + print(role.name) +finally: + await client.close() + await credential.close() ``` +## Troubleshooting + ### Handle service errors +Service operations raise `HttpResponseError` or a more specific subclass when a request fails: + ```python from azure.core.exceptions import HttpResponseError try: room = client.get_room("room-id") except HttpResponseError as error: - print(f"Chat service request failed: {error}") + print(f"Chat service request failed with status {error.status_code}") ``` -See the executable [package samples][samples] for authentication, sync and async resource management, built-in constants, client access generation, and message history. +### Logging -## Troubleshooting +This library uses the standard Python [logging][python_logging] library. Enable HTTP logging for a client by passing `logging_enable=True`: -Enable SDK logging by passing `logging_enable=True` when creating the client. HTTP headers and bodies can contain sensitive information; do not enable detailed logging in production without reviewing the output. +```python +import logging +import sys -The client access API returns a WebSocket URL containing an access token. Do not log or persist that URL. Connection strings and access keys must also be treated as secrets. +from azure.identity import DefaultAzureCredential +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient -## Contributing +logger = logging.getLogger("azure") +logger.setLevel(logging.DEBUG) +logger.addHandler(logging.StreamHandler(stream=sys.stdout)) + +client = WebPubSubChatServiceClient( + endpoint, + hub, + DefaultAzureCredential(), + logging_enable=True, +) +``` + +HTTP logs can contain sensitive information. Do not enable detailed logging in production without reviewing how logs are collected and protected. For more information, see [Configure logging in the Azure SDK for Python][azure_sdk_logging]. + +### Authentication and authorization + +- Confirm that the endpoint and hub name identify the Web PubSub resource and Chat-enabled hub you intend to use. +- For Microsoft Entra ID, confirm that the principal has an appropriate Web PubSub data-plane role and that role assignment propagation has completed. +- Connection-string and access-key authentication are unavailable when local authentication is disabled on the Web PubSub resource. + +### Message history + +If a newly sent message does not appear immediately, confirm that the sending user is a room member with publish permission and that message history is enabled for the member's room role. -This project welcomes contributions and suggestions. Most contributions require -you to agree to a Contributor License Agreement (CLA) declaring that you have -the right to, and actually do, grant us the rights to use your contribution. -For details, visit https://cla.microsoft.com. +## Next steps -When you submit a pull request, a CLA-bot will automatically determine whether -you need to provide a CLA and decorate the PR appropriately (e.g., label, -comment). Simply follow the instructions provided by the bot. You will only -need to do this once across all repos using our CLA. +Explore the [complete package samples][samples] to learn how to: -This project has adopted the -[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information, -see the Code of Conduct FAQ or contact opencode@microsoft.com with any -additional questions or comments. +- Authenticate with a connection string, access key, or Microsoft Entra ID. +- Manage roles, permissions, users, rooms, and room members. +- Generate client access credentials. +- Query, update, and delete message history. +- Use synchronous and asynchronous clients. + +## Additional resources + +- [Azure Web PubSub documentation][webpubsub_docs] +- [Web PubSub Chat documentation][product_docs] +- [Web PubSub Chat REST API][rest_api] +- [Azure SDK for Python design guidelines][design_guidelines] + +## Contributing + +This project welcomes contributions and suggestions. See the [contributing guide][contributing] for instructions on building, testing, and submitting changes. + +This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information, see the [Code of Conduct FAQ][code_of_conduct_faq] or contact opencode@microsoft.com with questions or comments. -[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ -[azure_sub]: https://azure.microsoft.com/free/ -[webpubsub_docs]: https://learn.microsoft.com/azure/azure-web-pubsub/overview +[source_code]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/webpubsub/azure-messaging-webpubsubchatservice +[package]: https://pypi.org/project/azure-messaging-webpubsubchatservice/ +[api_reference]: https://learn.microsoft.com/python/api/overview/azure/messaging-webpubsubchatservice-readme?view=azure-python-preview +[product_docs]: https://learn.microsoft.com/azure/azure-web-pubsub/chat-overview [samples]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples +[changelog]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/webpubsub/azure-messaging-webpubsubchatservice/CHANGELOG.md +[azure_sub]: https://azure.microsoft.com/free/ +[webpubsub_docs]: https://learn.microsoft.com/azure/azure-web-pubsub/ +[create_instance]: https://learn.microsoft.com/azure/azure-web-pubsub/howto-develop-create-instance +[enable_chat]: https://learn.microsoft.com/azure/azure-web-pubsub/chat-howto-enable-chat +[connection_string]: https://learn.microsoft.com/azure/azure-web-pubsub/howto-websocket-connect#authorization +[azure_identity]: https://pypi.org/project/azure-identity/ +[azure_identity_auth]: https://learn.microsoft.com/azure/developer/python/sdk/authentication-overview +[entra_authorization]: https://learn.microsoft.com/azure/azure-web-pubsub/concept-azure-ad-authorization +[python_logging]: https://docs.python.org/3/library/logging.html +[azure_sdk_logging]: https://learn.microsoft.com/azure/developer/python/sdk/azure-sdk-logging +[rest_api]: https://learn.microsoft.com/rest/api/webpubsub/dataplane/webpubsubchat/web-pub-sub-chat-service +[design_guidelines]: https://azure.github.io/azure-sdk/python_design.html +[contributing]: https://github.com/Azure/azure-sdk-for-python/blob/main/CONTRIBUTING.md +[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ +[code_of_conduct_faq]: https://opensource.microsoft.com/codeofconduct/faq/ diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/api.md b/sdk/webpubsub/azure-messaging-webpubsubchatservice/api.md index 752abd7e3dc8..c288adb903f6 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/api.md +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/api.md @@ -1,24 +1,12 @@ ```py namespace azure.messaging.webpubsubservice.chat - class azure.messaging.webpubsubservice.chat.ChatRoles: + class azure.messaging.webpubsubservice.chat.BuiltInChatRoles: ROOM_MEMBER = room.member ROOM_OPERATOR = room.operator USER_NORMAL = user.normal - class azure.messaging.webpubsubservice.chat.RoomPermissions: - INVITE_USER = room.invite - PUBLISH_MESSAGE = room.publish_message - READ_HISTORY = room.history - REMOVE_USER = room.remove_user - - - class azure.messaging.webpubsubservice.chat.UserPermissions: - CREATE_ROOM = user.create_room - FETCH_ALL_ROOMS = user.fetch_all_rooms - - class azure.messaging.webpubsubservice.chat.WebPubSubChatServiceClient(WebPubSubChatServiceClientGenerated): implements ContextManager def __init__( @@ -724,16 +712,25 @@ namespace azure.messaging.webpubsubservice.chat.models def __init__(self, mapping: Mapping[str, Any]) -> None: ... + class azure.messaging.webpubsubservice.chat.models.ChatPermission(str, Enum, metaclass=CaseInsensitiveEnumMeta): + ROOM_HISTORY = "room.history" + ROOM_INVITE = "room.invite" + ROOM_PUBLISH_MESSAGE = "room.publish_message" + ROOM_REMOVE_USER = "room.remove_user" + USER_CREATE_ROOM = "user.create_room" + USER_FETCH_ALL_ROOMS = "user.fetch_all_rooms" + + class azure.messaging.webpubsubservice.chat.models.ChatRole(_Model): etag: str name: str - permissions: list[str] + permissions: list[Union[str, ChatPermission]] @overload def __init__( self, *, - permissions: list[str] + permissions: list[Union[str, ChatPermission]] ) -> None: ... @overload @@ -832,15 +829,6 @@ namespace azure.messaging.webpubsubservice.chat.models namespace azure.messaging.webpubsubservice.chat.types - class azure.messaging.webpubsubservice.chat.types.ChatConversation(TypedDict, total=False): - key "etag": Required[str] - key "id": Required[str] - key "parentRoom": Required[str] - etag: str - id: str - parent_room: str - - class azure.messaging.webpubsubservice.chat.types.ChatMessage(TypedDict, total=False): key "content": Required[MessageContent] key "createdAt": Required[str] @@ -848,8 +836,8 @@ namespace azure.messaging.webpubsubservice.chat.types key "etag": Required[str] key "id": Required[str] content: MessageContent - created_at: str - created_by: str + createdAt: str + createdBy: str etag: str id: str @@ -857,10 +845,10 @@ namespace azure.messaging.webpubsubservice.chat.types class azure.messaging.webpubsubservice.chat.types.ChatRole(TypedDict, total=False): key "etag": Required[str] key "name": Required[str] - key "permissions": Required[list[str]] + key "permissions": Required[list[Union[str, ChatPermission]]] etag: str name: str - permissions: list[str] + permissions: list[Union[str, ChatPermission]] class azure.messaging.webpubsubservice.chat.types.ChatRoom(TypedDict, total=False): @@ -868,7 +856,7 @@ namespace azure.messaging.webpubsubservice.chat.types key "etag": Required[str] key "id": Required[str] key "title": Required[str] - default_conversation: str + defaultConversation: str etag: str id: str title: str @@ -879,8 +867,8 @@ namespace azure.messaging.webpubsubservice.chat.types key "roleName": Required[str] key "userId": Required[str] etag: str - role_name: str - user_id: str + roleName: str + userId: str class azure.messaging.webpubsubservice.chat.types.ChatUser(TypedDict, total=False): @@ -893,7 +881,7 @@ namespace azure.messaging.webpubsubservice.chat.types id: str kind: Literal[ChatUserKind.HUMAN] nickname: str - role_name: str + roleName: str class azure.messaging.webpubsubservice.chat.types.ChatUserKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): @@ -910,7 +898,7 @@ namespace azure.messaging.webpubsubservice.chat.types id: str kind: Literal[ChatUserKind.HUMAN] nickname: str - role_name: str + roleName: str class azure.messaging.webpubsubservice.chat.types.MessageContent(TypedDict, total=False): diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/api.metadata.yml b/sdk/webpubsub/azure-messaging-webpubsubchatservice/api.metadata.yml index 40c924bd82b7..069c346e2099 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/api.metadata.yml +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/api.metadata.yml @@ -1,3 +1,3 @@ -apiMdSha256: 0736530dbfe716aa62d4b37329474ed288037c39383e54e30144dca83e2b940a +apiMdSha256: 371cf91ff0606ff3c81441472919c281aea494a1610d7bf7a43dd90998fbdf11 parserVersion: 0.3.31 pythonVersion: 3.12.13 diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/apiview-properties.json b/sdk/webpubsub/azure-messaging-webpubsubchatservice/apiview-properties.json index 49ad854cfff7..dd8c7f59007f 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/apiview-properties.json +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/apiview-properties.json @@ -9,6 +9,7 @@ "azure.messaging.webpubsubservice.chat.models.ChatUser": "WebPubSubChat.ChatUser", "azure.messaging.webpubsubservice.chat.models.HumanChatUser": "WebPubSubChat.HumanChatUser", "azure.messaging.webpubsubservice.chat.models.MessageContent": "WebPubSubChat.MessageContent", + "azure.messaging.webpubsubservice.chat.models.ChatPermission": "WebPubSubChat.ChatPermission", "azure.messaging.webpubsubservice.chat.models.ChatUserKind": "WebPubSubChat.ChatUserKind", "azure.messaging.webpubsubservice.chat.WebPubSubChatServiceClient.get_conversation": "WebPubSubChat.WebPubSubChatServiceClient.getConversation", "azure.messaging.webpubsubservice.chat.aio.WebPubSubChatServiceClient.get_conversation": "WebPubSubChat.WebPubSubChatServiceClient.getConversation", @@ -45,5 +46,5 @@ "azure.messaging.webpubsubservice.chat.WebPubSubChatServiceClient.delete_user": "WebPubSubChat.WebPubSubChatServiceClient.deleteUser", "azure.messaging.webpubsubservice.chat.aio.WebPubSubChatServiceClient.delete_user": "WebPubSubChat.WebPubSubChatServiceClient.deleteUser" }, - "CrossLanguageVersion": "bc8ec95ed6af" + "CrossLanguageVersion": "cb67ac71a86e" } \ No newline at end of file diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/assets.json b/sdk/webpubsub/azure-messaging-webpubsubchatservice/assets.json index 300edc2b5fcf..c605d3045b61 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/assets.json +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/assets.json @@ -2,5 +2,5 @@ "AssetsRepo": "Azure/azure-sdk-assets", "AssetsRepoPrefixPath": "python", "TagPrefix": "python/webpubsub/azure-messaging-webpubsubchatservice", - "Tag": "" + "Tag": "python/webpubsub/azure-messaging-webpubsubchatservice_fe02890411" } diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/__init__.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/__init__.py deleted file mode 100644 index d55ccad1f573..000000000000 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/__init__.py +++ /dev/null @@ -1 +0,0 @@ -__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_client.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_client.py index f12668af9984..4103a3541aa5 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_client.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_client.py @@ -27,7 +27,9 @@ from azure.core.credentials import TokenCredential -class WebPubSubChatServiceClient(_WebPubSubChatServiceClientOperationsMixin): +class WebPubSubChatServiceClient( + _WebPubSubChatServiceClientOperationsMixin +): # pylint: disable=docstring-keyword-should-match-keyword-only """WebPubSubChatServiceClient. :param endpoint: HTTP or HTTPS endpoint for the Web PubSub service instance. Required. @@ -64,7 +66,7 @@ def __init__(self, endpoint: str, credential: "TokenCredential", hub: str, **kwa self._config.custom_hook_policy, self._config.logging_policy, policies.DistributedTracingPolicy(**kwargs), - policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + (policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None), self._config.http_logging_policy, ] self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_configuration.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_configuration.py index d05d95783c7a..0a49b3f1374b 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_configuration.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_configuration.py @@ -1,3 +1,4 @@ +# pylint: disable=line-too-long,useless-suppression # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -16,7 +17,7 @@ from azure.core.credentials import TokenCredential -class WebPubSubChatServiceClientConfiguration: # pylint: disable=too-many-instance-attributes +class WebPubSubChatServiceClientConfiguration: # pylint: disable=too-many-instance-attributes,docstring-keyword-should-match-keyword-only """Configuration for WebPubSubChatServiceClient. Note that all parameters used to create this instance are saved as instance diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_constants.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_constants.py index 745066efdf4b..40607a7019e3 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_constants.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_constants.py @@ -4,7 +4,7 @@ # -------------------------------------------------------------------------- -class ChatRoles: +class BuiltInChatRoles: """Built-in Web PubSub Chat roles.""" USER_NORMAL = "user.normal" @@ -12,20 +12,4 @@ class ChatRoles: ROOM_OPERATOR = "room.operator" -class UserPermissions: - """Built-in Web PubSub Chat user permissions.""" - - CREATE_ROOM = "user.create_room" - FETCH_ALL_ROOMS = "user.fetch_all_rooms" - - -class RoomPermissions: - """Built-in Web PubSub Chat room permissions.""" - - INVITE_USER = "room.invite" - REMOVE_USER = "room.remove_user" - READ_HISTORY = "room.history" - PUBLISH_MESSAGE = "room.publish_message" - - -__all__ = ["ChatRoles", "RoomPermissions", "UserPermissions"] +__all__ = ["BuiltInChatRoles"] diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_operations/_operations.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_operations/_operations.py index 405738ee44f2..01e202a42d7d 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_operations/_operations.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_operations/_operations.py @@ -9,7 +9,7 @@ from collections.abc import MutableMapping from io import IOBase import json -from typing import Any, Callable, IO, Optional, TypeVar, Union, overload +from typing import Any, Callable, IO, Literal, Optional, TypeVar, Union, overload import urllib.parse from azure.core import MatchConditions, PipelineClient @@ -648,8 +648,50 @@ def build_web_pub_sub_chat_service_delete_user_request( # pylint: disable=name- return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) +def build_web_pub_sub_chat_service_generate_client_token_request( # pylint: disable=name-too-long + hub: str, + *, + user_id: Optional[str] = None, + role: Optional[list[str]] = None, + minutes_to_expire: Optional[int] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: Literal["2024-12-01"] = kwargs.pop("api_version", _params.pop("api-version", "2024-12-01")) + client_type: Literal["default"] = kwargs.pop("client_type", _params.pop("clientType", "default")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/api/hubs/{hub}/:generateToken" + path_format_arguments = { + "hub": _SERIALIZER.url("hub", hub, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + if user_id is not None: + _params["userId"] = _SERIALIZER.query("user_id", user_id, "str") + if role is not None: + _params["role"] = [_SERIALIZER.query("role", q, "str") if q is not None else "" for q in role] + if minutes_to_expire is not None: + _params["minutesToExpire"] = _SERIALIZER.query("minutes_to_expire", minutes_to_expire, "int") + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + _params["clientType"] = _SERIALIZER.query("client_type", client_type, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + class _WebPubSubChatServiceClientOperationsMixin( - ClientMixinABC[PipelineClient[HttpRequest, HttpResponse], WebPubSubChatServiceClientConfiguration] + ClientMixinABC[ + PipelineClient[HttpRequest, HttpResponse], + WebPubSubChatServiceClientConfiguration, + ] ): @distributed_trace @@ -770,7 +812,10 @@ def prepare_request(next_link=None): ) path_format_arguments = { "endpoint": self._serialize.url( - "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + "self._config.endpoint", + self._config.endpoint, + "str", + skip_quote=True, ), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -793,7 +838,10 @@ def prepare_request(next_link=None): ) path_format_arguments = { "endpoint": self._serialize.url( - "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + "self._config.endpoint", + self._config.endpoint, + "str", + skip_quote=True, ), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -820,7 +868,11 @@ def get_next(next_link=None): response = pipeline_response.http_response if response.status_code not in [200]: - map_error(status_code=response.status_code, response=response, error_map=error_map) + map_error( + status_code=response.status_code, + response=response, + error_map=error_map, + ) raise HttpResponseError(response=response) return pipeline_response @@ -1155,7 +1207,10 @@ def prepare_request(next_link=None): ) path_format_arguments = { "endpoint": self._serialize.url( - "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + "self._config.endpoint", + self._config.endpoint, + "str", + skip_quote=True, ), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -1178,7 +1233,10 @@ def prepare_request(next_link=None): ) path_format_arguments = { "endpoint": self._serialize.url( - "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + "self._config.endpoint", + self._config.endpoint, + "str", + skip_quote=True, ), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -1205,7 +1263,11 @@ def get_next(next_link=None): response = pipeline_response.http_response if response.status_code not in [200]: - map_error(status_code=response.status_code, response=response, error_map=error_map) + map_error( + status_code=response.status_code, + response=response, + error_map=error_map, + ) raise HttpResponseError(response=response) return pipeline_response @@ -1924,7 +1986,10 @@ def prepare_request(next_link=None): ) path_format_arguments = { "endpoint": self._serialize.url( - "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + "self._config.endpoint", + self._config.endpoint, + "str", + skip_quote=True, ), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -1947,7 +2012,10 @@ def prepare_request(next_link=None): ) path_format_arguments = { "endpoint": self._serialize.url( - "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + "self._config.endpoint", + self._config.endpoint, + "str", + skip_quote=True, ), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -1974,7 +2042,11 @@ def get_next(next_link=None): response = pipeline_response.http_response if response.status_code not in [200]: - map_error(status_code=response.status_code, response=response, error_map=error_map) + map_error( + status_code=response.status_code, + response=response, + error_map=error_map, + ) raise HttpResponseError(response=response) return pipeline_response @@ -2604,3 +2676,90 @@ def delete_user( # pylint: disable=inconsistent-return-statements if cls: return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace + def _generate_client_token( + self, + *, + user_id: Optional[str] = None, + role: Optional[list[str]] = None, + minutes_to_expire: Optional[int] = None, + **kwargs: Any + ) -> _models._models.GenerateClientTokenResponse: + """Generate a token for connecting a client to Azure Web PubSub. + + Generate a token for connecting a client to Azure Web PubSub. + + :keyword user_id: User identifier for the client connection. Default value is None. + :paramtype user_id: str + :keyword role: Roles granted to the client connection. Default value is None. + :paramtype role: list[str] + :keyword minutes_to_expire: Lifetime of the generated token, in minutes. Default value is None. + :paramtype minutes_to_expire: int + :return: GenerateClientTokenResponse. The GenerateClientTokenResponse is compatible with + MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models._models.GenerateClientTokenResponse + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + api_version: Literal["2024-12-01"] = kwargs.pop("api_version", _params.pop("api-version", "2024-12-01")) + client_type: Literal["default"] = kwargs.pop("client_type", _params.pop("clientType", "default")) + cls: ClsType[_models._models.GenerateClientTokenResponse] = kwargs.pop("cls", None) + + _request = build_web_pub_sub_chat_service_generate_client_token_request( + hub=self._config.hub, + user_id=user_id, + role=role, + minutes_to_expire=minutes_to_expire, + api_version=api_version, + client_type=client_type, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["content-type"] = self._deserialize("str", response.headers.get("content-type")) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize( + _models._models.GenerateClientTokenResponse, + response.json(), # pylint: disable=protected-access + ) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_operations/_patch.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_operations/_patch.py index 87676c65a8f0..ea765788358a 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_operations/_patch.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_operations/_patch.py @@ -8,7 +8,6 @@ Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ - __all__: list[str] = [] # Add all objects you want publicly available to users at this package level diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_patch.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_patch.py index df9f66e25c08..847f1d56575f 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_patch.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_patch.py @@ -7,20 +7,21 @@ Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ -from typing import Any, Dict, Optional, TYPE_CHECKING, Union + +from typing import Any, Dict, Optional, TYPE_CHECKING, Union, cast from azure.core.credentials import AzureKeyCredential from azure.core.tracing.decorator import distributed_trace -from azure.messaging.webpubsubservice._patch import ( +from ._shared import ( ApiManagementProxy, JwtCredentialPolicy, - WebPubSubServiceClient, _parse_connection_string, + get_token_by_key, ) from ._client import WebPubSubChatServiceClient as WebPubSubChatServiceClientGenerated -from ._constants import ChatRoles, RoomPermissions, UserPermissions +from ._constants import BuiltInChatRoles if TYPE_CHECKING: from azure.core.credentials import TokenCredential @@ -57,9 +58,6 @@ def __init__( raise ValueError("Parameter 'hub' must not be empty.") if credential is None: raise ValueError("Parameter 'credential' must not be None.") - service_client_kwargs = { - name: kwargs[name] for name in ("reverse_proxy_endpoint", "transport") if name in kwargs - } port = kwargs.pop("port", None) if port: endpoint = f"{endpoint.rstrip('/')}:{port}" @@ -74,12 +72,11 @@ def __init__( kwargs["proxy_policy"] = ApiManagementProxy(**kwargs) if api_version is not None: kwargs["api_version"] = api_version - super().__init__(endpoint=endpoint, hub=hub, credential=credential, **kwargs) - self._web_pub_sub_service_client = WebPubSubServiceClient( + super().__init__( endpoint=endpoint, hub=hub, - credential=credential, - **service_client_kwargs, + credential=cast("TokenCredential", credential), + **kwargs, ) @classmethod @@ -116,24 +113,36 @@ def get_client_access_token( :return: The Web PubSub client endpoint, token, and connection URL. :rtype: dict[str, Any] """ - return self._web_pub_sub_service_client.get_client_access_token( # pylint: disable=no-member - user_id=user_id, - roles=list(_CHAT_CLIENT_ROLES), - minutes_to_expire=minutes_to_expire, - groups=[], - client_protocol="Default", - **kwargs, - ) - - def close(self) -> None: - self._web_pub_sub_service_client.close() - super().close() + endpoint = self._config.endpoint.lower().rstrip("/") + path = "/client/hubs/" + base_url = f"ws{endpoint[4:]}{path}{self._config.hub}" + if isinstance(self._config.credential, AzureKeyCredential): + token = get_token_by_key( + endpoint, + path, + self._config.hub, + self._config.credential.key, + user_id=user_id, + roles=list(_CHAT_CLIENT_ROLES), + minutes_to_expire=minutes_to_expire, + ) + else: + response = self._generate_client_token( + user_id=user_id, + role=list(_CHAT_CLIENT_ROLES), + minutes_to_expire=minutes_to_expire, + **kwargs, + ) + token = response.token + return { + "baseUrl": base_url, + "token": token, + "url": f"{base_url}?access_token={token}", + } __all__: list[str] = [ - "ChatRoles", - "RoomPermissions", - "UserPermissions", + "BuiltInChatRoles", "WebPubSubChatServiceClient", ] diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_shared.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_shared.py new file mode 100644 index 000000000000..80677eeddcea --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_shared.py @@ -0,0 +1,149 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +from typing import Any, Awaitable, Optional, Union +from datetime import datetime, timedelta, timezone + +import jwt +from azure.core.pipeline import PipelineRequest +from azure.core.pipeline.policies import SansIOHTTPPolicy, ProxyPolicy +from azure.core.credentials import AzureKeyCredential + + +def _parse_connection_string(connection_string: str, **kwargs: Any) -> Any: + for segment in connection_string.split(";"): + if "=" in segment: + key, value = segment.split("=", 1) + key = key.lower() + if key not in ("version",): + kwargs.setdefault(key, value) + elif segment: + raise ValueError("Malformed connection string - expected 'key=value'") + if "endpoint" not in kwargs: + raise ValueError("connection_string missing 'endpoint' field") + if "accesskey" not in kwargs: + raise ValueError("connection_string missing 'accesskey' field") + return kwargs + + +class JwtCredentialPolicy(SansIOHTTPPolicy): + def __init__( + self, + credential: AzureKeyCredential, + *, + origin_endpoint: Optional[str] = None, + reverse_proxy_endpoint: Optional[str] = None, + ) -> None: + """Create a new instance of the policy associated with the given credential. + + :param credential: The azure.core.credentials.AzureKeyCredential instance to use + :type credential: ~azure.core.credentials.AzureKeyCredential + """ + self._credential = credential + self._original_url = origin_endpoint + self._reverse_proxy_endpoint = reverse_proxy_endpoint + + def on_request(self, request: PipelineRequest) -> Union[None, Awaitable[None]]: + """Is executed before sending the request from next policy. + + :param request: Request to be modified before sent from next policy. + :type request: ~azure.core.pipeline.PipelineRequest + :return: An awaitable or None. + :rtype: ~typing.Awaitable[None] or None + """ + url = request.http_request.url + if self._reverse_proxy_endpoint: + url = url.replace(self._reverse_proxy_endpoint, self._original_url, 1) + request.http_request.headers["Authorization"] = "Bearer " + self._encode(url) + return super(JwtCredentialPolicy, self).on_request(request) + + def _encode(self, url: AzureKeyCredential) -> str: + data = { + "aud": url, + "exp": datetime.now(tz=timezone.utc) + timedelta(seconds=60), + } + encoded = jwt.encode( + payload=data, + key=self._credential.key, + algorithm="HS256", + ) + return encoded + + +class ApiManagementProxy(ProxyPolicy): + def __init__(self, **kwargs: Any) -> None: + """Create a new instance of the policy. + + :param endpoint: endpoint to be replaced + :type endpoint: str + :param proxy_endpoint: proxy endpoint + :type proxy_endpoint: str + """ + super(ApiManagementProxy, self).__init__(**kwargs) + self._endpoint = kwargs.pop("origin_endpoint", None) + self._reverse_proxy_endpoint = kwargs.pop("reverse_proxy_endpoint", None) + + def on_request(self, request: PipelineRequest) -> None: + """Is executed before sending the request from next policy. + + :param request: Request to be modified before sent from next policy. + :type request: ~azure.core.pipeline.PipelineRequest + """ + super(ApiManagementProxy, self).on_request(request) + if self._endpoint and self._reverse_proxy_endpoint: + request.http_request.url = request.http_request.url.replace(self._endpoint, self._reverse_proxy_endpoint) + + +def get_token_by_key( + endpoint: str, + path: str, + hub: str, + key: str, + *, + user_id: Optional[str] = None, + minutes_to_expire: int = 60, + roles: Optional[list[str]] = None, + groups: Optional[list[str]] = None, +) -> str: + """Build token with access key. + + :param endpoint: HTTPS endpoint for the WebPubSub service instance. + :type endpoint: str + :param path: HTTPS path for the WebPubSub service instance. + :type path: str + :param hub: The hub to give access to. + :type hub: str + :param key: The access key + :type key: str + :keyword user_id: User ID for the client connection. + :paramtype user_id: str + :keyword minutes_to_expire: Token lifetime in minutes. Defaults to 60. + :paramtype minutes_to_expire: int + :keyword roles: Roles granted to the client connection. + :paramtype roles: list[str] + :keyword groups: Groups the client connection will join. + :paramtype groups: list[str] + :returns: token + :rtype: str + """ + if minutes_to_expire < 1: + raise ValueError("minutes_to_expire must be at least 1") + + audience = endpoint + path + hub + ttl = timedelta(minutes=minutes_to_expire) + + payload = { + "aud": audience, + "iat": datetime.now(tz=timezone.utc), + "exp": datetime.now(tz=timezone.utc) + ttl, + } + if user_id: + payload["sub"] = user_id + if roles: + payload["role"] = roles + if groups: + payload["webpubsub.group"] = groups + encoded = jwt.encode(payload, key, algorithm="HS256") + return encoded diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/model_base.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/model_base.py index b93f5120d517..d7531c4f81fc 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/model_base.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/model_base.py @@ -158,9 +158,23 @@ def _is_readonly(p): class SdkJSONEncoder(JSONEncoder): - """A JSON encoder that's capable of serializing datetime objects and bytes.""" + """A JSON encoder that's capable of serializing datetime objects and bytes. + + :param args: Additional positional arguments passed to the base ``JSONEncoder``. + :type args: typing.Any + :keyword exclude_readonly: Whether to exclude readonly properties. Defaults to False. + :paramtype exclude_readonly: bool + :keyword format: The format to use for serialization. Defaults to None. + :paramtype format: typing.Optional[str] + """ - def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + def __init__( + self, + *args, + exclude_readonly: bool = False, + format: typing.Optional[str] = None, + **kwargs, + ): super().__init__(*args, **kwargs) self.exclude_readonly = exclude_readonly self.format = format @@ -342,6 +356,12 @@ def _deserialize_int_as_str(attr): return int(attr) +def _deserialize_bool_as_str(attr): + if isinstance(attr, bool): + return attr + return attr.lower() == "true" + + _DESERIALIZE_MAPPING = { datetime: _deserialize_datetime, date: _deserialize_date, @@ -369,6 +389,8 @@ def _deserialize_int_as_str(attr): def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): if annotation is int and rf and rf._format == "str": return _deserialize_int_as_str + if annotation is bool and rf and rf._format == "str": + return _deserialize_bool_as_str if annotation is str and rf and rf._format in _ARRAY_ENCODE_MAPPING: return functools.partial(_deserialize_array_encoded, _ARRAY_ENCODE_MAPPING[rf._format]) if rf and rf._format: @@ -458,21 +480,21 @@ def __ne__(self, other: typing.Any) -> bool: def keys(self) -> typing.KeysView[str]: """ - :returns: a set-like object providing a view on D's keys + :returns: a set-like object providing a view on the mapping's keys :rtype: ~typing.KeysView """ return self._data.keys() def values(self) -> typing.ValuesView[typing.Any]: """ - :returns: an object providing a view on D's values + :returns: an object providing a view on the mapping's values :rtype: ~typing.ValuesView """ return self._data.values() def items(self) -> typing.ItemsView[str, typing.Any]: """ - :returns: set-like object providing a view on D's items + :returns: a set-like object providing a view on the mapping's items :rtype: ~typing.ItemsView """ return self._data.items() @@ -482,7 +504,7 @@ def get(self, key: str, default: typing.Any = None) -> typing.Any: Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None - :returns: D[k] if k in D, else d. + :returns: The value for key if key is in the dictionary, else default. :rtype: any """ try: @@ -517,19 +539,19 @@ def popitem(self) -> tuple[str, typing.Any]: Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple - :raises KeyError: if D is empty. + :raises KeyError: if the dictionary is empty. """ return self._data.popitem() def clear(self) -> None: """ - Remove all items from D. + Remove all items from the dictionary. """ self._data.clear() def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: # pylint: disable=arguments-differ """ - Updates D from mapping/iterable E and F. + Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs. """ self._data.update(*args, **kwargs) @@ -542,10 +564,11 @@ def setdefault(self, key: str, default: typing.Any) -> typing.Any: ... # pylint def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: """ - Same as calling D.get(k, d), and setting D[k]=d if k not found + Return the value for key if key is in the dictionary; otherwise set the key to + default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary - :returns: D[k] if k in D, else d. + :returns: The value for key if key is in the dictionary, else default. :rtype: any """ if default is _UNSET: @@ -910,7 +933,15 @@ def _init_from_xml( # pylint: disable=too-many-branches, too-many-statements field_plan = getattr(self, "_xml_field_plan", None) if field_plan: - for rest_name, xml_name, kind, deser, rf_type, is_optional, items_name in field_plan: + for ( + rest_name, + xml_name, + kind, + deser, + rf_type, + is_optional, + items_name, + ) in field_plan: if kind == 0: # wrapped element (most common) item = element.find(xml_name) if item is not None: @@ -1229,7 +1260,9 @@ def _get_deserialize_callable_from_annotation( # pylint: disable=too-many-retur rf._is_optional = True if len(annotation.__args__) <= 2: # pyright: ignore if_obj_deserializer = _get_deserialize_callable_from_annotation( - next(a for a in annotation.__args__ if a is not _NONE_TYPE), module, rf # pyright: ignore + next(a for a in annotation.__args__ if a is not _NONE_TYPE), + module, + rf, # pyright: ignore ) return functools.partial(_deserialize_with_optional, if_obj_deserializer) @@ -1367,7 +1400,8 @@ def _failsafe_deserialize( return _deserialize(deserializer, response.json(), module, rf, format) except Exception: # pylint: disable=broad-except _LOGGER.warning( - "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", + exc_info=True, ) return None @@ -1380,7 +1414,8 @@ def _failsafe_deserialize_xml( return _deserialize_xml(deserializer, response.text()) except Exception: # pylint: disable=broad-except _LOGGER.warning( - "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", + exc_info=True, ) return None @@ -1546,7 +1581,8 @@ def _get_xml_ns(meta: dict[str, typing.Any]) -> typing.Optional[str]: def _resolve_xml_ns( - prop_meta: dict[str, typing.Any], model_meta: typing.Optional[dict[str, typing.Any]] = None + prop_meta: dict[str, typing.Any], + model_meta: typing.Optional[dict[str, typing.Any]] = None, ) -> typing.Optional[str]: """Resolve XML namespace for a property, falling back to model namespace when appropriate. @@ -1687,7 +1723,9 @@ def _get_wrapped_element( ) -> ET.Element: _meta_ns = _get_xml_ns(meta) if meta else None wrapped_element = _create_xml_element( - meta.get("name") if meta else None, meta.get("prefix") if meta else None, _meta_ns + meta.get("name") if meta else None, + meta.get("prefix") if meta else None, + _meta_ns, ) if isinstance(v, (dict, list)): wrapped_element.extend(_get_element(v, exclude_readonly, meta)) @@ -1727,7 +1765,9 @@ def _safe_register_namespace(prefix: str, ns: str) -> None: def _create_xml_element( - tag: typing.Any, prefix: typing.Optional[str] = None, ns: typing.Optional[str] = None + tag: typing.Any, + prefix: typing.Optional[str] = None, + ns: typing.Optional[str] = None, ) -> ET.Element: if prefix and ns: _safe_register_namespace(prefix, ns) @@ -1755,7 +1795,10 @@ def _convert_element(e: ET.Element): if isinstance(dict_result[child.tag], list): dict_result[child.tag].append(_convert_element(child)) else: - dict_result[child.tag] = [dict_result[child.tag], _convert_element(child)] + dict_result[child.tag] = [ + dict_result[child.tag], + _convert_element(child), + ] else: dict_result[child.tag] = _convert_element(child) dict_result.update(e.attrib) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/serialization.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/serialization.py index 75906e2eb77f..1724ad940fdb 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/serialization.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/serialization.py @@ -239,9 +239,17 @@ def __init__(self, **kwargs: Any) -> None: self.additional_properties: Optional[dict[str, Any]] = {} for k in kwargs: # pylint: disable=consider-using-dict-items if k not in self._attribute_map: - _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) + _LOGGER.warning( + "%s is not a known attribute of class %s and will be ignored", + k, + self.__class__, + ) elif k in self._validation and self._validation[k].get("readonly", False): - _LOGGER.warning("Readonly attribute %s will be ignored in class %s", k, self.__class__) + _LOGGER.warning( + "Readonly attribute %s will be ignored in class %s", + k, + self.__class__, + ) else: setattr(self, k, kwargs[k]) @@ -292,7 +300,11 @@ def _create_xml_node(cls): except AttributeError: xml_map = {} - return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) + return _create_xml_node( + xml_map.get("name", cls.__name__), + xml_map.get("prefix", None), + xml_map.get("ns", None), + ) def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: """Return the JSON that would be sent to server from this model. @@ -453,7 +465,11 @@ def _classify(cls, response, objects): ) break else: - _LOGGER.warning("Discriminator %s is absent or null, use base class %s.", subtype_key, cls.__name__) + _LOGGER.warning( + "Discriminator %s is absent or null, use base class %s.", + subtype_key, + cls.__name__, + ) break return cls @@ -480,7 +496,11 @@ def _decode_attribute_map_key(key): class Serializer: # pylint: disable=too-many-public-methods - """Request object model serializer.""" + """Request object model serializer. + + :param classes: Mapping of model names to model types, used to resolve models during serialization. + :type classes: typing.Optional[typing.Mapping[str, type]] + """ basic_types = {str: "str", int: "int", bool: "bool", float: "float"} @@ -924,7 +944,11 @@ def serialize_iter(self, data, iter_type, div=None, **kwargs): if isinstance(el, ET.Element): el_node = el else: - el_node = _create_xml_node(node_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + el_node = _create_xml_node( + node_name, + xml_desc.get("prefix", None), + xml_desc.get("ns", None), + ) if el is not None: # Otherwise it writes "None" :-p el_node.text = str(el) final_result.append(el_node) @@ -1216,7 +1240,12 @@ def serialize_iso(attr, **kwargs): # pylint: disable=unused-argument if microseconds: microseconds = "." + microseconds date = "{:04}-{:02}-{:02}T{:02}:{:02}:{:02}".format( - utc.tm_year, utc.tm_mon, utc.tm_mday, utc.tm_hour, utc.tm_min, utc.tm_sec + utc.tm_year, + utc.tm_mon, + utc.tm_mday, + utc.tm_hour, + utc.tm_min, + utc.tm_sec, ) return date + microseconds + "Z" except (ValueError, OverflowError) as err: @@ -1521,7 +1550,10 @@ def _deserialize(self, target_obj, data): # pylint: disable=inconsistent-return if hasattr(data, "_attribute_map"): constants = [name for name, config in getattr(data, "_validation", {}).items() if config.get("constant")] try: - for attr, mapconfig in data._attribute_map.items(): # pylint: disable=protected-access + for ( + attr, + mapconfig, + ) in data._attribute_map.items(): # pylint: disable=protected-access if attr in constants: continue value = getattr(data, attr) @@ -1639,7 +1671,8 @@ def failsafe_deserialize(self, target_obj, data, content_type=None): return self(target_obj, data, content_type=content_type) except: # pylint: disable=bare-except _LOGGER.debug( - "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", + exc_info=True, ) return None @@ -1941,7 +1974,11 @@ def deserialize_enum(data, enum_obj): if enum_value.value.lower() == str(data).lower(): return enum_value # We don't fail anymore for unknown value, we deserialize as a string - _LOGGER.warning("Deserializer is not able to find %s as valid enum in %s", data, enum_obj) + _LOGGER.warning( + "Deserializer is not able to find %s as valid enum in %s", + data, + enum_obj, + ) return Deserializer.deserialize_unicode(data) @staticmethod diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_client.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_client.py index 2f3347e5fecb..9e7e53f3558a 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_client.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_client.py @@ -27,7 +27,9 @@ from azure.core.credentials_async import AsyncTokenCredential -class WebPubSubChatServiceClient(_WebPubSubChatServiceClientOperationsMixin): +class WebPubSubChatServiceClient( + _WebPubSubChatServiceClientOperationsMixin +): # pylint: disable=docstring-keyword-should-match-keyword-only """WebPubSubChatServiceClient. :param endpoint: HTTP or HTTPS endpoint for the Web PubSub service instance. Required. @@ -64,7 +66,7 @@ def __init__(self, endpoint: str, credential: "AsyncTokenCredential", hub: str, self._config.custom_hook_policy, self._config.logging_policy, policies.DistributedTracingPolicy(**kwargs), - policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + (policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None), self._config.http_logging_policy, ] self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_configuration.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_configuration.py index a44ca77c4856..564c0963ed46 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_configuration.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_configuration.py @@ -1,3 +1,4 @@ +# pylint: disable=line-too-long,useless-suppression # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -16,7 +17,7 @@ from azure.core.credentials_async import AsyncTokenCredential -class WebPubSubChatServiceClientConfiguration: # pylint: disable=too-many-instance-attributes +class WebPubSubChatServiceClientConfiguration: # pylint: disable=too-many-instance-attributes,docstring-keyword-should-match-keyword-only """Configuration for WebPubSubChatServiceClient. Note that all parameters used to create this instance are saved as instance diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_operations/_operations.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_operations/_operations.py index 571977fcedd3..4f7e4525d829 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_operations/_operations.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_operations/_operations.py @@ -9,7 +9,7 @@ from collections.abc import MutableMapping from io import IOBase import json -from typing import Any, Callable, IO, Optional, TypeVar, Union, overload +from typing import Any, Callable, IO, Literal, Optional, TypeVar, Union, overload import urllib.parse from azure.core import AsyncPipelineClient, MatchConditions @@ -42,6 +42,7 @@ build_web_pub_sub_chat_service_delete_room_member_request, build_web_pub_sub_chat_service_delete_room_request, build_web_pub_sub_chat_service_delete_user_request, + build_web_pub_sub_chat_service_generate_client_token_request, build_web_pub_sub_chat_service_get_conversation_request, build_web_pub_sub_chat_service_get_role_request, build_web_pub_sub_chat_service_get_room_request, @@ -60,7 +61,10 @@ class _WebPubSubChatServiceClientOperationsMixin( - ClientMixinABC[AsyncPipelineClient[HttpRequest, AsyncHttpResponse], WebPubSubChatServiceClientConfiguration] + ClientMixinABC[ + AsyncPipelineClient[HttpRequest, AsyncHttpResponse], + WebPubSubChatServiceClientConfiguration, + ] ): @distributed_trace_async @@ -182,7 +186,10 @@ def prepare_request(next_link=None): ) path_format_arguments = { "endpoint": self._serialize.url( - "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + "self._config.endpoint", + self._config.endpoint, + "str", + skip_quote=True, ), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -205,7 +212,10 @@ def prepare_request(next_link=None): ) path_format_arguments = { "endpoint": self._serialize.url( - "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + "self._config.endpoint", + self._config.endpoint, + "str", + skip_quote=True, ), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -232,7 +242,11 @@ async def get_next(next_link=None): response = pipeline_response.http_response if response.status_code not in [200]: - map_error(status_code=response.status_code, response=response, error_map=error_map) + map_error( + status_code=response.status_code, + response=response, + error_map=error_map, + ) raise HttpResponseError(response=response) return pipeline_response @@ -568,7 +582,10 @@ def prepare_request(next_link=None): ) path_format_arguments = { "endpoint": self._serialize.url( - "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + "self._config.endpoint", + self._config.endpoint, + "str", + skip_quote=True, ), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -591,7 +608,10 @@ def prepare_request(next_link=None): ) path_format_arguments = { "endpoint": self._serialize.url( - "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + "self._config.endpoint", + self._config.endpoint, + "str", + skip_quote=True, ), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -618,7 +638,11 @@ async def get_next(next_link=None): response = pipeline_response.http_response if response.status_code not in [200]: - map_error(status_code=response.status_code, response=response, error_map=error_map) + map_error( + status_code=response.status_code, + response=response, + error_map=error_map, + ) raise HttpResponseError(response=response) return pipeline_response @@ -1337,7 +1361,10 @@ def prepare_request(next_link=None): ) path_format_arguments = { "endpoint": self._serialize.url( - "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + "self._config.endpoint", + self._config.endpoint, + "str", + skip_quote=True, ), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -1360,7 +1387,10 @@ def prepare_request(next_link=None): ) path_format_arguments = { "endpoint": self._serialize.url( - "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + "self._config.endpoint", + self._config.endpoint, + "str", + skip_quote=True, ), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -1387,7 +1417,11 @@ async def get_next(next_link=None): response = pipeline_response.http_response if response.status_code not in [200]: - map_error(status_code=response.status_code, response=response, error_map=error_map) + map_error( + status_code=response.status_code, + response=response, + error_map=error_map, + ) raise HttpResponseError(response=response) return pipeline_response @@ -2017,3 +2051,90 @@ async def delete_user( if cls: return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace_async + async def _generate_client_token( + self, + *, + user_id: Optional[str] = None, + role: Optional[list[str]] = None, + minutes_to_expire: Optional[int] = None, + **kwargs: Any + ) -> _models._models.GenerateClientTokenResponse: + """Generate a token for connecting a client to Azure Web PubSub. + + Generate a token for connecting a client to Azure Web PubSub. + + :keyword user_id: User identifier for the client connection. Default value is None. + :paramtype user_id: str + :keyword role: Roles granted to the client connection. Default value is None. + :paramtype role: list[str] + :keyword minutes_to_expire: Lifetime of the generated token, in minutes. Default value is None. + :paramtype minutes_to_expire: int + :return: GenerateClientTokenResponse. The GenerateClientTokenResponse is compatible with + MutableMapping + :rtype: ~azure.messaging.webpubsubservice.chat.models._models.GenerateClientTokenResponse + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + api_version: Literal["2024-12-01"] = kwargs.pop("api_version", _params.pop("api-version", "2024-12-01")) + client_type: Literal["default"] = kwargs.pop("client_type", _params.pop("clientType", "default")) + cls: ClsType[_models._models.GenerateClientTokenResponse] = kwargs.pop("cls", None) + + _request = build_web_pub_sub_chat_service_generate_client_token_request( + hub=self._config.hub, + user_id=user_id, + role=role, + minutes_to_expire=minutes_to_expire, + api_version=api_version, + client_type=client_type, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["content-type"] = self._deserialize("str", response.headers.get("content-type")) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize( + _models._models.GenerateClientTokenResponse, + response.json(), # pylint: disable=protected-access + ) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_operations/_patch.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_operations/_patch.py index 87676c65a8f0..ea765788358a 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_operations/_patch.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_operations/_patch.py @@ -8,7 +8,6 @@ Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ - __all__: list[str] = [] # Add all objects you want publicly available to users at this package level diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_patch.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_patch.py index a8a504ca8d5f..0945de708b34 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_patch.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/aio/_patch.py @@ -7,15 +7,19 @@ Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ -from typing import Any, Dict, Optional, TYPE_CHECKING, Union + +from typing import Any, Dict, Optional, TYPE_CHECKING, Union, cast from azure.core.credentials import AzureKeyCredential from azure.core.tracing.decorator_async import distributed_trace_async -from azure.messaging.webpubsubservice._patch import ApiManagementProxy, JwtCredentialPolicy, _parse_connection_string -from azure.messaging.webpubsubservice.aio._patch import WebPubSubServiceClient - from .._patch import _CHAT_CLIENT_ROLES +from .._shared import ( + ApiManagementProxy, + JwtCredentialPolicy, + _parse_connection_string, + get_token_by_key, +) from ._client import WebPubSubChatServiceClient as WebPubSubChatServiceClientGenerated if TYPE_CHECKING: @@ -51,9 +55,6 @@ def __init__( raise ValueError("Parameter 'hub' must not be empty.") if credential is None: raise ValueError("Parameter 'credential' must not be None.") - service_client_kwargs = { - name: kwargs[name] for name in ("reverse_proxy_endpoint", "transport") if name in kwargs - } port = kwargs.pop("port", None) if port: endpoint = f"{endpoint.rstrip('/')}:{port}" @@ -68,12 +69,11 @@ def __init__( kwargs["proxy_policy"] = ApiManagementProxy(**kwargs) if api_version is not None: kwargs["api_version"] = api_version - super().__init__(endpoint=endpoint, hub=hub, credential=credential, **kwargs) - self._web_pub_sub_service_client = WebPubSubServiceClient( + super().__init__( endpoint=endpoint, hub=hub, - credential=credential, - **service_client_kwargs, + credential=cast("AsyncTokenCredential", credential), + **kwargs, ) @classmethod @@ -110,18 +110,32 @@ async def get_client_access_token( :return: The Web PubSub client endpoint, token, and connection URL. :rtype: dict[str, Any] """ - return await self._web_pub_sub_service_client.get_client_access_token( # pylint: disable=no-member - user_id=user_id, - roles=list(_CHAT_CLIENT_ROLES), - minutes_to_expire=minutes_to_expire, - groups=[], - client_protocol="Default", - **kwargs, - ) - - async def close(self) -> None: - await self._web_pub_sub_service_client.close() - await super().close() + endpoint = self._config.endpoint.lower().rstrip("/") + path = "/client/hubs/" + base_url = f"ws{endpoint[4:]}{path}{self._config.hub}" + if isinstance(self._config.credential, AzureKeyCredential): + token = get_token_by_key( + endpoint, + path, + self._config.hub, + self._config.credential.key, + user_id=user_id, + roles=list(_CHAT_CLIENT_ROLES), + minutes_to_expire=minutes_to_expire, + ) + else: + response = await self._generate_client_token( + user_id=user_id, + role=list(_CHAT_CLIENT_ROLES), + minutes_to_expire=minutes_to_expire, + **kwargs, + ) + token = response.token + return { + "baseUrl": base_url, + "token": token, + "url": f"{base_url}?access_token={token}", + } __all__: list[str] = ["WebPubSubChatServiceClient"] diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/__init__.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/__init__.py index 6472dca37389..f899728a6f97 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/__init__.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/__init__.py @@ -25,6 +25,7 @@ ) from ._enums import ( # type: ignore + ChatPermission, ChatUserKind, ) from ._patch import __all__ as _patch_all @@ -40,6 +41,7 @@ "ChatUser", "HumanChatUser", "MessageContent", + "ChatPermission", "ChatUserKind", ] __all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_enums.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_enums.py index 5c2004cdae61..1a61c9616269 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_enums.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_enums.py @@ -10,6 +10,23 @@ from azure.core import CaseInsensitiveEnumMeta +class ChatPermission(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """A permission that can be assigned to a chat role.""" + + USER_CREATE_ROOM = "user.create_room" + """Allows a user to create chat rooms.""" + USER_FETCH_ALL_ROOMS = "user.fetch_all_rooms" + """Allows a user to list the rooms they belong to.""" + ROOM_PUBLISH_MESSAGE = "room.publish_message" + """Allows a room member to publish messages.""" + ROOM_HISTORY = "room.history" + """Allows a room member to read message history.""" + ROOM_INVITE = "room.invite" + """Allows a room member to add users to a room.""" + ROOM_REMOVE_USER = "room.remove_user" + """Allows a room operator to remove users from a room.""" + + class ChatUserKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): """Discriminator for the kind of chat user.""" diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_models.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_models.py index c197573a2f29..37f182a958b8 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_models.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_models.py @@ -9,7 +9,7 @@ # pylint: disable=useless-super-delegation import datetime -from typing import Any, Literal, Mapping, Optional, TYPE_CHECKING, overload +from typing import Any, Literal, Mapping, Optional, TYPE_CHECKING, Union, overload from .._utils.model_base import Model as _Model, rest_discriminator, rest_field from ._enums import ChatUserKind @@ -18,7 +18,7 @@ from .. import models as _models -class ChatConversation(_Model): +class ChatConversation(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """Represents a chat conversation. :ivar id: Conversation identifier. Required. @@ -54,7 +54,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class ChatMessage(_Model): +class ChatMessage(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """Represents a chat message. :ivar id: Message identifier. Required. @@ -99,7 +99,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class ChatRole(_Model): +class ChatRole(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """Represents a chat role. A role name must start with 'user.' or 'room.' prefix. A role must contain either user permissions or room permissions, but not both. @@ -107,14 +107,16 @@ class ChatRole(_Model): :vartype name: str :ivar permissions: Permissions associated with the role. Do not mix user permissions and room permissions in one role. Required. - :vartype permissions: list[str] + :vartype permissions: list[str or ~azure.messaging.webpubsubservice.chat.models.ChatPermission] :ivar etag: The entity tag for this resource. Required. :vartype etag: str """ name: str = rest_field(visibility=["read"]) """Role name. Must start with 'user.' or 'room.' prefix. Required.""" - permissions: list[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + permissions: list[Union[str, "_models.ChatPermission"]] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) """Permissions associated with the role. Do not mix user permissions and room permissions in one role. Required.""" etag: str = rest_field(visibility=["read"]) @@ -124,7 +126,7 @@ class ChatRole(_Model): def __init__( self, *, - permissions: list[str], + permissions: list[Union[str, "_models.ChatPermission"]], ) -> None: ... @overload @@ -138,7 +140,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class ChatRoom(_Model): +class ChatRoom(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """Represents a chat room. :ivar id: Room identifier. Required. @@ -178,7 +180,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class ChatRoomMember(_Model): +class ChatRoomMember(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """Represents a room member. :ivar user_id: User ID of the member. Required. @@ -214,7 +216,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class ChatUser(_Model): +class ChatUser(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """Represents a user profile in the chat system. This is a discriminated base type; concrete payloads are selected by the ``kind`` field (e.g. ``HumanChatUser``). @@ -260,7 +262,35 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class HumanChatUser(ChatUser, discriminator="Human"): +class GenerateClientTokenResponse(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only + """Response containing a Web PubSub client access token. + + :ivar token: Access token used to connect to Azure Web PubSub. Required. + :vartype token: str + """ + + token: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Access token used to connect to Azure Web PubSub. Required.""" + + @overload + def __init__( + self, + *, + token: str, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class HumanChatUser(ChatUser, discriminator="Human"): # pylint: disable=docstring-keyword-should-match-keyword-only """A human end-user, identified by a user role. :ivar id: User identifier. Required. @@ -300,7 +330,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: self.kind = ChatUserKind.HUMAN # type: ignore -class MessageContent(_Model): +class MessageContent(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """Message content body. :ivar text: Text content. diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_patch.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_patch.py index 87676c65a8f0..ea765788358a 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_patch.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/models/_patch.py @@ -8,7 +8,6 @@ Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ - __all__: list[str] = [] # Add all objects you want publicly available to users at this package level diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/types.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/types.py index a45d3e8a7b18..c738d721fea3 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/types.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/types.py @@ -6,29 +6,13 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from typing import Literal, Union +from typing import Literal, TYPE_CHECKING, Union from typing_extensions import Required, TypedDict from .models._enums import ChatUserKind - -class ChatConversation(TypedDict, total=False): - """Represents a chat conversation. - - :ivar id: Conversation identifier. Required. - :vartype id: str - :ivar parent_room: Parent room identifier. Required. - :vartype parent_room: str - :ivar etag: The entity tag for this resource. Required. - :vartype etag: str - """ - - id: Required[str] - """Conversation identifier. Required.""" - parentRoom: Required[str] - """Parent room identifier. Required.""" - etag: Required[str] - """The entity tag for this resource. Required.""" +if TYPE_CHECKING: + from .models import ChatPermission class ChatMessage(TypedDict, total=False): @@ -36,12 +20,12 @@ class ChatMessage(TypedDict, total=False): :ivar id: Message identifier. Required. :vartype id: str - :ivar created_by: User who created the message. Required. - :vartype created_by: str + :ivar createdBy: User who created the message. Required. + :vartype createdBy: str :ivar content: Message content. Required. :vartype content: "MessageContent" - :ivar created_at: Timestamp when the message was created. Required. - :vartype created_at: str + :ivar createdAt: Timestamp when the message was created. Required. + :vartype createdAt: str :ivar etag: The entity tag for this resource. Required. :vartype etag: str """ @@ -66,14 +50,14 @@ class ChatRole(TypedDict, total=False): :vartype name: str :ivar permissions: Permissions associated with the role. Do not mix user permissions and room permissions in one role. Required. - :vartype permissions: list[str] + :vartype permissions: list[Union[str, "ChatPermission"]] :ivar etag: The entity tag for this resource. Required. :vartype etag: str """ name: Required[str] """Role name. Must start with 'user.' or 'room.' prefix. Required.""" - permissions: Required[list[str]] + permissions: Required[list[Union[str, "ChatPermission"]]] """Permissions associated with the role. Do not mix user permissions and room permissions in one role. Required.""" etag: Required[str] @@ -87,8 +71,8 @@ class ChatRoom(TypedDict, total=False): :vartype id: str :ivar title: Room title. Required. :vartype title: str - :ivar default_conversation: Default conversation ID for this room. Required. - :vartype default_conversation: str + :ivar defaultConversation: Default conversation ID for this room. Required. + :vartype defaultConversation: str :ivar etag: The entity tag for this resource. Required. :vartype etag: str """ @@ -106,10 +90,10 @@ class ChatRoom(TypedDict, total=False): class ChatRoomMember(TypedDict, total=False): """Represents a room member. - :ivar user_id: User ID of the member. Required. - :vartype user_id: str - :ivar role_name: Room role assigned to the user within this room. Required. - :vartype role_name: str + :ivar userId: User ID of the member. Required. + :vartype userId: str + :ivar roleName: Room role assigned to the user within this room. Required. + :vartype roleName: str :ivar etag: The entity tag for this resource. Required. :vartype etag: str """ @@ -133,8 +117,8 @@ class HumanChatUser(TypedDict, total=False): :vartype etag: str :ivar kind: Required. A human end-user. :vartype kind: Literal[ChatUserKind.HUMAN] - :ivar role_name: Global user role assigned to the user. Must start with ``user.``. Required. - :vartype role_name: str + :ivar roleName: Global user role assigned to the user. Must start with ``user.``. Required. + :vartype roleName: str """ id: Required[str] diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/dev_requirements.txt b/sdk/webpubsub/azure-messaging-webpubsubchatservice/dev_requirements.txt index 49b469b621e4..ad0907b03b93 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/dev_requirements.txt +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/dev_requirements.txt @@ -1,5 +1,4 @@ -e ../../../eng/tools/azure-sdk-tools ../../core/azure-core ../../identity/azure-identity -../azure-messaging-webpubsubservice aiohttp \ No newline at end of file diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/create_or_replace_role.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/create_or_replace_role.py index cc17ab50b470..2d5882be173a 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/create_or_replace_role.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_samples/chat/create_or_replace_role.py @@ -33,9 +33,7 @@ def main(): response = client.create_or_replace_role( role_name="room.moderator", - resource={ - "permissions": ["room.history", "room.mute", "room.freeze", "room.remove_user", "room.publish_message"] - }, + resource={"permissions": ["room.history", "room.remove_user", "room.publish_message"]}, ) print(response) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/conftest.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/conftest.py index 7ca6a594c872..ad08bc425f6c 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/conftest.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/conftest.py @@ -34,11 +34,21 @@ def add_sanitizers(test_proxy): "WEBPUBSUBCHATSERVICE_CLIENT_SECRET", "00000000-0000-0000-0000-000000000000" ) add_general_regex_sanitizer( - regex=webpubsubchatservice_subscription_id, value="00000000-0000-0000-0000-000000000000" + regex=webpubsubchatservice_subscription_id, + value="00000000-0000-0000-0000-000000000000", + ) + add_general_regex_sanitizer( + regex=webpubsubchatservice_tenant_id, + value="00000000-0000-0000-0000-000000000000", + ) + add_general_regex_sanitizer( + regex=webpubsubchatservice_client_id, + value="00000000-0000-0000-0000-000000000000", + ) + add_general_regex_sanitizer( + regex=webpubsubchatservice_client_secret, + value="00000000-0000-0000-0000-000000000000", ) - add_general_regex_sanitizer(regex=webpubsubchatservice_tenant_id, value="00000000-0000-0000-0000-000000000000") - add_general_regex_sanitizer(regex=webpubsubchatservice_client_id, value="00000000-0000-0000-0000-000000000000") - add_general_regex_sanitizer(regex=webpubsubchatservice_client_secret, value="00000000-0000-0000-0000-000000000000") add_header_regex_sanitizer(key="Set-Cookie", value="[set-cookie;]") add_header_regex_sanitizer(key="Cookie", value="cookie;") diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/test_web_pub_sub_chat_service.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/test_web_pub_sub_chat_service.py index 12a168e8992f..f64bfc6f89ea 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/test_web_pub_sub_chat_service.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/test_web_pub_sub_chat_service.py @@ -7,7 +7,10 @@ # -------------------------------------------------------------------------- import pytest from devtools_testutils import recorded_by_proxy -from testpreparer import WebPubSubChatServiceClientTestBase, WebPubSubChatServicePreparer +from testpreparer import ( + WebPubSubChatServiceClientTestBase, + WebPubSubChatServicePreparer, +) @pytest.mark.skip("you may need to update the auto-generated test case before run it") @@ -114,7 +117,12 @@ def test_create_or_replace_room(self, webpubsubchatservice_endpoint): client = self.create_client(endpoint=webpubsubchatservice_endpoint) response = client.create_or_replace_room( room_id="str", - resource={"defaultConversation": "str", "etag": "str", "id": "str", "title": "str"}, + resource={ + "defaultConversation": "str", + "etag": "str", + "id": "str", + "title": "str", + }, ) # please add some check logic here by yourself @@ -195,7 +203,13 @@ def test_create_or_replace_user(self, webpubsubchatservice_endpoint): client = self.create_client(endpoint=webpubsubchatservice_endpoint) response = client.create_or_replace_user( user_id="str", - resource={"etag": "str", "id": "str", "kind": "Human", "nickname": "str", "roleName": "str"}, + resource={ + "etag": "str", + "id": "str", + "kind": "Human", + "nickname": "str", + "roleName": "str", + }, ) # please add some check logic here by yourself diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/test_web_pub_sub_chat_service_async.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/test_web_pub_sub_chat_service_async.py index d523fbf6b6df..43abc2d31b82 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/test_web_pub_sub_chat_service_async.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/generated_tests/test_web_pub_sub_chat_service_async.py @@ -115,7 +115,12 @@ async def test_create_or_replace_room(self, webpubsubchatservice_endpoint): client = self.create_async_client(endpoint=webpubsubchatservice_endpoint) response = await client.create_or_replace_room( room_id="str", - resource={"defaultConversation": "str", "etag": "str", "id": "str", "title": "str"}, + resource={ + "defaultConversation": "str", + "etag": "str", + "id": "str", + "title": "str", + }, ) # please add some check logic here by yourself @@ -196,7 +201,13 @@ async def test_create_or_replace_user(self, webpubsubchatservice_endpoint): client = self.create_async_client(endpoint=webpubsubchatservice_endpoint) response = await client.create_or_replace_user( user_id="str", - resource={"etag": "str", "id": "str", "kind": "Human", "nickname": "str", "roleName": "str"}, + resource={ + "etag": "str", + "id": "str", + "kind": "Human", + "nickname": "str", + "roleName": "str", + }, ) # please add some check logic here by yourself diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/package-lock.json b/sdk/webpubsub/azure-messaging-webpubsubchatservice/package-lock.json new file mode 100644 index 000000000000..062ac9c1751d --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/package-lock.json @@ -0,0 +1,6 @@ +{ + "name": "azure-messaging-webpubsubchatservice", + "lockfileVersion": 3, + "requires": true, + "packages": {} +} diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/pyproject.toml b/sdk/webpubsub/azure-messaging-webpubsubchatservice/pyproject.toml new file mode 100644 index 000000000000..4ad8b1a3d316 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/pyproject.toml @@ -0,0 +1,63 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +[build-system] +requires = ["setuptools>=77.0.3", "wheel"] +build-backend = "setuptools.build_meta" + +[project] +name = "azure-messaging-webpubsubchatservice" +authors = [ + { name = "Microsoft Corporation", email = "azpysdkhelp@microsoft.com" }, +] +description = "Microsoft Corporation Azure Web PubSub Chat Service Client Library for Python" +license = "MIT" +classifiers = [ + "Development Status :: 4 - Beta", + "Programming Language :: Python", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", + "Programming Language :: Python :: 3.14", +] +requires-python = ">=3.10" +keywords = ["azure", "azure sdk"] + +dependencies = [ + "isodate>=0.6.1", + "azure-core>=1.37.0", + "PyJWT>=2.6.0", + "typing-extensions>=4.6.0", +] +dynamic = [ +"version", "readme" +] + +[project.urls] +repository = "https://github.com/Azure/azure-sdk-for-python" + +[tool.setuptools.dynamic] +version = {attr = "azure.messaging.webpubsubservice.chat._version.VERSION"} +readme = {file = ["README.md", "CHANGELOG.md"], content-type = "text/markdown"} + +[tool.setuptools.packages.find] +exclude = [ + "tests*", + "generated_tests*", + "samples*", + "generated_samples*", + "doc*", + "azure", + "azure.messaging", + "azure.messaging.webpubsubservice", +] + +[tool.setuptools.package-data] +pytyped = ["py.typed"] diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_authentication.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_authentication.py index 3be4787b4fe1..04413cf99a2d 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_authentication.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_authentication.py @@ -49,7 +49,11 @@ def entra_auth(): def main(): - required = ("WPS_CHAT_ENDPOINT", "WPS_CHAT_CONNECTION_STRING", "WPS_CHAT_ACCESS_KEY") + required = ( + "WPS_CHAT_ENDPOINT", + "WPS_CHAT_CONNECTION_STRING", + "WPS_CHAT_ACCESS_KEY", + ) missing = [name for name in required if not os.environ.get(name)] if missing: print(f"Set {', '.join(missing)} to run this sample.") diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_resource_management.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_resource_management.py deleted file mode 100644 index ff8b626faaf3..000000000000 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_resource_management.py +++ /dev/null @@ -1,60 +0,0 @@ -# -------------------------------------------------------------------------- -# Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for license information. -# -------------------------------------------------------------------------- -import os -import uuid - -from azure.core.exceptions import HttpResponseError -from azure.messaging.webpubsubservice.chat import RoomPermissions, UserPermissions, WebPubSubChatServiceClient -from azure.messaging.webpubsubservice.chat.models import ChatRole, ChatRoom, ChatRoomMember, HumanChatUser - - -def main(): - connection_string = os.environ.get("WPS_CHAT_CONNECTION_STRING") - if not connection_string: - print("Set WPS_CHAT_CONNECTION_STRING to run this sample.") - return - - suffix = uuid.uuid4().hex[:8] - user_role = f"user.sample_{suffix}" - room_role = f"room.sample_{suffix}" - user_id = f"sample-user-{suffix}" - room_id = f"sample-room-{suffix}" - with WebPubSubChatServiceClient.from_connection_string( - connection_string, - os.environ.get("WPS_CHAT_HUB", "test_hub"), - ) as client: - try: - client.create_or_replace_role(user_role, ChatRole(permissions=[UserPermissions.CREATE_ROOM])) - client.create_or_replace_role(room_role, ChatRole(permissions=[RoomPermissions.PUBLISH_MESSAGE])) - client.create_or_replace_user( - user_id, - HumanChatUser(nickname="Sample User", role_name=user_role), - ) - client.create_or_replace_room(room_id, ChatRoom(title="Sample Room")) - client.create_or_replace_room_member( - room_id, - user_id, - ChatRoomMember(role_name=room_role), - ) - for member in client.list_room_members(room_id): - print(member.user_id, member.role_name) - except HttpResponseError as error: - print(f"Chat service request failed: {error}") - raise - finally: - for action, args in ( - (client.delete_room, (room_id,)), - (client.delete_user, (user_id,)), - (client.delete_role, (user_role,)), - (client.delete_role, (room_role,)), - ): - try: - action(*args) - except HttpResponseError: - pass - - -if __name__ == "__main__": - main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_roles_and_permissions.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_roles_and_permissions.py index c33d5b8d93ed..b634d0332b8e 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_roles_and_permissions.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_roles_and_permissions.py @@ -2,15 +2,65 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. See License.txt in the project root for license information. # -------------------------------------------------------------------------- -from azure.messaging.webpubsubservice.chat import ChatRoles, RoomPermissions, UserPermissions +import os +import uuid +from azure.core.exceptions import HttpResponseError +from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient +from azure.messaging.webpubsubservice.chat.models import ( + ChatPermission, + ChatRole, + ChatRoom, + ChatRoomMember, + HumanChatUser, +) -print(ChatRoles.USER_NORMAL) -print(ChatRoles.ROOM_MEMBER) -print(ChatRoles.ROOM_OPERATOR) -print(UserPermissions.CREATE_ROOM) -print(UserPermissions.FETCH_ALL_ROOMS) -print(RoomPermissions.INVITE_USER) -print(RoomPermissions.REMOVE_USER) -print(RoomPermissions.READ_HISTORY) -print(RoomPermissions.PUBLISH_MESSAGE) + +def main(): + connection_string = os.environ.get("WPS_CHAT_CONNECTION_STRING") + if not connection_string: + print("Set WPS_CHAT_CONNECTION_STRING to run this sample.") + return + + suffix = uuid.uuid4().hex[:8] + user_role = f"user.sample_{suffix}" + room_role = f"room.sample_{suffix}" + user_id = f"sample-user-{suffix}" + room_id = f"sample-room-{suffix}" + with WebPubSubChatServiceClient.from_connection_string( + connection_string, + os.environ.get("WPS_CHAT_HUB", "test_hub"), + ) as client: + try: + client.create_or_replace_role(user_role, ChatRole(permissions=[ChatPermission.USER_CREATE_ROOM])) + client.create_or_replace_role(room_role, ChatRole(permissions=[ChatPermission.ROOM_PUBLISH_MESSAGE])) + client.create_or_replace_user( + user_id, + HumanChatUser(nickname="Sample User", role_name=user_role), + ) + client.create_or_replace_room(room_id, ChatRoom(title="Sample Room")) + client.create_or_replace_room_member( + room_id, + user_id, + ChatRoomMember(role_name=room_role), + ) + for member in client.list_room_members(room_id): + print(member.user_id, member.role_name) + except HttpResponseError as error: + print(f"Chat service request failed: {error}") + raise + finally: + for action, args in ( + (client.delete_room, (room_id,)), + (client.delete_user, (user_id,)), + (client.delete_role, (user_role,)), + (client.delete_role, (room_role,)), + ): + try: + action(*args) + except HttpResponseError: + pass + + +if __name__ == "__main__": + main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_resource_management_async.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_roles_and_permissions_async.py similarity index 88% rename from sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_resource_management_async.py rename to sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_roles_and_permissions_async.py index bc0f7c7c1bb8..4bf93443d023 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_resource_management_async.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/samples/sample_roles_and_permissions_async.py @@ -7,9 +7,14 @@ import uuid from azure.core.exceptions import HttpResponseError -from azure.messaging.webpubsubservice.chat import RoomPermissions, UserPermissions from azure.messaging.webpubsubservice.chat.aio import WebPubSubChatServiceClient -from azure.messaging.webpubsubservice.chat.models import ChatRole, ChatRoom, ChatRoomMember, HumanChatUser +from azure.messaging.webpubsubservice.chat.models import ( + ChatPermission, + ChatRole, + ChatRoom, + ChatRoomMember, + HumanChatUser, +) async def main(): @@ -28,8 +33,8 @@ async def main(): os.environ.get("WPS_CHAT_HUB", "test_hub"), ) try: - await client.create_or_replace_role(user_role, ChatRole(permissions=[UserPermissions.CREATE_ROOM])) - await client.create_or_replace_role(room_role, ChatRole(permissions=[RoomPermissions.PUBLISH_MESSAGE])) + await client.create_or_replace_role(user_role, ChatRole(permissions=[ChatPermission.USER_CREATE_ROOM])) + await client.create_or_replace_role(room_role, ChatRole(permissions=[ChatPermission.ROOM_PUBLISH_MESSAGE])) await client.create_or_replace_user( user_id, HumanChatUser(nickname="Async Sample User", role_name=user_role), diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/setup.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/setup.py index 73d270253061..6fd30d0495ac 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/setup.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/setup.py @@ -9,11 +9,11 @@ import os import re -from setuptools import setup, find_packages +from setuptools import setup, find_namespace_packages PACKAGE_NAME = "azure-messaging-webpubsubchatservice" -PACKAGE_PPRINT_NAME = "Azure Web PubSub Chat Service" +PACKAGE_PPRINT_NAME = "Azure Web PubSub Chat Service Client" PACKAGE_NAMESPACE = "azure.messaging.webpubsubservice.chat" # a.b.c => a/b/c @@ -51,7 +51,7 @@ "License :: OSI Approved :: MIT License", ], zip_safe=False, - packages=find_packages( + packages=find_namespace_packages( exclude=[ "tests", # Exclude packages that will be covered by PEP420 or nspkg @@ -67,7 +67,6 @@ install_requires=[ "isodate>=0.6.1", "azure-core>=1.37.0", - "azure-messaging-webpubsubservice>=1.3.0", "PyJWT>=2.6.0", "typing-extensions>=4.6.0", ], diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/test-resources.bicep b/sdk/webpubsub/azure-messaging-webpubsubchatservice/test-resources.bicep index 6ad5321c8159..c0a9b9d514a9 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/test-resources.bicep +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/test-resources.bicep @@ -125,4 +125,5 @@ resource ownerRoleAssignment 'Microsoft.Authorization/roleAssignments@2022-04-01 } output WPS_CHAT_ENDPOINT string = 'https://${webPubSub.properties.hostName}' -output WPS_CHAT_CONNECTION_STRING string = listKeys(webPubSub.id, webPubSubApiVersion).primaryConnectionString \ No newline at end of file +output WPS_CHAT_DISABLE_LOCAL_AUTH bool = supportsSafeSecretStandard +output WPS_CHAT_CONNECTION_STRING string = supportsSafeSecretStandard ? '' : listKeys(webPubSub.id, webPubSubApiVersion).primaryConnectionString \ No newline at end of file diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/chat_message_seed.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/chat_message_seed.py new file mode 100644 index 000000000000..c48e5b9af46b --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/chat_message_seed.py @@ -0,0 +1,117 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +import asyncio +import json +import time +import uuid + +from aiohttp import ClientSession, ClientTimeout, WSMsgType + + +_TIMEOUT = 30 +_SUBPROTOCOL = "json.webpubsub.azure.v1" + + +async def _receive_message(web_socket, predicate, description): + deadline = time.monotonic() + _TIMEOUT + while True: + remaining = deadline - time.monotonic() + if remaining <= 0: + raise TimeoutError(f"Timed out waiting for {description}.") + raw_message = await asyncio.wait_for(web_socket.receive(), remaining) + if raw_message.type == WSMsgType.ERROR: + raise RuntimeError(f"WebSocket failed while waiting for {description}.") from web_socket.exception() + if raw_message.type in ( + WSMsgType.CLOSE, + WSMsgType.CLOSED, + WSMsgType.CLOSING, + ): + raise RuntimeError(f"Connection closed while waiting for {description}.") + if raw_message.type != WSMsgType.TEXT: + continue + message = json.loads(raw_message.data) + if isinstance(message, dict) and predicate(message): + return message + + +async def _invoke(web_socket, event_name, data_type, data): + invocation_id = str(uuid.uuid4()) + await web_socket.send_str( + json.dumps( + { + "type": "invoke", + "invocationId": invocation_id, + "target": "event", + "event": event_name, + "dataType": data_type, + "data": data, + }, + separators=(",", ":"), + ) + ) + response = await _receive_message( + web_socket, + lambda message: message.get("type") == "invokeResponse" and message.get("invocationId") == invocation_id, + f"{event_name} invocation response", + ) + if not response.get("success"): + raise RuntimeError(f"{event_name} invocation failed: {response}") + return response.get("data") + + +async def _connect_and_login(client_access_url): + session = ClientSession(timeout=ClientTimeout(total=_TIMEOUT)) + web_socket = None + try: + web_socket = await session.ws_connect( + client_access_url, + protocols=(_SUBPROTOCOL,), + ) + await _receive_message( + web_socket, + lambda message: message.get("type") == "system" and message.get("event") == "connected", + "connected event", + ) + await _invoke(web_socket, "chat.login", "text", "") + return session, web_socket + except BaseException: + if web_socket is not None: + await web_socket.close() + await session.close() + raise + + +async def create_chat_message_async(client_access_url, conversation_id, content): + session, web_socket = await _connect_and_login(client_access_url) + try: + await _invoke( + web_socket, + "chat.sendTextMessage", + "json", + { + "conversation": {"conversationId": conversation_id}, + "content": content, + }, + ) + finally: + await web_socket.close() + await session.close() + + +def create_chat_message(client_access_url, conversation_id, content): + asyncio.run(create_chat_message_async(client_access_url, conversation_id, content)) + + +async def verify_chat_connection_async(client_access_url): + session, web_socket = await _connect_and_login(client_access_url) + try: + return + finally: + await web_socket.close() + await session.close() + + +def verify_chat_connection(client_access_url): + asyncio.run(verify_chat_connection_async(client_access_url)) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/conftest.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/conftest.py index 46ae08d235bc..5ce0745f5f8d 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/conftest.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/conftest.py @@ -2,15 +2,15 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. See License.txt in the project root for license information. # -------------------------------------------------------------------------- -import os -import re - import pytest from dotenv import load_dotenv -from devtools_testutils import add_general_regex_sanitizer, set_custom_default_matcher, test_proxy - +from devtools_testutils import ( + remove_batch_sanitizers, + set_custom_default_matcher, + test_proxy, +) -load_dotenv(os.path.join(os.path.dirname(__file__), ".env"), override=False) +load_dotenv(override=False) @pytest.fixture(scope="session", autouse=True) @@ -21,10 +21,4 @@ def start_proxy(test_proxy): @pytest.fixture(scope="session", autouse=True) def add_sanitizers(test_proxy): set_custom_default_matcher(ignore_query_ordering=True) - connection_string = os.environ.get("WPS_CHAT_CONNECTION_STRING", "") - access_key_match = re.search(r"(?:^|;)AccessKey=([^;]+)", connection_string, re.IGNORECASE) - if access_key_match: - add_general_regex_sanitizer( - regex=re.escape(access_key_match.group(1)), - value="Kg==", - ) + remove_batch_sanitizers(["AZSDK3430", "AZSDK3433", "AZSDK3442", "AZSDK3490", "AZSDK3493", "AZSDK4001"]) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_chat_message_seed.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_chat_message_seed.py new file mode 100644 index 000000000000..faa245947e56 --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_chat_message_seed.py @@ -0,0 +1,120 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +import json +from types import SimpleNamespace +import unittest +from unittest.mock import patch + +from aiohttp import WSMsgType + +from chat_message_seed import ( + create_chat_message_async, + verify_chat_connection_async, +) + + +class _FakeWebSocket: + def __init__(self, failing_event=None): + self.failing_event = failing_event + self.sent_messages = [] + self.closed = False + self._connected = False + + async def receive(self): + if not self._connected: + self._connected = True + data = {"type": "system", "event": "connected"} + else: + request = self.sent_messages[-1] + succeeded = request["event"] != self.failing_event + data = { + "type": "invokeResponse", + "invocationId": request["invocationId"], + "success": succeeded, + } + if not succeeded: + data["error"] = {"name": "Forbidden", "message": "Denied"} + return SimpleNamespace(type=WSMsgType.TEXT, data=json.dumps(data)) + + async def send_str(self, data): + self.sent_messages.append(json.loads(data)) + + async def close(self): + self.closed = True + + +class _FakeClientSession: + def __init__(self, web_socket): + self.web_socket = web_socket + self.closed = False + self.connection = None + + async def ws_connect(self, url, **kwargs): + self.connection = (url, kwargs) + return self.web_socket + + async def close(self): + self.closed = True + + +class ChatMessageSeedTest(unittest.IsolatedAsyncioTestCase): + async def test_verify_chat_connection_logs_in(self): + web_socket = _FakeWebSocket() + session = _FakeClientSession(web_socket) + + with patch("chat_message_seed.ClientSession", return_value=session): + await verify_chat_connection_async("wss://example.test/client") + + self.assertEqual( + session.connection, + ( + "wss://example.test/client", + {"protocols": ("json.webpubsub.azure.v1",)}, + ), + ) + self.assertEqual( + [message["event"] for message in web_socket.sent_messages], + ["chat.login"], + ) + self.assertTrue(web_socket.closed) + self.assertTrue(session.closed) + + async def test_create_chat_message_logs_in_then_sends_to_conversation(self): + web_socket = _FakeWebSocket() + session = _FakeClientSession(web_socket) + + with patch("chat_message_seed.ClientSession", return_value=session): + await create_chat_message_async("wss://example.test/client", "conversation-id", "hello") + + self.assertEqual( + [message["event"] for message in web_socket.sent_messages], + ["chat.login", "chat.sendTextMessage"], + ) + self.assertEqual(web_socket.sent_messages[0]["dataType"], "text") + self.assertEqual(web_socket.sent_messages[0]["data"], "") + self.assertEqual( + web_socket.sent_messages[1]["data"], + { + "conversation": {"conversationId": "conversation-id"}, + "content": "hello", + }, + ) + self.assertTrue(web_socket.closed) + self.assertTrue(session.closed) + + async def test_create_chat_message_surfaces_invocation_failure(self): + web_socket = _FakeWebSocket(failing_event="chat.sendTextMessage") + session = _FakeClientSession(web_socket) + + with patch("chat_message_seed.ClientSession", return_value=session): + with self.assertRaisesRegex(RuntimeError, "chat.sendTextMessage invocation failed"): + await create_chat_message_async("wss://example.test/client", "conversation-id", "hello") + + self.assertTrue(web_socket.closed) + self.assertTrue(session.closed) + + +if __name__ == "__main__": + unittest.main() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_client.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_client.py index de5845a54e99..0b69fdb0baf2 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_client.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_client.py @@ -3,7 +3,7 @@ # Licensed under the MIT License. See License.txt in the project root for license information. # -------------------------------------------------------------------------- import time -from unittest.mock import Mock +from unittest.mock import Mock, patch from urllib.parse import urlparse import jwt @@ -11,12 +11,10 @@ from azure.core.credentials import AccessToken, AzureKeyCredential from azure.messaging.webpubsubservice.chat import ( - ChatRoles, - RoomPermissions, - UserPermissions, + BuiltInChatRoles, WebPubSubChatServiceClient, ) - +from azure.messaging.webpubsubservice.chat.models import ChatPermission ACCESS_KEY = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGH" ENDPOINT = "https://example.webpubsub.azure.com" @@ -66,6 +64,19 @@ def test_connection_string_validation(connection_string): WebPubSubChatServiceClient.from_connection_string(connection_string, HUB) +def test_malformed_connection_string_does_not_expose_input(): + connection_string = ( + f"Endpoint={ENDPOINT};AccessKey={ACCESS_KEY};malformed-secret-segment" + ) + + with pytest.raises(ValueError) as error: + WebPubSubChatServiceClient.from_connection_string(connection_string, HUB) + + assert str(error.value) == "Malformed connection string - expected 'key=value'" + assert ACCESS_KEY not in str(error.value) + assert "malformed-secret-segment" not in str(error.value) + + def test_connection_string_parses_endpoint_access_key_and_port(): client = WebPubSubChatServiceClient.from_connection_string( f"Endpoint={ENDPOINT};AccessKey={ACCESS_KEY};Port=8443;Version=1.0;", @@ -74,7 +85,6 @@ def test_connection_string_parses_endpoint_access_key_and_port(): try: assert client._config.endpoint == f"{ENDPOINT}:8443" assert client._config.credential.key == ACCESS_KEY - assert client._web_pub_sub_service_client._config.endpoint == f"{ENDPOINT}:8443" finally: client.close() @@ -84,7 +94,9 @@ def test_key_credential_request_uses_full_uri_audience_and_sixty_second_token(): try: request = _capture_list_roles_request(client) token = request.headers["Authorization"].removeprefix("Bearer ") - claims = jwt.decode(token, ACCESS_KEY, algorithms=["HS256"], audience=request.url) + claims = jwt.decode( + token, ACCESS_KEY, algorithms=["HS256"], audience=request.url + ) assert claims["aud"] == request.url assert "api-version=2026-02-01-preview" in request.url @@ -106,8 +118,12 @@ def test_updating_key_credential_changes_subsequent_request_tokens(): second_token = second_request.headers["Authorization"].removeprefix("Bearer ") assert first_token != second_token - jwt.decode(first_token, ACCESS_KEY, algorithms=["HS256"], audience=first_request.url) - jwt.decode(second_token, updated_key, algorithms=["HS256"], audience=second_request.url) + jwt.decode( + first_token, ACCESS_KEY, algorithms=["HS256"], audience=first_request.url + ) + jwt.decode( + second_token, updated_key, algorithms=["HS256"], audience=second_request.url + ) finally: client.close() @@ -124,7 +140,9 @@ def test_reverse_proxy_preserves_path_query_and_original_key_audience(): request = _capture_list_roles_request(client) token = request.headers["Authorization"].removeprefix("Bearer ") original_url = request.url.replace(proxy_endpoint, ENDPOINT, 1) - claims = jwt.decode(token, ACCESS_KEY, algorithms=["HS256"], audience=original_url) + claims = jwt.decode( + token, ACCESS_KEY, algorithms=["HS256"], audience=original_url + ) assert urlparse(request.url).netloc == "proxy.contoso.com" assert urlparse(request.url).path == urlparse(original_url).path @@ -149,80 +167,67 @@ def test_reverse_proxy_with_entra_credential_keeps_bearer_token(): client.close() -def test_client_access_token_delegates_fixed_chat_requirements(): - client = WebPubSubChatServiceClient(ENDPOINT, HUB, AzureKeyCredential(ACCESS_KEY)) - expected = {"baseUrl": "wss://example", "token": "token", "url": "wss://example?access_token=token"} - client._web_pub_sub_service_client.get_client_access_token = Mock(return_value=expected) - try: - result = client.get_client_access_token(user_id="alice") - assert result is expected - client._web_pub_sub_service_client.get_client_access_token.assert_called_once_with( - user_id="alice", - roles=CHAT_ROLES, - minutes_to_expire=60, - groups=[], - client_protocol="Default", - ) - finally: - client.close() - - -def test_entra_client_access_delegation_propagates_reverse_proxy(): - credential = FakeTokenCredential() - proxy_endpoint = "https://proxy.contoso.com" - client = WebPubSubChatServiceClient( - ENDPOINT, - HUB, - credential, - reverse_proxy_endpoint=proxy_endpoint, - ) - expected = {"baseUrl": "wss://example", "token": "token", "url": "wss://example?access_token=token"} - client._web_pub_sub_service_client.get_client_access_token = Mock(return_value=expected) +def test_token_credential_client_access_token_uses_generated_operation(): + client = WebPubSubChatServiceClient(ENDPOINT, HUB, FakeTokenCredential()) try: - inner = client._web_pub_sub_service_client - assert inner._config.credential is credential - assert inner._config.proxy_policy._endpoint == ENDPOINT - assert inner._config.proxy_policy._reverse_proxy_endpoint == proxy_endpoint - assert client.get_client_access_token(user_id="alice") is expected - inner.get_client_access_token.assert_called_once_with( - user_id="alice", - roles=CHAT_ROLES, - minutes_to_expire=60, - groups=[], - client_protocol="Default", + with patch.object( + client, "_generate_client_token", return_value=Mock(token="token") + ) as generate: + result = client.get_client_access_token(user_id="alice") + + base_url = f"wss://example.webpubsub.azure.com/client/hubs/{HUB}" + assert result == { + "baseUrl": base_url, + "token": "token", + "url": f"{base_url}?access_token=token", + } + generate.assert_called_once_with( + user_id="alice", role=CHAT_ROLES, minutes_to_expire=60 ) finally: client.close() -def test_key_client_access_token_returns_wss_url_and_required_roles(): +def test_key_client_access_token_is_generated_locally(): client = WebPubSubChatServiceClient(ENDPOINT, HUB, AzureKeyCredential(ACCESS_KEY)) try: - result = client.get_client_access_token(user_id="alice") + with patch.object(client, "_generate_client_token") as generate: + result = client.get_client_access_token(user_id="alice") + + generate.assert_not_called() + base_url = f"wss://example.webpubsub.azure.com/client/hubs/{HUB}" + assert result["baseUrl"] == base_url + assert result["url"] == f"{base_url}?access_token={result['token']}" claims = jwt.decode( result["token"], ACCESS_KEY, algorithms=["HS256"], audience=result["baseUrl"].replace("wss://", "https://"), ) - - assert result["baseUrl"].startswith("wss://") - assert result["url"] == f'{result["baseUrl"]}?access_token={result["token"]}' assert claims["sub"] == "alice" assert claims["role"] == CHAT_ROLES - assert "webpubsub.group" not in claims assert 3595 <= claims["exp"] - claims["iat"] <= 3605 finally: client.close() -def test_role_and_permission_constants(): - assert ChatRoles.USER_NORMAL == "user.normal" - assert ChatRoles.ROOM_MEMBER == "room.member" - assert ChatRoles.ROOM_OPERATOR == "room.operator" - assert UserPermissions.CREATE_ROOM == "user.create_room" - assert UserPermissions.FETCH_ALL_ROOMS == "user.fetch_all_rooms" - assert RoomPermissions.INVITE_USER == "room.invite" - assert RoomPermissions.REMOVE_USER == "room.remove_user" - assert RoomPermissions.READ_HISTORY == "room.history" - assert RoomPermissions.PUBLISH_MESSAGE == "room.publish_message" +@pytest.mark.parametrize("minutes_to_expire", [0, -1]) +def test_key_client_access_token_rejects_invalid_expiration(minutes_to_expire): + client = WebPubSubChatServiceClient(ENDPOINT, HUB, AzureKeyCredential(ACCESS_KEY)) + try: + with pytest.raises(ValueError, match="minutes_to_expire must be at least 1"): + client.get_client_access_token(minutes_to_expire=minutes_to_expire) + finally: + client.close() + + +def test_builtin_roles_and_generated_permissions(): + assert BuiltInChatRoles.USER_NORMAL == "user.normal" + assert BuiltInChatRoles.ROOM_MEMBER == "room.member" + assert BuiltInChatRoles.ROOM_OPERATOR == "room.operator" + assert ChatPermission.USER_CREATE_ROOM == "user.create_room" + assert ChatPermission.USER_FETCH_ALL_ROOMS == "user.fetch_all_rooms" + assert ChatPermission.ROOM_INVITE == "room.invite" + assert ChatPermission.ROOM_REMOVE_USER == "room.remove_user" + assert ChatPermission.ROOM_HISTORY == "room.history" + assert ChatPermission.ROOM_PUBLISH_MESSAGE == "room.publish_message" diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_client_async.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_client_async.py index 3ed14730e195..e482ad9cb899 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_client_async.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_client_async.py @@ -3,7 +3,7 @@ # Licensed under the MIT License. See License.txt in the project root for license information. # -------------------------------------------------------------------------- import time -from unittest.mock import AsyncMock +from unittest.mock import AsyncMock, Mock, patch from urllib.parse import urlparse import jwt @@ -12,7 +12,6 @@ from azure.messaging.webpubsubservice.chat.aio import WebPubSubChatServiceClient - ACCESS_KEY = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGH" ENDPOINT = "https://example.webpubsub.azure.com" HUB = "chat" @@ -50,7 +49,9 @@ async def test_async_connection_string_and_key_request_match_sync_behavior(): try: request = await _capture_list_roles_request(client) token = request.headers["Authorization"].removeprefix("Bearer ") - claims = jwt.decode(token, ACCESS_KEY, algorithms=["HS256"], audience=request.url) + claims = jwt.decode( + token, ACCESS_KEY, algorithms=["HS256"], audience=request.url + ) assert client._config.endpoint == f"{ENDPOINT}:8443" assert claims["aud"] == request.url @@ -72,7 +73,9 @@ async def test_async_reverse_proxy_with_key_uses_original_audience(): request = await _capture_list_roles_request(client) original_url = request.url.replace(proxy_endpoint, ENDPOINT, 1) token = request.headers["Authorization"].removeprefix("Bearer ") - claims = jwt.decode(token, ACCESS_KEY, algorithms=["HS256"], audience=original_url) + claims = jwt.decode( + token, ACCESS_KEY, algorithms=["HS256"], audience=original_url + ) assert urlparse(request.url).netloc == "proxy.contoso.com" assert claims["aud"] == original_url @@ -97,48 +100,49 @@ async def test_async_reverse_proxy_with_entra_credential_keeps_bearer_token(): @pytest.mark.asyncio -async def test_async_client_access_token_delegates_fixed_chat_requirements(): - client = WebPubSubChatServiceClient(ENDPOINT, HUB, AzureKeyCredential(ACCESS_KEY)) - expected = {"baseUrl": "wss://example", "token": "token", "url": "wss://example?access_token=token"} - client._web_pub_sub_service_client.get_client_access_token = AsyncMock(return_value=expected) +async def test_async_token_credential_client_access_token_uses_generated_operation(): + client = WebPubSubChatServiceClient(ENDPOINT, HUB, FakeAsyncTokenCredential()) try: - result = await client.get_client_access_token(user_id="alice") - assert result is expected - client._web_pub_sub_service_client.get_client_access_token.assert_awaited_once_with( - user_id="alice", - roles=CHAT_ROLES, - minutes_to_expire=60, - groups=[], - client_protocol="Default", + with patch.object( + client, "_generate_client_token", new_callable=AsyncMock + ) as generate: + generate.return_value = Mock(token="token") + result = await client.get_client_access_token(user_id="alice") + + base_url = f"wss://example.webpubsub.azure.com/client/hubs/{HUB}" + assert result == { + "baseUrl": base_url, + "token": "token", + "url": f"{base_url}?access_token=token", + } + generate.assert_awaited_once_with( + user_id="alice", role=CHAT_ROLES, minutes_to_expire=60 ) finally: await client.close() @pytest.mark.asyncio -async def test_async_entra_client_access_delegation_propagates_reverse_proxy(): - credential = FakeAsyncTokenCredential() - proxy_endpoint = "https://proxy.contoso.com" - client = WebPubSubChatServiceClient( - ENDPOINT, - HUB, - credential, - reverse_proxy_endpoint=proxy_endpoint, - ) - expected = {"baseUrl": "wss://example", "token": "token", "url": "wss://example?access_token=token"} - client._web_pub_sub_service_client.get_client_access_token = AsyncMock(return_value=expected) +async def test_async_key_client_access_token_is_generated_locally(): + client = WebPubSubChatServiceClient(ENDPOINT, HUB, AzureKeyCredential(ACCESS_KEY)) try: - inner = client._web_pub_sub_service_client - assert inner._config.credential is credential - assert inner._config.proxy_policy._endpoint == ENDPOINT - assert inner._config.proxy_policy._reverse_proxy_endpoint == proxy_endpoint - assert await client.get_client_access_token(user_id="alice") is expected - inner.get_client_access_token.assert_awaited_once_with( - user_id="alice", - roles=CHAT_ROLES, - minutes_to_expire=60, - groups=[], - client_protocol="Default", + with patch.object( + client, "_generate_client_token", new_callable=AsyncMock + ) as generate: + result = await client.get_client_access_token(user_id="alice") + + generate.assert_not_awaited() + base_url = f"wss://example.webpubsub.azure.com/client/hubs/{HUB}" + assert result["baseUrl"] == base_url + assert result["url"] == f"{base_url}?access_token={result['token']}" + claims = jwt.decode( + result["token"], + ACCESS_KEY, + algorithms=["HS256"], + audience=result["baseUrl"].replace("wss://", "https://"), ) + assert claims["sub"] == "alice" + assert claims["role"] == CHAT_ROLES + assert 3595 <= claims["exp"] - claims["iat"] <= 3605 finally: await client.close() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live.py index a71b41713ada..f8f7ec9ec521 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live.py @@ -2,45 +2,154 @@ # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. See License.txt in the project root for license information. # -------------------------------------------------------------------------- +import pytest from devtools_testutils import recorded_by_proxy -from azure.messaging.webpubsubservice.chat import RoomPermissions, UserPermissions -from azure.messaging.webpubsubservice.chat.models import ChatRole, ChatRoom, ChatRoomMember, HumanChatUser +from azure.core import MatchConditions +from azure.core.exceptions import HttpResponseError +from azure.messaging.webpubsubservice.chat.models import ( + ChatMessage, + ChatPermission, + ChatRole, + ChatRoom, + ChatRoomMember, + HumanChatUser, + MessageContent, +) -from testcase import WebPubSubChatPreparer, WebPubSubChatTest +from testcase import ( + WebPubSubChatAccessPreparer, + WebPubSubChatPreparer, + WebPubSubChatTest, +) class TestWebPubSubChatLive(WebPubSubChatTest): @WebPubSubChatPreparer() @recorded_by_proxy - def test_role_lifecycle_and_paging(self, wps_chat_connection_string): - client = self.create_client(wps_chat_connection_string) + def test_role_lifecycle_and_paging(self, wps_chat_endpoint): + client = self.create_client(wps_chat_endpoint) role_names = ["user.python_e2e_role_1", "user.python_e2e_role_2"] try: for role_name in role_names: role = client.create_or_replace_role( role_name, - ChatRole(permissions=[UserPermissions.CREATE_ROOM]), + ChatRole(permissions=[ChatPermission.USER_CREATE_ROOM]), ) assert role.name == role_name - assert client.get_role(role_name).permissions == [UserPermissions.CREATE_ROOM] + assert client.get_role(role_name).permissions == [ + ChatPermission.USER_CREATE_ROOM + ] listed = list(client.list_roles(maxpagesize=1)) assert {role.name for role in listed}.issuperset(role_names) + + page_iterator = client.list_roles(maxpagesize=1).by_page() + first_page = list(next(page_iterator)) + assert len(first_page) == 1 + assert page_iterator.continuation_token + + resumed_page_iterator = client.list_roles(maxpagesize=1).by_page( + page_iterator.continuation_token + ) + second_page = list(next(resumed_page_iterator)) + assert len(second_page) == 1 + assert second_page[0].name != first_page[0].name finally: for role_name in role_names: self.cleanup(client.delete_role, role_name) client.close() + @WebPubSubChatAccessPreparer() + @recorded_by_proxy + def test_list_roles_using_connection_string( + self, + wps_chat_endpoint, + wps_chat_connection_string, + wps_chat_disable_local_auth, + ): + if wps_chat_disable_local_auth.lower() == "true": + pytest.skip("Local authentication is disabled") + + client = self.create_key_client(wps_chat_connection_string) + try: + roles = list(client.list_roles()) + assert all(role.name for role in roles) + finally: + client.close() + @WebPubSubChatPreparer() @recorded_by_proxy - def test_room_conversation_and_empty_pages(self, wps_chat_connection_string): - client = self.create_client(wps_chat_connection_string) + def test_create_role_only_when_missing(self, wps_chat_endpoint): + client = self.create_client(wps_chat_endpoint) + role_name = "user.python_create_only_role" + try: + created = client.create_or_replace_role( + role_name, + ChatRole(permissions=[ChatPermission.USER_CREATE_ROOM]), + match_condition=MatchConditions.IfMissing, + ) + assert created.name == role_name + + with pytest.raises(HttpResponseError) as error: + client.create_or_replace_role( + role_name, + ChatRole(permissions=[ChatPermission.USER_FETCH_ALL_ROOMS]), + match_condition=MatchConditions.IfMissing, + ) + assert error.value.status_code == 412 + finally: + self.cleanup(client.delete_role, role_name) + client.close() + + @WebPubSubChatPreparer() + @recorded_by_proxy + def test_rejects_stale_role_etag(self, wps_chat_endpoint): + client = self.create_client(wps_chat_endpoint) + role_name = "user.python_etag_role" + try: + created = client.create_or_replace_role( + role_name, + ChatRole(permissions=[ChatPermission.USER_CREATE_ROOM]), + ) + replaced = client.create_or_replace_role( + role_name, + ChatRole( + permissions=[ + ChatPermission.USER_CREATE_ROOM, + ChatPermission.USER_FETCH_ALL_ROOMS, + ] + ), + etag=created.etag, + match_condition=MatchConditions.IfNotModified, + ) + assert replaced.etag != created.etag + + with pytest.raises(HttpResponseError) as error: + client.create_or_replace_role( + role_name, + ChatRole(permissions=[ChatPermission.USER_CREATE_ROOM]), + etag=created.etag, + match_condition=MatchConditions.IfNotModified, + ) + assert error.value.status_code == 412 + finally: + self.cleanup(client.delete_role, role_name) + client.close() + + @WebPubSubChatPreparer() + @recorded_by_proxy + def test_room_conversation_and_empty_pages(self, wps_chat_endpoint): + client = self.create_client(wps_chat_endpoint) room_id = "python-e2e-empty-room" try: - room = client.create_or_replace_room(room_id, ChatRoom(title="Python E2E Room")) + room = client.create_or_replace_room( + room_id, ChatRoom(title="Python E2E Room") + ) assert room.id == room_id - assert client.get_room(room_id).title == "Python E2E Room" + fetched_room = client.get_room(room_id) + assert fetched_room.id == room_id + assert fetched_room.title == "Python E2E Room" conversation = client.get_conversation(room.default_conversation) assert conversation.id == room.default_conversation @@ -53,21 +162,28 @@ def test_room_conversation_and_empty_pages(self, wps_chat_connection_string): @WebPubSubChatPreparer() @recorded_by_proxy - def test_user_and_room_member_lifecycle(self, wps_chat_connection_string): - client = self.create_client(wps_chat_connection_string) + def test_user_and_room_member_lifecycle(self, wps_chat_endpoint): + client = self.create_client(wps_chat_endpoint) user_role = "user.python_e2e_member" room_role = "room.python_e2e_member" user_id = "python-e2e-user" room_id = "python-e2e-member-room" try: - client.create_or_replace_role(user_role, ChatRole(permissions=[UserPermissions.CREATE_ROOM])) - client.create_or_replace_role(room_role, ChatRole(permissions=[RoomPermissions.PUBLISH_MESSAGE])) + client.create_or_replace_role( + user_role, ChatRole(permissions=[ChatPermission.USER_CREATE_ROOM]) + ) + client.create_or_replace_role( + room_role, ChatRole(permissions=[ChatPermission.ROOM_PUBLISH_MESSAGE]) + ) user = client.create_or_replace_user( user_id, HumanChatUser(nickname="Python User", role_name=user_role), ) assert user.id == user_id - assert client.get_user(user_id).nickname == "Python User" + assert user.kind == "Human" + fetched_user = client.get_user(user_id) + assert fetched_user.id == user_id + assert fetched_user.nickname == "Python User" client.create_or_replace_room(room_id, ChatRoom(title="Member Room")) member = client.create_or_replace_room_member( @@ -76,7 +192,11 @@ def test_user_and_room_member_lifecycle(self, wps_chat_connection_string): ChatRoomMember(role_name=room_role), ) assert member.user_id == user_id - assert any(item.user_id == user_id for item in client.list_room_members(room_id)) + assert member.role_name == room_role + assert any( + item.user_id == user_id and item.role_name == room_role + for item in client.list_room_members(room_id) + ) client.delete_room_member(room_id, user_id) finally: self.cleanup(client.delete_room, room_id) @@ -87,11 +207,99 @@ def test_user_and_room_member_lifecycle(self, wps_chat_connection_string): @WebPubSubChatPreparer() @recorded_by_proxy - def test_client_access_token(self, wps_chat_connection_string): - client = self.create_client(wps_chat_connection_string) + def test_message_lifecycle(self, wps_chat_endpoint): + client = self.create_client(wps_chat_endpoint) + user_role = "user.python_e2e_message" + room_role = "room.python_e2e_message" + user_id = "python-e2e-message-user" + room_id = "python-e2e-message-room" + message_text = "Python E2E original message" + updated_text = "Python E2E updated message" + binary_content = bytes([0, 1, 2, 254, 255]) try: - result = client.get_client_access_token(user_id="python-e2e-access-user") - assert result["baseUrl"].startswith("wss://") - assert "access_token=" in result["url"] + client.create_or_replace_role( + user_role, ChatRole(permissions=[ChatPermission.USER_CREATE_ROOM]) + ) + client.create_or_replace_role( + room_role, + ChatRole( + permissions=[ + ChatPermission.ROOM_PUBLISH_MESSAGE, + ChatPermission.ROOM_HISTORY, + ] + ), + ) + client.create_or_replace_user( + user_id, + HumanChatUser(nickname="Python Message User", role_name=user_role), + ) + room = client.create_or_replace_room( + room_id, ChatRoom(title="Python Message Room") + ) + client.create_or_replace_room_member( + room_id, user_id, ChatRoomMember(role_name=room_role) + ) + + self.seed_chat_message( + client, user_id, room.default_conversation, message_text + ) + message = next( + item + for item in client.list_messages(room.default_conversation) + if item.created_by == user_id and item.content.text == message_text + ) + updated = client.update_message( + room.default_conversation, + message.id, + ChatMessage( + created_by=user_id, content=MessageContent(text=updated_text) + ), + ) + assert updated.content.text == updated_text + binary_updated = client.update_message( + room.default_conversation, + message.id, + ChatMessage( + created_by=user_id, + content=MessageContent(binary=binary_content), + ), + ) + assert binary_updated.content.binary == binary_content + client.delete_message(room.default_conversation, message.id) + assert all( + item.id != message.id + for item in client.list_messages(room.default_conversation) + ) finally: + self.cleanup(client.delete_room, room_id) + self.cleanup(client.delete_user, user_id) + self.cleanup(client.delete_role, user_role) + self.cleanup(client.delete_role, room_role) client.close() + + @WebPubSubChatAccessPreparer() + @recorded_by_proxy + def test_client_access_token( + self, + wps_chat_endpoint, + wps_chat_connection_string, + wps_chat_disable_local_auth, + ): + token_client = self.create_client(wps_chat_endpoint) + key_client = None + try: + token_access = token_client.get_client_access_token( + user_id="python-e2e-token-access-user" + ) + self.assert_client_access(token_access, wps_chat_endpoint) + + if wps_chat_disable_local_auth.lower() != "true": + key_client = self.create_key_client(wps_chat_connection_string) + key_access = key_client.get_client_access_token( + user_id="python-e2e-key-access-user" + ) + self.assert_client_access(key_access, wps_chat_endpoint) + finally: + token_client.close() + if key_client: + key_client.close() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live_async.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live_async.py index 3f72609ebc88..cdf086cd4117 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live_async.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live_async.py @@ -3,12 +3,25 @@ # Licensed under the MIT License. See License.txt in the project root for license information. # -------------------------------------------------------------------------- import pytest -from devtools_testutils import recorded_by_proxy +from devtools_testutils.aio import recorded_by_proxy_async -from azure.messaging.webpubsubservice.chat import RoomPermissions, UserPermissions -from azure.messaging.webpubsubservice.chat.models import ChatRole, ChatRoom, ChatRoomMember, HumanChatUser +from azure.core import MatchConditions +from azure.core.exceptions import HttpResponseError +from azure.messaging.webpubsubservice.chat.models import ( + ChatMessage, + ChatPermission, + ChatRole, + ChatRoom, + ChatRoomMember, + HumanChatUser, + MessageContent, +) -from testcase import WebPubSubChatPreparer, WebPubSubChatTest +from testcase import ( + WebPubSubChatAccessPreparer, + WebPubSubChatPreparer, + WebPubSubChatTest, +) async def _collect(paged): @@ -17,44 +30,291 @@ async def _collect(paged): class TestWebPubSubChatLiveAsync(WebPubSubChatTest): @WebPubSubChatPreparer() - @recorded_by_proxy + @recorded_by_proxy_async @pytest.mark.asyncio - async def test_async_resource_lifecycle(self, wps_chat_connection_string): - client = self.create_async_client(wps_chat_connection_string) - user_role = "user.python_async_e2e" - room_role = "room.python_async_e2e" + async def test_async_role_lifecycle_and_paging(self, wps_chat_endpoint): + client = self.create_async_client(wps_chat_endpoint) + role_names = ["user.python_async_e2e_role_1", "user.python_async_e2e_role_2"] + try: + for role_name in role_names: + role = await client.create_or_replace_role( + role_name, + ChatRole(permissions=[ChatPermission.USER_CREATE_ROOM]), + ) + assert role.name == role_name + assert (await client.get_role(role_name)).permissions == [ + ChatPermission.USER_CREATE_ROOM + ] + + listed = await _collect(client.list_roles(maxpagesize=1)) + assert {role.name for role in listed}.issuperset(role_names) + + page_iterator = client.list_roles(maxpagesize=1).by_page() + first_page = await _collect(await anext(page_iterator)) + assert len(first_page) == 1 + assert page_iterator.continuation_token + + resumed_page_iterator = client.list_roles(maxpagesize=1).by_page( + page_iterator.continuation_token + ) + second_page = await _collect(await anext(resumed_page_iterator)) + assert len(second_page) == 1 + assert second_page[0].name != first_page[0].name + finally: + for role_name in role_names: + await self.cleanup_async(client.delete_role, role_name) + await client.close() + + @WebPubSubChatAccessPreparer() + @recorded_by_proxy_async + @pytest.mark.asyncio + async def test_async_list_roles_using_connection_string( + self, + wps_chat_endpoint, + wps_chat_connection_string, + wps_chat_disable_local_auth, + ): + if wps_chat_disable_local_auth.lower() == "true": + pytest.skip("Local authentication is disabled") + + client = self.create_async_key_client(wps_chat_connection_string) + try: + roles = await _collect(client.list_roles()) + assert all(role.name for role in roles) + finally: + await client.close() + + @WebPubSubChatPreparer() + @recorded_by_proxy_async + @pytest.mark.asyncio + async def test_async_create_role_only_when_missing(self, wps_chat_endpoint): + client = self.create_async_client(wps_chat_endpoint) + role_name = "user.python_async_create_only_role" + try: + created = await client.create_or_replace_role( + role_name, + ChatRole(permissions=[ChatPermission.USER_CREATE_ROOM]), + match_condition=MatchConditions.IfMissing, + ) + assert created.name == role_name + + with pytest.raises(HttpResponseError) as error: + await client.create_or_replace_role( + role_name, + ChatRole(permissions=[ChatPermission.USER_FETCH_ALL_ROOMS]), + match_condition=MatchConditions.IfMissing, + ) + assert error.value.status_code == 412 + finally: + await self.cleanup_async(client.delete_role, role_name) + await client.close() + + @WebPubSubChatPreparer() + @recorded_by_proxy_async + @pytest.mark.asyncio + async def test_async_rejects_stale_role_etag(self, wps_chat_endpoint): + client = self.create_async_client(wps_chat_endpoint) + role_name = "user.python_async_etag_role" + try: + created = await client.create_or_replace_role( + role_name, + ChatRole(permissions=[ChatPermission.USER_CREATE_ROOM]), + ) + replaced = await client.create_or_replace_role( + role_name, + ChatRole( + permissions=[ + ChatPermission.USER_CREATE_ROOM, + ChatPermission.USER_FETCH_ALL_ROOMS, + ] + ), + etag=created.etag, + match_condition=MatchConditions.IfNotModified, + ) + assert replaced.etag != created.etag + + with pytest.raises(HttpResponseError) as error: + await client.create_or_replace_role( + role_name, + ChatRole(permissions=[ChatPermission.USER_CREATE_ROOM]), + etag=created.etag, + match_condition=MatchConditions.IfNotModified, + ) + assert error.value.status_code == 412 + finally: + await self.cleanup_async(client.delete_role, role_name) + await client.close() + + @WebPubSubChatPreparer() + @recorded_by_proxy_async + @pytest.mark.asyncio + async def test_async_room_conversation_and_empty_pages(self, wps_chat_endpoint): + client = self.create_async_client(wps_chat_endpoint) + room_id = "python-async-e2e-empty-room" + try: + room = await client.create_or_replace_room( + room_id, ChatRoom(title="Async Python E2E Room") + ) + assert room.id == room_id + fetched_room = await client.get_room(room_id) + assert fetched_room.id == room_id + assert fetched_room.title == "Async Python E2E Room" + + conversation = await client.get_conversation(room.default_conversation) + assert conversation.id == room.default_conversation + assert conversation.parent_room == room_id + assert await _collect(client.list_messages(room.default_conversation)) == [] + assert await _collect(client.list_room_members(room_id)) == [] + finally: + await self.cleanup_async(client.delete_room, room_id) + await client.close() + + @WebPubSubChatPreparer() + @recorded_by_proxy_async + @pytest.mark.asyncio + async def test_async_user_and_room_member_lifecycle(self, wps_chat_endpoint): + client = self.create_async_client(wps_chat_endpoint) + user_role = "user.python_async_e2e_member" + room_role = "room.python_async_e2e_member" user_id = "python-async-e2e-user" - room_id = "python-async-e2e-room" + room_id = "python-async-e2e-member-room" try: - await client.create_or_replace_role(user_role, ChatRole(permissions=[UserPermissions.CREATE_ROOM])) - await client.create_or_replace_role(room_role, ChatRole(permissions=[RoomPermissions.PUBLISH_MESSAGE])) - assert (await client.get_role(user_role)).name == user_role - assert any(role.name == user_role for role in await _collect(client.list_roles(maxpagesize=1))) + await client.create_or_replace_role( + user_role, ChatRole(permissions=[ChatPermission.USER_CREATE_ROOM]) + ) + await client.create_or_replace_role( + room_role, ChatRole(permissions=[ChatPermission.ROOM_PUBLISH_MESSAGE]) + ) user = await client.create_or_replace_user( user_id, HumanChatUser(nickname="Async Python User", role_name=user_role), ) assert user.id == user_id - room = await client.create_or_replace_room(room_id, ChatRoom(title="Async Room")) + assert user.kind == "Human" + fetched_user = await client.get_user(user_id) + assert fetched_user.id == user_id + assert fetched_user.nickname == "Async Python User" + await client.create_or_replace_room( + room_id, ChatRoom(title="Async Member Room") + ) member = await client.create_or_replace_room_member( room_id, user_id, ChatRoomMember(role_name=room_role), ) assert member.user_id == user_id - assert any(item.user_id == user_id for item in await _collect(client.list_room_members(room_id))) + assert member.role_name == room_role + assert any( + item.user_id == user_id and item.role_name == room_role + for item in await _collect(client.list_room_members(room_id)) + ) + await client.delete_room_member(room_id, user_id) + finally: + await self.cleanup_async(client.delete_room, room_id) + await self.cleanup_async(client.delete_user, user_id) + await self.cleanup_async(client.delete_role, user_role) + await self.cleanup_async(client.delete_role, room_role) + await client.close() - conversation = await client.get_conversation(room.default_conversation) - assert conversation.parent_room == room_id - assert await _collect(client.list_messages(room.default_conversation)) == [] + @WebPubSubChatPreparer() + @recorded_by_proxy_async + @pytest.mark.asyncio + async def test_async_message_lifecycle(self, wps_chat_endpoint): + client = self.create_async_client(wps_chat_endpoint) + user_role = "user.python_async_message" + room_role = "room.python_async_message" + user_id = "python-async-message-user" + room_id = "python-async-message-room" + message_text = "Python async E2E original message" + updated_text = "Python async E2E updated message" + binary_content = bytes([0, 1, 2, 254, 255]) + try: + await client.create_or_replace_role( + user_role, ChatRole(permissions=[ChatPermission.USER_CREATE_ROOM]) + ) + await client.create_or_replace_role( + room_role, + ChatRole( + permissions=[ + ChatPermission.ROOM_PUBLISH_MESSAGE, + ChatPermission.ROOM_HISTORY, + ] + ), + ) + await client.create_or_replace_user( + user_id, + HumanChatUser(nickname="Async Message User", role_name=user_role), + ) + room = await client.create_or_replace_room( + room_id, ChatRoom(title="Async Message Room") + ) + await client.create_or_replace_room_member( + room_id, user_id, ChatRoomMember(role_name=room_role) + ) - access = await client.get_client_access_token(user_id=user_id) - assert access["baseUrl"].startswith("wss://") - await client.delete_room_member(room_id, user_id) + await self.seed_chat_message_async(client, user_id, room.default_conversation, message_text) + messages = await _collect(client.list_messages(room.default_conversation)) + message = next( + item + for item in messages + if item.created_by == user_id and item.content.text == message_text + ) + updated = await client.update_message( + room.default_conversation, + message.id, + ChatMessage( + created_by=user_id, content=MessageContent(text=updated_text) + ), + ) + assert updated.content.text == updated_text + binary_updated = await client.update_message( + room.default_conversation, + message.id, + ChatMessage( + created_by=user_id, + content=MessageContent(binary=binary_content), + ), + ) + assert binary_updated.content.binary == binary_content + await client.delete_message(room.default_conversation, message.id) + assert all( + item.id != message.id + for item in await _collect( + client.list_messages(room.default_conversation) + ) + ) finally: await self.cleanup_async(client.delete_room, room_id) await self.cleanup_async(client.delete_user, user_id) await self.cleanup_async(client.delete_role, user_role) await self.cleanup_async(client.delete_role, room_role) await client.close() + + @WebPubSubChatAccessPreparer() + @recorded_by_proxy_async + @pytest.mark.asyncio + async def test_async_client_access_token( + self, + wps_chat_endpoint, + wps_chat_connection_string, + wps_chat_disable_local_auth, + ): + if wps_chat_disable_local_auth.lower() == "true": + pytest.skip("Local authentication is disabled") + + token_client = self.create_async_client(wps_chat_endpoint) + key_client = self.create_async_key_client(wps_chat_connection_string) + try: + token_access = await token_client.get_client_access_token( + user_id="python-async-e2e-token-access-user" + ) + await self.assert_client_access_async(token_access, wps_chat_endpoint) + + key_access = await key_client.get_client_access_token( + user_id="python-async-e2e-key-access-user" + ) + await self.assert_client_access_async(key_access, wps_chat_endpoint) + finally: + await token_client.close() + await key_client.close() diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/testcase.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/testcase.py index d6d61852d3a7..f9550c9015d2 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/testcase.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/testcase.py @@ -9,15 +9,68 @@ from devtools_testutils import AzureRecordedTestCase, PowerShellPreparer from azure.messaging.webpubsubservice.chat import WebPubSubChatServiceClient -from azure.messaging.webpubsubservice.chat.aio import WebPubSubChatServiceClient as AsyncWebPubSubChatServiceClient +from azure.messaging.webpubsubservice.chat.aio import ( + WebPubSubChatServiceClient as AsyncWebPubSubChatServiceClient, +) + +from chat_message_seed import ( + create_chat_message, + create_chat_message_async, + verify_chat_connection, + verify_chat_connection_async, +) class WebPubSubChatTest(AzureRecordedTestCase): - def create_client(self, connection_string): - return WebPubSubChatServiceClient.from_connection_string(connection_string, "test_hub") + def create_client(self, endpoint): + return WebPubSubChatServiceClient( + endpoint, + "test_hub", + self.get_credential(WebPubSubChatServiceClient), + ) - def create_async_client(self, connection_string): - return AsyncWebPubSubChatServiceClient.from_connection_string(connection_string, "test_hub") + def create_async_client(self, endpoint): + return AsyncWebPubSubChatServiceClient( + endpoint, + "test_hub", + self.get_credential(AsyncWebPubSubChatServiceClient, is_async=True), + ) + + @staticmethod + def create_key_client(connection_string): + return WebPubSubChatServiceClient.from_connection_string( + connection_string, "test_hub" + ) + + @staticmethod + def create_async_key_client(connection_string): + return AsyncWebPubSubChatServiceClient.from_connection_string( + connection_string, "test_hub" + ) + + def assert_client_access(self, access, endpoint): + expected_base_url = f"wss://{endpoint.removeprefix('https://').rstrip('/')}/client/hubs/test_hub" + assert access["baseUrl"] == expected_base_url + assert access["url"] == f"{expected_base_url}?access_token={access['token']}" + if not self.is_playback(): + verify_chat_connection(access["url"]) + + async def assert_client_access_async(self, access, endpoint): + expected_base_url = f"wss://{endpoint.removeprefix('https://').rstrip('/')}/client/hubs/test_hub" + assert access["baseUrl"] == expected_base_url + assert access["url"] == f"{expected_base_url}?access_token={access['token']}" + if not self.is_playback(): + await verify_chat_connection_async(access["url"]) + + def seed_chat_message(self, client, user_id, conversation_id, content): + if not self.is_playback(): + access = client.get_client_access_token(user_id=user_id) + create_chat_message(access["url"], conversation_id, content) + + async def seed_chat_message_async(self, client, user_id, conversation_id, content): + if not self.is_playback(): + access = await client.get_client_access_token(user_id=user_id) + await create_chat_message_async(access["url"], conversation_id, content) @staticmethod def cleanup(action, *args): @@ -38,5 +91,12 @@ async def cleanup_async(action, *args): PowerShellPreparer, "wps_chat", wps_chat_endpoint="https://myservice.webpubsub.azure.com", - wps_chat_connection_string="Endpoint=https://myservice.webpubsub.azure.com;AccessKey=Kg==;Version=1.0;", +) + +WebPubSubChatAccessPreparer = functools.partial( + WebPubSubChatPreparer, + wps_chat_connection_string=( + "Endpoint=https://myservice.webpubsub.azure.com;" + "AccessKey=ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGH;" + ), ) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tsp-location.yaml b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tsp-location.yaml index f99f61605125..f3de14e1e623 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tsp-location.yaml +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tsp-location.yaml @@ -1,5 +1,5 @@ directory: specification/webpubsub/data-plane/WebPubSubChat -commit: f58a62e4a14eb2fdb76a6826646e08fc18aac208 +commit: 690177cbd9f00529bb3350857044504ce66852f6 repo: Azure/azure-rest-api-specs additionalDirectories: [] entrypointFile: client.tsp diff --git a/sdk/webpubsub/azure-messaging-webpubsubservice/azure/messaging/webpubsubservice/__init__.py b/sdk/webpubsub/azure-messaging-webpubsubservice/azure/messaging/webpubsubservice/__init__.py index 42bc7323e606..666d8aaead6d 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubservice/azure/messaging/webpubsubservice/__init__.py +++ b/sdk/webpubsub/azure-messaging-webpubsubservice/azure/messaging/webpubsubservice/__init__.py @@ -7,6 +7,10 @@ # -------------------------------------------------------------------------- # pylint: disable=wrong-import-position +# The Chat client currently ships separately under this namespace. Extend the +# path so both distributions can coexist; revisit after Architecture Board review. +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore + from typing import TYPE_CHECKING if TYPE_CHECKING: diff --git a/sdk/webpubsub/tests.yml b/sdk/webpubsub/tests.yml index 7a03ef94410d..dbf53d25f9a2 100644 --- a/sdk/webpubsub/tests.yml +++ b/sdk/webpubsub/tests.yml @@ -1,10 +1,18 @@ trigger: none +parameters: + - name: Services + type: object + default: + - azure-mgmt-webpubsub + - azure-messaging-webpubsubservice + - azure-messaging-webpubsubclient + extends: template: /eng/pipelines/templates/stages/archetype-sdk-tests.yml parameters: - BuildTargetingString: azure* ServiceDirectory: webpubsub + Packages: ${{ parameters.Services }} MatrixReplace: - TestSamples=.*/true EnvVars: From 83d7f4fa4407a7032fc03297baf86a0734f64d36 Mon Sep 17 00:00:00 2001 From: Zitong Yang Date: Fri, 4 Sep 2026 00:08:13 +1000 Subject: [PATCH 4/6] Fix doc error --- .../MANIFEST.in | 1 + ...re.messaging.webpubsubservice.chat.aio.rst | 7 +++++ ...messaging.webpubsubservice.chat.models.rst | 7 +++++ .../azure.messaging.webpubsubservice.chat.rst | 27 +++++++++++++++++++ .../tests/test_live.py | 2 ++ .../tests/testcase.py | 1 + 6 files changed, 45 insertions(+) create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/doc/azure.messaging.webpubsubservice.chat.aio.rst create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/doc/azure.messaging.webpubsubservice.chat.models.rst create mode 100644 sdk/webpubsub/azure-messaging-webpubsubchatservice/doc/azure.messaging.webpubsubservice.chat.rst diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/MANIFEST.in b/sdk/webpubsub/azure-messaging-webpubsubchatservice/MANIFEST.in index ccb8abdb144f..7acdec39e384 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/MANIFEST.in +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/MANIFEST.in @@ -3,5 +3,6 @@ include LICENSE include azure/messaging/webpubsubservice/chat/py.typed recursive-include tests *.py recursive-include samples *.py *.md +recursive-include doc *.rst include azure/__init__.py include azure/messaging/__init__.py diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/doc/azure.messaging.webpubsubservice.chat.aio.rst b/sdk/webpubsub/azure-messaging-webpubsubchatservice/doc/azure.messaging.webpubsubservice.chat.aio.rst new file mode 100644 index 000000000000..85bd9cf818cc --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/doc/azure.messaging.webpubsubservice.chat.aio.rst @@ -0,0 +1,7 @@ +azure.messaging.webpubsubservice.chat.aio package +================================================= + +.. automodule:: azure.messaging.webpubsubservice.chat.aio + :inherited-members: + :members: + :undoc-members: \ No newline at end of file diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/doc/azure.messaging.webpubsubservice.chat.models.rst b/sdk/webpubsub/azure-messaging-webpubsubchatservice/doc/azure.messaging.webpubsubservice.chat.models.rst new file mode 100644 index 000000000000..091a8ac4b13c --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/doc/azure.messaging.webpubsubservice.chat.models.rst @@ -0,0 +1,7 @@ +azure.messaging.webpubsubservice.chat.models package +==================================================== + +.. automodule:: azure.messaging.webpubsubservice.chat.models + :inherited-members: + :members: + :undoc-members: \ No newline at end of file diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/doc/azure.messaging.webpubsubservice.chat.rst b/sdk/webpubsub/azure-messaging-webpubsubchatservice/doc/azure.messaging.webpubsubservice.chat.rst new file mode 100644 index 000000000000..76d05d85641c --- /dev/null +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/doc/azure.messaging.webpubsubservice.chat.rst @@ -0,0 +1,27 @@ +azure.messaging.webpubsubservice.chat package +============================================= + +.. automodule:: azure.messaging.webpubsubservice.chat + :inherited-members: + :members: + :undoc-members: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + azure.messaging.webpubsubservice.chat.aio + azure.messaging.webpubsubservice.chat.models + +Submodules +---------- + +azure.messaging.webpubsubservice.chat.types module +-------------------------------------------------- + +.. automodule:: azure.messaging.webpubsubservice.chat.types + :inherited-members: + :members: + :undoc-members: \ No newline at end of file diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live.py index f8f7ec9ec521..25980f50714f 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live.py @@ -285,6 +285,8 @@ def test_client_access_token( wps_chat_connection_string, wps_chat_disable_local_auth, ): + if wps_chat_disable_local_auth.lower() == "true": + pytest.skip("Local authentication is disabled") token_client = self.create_client(wps_chat_endpoint) key_client = None try: diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/testcase.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/testcase.py index f9550c9015d2..0d04bba041ee 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/testcase.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/testcase.py @@ -99,4 +99,5 @@ async def cleanup_async(action, *args): "Endpoint=https://myservice.webpubsub.azure.com;" "AccessKey=ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGH;" ), + wps_chat_disable_local_auth="false", ) From 312381b9158d7e1d7b315e6431ac4b1c5e4e5ee9 Mon Sep 17 00:00:00 2001 From: Zitong Yang Date: Fri, 4 Sep 2026 00:40:11 +1000 Subject: [PATCH 5/6] Fix tests --- .../assets.json | 2 +- .../tests/test_live.py | 2 -- .../tests/test_live_async.py | 18 +++++++++--------- 3 files changed, 10 insertions(+), 12 deletions(-) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/assets.json b/sdk/webpubsub/azure-messaging-webpubsubchatservice/assets.json index c605d3045b61..a8cc807f306f 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/assets.json +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/assets.json @@ -2,5 +2,5 @@ "AssetsRepo": "Azure/azure-sdk-assets", "AssetsRepoPrefixPath": "python", "TagPrefix": "python/webpubsub/azure-messaging-webpubsubchatservice", - "Tag": "python/webpubsub/azure-messaging-webpubsubchatservice_fe02890411" + "Tag": "python/webpubsub/azure-messaging-webpubsubchatservice_b012a5c98a" } diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live.py index 25980f50714f..f8f7ec9ec521 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live.py @@ -285,8 +285,6 @@ def test_client_access_token( wps_chat_connection_string, wps_chat_disable_local_auth, ): - if wps_chat_disable_local_auth.lower() == "true": - pytest.skip("Local authentication is disabled") token_client = self.create_client(wps_chat_endpoint) key_client = None try: diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live_async.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live_async.py index cdf086cd4117..78370881e487 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live_async.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/tests/test_live_async.py @@ -300,21 +300,21 @@ async def test_async_client_access_token( wps_chat_connection_string, wps_chat_disable_local_auth, ): - if wps_chat_disable_local_auth.lower() == "true": - pytest.skip("Local authentication is disabled") - token_client = self.create_async_client(wps_chat_endpoint) - key_client = self.create_async_key_client(wps_chat_connection_string) + key_client = None try: token_access = await token_client.get_client_access_token( user_id="python-async-e2e-token-access-user" ) await self.assert_client_access_async(token_access, wps_chat_endpoint) - key_access = await key_client.get_client_access_token( - user_id="python-async-e2e-key-access-user" - ) - await self.assert_client_access_async(key_access, wps_chat_endpoint) + if wps_chat_disable_local_auth.lower() != "true": + key_client = self.create_async_key_client(wps_chat_connection_string) + key_access = await key_client.get_client_access_token( + user_id="python-async-e2e-key-access-user" + ) + await self.assert_client_access_async(key_access, wps_chat_endpoint) finally: await token_client.close() - await key_client.close() + if key_client: + await key_client.close() From a1b0c6c75d42fa9dcceae003f7c2b233ad55d373 Mon Sep 17 00:00:00 2001 From: Zitong Yang Date: Fri, 4 Sep 2026 01:18:17 +1000 Subject: [PATCH 6/6] Fix Web PubSub Chat CI checks --- .../azure/messaging/webpubsubservice/chat/_utils/model_base.py | 2 +- .../azure-messaging-webpubsubchatservice/pyproject.toml | 2 +- sdk/webpubsub/azure-messaging-webpubsubchatservice/setup.py | 2 +- sdk/webpubsub/cspell.yaml | 2 ++ 4 files changed, 5 insertions(+), 3 deletions(-) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/model_base.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/model_base.py index d7531c4f81fc..67ba4e4e963e 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/model_base.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/azure/messaging/webpubsubservice/chat/_utils/model_base.py @@ -1260,7 +1260,7 @@ def _get_deserialize_callable_from_annotation( # pylint: disable=too-many-retur rf._is_optional = True if len(annotation.__args__) <= 2: # pyright: ignore if_obj_deserializer = _get_deserialize_callable_from_annotation( - next(a for a in annotation.__args__ if a is not _NONE_TYPE), + next(a for a in annotation.__args__ if a is not _NONE_TYPE), # pyright: ignore module, rf, # pyright: ignore ) diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/pyproject.toml b/sdk/webpubsub/azure-messaging-webpubsubchatservice/pyproject.toml index 4ad8b1a3d316..963d409bff34 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/pyproject.toml +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/pyproject.toml @@ -33,7 +33,7 @@ keywords = ["azure", "azure sdk"] dependencies = [ "isodate>=0.6.1", "azure-core>=1.37.0", - "PyJWT>=2.6.0", + "pyjwt>=2.6.0", "typing-extensions>=4.6.0", ] dynamic = [ diff --git a/sdk/webpubsub/azure-messaging-webpubsubchatservice/setup.py b/sdk/webpubsub/azure-messaging-webpubsubchatservice/setup.py index 6fd30d0495ac..0a195d90795c 100644 --- a/sdk/webpubsub/azure-messaging-webpubsubchatservice/setup.py +++ b/sdk/webpubsub/azure-messaging-webpubsubchatservice/setup.py @@ -67,7 +67,7 @@ install_requires=[ "isodate>=0.6.1", "azure-core>=1.37.0", - "PyJWT>=2.6.0", + "pyjwt>=2.6.0", "typing-extensions>=4.6.0", ], python_requires=">=3.10", diff --git a/sdk/webpubsub/cspell.yaml b/sdk/webpubsub/cspell.yaml index 774db9be8685..9e814c78b4d4 100644 --- a/sdk/webpubsub/cspell.yaml +++ b/sdk/webpubsub/cspell.yaml @@ -5,9 +5,11 @@ import: words: - awps - ctxt + - deser - deseralize - MQTT - Nify - psutil + - undoc - unflattened - wday