microsoft-agents-storage-cosmos 0.6.0.dev8__py3-none-any.whl → 0.6.0.dev10__py3-none-any.whl

microsoft_agents/storage/cosmos/cosmos_db_storage.py

@@ -20,6 +20,7 @@ from azure.cosmos.partition_key import NonePartitionKeyValue
 from microsoft_agents.hosting.core.storage import AsyncStorageBase, StoreItem
 from microsoft_agents.hosting.core.storage._type_aliases import JSON
 from microsoft_agents.hosting.core.storage.error_handling import ignore_error
+from microsoft_agents.storage.cosmos.errors import storage_errors
 
 from .cosmos_db_storage_config import CosmosDBStorageConfig
 from .key_ops import sanitize_key
@@ -55,7 +56,9 @@ class CosmosDBStorage(AsyncStorageBase):
         if self._config.url:
             if not self._config.credential:
                 raise ValueError(
-                    "CosmosDBStorage: Credential is required when using a custom service URL."
+                    storage_errors.InvalidConfiguration.format(
+                        "Credential is required when using a custom service URL"
+                    )
                 )
             return CosmosClient(
                 account_url=self._config.url, credential=self._config.credential
@@ -89,7 +92,7 @@ class CosmosDBStorage(AsyncStorageBase):
     ) -> tuple[Union[str, None], Union[StoreItemT, None]]:
 
         if key == "":
-            raise ValueError("CosmosDBStorage: Key cannot be empty.")
+            raise ValueError(str(storage_errors.CosmosDbKeyCannotBeEmpty))
 
         escaped_key: str = self._sanitize(key)
         read_item_response: CosmosDict = await ignore_error(
@@ -106,7 +109,7 @@ class CosmosDBStorage(AsyncStorageBase):
 
     async def _write_item(self, key: str, item: StoreItem) -> None:
         if key == "":
-            raise ValueError("CosmosDBStorage: Key cannot be empty.")
+            raise ValueError(str(storage_errors.CosmosDbKeyCannotBeEmpty))
 
         escaped_key: str = self._sanitize(key)
 
@@ -119,7 +122,7 @@ class CosmosDBStorage(AsyncStorageBase):
 
     async def _delete_item(self, key: str) -> None:
         if key == "":
-            raise ValueError("CosmosDBStorage: Key cannot be empty.")
+            raise ValueError(str(storage_errors.CosmosDbKeyCannotBeEmpty))
 
         escaped_key: str = self._sanitize(key)
 
@@ -156,8 +159,9 @@ class CosmosDBStorage(AsyncStorageBase):
                     self._compatability_mode_partition_key = True
                 elif "/id" not in paths:
                     raise Exception(
-                        f"Custom Partition Key Paths are not supported. {self._config.container_id} "
-                        "has a custom Partition Key Path of {paths[0]}."
+                        storage_errors.InvalidConfiguration.format(
+                            f"Custom Partition Key Paths are not supported. {self._config.container_id} has a custom Partition Key Path of {paths[0]}."
+                        )
                     )
             else:
                 raise err

microsoft_agents/storage/cosmos/cosmos_db_storage_config.py

@@ -2,6 +2,7 @@ import json
 from typing import Union
 
 from azure.core.credentials import TokenCredential
+from microsoft_agents.storage.cosmos.errors import storage_errors
 
 from .key_ops import sanitize_key
 
@@ -69,15 +70,15 @@ class CosmosDBStorageConfig:
 
         This is used prior to the creation of the CosmosDBStorage object."""
         if not config:
-            raise ValueError("CosmosDBStorage: CosmosDBConfig is required.")
+            raise ValueError(str(storage_errors.CosmosDbConfigRequired))
         if not config.cosmos_db_endpoint:
-            raise ValueError("CosmosDBStorage: cosmos_db_endpoint is required.")
+            raise ValueError(str(storage_errors.CosmosDbEndpointRequired))
         if not config.auth_key:
-            raise ValueError("CosmosDBStorage: auth_key is required.")
+            raise ValueError(str(storage_errors.CosmosDbAuthKeyRequired))
         if not config.database_id:
-            raise ValueError("CosmosDBStorage: database_id is required.")
+            raise ValueError(str(storage_errors.CosmosDbDatabaseIdRequired))
         if not config.container_id:
-            raise ValueError("CosmosDBStorage: container_id is required.")
+            raise ValueError(str(storage_errors.CosmosDbContainerIdRequired))
 
         CosmosDBStorageConfig._validate_suffix(config)
 
@@ -85,11 +86,11 @@ class CosmosDBStorageConfig:
     def _validate_suffix(config: "CosmosDBStorageConfig") -> None:
         if config.key_suffix:
             if config.compatibility_mode:
-                raise ValueError(
-                    "compatibilityMode cannot be true while using a keySuffix."
-                )
+                raise ValueError(str(storage_errors.CosmosDbCompatibilityModeRequired))
             suffix_escaped: str = sanitize_key(config.key_suffix)
             if suffix_escaped != config.key_suffix:
                 raise ValueError(
-                    f"Cannot use invalid Row Key characters: {config.key_suffix} in keySuffix."
+                    storage_errors.CosmosDbInvalidKeySuffixCharacters.format(
+                        config.key_suffix
+                    )
                 )

microsoft_agents/storage/cosmos/errors/__init__.py

@@ -0,0 +1,15 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+"""
+Error resources for Microsoft Agents Storage Cosmos package.
+"""
+
+from microsoft_agents.hosting.core.errors import ErrorMessage
+
+from .error_resources import StorageErrorResources
+
+# Singleton instance
+storage_errors = StorageErrorResources()
+
+__all__ = ["ErrorMessage", "StorageErrorResources", "storage_errors"]

microsoft_agents/storage/cosmos/errors/error_resources.py

@@ -0,0 +1,100 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+"""
+Storage error resources for Microsoft Agents SDK (CosmosDB).
+
+Error codes are in the range -61000 to -61999.
+"""
+
+from microsoft_agents.hosting.core.errors import ErrorMessage
+
+
+class StorageErrorResources:
+    """
+    Error messages for storage operations (CosmosDB).
+
+    Error codes are organized in the range -61000 to -61999.
+    """
+
+    CosmosDbConfigRequired = ErrorMessage(
+        "CosmosDBStorage: CosmosDBConfig is required.",
+        -61000,
+        "storage-configuration",
+    )
+
+    CosmosDbEndpointRequired = ErrorMessage(
+        "CosmosDBStorage: cosmos_db_endpoint is required.",
+        -61001,
+        "storage-configuration",
+    )
+
+    CosmosDbAuthKeyRequired = ErrorMessage(
+        "CosmosDBStorage: auth_key is required.",
+        -61002,
+        "storage-configuration",
+    )
+
+    CosmosDbDatabaseIdRequired = ErrorMessage(
+        "CosmosDBStorage: database_id is required.",
+        -61003,
+        "storage-configuration",
+    )
+
+    CosmosDbContainerIdRequired = ErrorMessage(
+        "CosmosDBStorage: container_id is required.",
+        -61004,
+        "storage-configuration",
+    )
+
+    CosmosDbKeyCannotBeEmpty = ErrorMessage(
+        "CosmosDBStorage: Key cannot be empty.",
+        -61005,
+        "storage-configuration",
+    )
+
+    CosmosDbPartitionKeyInvalid = ErrorMessage(
+        "CosmosDBStorage: PartitionKey of {0} cannot be used with a CosmosDbPartitionedStorageOptions.PartitionKey of {1}.",
+        -61006,
+        "storage-configuration",
+    )
+
+    CosmosDbPartitionKeyPathInvalid = ErrorMessage(
+        "CosmosDBStorage: PartitionKeyPath must match cosmosDbPartitionedStorageOptions value of {0}",
+        -61007,
+        "storage-configuration",
+    )
+
+    CosmosDbCompatibilityModeRequired = ErrorMessage(
+        "CosmosDBStorage: compatibilityMode cannot be set when using partitionKey options.",
+        -61008,
+        "storage-configuration",
+    )
+
+    CosmosDbPartitionKeyNotFound = ErrorMessage(
+        "CosmosDBStorage: Partition key '{0}' missing from state, you may be missing custom state implementation.",
+        -61009,
+        "storage-configuration",
+    )
+
+    CosmosDbInvalidPartitionKeyValue = ErrorMessage(
+        "CosmosDBStorage: Invalid PartitionKey property on item with id {0}",
+        -61010,
+        "storage-configuration",
+    )
+
+    CosmosDbInvalidKeySuffixCharacters = ErrorMessage(
+        "Cannot use invalid Row Key characters: {0} in keySuffix.",
+        -61011,
+        "storage-configuration",
+    )
+
+    InvalidConfiguration = ErrorMessage(
+        "Invalid configuration: {0}",
+        -61012,
+        "configuration",
+    )
+
+    def __init__(self):
+        """Initialize StorageErrorResources."""
+        pass

{microsoft_agents_storage_cosmos-0.6.0.dev8.dist-info → microsoft_agents_storage_cosmos-0.6.0.dev10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: microsoft-agents-storage-cosmos
-Version: 0.6.0.dev8
+Version: 0.6.0.dev10
 Summary: A Cosmos DB storage library for Microsoft Agents
 Author: Microsoft Corporation
 License-Expression: MIT
@@ -15,7 +15,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: microsoft-agents-hosting-core==0.6.0.dev8
+Requires-Dist: microsoft-agents-hosting-core==0.6.0.dev10
 Requires-Dist: azure-core
 Requires-Dist: azure-cosmos
 Dynamic: license-file

microsoft_agents_storage_cosmos-0.6.0.dev10.dist-info/RECORD

@@ -0,0 +1,11 @@
+microsoft_agents/storage/cosmos/__init__.py,sha256=2JVNhbohUB-Pm8LmgagHQH3vlEgljpUzbfPhdOS-rCQ,174
+microsoft_agents/storage/cosmos/cosmos_db_storage.py,sha256=TLvvVKmRqKWrXsy9ddOjXPbPjPvLFXW6oB3KE9cuIC4,6753
+microsoft_agents/storage/cosmos/cosmos_db_storage_config.py,sha256=ji--EihsTE9FiGyUpeaw0or1iMN8-Z6O-gUd0fMcfx0,4210
+microsoft_agents/storage/cosmos/key_ops.py,sha256=2wnSdSpKzwoCvw4giNn68pBDOa1Gc1jyvEhk2tc_gPQ,1747
+microsoft_agents/storage/cosmos/errors/__init__.py,sha256=lFjCjclpBSTAeVXTNT6QdkZORd4jDX1yeVAYGz0kCjI,413
+microsoft_agents/storage/cosmos/errors/error_resources.py,sha256=yEX_ivRtOcnZ8jv-GWNM8qm-RsgfBOA5cvGsRPih9YY,2811
+microsoft_agents_storage_cosmos-0.6.0.dev10.dist-info/licenses/LICENSE,sha256=ws_MuBL-SCEBqPBFl9_FqZkaaydIJmxHrJG2parhU4M,1141
+microsoft_agents_storage_cosmos-0.6.0.dev10.dist-info/METADATA,sha256=Vj0LewHBnPRVqBj7llp5WAvbDWL4ea9znbu1OkSHJkE,7786
+microsoft_agents_storage_cosmos-0.6.0.dev10.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+microsoft_agents_storage_cosmos-0.6.0.dev10.dist-info/top_level.txt,sha256=lWKcT4v6fTA_NgsuHdNvuMjSrkiBMXohn64ApY7Xi8A,17
+microsoft_agents_storage_cosmos-0.6.0.dev10.dist-info/RECORD,,

microsoft_agents_storage_cosmos-0.6.0.dev8.dist-info/RECORD

@@ -1,9 +0,0 @@
-microsoft_agents/storage/cosmos/__init__.py,sha256=2JVNhbohUB-Pm8LmgagHQH3vlEgljpUzbfPhdOS-rCQ,174
-microsoft_agents/storage/cosmos/cosmos_db_storage.py,sha256=yqU51Ji0wceuHKtppa2oQDrBqXI0LFi69OPGDe2mh8o,6529
-microsoft_agents/storage/cosmos/cosmos_db_storage_config.py,sha256=a2-s7Kj5RbYnVU0CyB60dEG501-oRcSXZTQ--_QlISA,4143
-microsoft_agents/storage/cosmos/key_ops.py,sha256=2wnSdSpKzwoCvw4giNn68pBDOa1Gc1jyvEhk2tc_gPQ,1747
-microsoft_agents_storage_cosmos-0.6.0.dev8.dist-info/licenses/LICENSE,sha256=ws_MuBL-SCEBqPBFl9_FqZkaaydIJmxHrJG2parhU4M,1141
-microsoft_agents_storage_cosmos-0.6.0.dev8.dist-info/METADATA,sha256=LBpG-HgjHvKF8GGrYjEmcXz70WAUfZm3RXnT5CGGRpg,7784
-microsoft_agents_storage_cosmos-0.6.0.dev8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-microsoft_agents_storage_cosmos-0.6.0.dev8.dist-info/top_level.txt,sha256=lWKcT4v6fTA_NgsuHdNvuMjSrkiBMXohn64ApY7Xi8A,17
-microsoft_agents_storage_cosmos-0.6.0.dev8.dist-info/RECORD,,