Add @require_kwargs decorator

Author: jhamon

pinecone/db_control/resources/asyncio/collection.py

@@ -1,32 +1,32 @@
 import logging
-from typing import TYPE_CHECKING
-
 
 from pinecone.db_control.models import CollectionList
 
 from pinecone.db_control.request_factory import PineconeDBControlRequestFactory
+from pinecone.utils import require_kwargs
 
 logger = logging.getLogger(__name__)
 """ @private """
 
-if TYPE_CHECKING:
-    pass
-
 
 class CollectionResourceAsyncio:
     def __init__(self, index_api):
         self.index_api = index_api
 
-    async def create(self, name: str, source: str):
+    @require_kwargs
+    async def create(self, *, name: str, source: str):
         req = PineconeDBControlRequestFactory.create_collection_request(name=name, source=source)
         await self.index_api.create_collection(create_collection_request=req)
 
+    @require_kwargs
     async def list(self) -> CollectionList:
         response = await self.index_api.list_collections()
         return CollectionList(response)
 
-    async def delete(self, name: str):
+    @require_kwargs
+    async def delete(self, *, name: str):
         await self.index_api.delete_collection(name)
 
-    async def describe(self, name: str):
+    @require_kwargs
+    async def describe(self, *, name: str):
         return await self.index_api.describe_collection(name).to_dict()

pinecone/db_control/resources/asyncio/index.py

@@ -19,7 +19,7 @@
 from pinecone.db_control.types import CreateIndexForModelEmbedTypedDict
 from pinecone.db_control.request_factory import PineconeDBControlRequestFactory
 from pinecone.core.openapi.db_control import API_VERSION
-
+from pinecone.utils import require_kwargs
 
 logger = logging.getLogger(__name__)
 """ @private """
@@ -30,8 +30,10 @@ def __init__(self, index_api, config):
         self._index_api = index_api
         self._config = config
 
+    @require_kwargs
     async def create(
         self,
+        *,
         name: str,
         spec: Union[Dict, ServerlessSpec, PodSpec],
         dimension: Optional[int] = None,
@@ -56,8 +58,10 @@ async def create(
             return IndexModel(resp)
         return await self.__poll_describe_index_until_ready(name, timeout)
 
+    @require_kwargs
     async def create_for_model(
         self,
+        *,
         name: str,
         cloud: Union[CloudProvider, str],
         region: Union[AwsRegion, GcpRegion, AzureRegion, str],
@@ -80,8 +84,10 @@ async def create_for_model(
             return IndexModel(resp)
         return await self.__poll_describe_index_until_ready(name, timeout)
 
+    @require_kwargs
     async def create_from_backup(
         self,
+        *,
         name: str,
         backup_id: str,
         deletion_protection: Optional[Union[DeletionProtection, str]] = DeletionProtection.DISABLED,
@@ -134,7 +140,8 @@ async def is_ready() -> bool:
 
         return description
 
-    async def delete(self, name: str, timeout: Optional[int] = None):
+    @require_kwargs
+    async def delete(self, *, name: str, timeout: Optional[int] = None):
         await self._index_api.delete_index(name)
 
         if timeout == -1:
@@ -156,23 +163,28 @@ async def delete(self, name: str, timeout: Optional[int] = None):
                 )
             )
 
+    @require_kwargs
     async def list(self) -> IndexList:
         response = await self._index_api.list_indexes()
         return IndexList(response)
 
-    async def describe(self, name: str) -> IndexModel:
+    @require_kwargs
+    async def describe(self, *, name: str) -> IndexModel:
         description = await self._index_api.describe_index(name)
         return IndexModel(description)
 
-    async def has(self, name: str) -> bool:
+    @require_kwargs
+    async def has(self, *, name: str) -> bool:
         available_indexes = await self.list()
         if name in available_indexes.names():
             return True
         else:
             return False
 
+    @require_kwargs
     async def configure(
         self,
+        *,
         name: str,
         replicas: Optional[int] = None,
         pod_type: Optional[Union[PodType, str]] = None,

pinecone/db_control/resources/sync/collection.py

@@ -2,6 +2,7 @@
 
 from pinecone.db_control.models import CollectionList
 from pinecone.db_control.request_factory import PineconeDBControlRequestFactory
+from pinecone.utils import require_kwargs
 
 logger = logging.getLogger(__name__)
 """ @private """
@@ -12,16 +13,20 @@ def __init__(self, index_api):
         self.index_api = index_api
         """ @private """
 
-    def create(self, name: str, source: str) -> None:
+    @require_kwargs
+    def create(self, *, name: str, source: str) -> None:
         req = PineconeDBControlRequestFactory.create_collection_request(name=name, source=source)
         self.index_api.create_collection(create_collection_request=req)
 
+    @require_kwargs
     def list(self) -> CollectionList:
         response = self.index_api.list_collections()
         return CollectionList(response)
 
-    def delete(self, name: str) -> None:
+    @require_kwargs
+    def delete(self, *, name: str) -> None:
         self.index_api.delete_collection(name)
 
-    def describe(self, name: str):
+    @require_kwargs
+    def describe(self, *, name: str):
         return self.index_api.describe_collection(name).to_dict()

pinecone/db_control/resources/sync/index.py

@@ -36,8 +36,10 @@ def __init__(self, index_api, config):
         self._index_host_store = IndexHostStore()
         """ @private """
 
+    @require_kwargs
     def create(
         self,
+        *,
         name: str,
         spec: Union[Dict, ServerlessSpec, PodSpec],
         dimension: Optional[int] = None,
@@ -62,8 +64,10 @@ def create(
             return IndexModel(resp)
         return self.__poll_describe_index_until_ready(name, timeout)
 
+    @require_kwargs
     def create_for_model(
         self,
+        *,
         name: str,
         cloud: Union[CloudProvider, str],
         region: Union[AwsRegion, GcpRegion, AzureRegion, str],
@@ -159,7 +163,8 @@ def is_ready() -> bool:
 
         return description
 
-    def delete(self, name: str, timeout: Optional[int] = None):
+    @require_kwargs
+    def delete(self, *, name: str, timeout: Optional[int] = None):
         self._index_api.delete_index(name)
         self._index_host_store.delete_host(self._config, name)
 
@@ -182,26 +187,31 @@ def delete(self, name: str, timeout: Optional[int] = None):
                 )
             )
 
+    @require_kwargs
     def list(self) -> IndexList:
         response = self._index_api.list_indexes()
         return IndexList(response)
 
-    def describe(self, name: str) -> IndexModel:
+    @require_kwargs
+    def describe(self, *, name: str) -> IndexModel:
         api_instance = self._index_api
         description = api_instance.describe_index(name)
         host = description.host
         self._index_host_store.set_host(self._config, name, host)
 
         return IndexModel(description)
 
-    def has(self, name: str) -> bool:
+    @require_kwargs
+    def has(self, *, name: str) -> bool:
         if name in self.list().names():
             return True
         else:
             return False
 
+    @require_kwargs
     def configure(
         self,
+        *,
         name: str,
         replicas: Optional[int] = None,
         pod_type: Optional[Union[PodType, str]] = None,

pinecone/legacy_pinecone_interface.py

@@ -334,6 +334,7 @@ def create_index_from_backup(
     @abstractmethod
     def create_index_for_model(
         self,
+        *,
         name: str,
         cloud: Union["CloudProvider", str],
         region: Union["AwsRegion", "GcpRegion", "AzureRegion", str],

pinecone/pinecone_asyncio.py

@@ -4,8 +4,7 @@
 
 from pinecone.config import PineconeConfig, ConfigBuilder
 
-from pinecone.utils import normalize_host, require_kwargs
-from pinecone.utils import docslinks
+from pinecone.utils import normalize_host, require_kwargs, docslinks
 
 from .pinecone_interface_asyncio import PineconeAsyncioDBControlInterface
 from .pinecone import check_realistic_host