deprecate: mark async gRPC properties as deprecated in QdrantRemote (#…

…740) * deprecate: mark async gRPC properties as deprecated in QdrantRemote - Added deprecation warnings to async gRPC properties: async_grpc_collections, async_grpc_points, async_grpc_snapshots, and async_grpc_root refs: #592 * deprecate: Added deprication for async_grpc in QdrantClient and QdrantRemote
qdrant · Aug 18, 2024 · 75b572c · 75b572c
1 parent 94eac24
commit 75b572c
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 28 deletions.
diff --git a/qdrant_client/qdrant_client.py b/qdrant_client/qdrant_client.py
@@ -189,6 +189,11 @@ def async_grpc_points(self) -> grpc.PointsStub:
         Returns:
             An instance of raw gRPC client, generated from Protobuf
         """
+        warnings.warn(
+            "async_grpc_points is deprecated and will be removed in a future release. Use `AsyncQdrantRemote.grpc_points` instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         if isinstance(self._client, QdrantRemote):
             return self._client.async_grpc_points
 
@@ -201,6 +206,11 @@ def async_grpc_collections(self) -> grpc.CollectionsStub:
         Returns:
             An instance of raw gRPC client, generated from Protobuf
         """
+        warnings.warn(
+            "async_grpc_collections is deprecated and will be removed in a future release. Use `AsyncQdrantRemote.grpc_collections` instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         if isinstance(self._client, QdrantRemote):
             return self._client.async_grpc_collections
 

diff --git a/qdrant_client/qdrant_remote.py b/qdrant_client/qdrant_remote.py
@@ -321,6 +321,11 @@ def async_grpc_snapshots(self) -> grpc.SnapshotsStub:
         Returns:
             An instance of raw gRPC client, generated from Protobuf
         """
+        warnings.warn(
+            "async_grpc_snapshots is deprecated and will be removed in a future release. Use `AsyncQdrantRemote.grpc_snapshots` instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         if self._aio_grpc_snapshots_client is None:
             self._init_async_grpc_snapshots_client()
         return self._aio_grpc_snapshots_client
@@ -332,6 +337,11 @@ def async_grpc_root(self) -> grpc.QdrantStub:
         Returns:
             An instance of raw gRPC client, generated from Protobuf
         """
+        warnings.warn(
+            "async_grpc_root is deprecated and will be removed in a future release. Use `AsyncQdrantRemote.grpc_root` instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         if self._aio_grpc_root_client is None:
             self._init_async_grpc_root_client()
         return self._aio_grpc_root_client
@@ -754,34 +764,34 @@ def query_batch_points(
             return http_res
 
     def query_points_groups(
-            self,
-            collection_name: str,
-            group_by: str,
-            query: Union[
-                types.PointId,
-                List[float],
-                List[List[float]],
-                types.SparseVector,
-                types.Query,
-                types.NumpyArray,
-                types.Document,
-                None,
-            ] = None,
-            using: Optional[str] = None,
-            prefetch: Union[types.Prefetch, List[types.Prefetch], None] = None,
-            query_filter: Optional[types.Filter] = None,
-            search_params: Optional[types.SearchParams] = None,
-            limit: int = 10,
-            group_size: int = 3,
-            with_payload: Union[bool, Sequence[str], types.PayloadSelector] = True,
-            with_vectors: Union[bool, Sequence[str]] = False,
-            score_threshold: Optional[float] = None,
-            with_lookup: Optional[types.WithLookupInterface] = None,
-            lookup_from: Optional[types.LookupLocation] = None,
-            consistency: Optional[types.ReadConsistency] = None,
-            shard_key_selector: Optional[types.ShardKeySelector] = None,
-            timeout: Optional[int] = None,
-            **kwargs: Any,
+        self,
+        collection_name: str,
+        group_by: str,
+        query: Union[
+            types.PointId,
+            List[float],
+            List[List[float]],
+            types.SparseVector,
+            types.Query,
+            types.NumpyArray,
+            types.Document,
+            None,
+        ] = None,
+        using: Optional[str] = None,
+        prefetch: Union[types.Prefetch, List[types.Prefetch], None] = None,
+        query_filter: Optional[types.Filter] = None,
+        search_params: Optional[types.SearchParams] = None,
+        limit: int = 10,
+        group_size: int = 3,
+        with_payload: Union[bool, Sequence[str], types.PayloadSelector] = True,
+        with_vectors: Union[bool, Sequence[str]] = False,
+        score_threshold: Optional[float] = None,
+        with_lookup: Optional[types.WithLookupInterface] = None,
+        lookup_from: Optional[types.LookupLocation] = None,
+        consistency: Optional[types.ReadConsistency] = None,
+        shard_key_selector: Optional[types.ShardKeySelector] = None,
+        timeout: Optional[int] = None,
+        **kwargs: Any,
     ) -> types.GroupsResult:
         if self._prefer_grpc:
             if isinstance(query, get_args(models.Query)):