microsoft-agents-a365-runtime 0.1.0.dev30__py3-none-any.whl → 0.2.1.dev0__py3-none-any.whl

microsoft_agents_a365/runtime/__init__.py

@@ -1,6 +1,9 @@
-# Copyright (c) Microsoft. All rights reserved.
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
 
 from .environment_utils import get_observability_authentication_scope
+from .operation_error import OperationError
+from .operation_result import OperationResult
 from .power_platform_api_discovery import ClusterCategory, PowerPlatformApiDiscovery
 from .utility import Utility
 
@@ -9,6 +12,8 @@ __all__ = [
     "PowerPlatformApiDiscovery",
     "ClusterCategory",
     "Utility",
+    "OperationError",
+    "OperationResult",
 ]
 
 __path__ = __import__("pkgutil").extend_path(__path__, __name__)

microsoft_agents_a365/runtime/environment_utils.py

@@ -1,4 +1,5 @@
-# Copyright (c) Microsoft. All rights reserved.
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
 
 """
 Utility logic for environment-related operations.
@@ -21,10 +22,14 @@ def get_observability_authentication_scope() -> list[str]:
     """
     Returns the scope for authenticating to the observability service based on the current environment.
 
+    The scope can be overridden via the A365_OBSERVABILITY_SCOPE_OVERRIDE environment variable
+    to enable testing against pre-production environments.
+
     Returns:
         list[str]: The authentication scope for the current environment.
     """
-    return [PROD_OBSERVABILITY_SCOPE]
+    override_scope = os.getenv("A365_OBSERVABILITY_SCOPE_OVERRIDE", "").strip()
+    return [override_scope] if override_scope else [PROD_OBSERVABILITY_SCOPE]
 
 
 def is_development_environment() -> bool:

microsoft_agents_a365/runtime/operation_error.py

@@ -0,0 +1,58 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+"""
+Encapsulates an error from an operation.
+"""
+
+
+class OperationError:
+    """
+    Represents an error that occurred during an operation.
+
+    This class wraps an exception and provides a consistent interface for
+    accessing error information.
+    """
+
+    def __init__(self, exception: Exception):
+        """
+        Initialize a new instance of the OperationError class.
+
+        Args:
+            exception: The exception associated with the error.
+
+        Raises:
+            ValueError: If exception is None.
+        """
+        if exception is None:
+            raise ValueError("exception cannot be None")
+        self._exception = exception
+
+    @property
+    def exception(self) -> Exception:
+        """
+        Get the exception associated with the error.
+
+        Returns:
+            Exception: The exception associated with the error.
+        """
+        return self._exception
+
+    @property
+    def message(self) -> str:
+        """
+        Get the message associated with the error.
+
+        Returns:
+            str: The error message from the exception.
+        """
+        return str(self._exception)
+
+    def __str__(self) -> str:
+        """
+        Return a string representation of the error.
+
+        Returns:
+            str: A string representation of the error.
+        """
+        return str(self._exception)

microsoft_agents_a365/runtime/operation_result.py

@@ -0,0 +1,98 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+"""
+Represents the result of an operation.
+"""
+
+from typing import List, Optional
+
+from .operation_error import OperationError
+
+
+class OperationResult:
+    """
+    Represents the result of an operation.
+
+    This class encapsulates the success or failure state of an operation along
+    with any associated errors.
+    """
+
+    _success_instance: Optional["OperationResult"] = None
+
+    def __init__(self, succeeded: bool, errors: Optional[List[OperationError]] = None):
+        """
+        Initialize a new instance of the OperationResult class.
+
+        Args:
+            succeeded: Flag indicating whether the operation succeeded.
+            errors: Optional list of errors that occurred during the operation.
+        """
+        self._succeeded = succeeded
+        self._errors = errors if errors is not None else []
+
+    @property
+    def succeeded(self) -> bool:
+        """
+        Get a flag indicating whether the operation succeeded.
+
+        Returns:
+            bool: True if the operation succeeded, otherwise False.
+        """
+        return self._succeeded
+
+    @property
+    def errors(self) -> List[OperationError]:
+        """
+        Get the list of errors that occurred during the operation.
+
+        Note:
+            This property returns a defensive copy of the internal error list
+            to prevent external modifications, which is especially important for
+            protecting the singleton instance returned by success().
+
+        Returns:
+            List[OperationError]: A copy of the list of operation errors.
+        """
+        return list(self._errors)
+
+    @staticmethod
+    def success() -> "OperationResult":
+        """
+        Return an OperationResult indicating a successful operation.
+
+        Returns:
+            OperationResult: An OperationResult indicating a successful operation.
+        """
+        return OperationResult._success_instance
+
+    @staticmethod
+    def failed(*errors: OperationError) -> "OperationResult":
+        """
+        Create an OperationResult indicating a failed operation.
+
+        Args:
+            *errors: Variable number of OperationError instances.
+
+        Returns:
+            OperationResult: An OperationResult indicating a failed operation.
+        """
+        error_list = list(errors) if errors else []
+        return OperationResult(succeeded=False, errors=error_list)
+
+    def __str__(self) -> str:
+        """
+        Convert the value of the current OperationResult object to its string representation.
+
+        Returns:
+            str: A string representation of the current OperationResult object.
+        """
+        if self._succeeded:
+            return "Succeeded"
+        else:
+            error_messages = ", ".join(str(error.message) for error in self._errors)
+            return f"Failed: {error_messages}" if error_messages else "Failed"
+
+
+# Module-level eager initialization (thread-safe by Python's import lock)
+OperationResult._success_instance = OperationResult(succeeded=True)

microsoft_agents_a365/runtime/power_platform_api_discovery.py

@@ -1,4 +1,5 @@
-# Copyright (c) Microsoft. All rights reserved.
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
 
 import re
 from typing import Literal

microsoft_agents_a365/runtime/utility.py

@@ -1,4 +1,5 @@
-# Copyright (c) Microsoft. All rights reserved.
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
 
 """
 Utility functions for Microsoft Agent 365 runtime operations.
@@ -9,7 +10,9 @@ and other common runtime operations.
 
 from __future__ import annotations
 
+import platform
 import uuid
+from importlib.metadata import PackageNotFoundError, version
 from typing import Any, Optional
 
 import jwt
@@ -23,6 +26,8 @@ class Utility:
     and other utility functions used across the Agent 365 runtime.
     """
 
+    _cached_version = None
+
     @staticmethod
     def get_app_id_from_token(token: Optional[str]) -> str:
         """
@@ -80,3 +85,27 @@ class Utility:
 
         # Fallback to extracting App ID from the auth token
         return Utility.get_app_id_from_token(auth_token)
+
+    @staticmethod
+    def get_user_agent_header(orchestrator: Optional[str] = None) -> str:
+        """
+        Generates a User-Agent header string for SDK requests.
+
+        Args:
+            orchestrator: Optional orchestrator name to include in the User-Agent header.
+                         Defaults to empty string if not provided.
+
+        Returns:
+            str: A formatted User-Agent header string containing SDK version, OS type,
+                 Python version, and optional orchestrator information.
+        """
+        if Utility._cached_version is None:
+            try:
+                Utility._cached_version = version("microsoft-agents-a365-runtime")
+            except PackageNotFoundError:
+                Utility._cached_version = "unknown"
+
+        orchestrator_part = f"; {orchestrator}" if orchestrator else ""
+        os_type = platform.system()
+        python_version = platform.python_version()
+        return f"Agent365SDK/{Utility._cached_version} ({os_type}; Python {python_version}{orchestrator_part})"

{microsoft_agents_a365_runtime-0.1.0.dev30.dist-info → microsoft_agents_a365_runtime-0.2.1.dev0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: microsoft-agents-a365-runtime
-Version: 0.1.0.dev30
+Version: 0.2.1.dev0
 Summary: Telemetry, tracing, and monitoring components for AI agents
 Author-email: Microsoft <support@microsoft.com>
 License: MIT
@@ -53,7 +53,7 @@ For usage examples and detailed documentation, see the [Microsoft Agent 365 Deve
 For issues, questions, or feedback:
 
 - File issues in the [GitHub Issues](https://github.com/microsoft/Agent365-python/issues) section
-- See the [main documentation](../../../README.md) for more information
+- See the [main documentation](../../README.md) for more information
  
 ## Trademarks
  
@@ -63,4 +63,4 @@ For issues, questions, or feedback:
 
 Copyright (c) Microsoft Corporation. All rights reserved.
 
-Licensed under the MIT License - see the [LICENSE](../../../LICENSE.md) file for details.
+Licensed under the MIT License - see the [LICENSE](../../LICENSE.md) file for details.

microsoft_agents_a365_runtime-0.2.1.dev0.dist-info/RECORD

@@ -0,0 +1,11 @@
+microsoft_agents_a365/runtime/__init__.py,sha256=_Q6AfhdNV-YhvkJKqTG-TlImI2B5bEbtTC_Mv82-ob4,591
+microsoft_agents_a365/runtime/environment_utils.py,sha256=B5A3CfGJJeuVgIW3Si7oSPYLQNkzc54nNqw3QnLgaC0,1824
+microsoft_agents_a365/runtime/operation_error.py,sha256=OqG6IIQR5lfvZrtyqpTa9Gc4B_eo2qxfoJ1Cj96WiUs,1418
+microsoft_agents_a365/runtime/operation_result.py,sha256=HIJLAzoAfPTINzjnThzXHDAizRaZ4xXX4D7TuOPjmdk,3066
+microsoft_agents_a365/runtime/power_platform_api_discovery.py,sha256=B6Ar2-P9pHrv-Pe_vFl0j9gRqAWyipbTfxkLEc9aA0k,3460
+microsoft_agents_a365/runtime/utility.py,sha256=5YEN1EGmHvRBb9gc9GeD58xAxUzGiZNON_zWkXh9Oms,4282
+microsoft_agents_a365/runtime/version_utils.py,sha256=nkgYIaPXD9OyT_lJ8K3sqpEze_VMJzekMmjsiYNghB8,965
+microsoft_agents_a365_runtime-0.2.1.dev0.dist-info/METADATA,sha256=WHoLAEw8Vy5lhwW29IJ8Il0rmGXOO7gJgyA0dXgExMw,3205
+microsoft_agents_a365_runtime-0.2.1.dev0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+microsoft_agents_a365_runtime-0.2.1.dev0.dist-info/top_level.txt,sha256=m90AvzRnjbL6fpi20mzOj6HUVkR2LWuf2JuXm4LL9LU,27
+microsoft_agents_a365_runtime-0.2.1.dev0.dist-info/RECORD,,

{microsoft_agents_a365_runtime-0.1.0.dev30.dist-info → microsoft_agents_a365_runtime-0.2.1.dev0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{microsoft_agents_a365_runtime-0.1.0.dev30.dist-info → microsoft_agents_a365_runtime-0.2.1.dev0.dist-info}/top_level.txt

@@ -1 +1,2 @@
+docs
 microsoft_agents_a365

microsoft_agents_a365_runtime-0.1.0.dev30.dist-info/RECORD

@@ -1,9 +0,0 @@
-microsoft_agents_a365/runtime/__init__.py,sha256=g5641veSgmz8JErlGhlc-noOXcKYZpsq_yBWMg4bcyM,431
-microsoft_agents_a365/runtime/environment_utils.py,sha256=T5b1DAUV1VxwcKxbjeqxfDkuhFCBZ-8kez-_yGbmv58,1524
-microsoft_agents_a365/runtime/power_platform_api_discovery.py,sha256=CS-Vhd6jsMq7lSwtdZIDh-Oybzn_osOTtvml_uYZ8eQ,3435
-microsoft_agents_a365/runtime/utility.py,sha256=FXrdaDHL1JypZkh8JKL0zh355xAllR5xd9bUDGgDCTI,3114
-microsoft_agents_a365/runtime/version_utils.py,sha256=nkgYIaPXD9OyT_lJ8K3sqpEze_VMJzekMmjsiYNghB8,965
-microsoft_agents_a365_runtime-0.1.0.dev30.dist-info/METADATA,sha256=y5N_0rZqUUh2BDTcPU9OZo2Vz3xfXIuzh82Xe3aL8us,3212
-microsoft_agents_a365_runtime-0.1.0.dev30.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-microsoft_agents_a365_runtime-0.1.0.dev30.dist-info/top_level.txt,sha256=G3c2_4sy5_EM_BWO67SbK2tKj4G8XFn-QXRbh8g9Lgk,22
-microsoft_agents_a365_runtime-0.1.0.dev30.dist-info/RECORD,,