microsoft-agents-activity 0.7.0.dev0__py3-none-any.whl

microsoft_agents/activity/__init__.py

@@ -0,0 +1,200 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .agents_model import AgentsModel
+from .action_types import ActionTypes
+from .activity import Activity
+from .activity_event_names import ActivityEventNames
+from .activity_types import ActivityTypes
+from .adaptive_card_invoke_action import AdaptiveCardInvokeAction
+from .adaptive_card_invoke_response import AdaptiveCardInvokeResponse
+from .adaptive_card_invoke_value import AdaptiveCardInvokeValue
+from .animation_card import AnimationCard
+from .attachment import Attachment
+from .attachment_data import AttachmentData
+from .attachment_info import AttachmentInfo
+from .attachment_view import AttachmentView
+from .audio_card import AudioCard
+from .basic_card import BasicCard
+from .card_action import CardAction
+from .card_image import CardImage
+from .channels import Channels
+from .channel_account import ChannelAccount
+from ._channel_id_field_mixin import _ChannelIdFieldMixin
+from .channel_id import ChannelId
+from .conversation_account import ConversationAccount
+from .conversation_members import ConversationMembers
+from .conversation_parameters import ConversationParameters
+from .conversation_reference import ConversationReference
+from .conversation_resource_response import ConversationResourceResponse
+from .conversations_result import ConversationsResult
+from .expected_replies import ExpectedReplies
+from .entity import (
+    Entity,
+    EntityTypes,
+    AIEntity,
+    ClientCitation,
+    ClientCitationAppearance,
+    ClientCitationImage,
+    ClientCitationIconName,
+    Mention,
+    SensitivityUsageInfo,
+    SensitivityPattern,
+    GeoCoordinates,
+    Place,
+    ProductInfo,
+    Thing,
+)
+from .error import Error
+from .error_response import ErrorResponse
+from .fact import Fact
+from .hero_card import HeroCard
+from .inner_http_error import InnerHttpError
+from .invoke_response import InvokeResponse
+from .media_card import MediaCard
+from .media_event_value import MediaEventValue
+from .media_url import MediaUrl
+from .message_reaction import MessageReaction
+from .oauth_card import OAuthCard
+from .paged_members_result import PagedMembersResult
+from .receipt_card import ReceiptCard
+from .receipt_item import ReceiptItem
+from .resource_response import ResourceResponse
+from .semantic_action import SemanticAction
+from .signin_card import SigninCard
+from .suggested_actions import SuggestedActions
+from .text_highlight import TextHighlight
+from .thumbnail_card import ThumbnailCard
+from .thumbnail_url import ThumbnailUrl
+from .token_exchange_invoke_request import TokenExchangeInvokeRequest
+from .token_exchange_invoke_response import TokenExchangeInvokeResponse
+from .token_exchange_state import TokenExchangeState
+from .token_or_sign_in_resource_response import TokenOrSignInResourceResponse
+from .token_request import TokenRequest
+from .token_response import TokenResponse
+from .token_status import TokenStatus
+from .transcript import Transcript
+from .video_card import VideoCard
+
+from .activity_importance import ActivityImportance
+from .attachment_layout_types import AttachmentLayoutTypes
+from .contact_relation_update_action_types import ContactRelationUpdateActionTypes
+from .delivery_modes import DeliveryModes
+from .end_of_conversation_codes import EndOfConversationCodes
+from .input_hints import InputHints
+from .installation_update_action_types import InstallationUpdateActionTypes
+from .message_reaction_types import MessageReactionTypes
+from .role_types import RoleTypes
+from .semantic_actions_states import SemanticActionsStates
+from .text_format_types import TextFormatTypes
+from .sign_in_constants import SignInConstants
+
+from .sign_in_resource import SignInResource
+from .token_exchange_resource import TokenExchangeResource
+from .token_post_resource import TokenPostResource
+
+from .delivery_modes import DeliveryModes
+from .caller_id_constants import CallerIdConstants
+
+from .conversation_update_types import ConversationUpdateTypes
+from .message_update_types import MessageUpdateTypes
+
+from .channel_adapter_protocol import ChannelAdapterProtocol
+from .turn_context_protocol import TurnContextProtocol
+from ._load_configuration import load_configuration_from_env
+
+__all__ = [
+    "AgentsModel",
+    "Activity",
+    "ActionTypes",
+    "ActivityEventNames",
+    "AdaptiveCardInvokeAction",
+    "AdaptiveCardInvokeResponse",
+    "AdaptiveCardInvokeValue",
+    "AnimationCard",
+    "Attachment",
+    "AttachmentData",
+    "AttachmentInfo",
+    "AttachmentView",
+    "AudioCard",
+    "BasicCard",
+    "CardAction",
+    "CardImage",
+    "Channels",
+    "ChannelAccount",
+    "ChannelId",
+    "_ChannelIdFieldMixin",
+    "ConversationAccount",
+    "ConversationMembers",
+    "ConversationParameters",
+    "ConversationReference",
+    "ConversationResourceResponse",
+    "ConversationsResult",
+    "ExpectedReplies",
+    "Entity",
+    "AIEntity",
+    "ClientCitation",
+    "ClientCitationAppearance",
+    "ClientCitationImage",
+    "ClientCitationIconName",
+    "SensitivityUsageInfo",
+    "SensitivityPattern",
+    "Error",
+    "ErrorResponse",
+    "Fact",
+    "GeoCoordinates",
+    "HeroCard",
+    "InnerHttpError",
+    "InvokeResponse",
+    "MediaCard",
+    "MediaEventValue",
+    "MediaUrl",
+    "Mention",
+    "MessageReaction",
+    "OAuthCard",
+    "PagedMembersResult",
+    "Place",
+    "ProductInfo",
+    "ReceiptCard",
+    "ReceiptItem",
+    "ResourceResponse",
+    "SemanticAction",
+    "SigninCard",
+    "SuggestedActions",
+    "TextHighlight",
+    "Thing",
+    "ThumbnailCard",
+    "ThumbnailUrl",
+    "TokenExchangeInvokeRequest",
+    "TokenExchangeInvokeResponse",
+    "TokenExchangeState",
+    "TokenRequest",
+    "TokenResponse",
+    "TokenStatus",
+    "Transcript",
+    "VideoCard",
+    "ActivityTypes",
+    "ActivityImportance",
+    "AttachmentLayoutTypes",
+    "ContactRelationUpdateActionTypes",
+    "DeliveryModes",
+    "EndOfConversationCodes",
+    "InputHints",
+    "InstallationUpdateActionTypes",
+    "MessageReactionTypes",
+    "RoleTypes",
+    "SemanticActionsStates",
+    "TextFormatTypes",
+    "SignInConstants",
+    "SignInResource",
+    "TokenExchangeResource",
+    "TokenPostResource",
+    "DeliveryModes",
+    "CallerIdConstants",
+    "ConversationUpdateTypes",
+    "MessageUpdateTypes",
+    "load_configuration_from_env",
+    "ChannelAdapterProtocol",
+    "TurnContextProtocol",
+    "TokenOrSignInResourceResponse",
+]

microsoft_agents/activity/_channel_id_field_mixin.py

@@ -0,0 +1,95 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from __future__ import annotations
+
+import logging
+from typing import Optional, Any
+
+from pydantic import (
+    ModelWrapValidatorHandler,
+    SerializerFunctionWrapHandler,
+    computed_field,
+    model_validator,
+    model_serializer,
+)
+
+from microsoft_agents.activity.errors import activity_errors
+
+from .channel_id import ChannelId
+
+logger = logging.getLogger(__name__)
+
+
+# can be generalized in the future, if needed
+class _ChannelIdFieldMixin:
+    """A mixin to add a computed field channel_id of type ChannelId to a Pydantic model."""
+
+    _channel_id: Optional[ChannelId] = None
+
+    # required to define the setter below
+    @computed_field(return_type=Optional[ChannelId], alias="channelId")
+    @property
+    def channel_id(self) -> Optional[ChannelId]:
+        """Gets the _channel_id field"""
+        return self._channel_id
+
+    # necessary for backward compatibility
+    # previously, channel_id was directly assigned with strings
+    @channel_id.setter
+    def channel_id(self, value: Any):
+        """Sets the channel_id after validating it as a ChannelId model."""
+        if isinstance(value, ChannelId):
+            self._channel_id = value
+        elif isinstance(value, str):
+            self._channel_id = ChannelId(value)
+        else:
+            raise ValueError(activity_errors.InvalidChannelIdType.format(type(value)))
+
+    def _set_validated_channel_id(self, data: Any) -> None:
+        """Sets the channel_id after validating it as a ChannelId model."""
+        if "channelId" in data:
+            self.channel_id = data["channelId"]
+        elif "channel_id" in data:
+            self.channel_id = data["channel_id"]
+
+    @model_validator(mode="wrap")
+    @classmethod
+    def _validate_channel_id(
+        cls, data: Any, handler: ModelWrapValidatorHandler
+    ) -> _ChannelIdFieldMixin:
+        """Validate the _channel_id field after model initialization.
+
+        :return: The model instance itself.
+        """
+        try:
+            model = handler(data)
+            model._set_validated_channel_id(data)
+            return model
+        except Exception:
+            logging.error("Model %s failed to validate with data %s", cls, data)
+            raise
+
+    def _remove_serialized_unset_channel_id(
+        self, serialized: dict[str, object]
+    ) -> None:
+        """Remove the _channel_id field if it is not set."""
+        if not self._channel_id:
+            if "channelId" in serialized:
+                del serialized["channelId"]
+            elif "channel_id" in serialized:
+                del serialized["channel_id"]
+
+    @model_serializer(mode="wrap")
+    def _serialize_channel_id(
+        self, handler: SerializerFunctionWrapHandler
+    ) -> dict[str, object]:
+        """Serialize the model using Pydantic's standard serialization.
+
+        :param handler: The serialization handler provided by Pydantic.
+        :return: A dictionary representing the serialized model.
+        """
+        serialized = handler(self)
+        if self:  # serialization can be called with None
+            self._remove_serialized_unset_channel_id(serialized)
+        return serialized

microsoft_agents/activity/_load_configuration.py

@@ -0,0 +1,33 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import Any
+
+
+def load_configuration_from_env(env_vars: dict[str, Any]) -> dict:
+    """
+    Parses environment variables and returns a dictionary with the relevant configuration.
+    """
+    vars = env_vars.copy()
+    result = {}
+    for key, value in vars.items():
+        levels = key.split("__")
+        current_level = result
+        last_level = None
+        for next_level in levels:
+            if next_level not in current_level:
+                current_level[next_level] = {}
+            last_level = current_level
+            current_level = current_level[next_level]
+        last_level[levels[-1]] = value
+
+    if result.get("CONNECTIONSMAP") and isinstance(result["CONNECTIONSMAP"], dict):
+        result["CONNECTIONSMAP"] = [
+            conn for conn in result.get("CONNECTIONSMAP", {}).values()
+        ]
+
+    return {
+        "AGENTAPPLICATION": result.get("AGENTAPPLICATION", {}),
+        "CONNECTIONS": result.get("CONNECTIONS", {}),
+        "CONNECTIONSMAP": result.get("CONNECTIONSMAP", {}),
+    }

microsoft_agents/activity/_model_utils.py

@@ -0,0 +1,64 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from abc import ABC
+from typing import Any, Callable
+
+from .agents_model import AgentsModel
+
+
+class ModelFieldHelper(ABC):
+    """Base class for model field processing prior to initialization of an AgentsModel"""
+
+    def process(self, key: str) -> dict[str, Any]:
+        """Takes the key in the destination object and returns a dictionary of new fields to add"""
+        raise NotImplementedError()
+
+
+class SkipIf(ModelFieldHelper):
+    """Skip if the value meets the given condition."""
+
+    def __init__(self, value, skip_condition: Callable[[Any], bool]):
+        self.value = value
+        self._skip_condition = skip_condition
+
+    def process(self, key: str) -> dict[str, Any]:
+        if self._skip_condition(self.value):
+            return {}
+        return {key: self.value}
+
+
+class SkipNone(SkipIf):
+    """Skip if the value is None."""
+
+    def __init__(self, value):
+        super().__init__(value, lambda v: v is None)
+
+
+def pick_model_dict(**kwargs):
+    """Processes a list of keyword arguments, using ModelFieldHelper subclasses to determine which fields to include in the final model.
+
+    This function is useful for dynamically constructing models based on varying input data.
+
+    Usage:
+        activity_dict = pick_model_dict(type="message", id="123", text=SkipNone(text_variable))
+        activity = Activity.model_validate(activity_dict)
+    """
+
+    model_dict = {}
+    for key, value in kwargs.items():
+        if not isinstance(value, ModelFieldHelper):
+            model_dict[key] = value
+        else:
+            model_dict.update(value.process(key))
+
+    return model_dict
+
+
+def pick_model(model_class: type[AgentsModel], **kwargs) -> AgentsModel:
+    """Picks model fields from the given keyword arguments.
+
+    Usage:
+        activity = pick_model(Activity, type="message", id="123", text=SkipNone(text_variable))
+    """
+    return model_class(**pick_model_dict(**kwargs))

microsoft_agents/activity/_type_aliases.py

@@ -0,0 +1,7 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import Annotated
+from pydantic import StringConstraints
+
+NonEmptyString = Annotated[str, StringConstraints(min_length=1)]

microsoft_agents/activity/_utils/__init__.py

@@ -0,0 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ._deferred_string import _DeferredString
+
+__all__ = ["_DeferredString"]

microsoft_agents/activity/_utils/_deferred_string.py

@@ -0,0 +1,34 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import logging
+from typing import Callable
+
+logger = logging.getLogger(__name__)
+
+
+class _DeferredString:
+    """A wrapper around a function to allow for deferred evaluation.
+
+    The result of the function is converted to a string with str().
+    If an error occurs during evaluation, an error is logged and a default
+    string is returned.
+    """
+
+    def __init__(self, func: Callable, *args, **kwargs):
+        """Initializes a DeferredString instance.
+
+        :param func: The function to be called to get the string value.
+        :param args: Positional arguments to pass to the function.
+        :param kwargs: Keyword arguments to pass to the function.
+        """
+        self.func = func
+        self.args = args
+        self.kwargs = kwargs
+
+    def __str__(self):
+        try:
+            return str(self.func(*self.args, **self.kwargs))
+        except Exception as e:
+            logger.error("Error evaluating deferred string", exc_info=e)
+            return "_DeferredString: error evaluating deferred string"

microsoft_agents/activity/action_types.py

@@ -0,0 +1,17 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from enum import Enum
+
+
+class ActionTypes(str, Enum):
+    open_url = "openUrl"
+    im_back = "imBack"
+    post_back = "postBack"
+    play_audio = "playAudio"
+    play_video = "playVideo"
+    show_image = "showImage"
+    download_file = "downloadFile"
+    signin = "signin"
+    call = "call"
+    message_back = "messageBack"