Merge branch 'main' of https://github.com/weaviate/weaviate-python-client into dev/1.32

tsmith023 · tsmith023 · commit dd929bf361ca · 2025-07-10T12:51:54.000+01:00
diff --git a/integration/test_tenants.py b/integration/test_tenants.py
@@ -504,3 +504,24 @@ def test_tenants_auto_tenant_creation(
                 collection=collection.name, properties={"name": "some name"}, tenant=f"tenant-{i}"
             )
     assert len(client.batch.failed_objects) == 0
+
+
+def test_tenants_deactivate_then_activate(collection_factory: CollectionFactory) -> None:
+    collection = collection_factory(
+        properties=[Property(name="name", data_type=DataType.TEXT)],
+        vectorizer_config=Configure.Vectorizer.none(),
+        multi_tenancy_config=Configure.multi_tenancy(enabled=True),
+    )
+
+    t = Tenant(name="tenant1")
+    collection.tenants.create([t])
+    tenant1 = collection.with_tenant(t)
+
+    tenant1.data.insert(properties={"name": "some name"})
+    assert tenant1.query.fetch_objects().objects[0].properties["name"] == "some name"
+
+    collection.tenants.deactivate(t)
+    assert collection.tenants.get()["tenant1"].activity_status == TenantActivityStatus.INACTIVE
+
+    collection.tenants.activate(t)
+    assert tenant1.query.fetch_objects().objects[0].properties["name"] == "some name"
diff --git a/requirements-devel.txt b/requirements-devel.txt
@@ -20,7 +20,7 @@ importlib_metadata==8.7.0
 tomli==2.2.1
 types-protobuf==6.30.2.20250703
 types-urllib3==1.26.25.14
-typing_extensions==4.14.0
+typing_extensions==4.14.1
 
 pre-commit
 flake8
diff --git a/weaviate/collections/tenants/async_.pyi b/weaviate/collections/tenants/async_.pyi
@@ -1,8 +1,8 @@
 from typing import Dict, Optional, Sequence, Union
 
-from weaviate.collections.classes.tenants import Tenant
 from weaviate.collections.tenants.types import (
     TenantCreateInputType,
+    TenantInputType,
     TenantOutputType,
     TenantUpdateInputType,
 )
@@ -14,13 +14,18 @@ class _TenantsAsync(_TenantsExecutor[ConnectionAsync]):
     async def create(
         self, tenants: Union[TenantCreateInputType, Sequence[TenantCreateInputType]]
     ) -> None: ...
-    async def remove(self, tenants: Union[str, Tenant, Sequence[Union[str, Tenant]]]) -> None: ...
+    async def remove(self, tenants: Union[TenantInputType, Sequence[TenantInputType]]) -> None: ...
     async def get(self) -> Dict[str, TenantOutputType]: ...
     async def get_by_names(
-        self, tenants: Sequence[Union[str, Tenant]]
+        self, tenants: Sequence[TenantInputType]
     ) -> Dict[str, TenantOutputType]: ...
-    async def get_by_name(self, tenant: Union[str, Tenant]) -> Optional[TenantOutputType]: ...
+    async def get_by_name(self, tenant: TenantInputType) -> Optional[TenantOutputType]: ...
     async def update(
         self, tenants: Union[TenantUpdateInputType, Sequence[TenantUpdateInputType]]
     ) -> None: ...
-    async def exists(self, tenant: Union[str, Tenant]) -> bool: ...
+    async def exists(self, tenant: TenantInputType) -> bool: ...
+    async def activate(self, tenant: Union[TenantInputType, Sequence[TenantInputType]]) -> None: ...
+    async def deactivate(
+        self, tenant: Union[TenantInputType, Sequence[TenantInputType]]
+    ) -> None: ...
+    async def offload(self, tenant: Union[TenantInputType, Sequence[TenantInputType]]) -> None: ...
diff --git a/weaviate/collections/tenants/executor.py b/weaviate/collections/tenants/executor.py
@@ -16,6 +16,7 @@
 from weaviate.collections.grpc.tenants import _TenantsGRPC
 from weaviate.collections.tenants.types import (
     TenantCreateInputType,
+    TenantInputType,
     TenantOutputType,
     TenantUpdateInputType,
 )
@@ -47,7 +48,7 @@ def create(
         self,
         tenants: Union[TenantCreateInputType, Sequence[TenantCreateInputType]],
     ) -> executor.Result[None]:
-        """Create the specified tenants for a collection in Weaviate.
+        """Create the specified tenants for this collection in Weaviate.
 
         The collection must have been created with multi-tenancy enabled.
 
@@ -94,9 +95,9 @@ def resp(res: Response) -> None:
 
     def remove(
         self,
-        tenants: Union[str, Tenant, Sequence[Union[str, Tenant]]],
+        tenants: Union[TenantInputType, Sequence[TenantInputType]],
     ) -> executor.Result[None]:
-        """Remove the specified tenants from a collection in Weaviate.
+        """Remove the specified tenants from this collection in Weaviate.
 
         The collection must have been created with multi-tenancy enabled.
 
@@ -170,7 +171,7 @@ def resp(res: Response) -> Dict[str, TenantOutputType]:
         )
 
     def __get_with_grpc(
-        self, *, tenants: Optional[Sequence[Union[str, Tenant]]] = None
+        self, *, tenants: Optional[Sequence[TenantInputType]] = None
     ) -> executor.Result[Dict[str, TenantOutputType]]:
         names = (
             [tenant.name if isinstance(tenant, Tenant) else tenant for tenant in tenants]
@@ -228,7 +229,7 @@ def __map_update_tenant(self, tenant: TenantUpdateInputType) -> TenantUpdate:
 
     def __map_create_tenants(
         self,
-        tenants: Union[str, Tenant, TenantCreate, Sequence[Union[str, Tenant, TenantCreate]]],
+        tenants: Union[TenantCreateInputType, Sequence[TenantCreateInputType]],
     ) -> List[dict]:
         if (
             isinstance(tenants, str)
@@ -260,7 +261,7 @@ def __map_update_tenants(
             ]
 
     def get(self) -> executor.Result[Dict[str, TenantOutputType]]:
-        """Return all tenants currently associated with a collection in Weaviate.
+        """Return all tenants currently associated with this collection in Weaviate.
 
         The collection must have been created with multi-tenancy enabled.
 
@@ -282,9 +283,9 @@ def resp(res: Dict[str, TenantOutputType]) -> Dict[str, TenantOutputType]:
         )
 
     def get_by_names(
-        self, tenants: Sequence[Union[str, Tenant]]
+        self, tenants: Sequence[TenantInputType]
     ) -> executor.Result[Dict[str, TenantOutputType]]:
-        """Return named tenants currently associated with a collection in Weaviate.
+        """Return named tenants currently associated with this collection in Weaviate.
 
         If the tenant does not exist, it will not be included in the response.
         If no names are provided, all tenants will be returned.
@@ -308,10 +309,8 @@ def get_by_names(
             )
         return self.__get_with_grpc(tenants=tenants)
 
-    def get_by_name(
-        self, tenant: Union[str, Tenant]
-    ) -> executor.Result[Optional[TenantOutputType]]:
-        """Return a specific tenant associated with a collection in Weaviate.
+    def get_by_name(self, tenant: TenantInputType) -> executor.Result[Optional[TenantOutputType]]:
+        """Return a specific tenant associated with this collection in Weaviate.
 
         If the tenant does not exist, `None` will be returned.
 
@@ -405,7 +404,7 @@ def update(
         self,
         tenants: Union[TenantUpdateInputType, Sequence[TenantUpdateInputType]],
     ) -> executor.Result[None]:
-        """Update the specified tenants for a collection in Weaviate.
+        """Update the specified tenants for this collection in Weaviate.
 
         The collection must have been created with multi-tenancy enabled.
 
@@ -432,8 +431,8 @@ def update(
             )
         return self.__update(tenants=tenants)
 
-    def exists(self, tenant: Union[str, Tenant]) -> executor.Result[bool]:
-        """Check if a tenant exists for a collection in Weaviate.
+    def exists(self, tenant: TenantInputType) -> executor.Result[bool]:
+        """Check if a tenant exists for this collection in Weaviate.
 
         The collection must have been created with multi-tenancy enabled.
 
@@ -451,7 +450,7 @@ def exists(self, tenant: Union[str, Tenant]) -> executor.Result[bool]:
         if self._validate_arguments:
             _validate_input(
                 _ValidateArgument(
-                    expected=[str, Tenant, Sequence[Union[str, Tenant]]],
+                    expected=[str, Tenant],
                     name="tenant",
                     value=tenant,
                 )
@@ -471,3 +470,100 @@ def resp(res: Response) -> bool:
                 ok_in=[200, 404], error=f"Check if tenant exists for {self._name}"
             ),  # allow 404 to perform bool check on response code
         )
+
+    def __update_tenant_activity_status(
+        self,
+        tenant: Union[TenantInputType, Sequence[TenantInputType]],
+        activity_status: TenantUpdateActivityStatus,
+    ) -> executor.Result[None]:
+        if self._validate_arguments:
+            _validate_input(
+                _ValidateArgument(
+                    expected=[
+                        str,
+                        Tenant,
+                        Sequence[Union[str, Tenant]],
+                    ],
+                    name="tenant",
+                    value=tenant,
+                )
+            )
+        if isinstance(tenant, str) or isinstance(tenant, Tenant):
+            tenants = [
+                TenantUpdate(
+                    name=tenant.name if isinstance(tenant, Tenant) else tenant,
+                    activity_status=activity_status,
+                )
+            ]
+        else:
+            tenants = [
+                TenantUpdate(
+                    name=t.name if isinstance(t, Tenant) else t,
+                    activity_status=activity_status,
+                )
+                for t in tenant
+            ]
+        return self.__update(tenants=tenants)
+
+    def activate(
+        self, tenant: Union[TenantInputType, Sequence[TenantInputType]]
+    ) -> executor.Result[None]:
+        """Activate the specified tenants for this collection in Weaviate.
+
+        The collection must have been created with multi-tenancy enabled.
+
+        Args:
+            tenant: A tenant name, `wvc.config.tenants.Tenant` object, or a list of tenants names
+                and/or `wvc.config.tenants.Tenant` objects to activate for the given collection.
+
+        Raises:
+            weaviate.exceptions.WeaviateConnectionError: If the network connection to Weaviate fails.
+            weaviate.exceptions.UnexpectedStatusCodeError: If Weaviate reports a non-OK status.
+            weaviate.exceptions.WeaviateInvalidInputError: If `tenant` is not a list of `wvc.Tenant` objects.
+        """
+        self.__update_tenant_activity_status(
+            tenant=tenant,
+            activity_status=TenantUpdateActivityStatus.ACTIVE,
+        )
+
+    def deactivate(
+        self, tenant: Union[TenantInputType, Sequence[TenantInputType]]
+    ) -> executor.Result[None]:
+        """Deactivate the specified tenants for this collection in Weaviate.
+
+        The collection must have been created with multi-tenancy enabled.
+
+        Args:
+            tenant: A tenant name, `wvc.config.tenants.Tenant` object, or a list of tenants names
+                and/or `wvc.config.tenants.Tenant` objects to deactivate for the given collection.
+
+        Raises:
+            weaviate.exceptions.WeaviateConnectionError: If the network connection to Weaviate fails.
+            weaviate.exceptions.UnexpectedStatusCodeError: If Weaviate reports a non-OK status.
+            weaviate.exceptions.WeaviateInvalidInputError: If `tenant` is not a list of `wvc.Tenant` objects.
+        """
+        self.__update_tenant_activity_status(
+            tenant=tenant,
+            activity_status=TenantUpdateActivityStatus.INACTIVE,
+        )
+
+    def offload(
+        self, tenant: Union[TenantInputType, Sequence[TenantInputType]]
+    ) -> executor.Result[None]:
+        """Offload the specified tenants for this collection in Weaviate.
+
+        The collection must have been created with multi-tenancy enabled.
+
+        Args:
+            tenant: A tenant name, `wvc.config.tenants.Tenant` object, or a list of tenants names
+                and/or `wvc.config.tenants.Tenant` objects to offload for the given collection.
+
+        Raises:
+            weaviate.exceptions.WeaviateConnectionError: If the network connection to Weaviate fails.
+            weaviate.exceptions.UnexpectedStatusCodeError: If Weaviate reports a non-OK status.
+            weaviate.exceptions.WeaviateInvalidInputError: If `tenant` is not a list of `wvc.Tenant` objects.
+        """
+        self.__update_tenant_activity_status(
+            tenant=tenant,
+            activity_status=TenantUpdateActivityStatus.OFFLOADED,
+        )
diff --git a/weaviate/collections/tenants/sync.pyi b/weaviate/collections/tenants/sync.pyi
@@ -1,8 +1,8 @@
 from typing import Dict, Optional, Sequence, Union
 
-from weaviate.collections.classes.tenants import Tenant
 from weaviate.collections.tenants.types import (
     TenantCreateInputType,
+    TenantInputType,
     TenantOutputType,
     TenantUpdateInputType,
 )
@@ -14,13 +14,14 @@ class _Tenants(_TenantsExecutor[ConnectionSync]):
     def create(
         self, tenants: Union[TenantCreateInputType, Sequence[TenantCreateInputType]]
     ) -> None: ...
-    def remove(self, tenants: Union[str, Tenant, Sequence[Union[str, Tenant]]]) -> None: ...
+    def remove(self, tenants: Union[TenantInputType, Sequence[TenantInputType]]) -> None: ...
     def get(self) -> Dict[str, TenantOutputType]: ...
-    def get_by_names(
-        self, tenants: Sequence[Union[str, Tenant]]
-    ) -> Dict[str, TenantOutputType]: ...
-    def get_by_name(self, tenant: Union[str, Tenant]) -> Optional[TenantOutputType]: ...
+    def get_by_names(self, tenants: Sequence[TenantInputType]) -> Dict[str, TenantOutputType]: ...
+    def get_by_name(self, tenant: TenantInputType) -> Optional[TenantOutputType]: ...
     def update(
         self, tenants: Union[TenantUpdateInputType, Sequence[TenantUpdateInputType]]
     ) -> None: ...
-    def exists(self, tenant: Union[str, Tenant]) -> bool: ...
+    def exists(self, tenant: TenantInputType) -> bool: ...
+    def activate(self, tenant: Union[TenantInputType, Sequence[TenantInputType]]) -> None: ...
+    def deactivate(self, tenant: Union[TenantInputType, Sequence[TenantInputType]]) -> None: ...
+    def offload(self, tenant: Union[TenantInputType, Sequence[TenantInputType]]) -> None: ...
diff --git a/weaviate/collections/tenants/types.py b/weaviate/collections/tenants/types.py
@@ -2,6 +2,7 @@
 
 from weaviate.collections.classes.tenants import Tenant, TenantCreate, TenantUpdate
 
+TenantInputType = Union[str, Tenant]
 TenantCreateInputType = Union[str, Tenant, TenantCreate]
 TenantUpdateInputType = Union[Tenant, TenantUpdate]
 TenantOutputType = Tenant
