feat: accept PropertyIndexType enum for index_name arguments (#2098)

Adds a PropertyIndexType str-enum (SEARCHABLE, FILTERABLE,
RANGE_FILTERS) accepted alongside the IndexName literals on
update_property_index, rebuild_property_index,
cancel_property_index_task and delete_property_index (backward-
compatible widening of the v1.36 signature). The value is normalized to
its wire form at the top of each method so paths, params and error
messages never render the enum repr. Route-equality mock tests pin that
the enum and literal forms hit identical routes, incl. RANGE_FILTERS ->
rangeFilters. Read-side status types keep plain literals/str for
forward compatibility.

Author: g-despot

mock_tests/test_property_reindex.py

@@ -1,5 +1,5 @@
 import json
-from typing import Generator
+from typing import Generator, Union
 
 import grpc
 import pytest
@@ -11,6 +11,7 @@
 from weaviate.collections.classes.config import (
     PropertyIndexState,
     PropertyIndexTaskStatus,
+    PropertyIndexType,
     Tokenization,
 )
 from weaviate.exceptions import (
@@ -393,6 +394,67 @@ def test_get_property_indexes(
     weaviate_139_mock.check_assertions()
 
 
+@pytest.mark.parametrize(
+    "index_name,wire",
+    [
+        (PropertyIndexType.SEARCHABLE, "searchable"),
+        ("searchable", "searchable"),
+        (PropertyIndexType.RANGE_FILTERS, "rangeFilters"),
+        ("rangeFilters", "rangeFilters"),
+    ],
+)
+def test_update_property_index_enum_and_literal_hit_same_route(
+    weaviate_139_mock: HTTPServer,
+    client_139: weaviate.WeaviateClient,
+    index_name: Union[PropertyIndexType, str],
+    wire: str,
+) -> None:
+    """The enum and literal forms of index_name hit the exact same wire route."""
+    weaviate_139_mock.expect_request(
+        f"{SCHEMA_PATH}/properties/name/index/{wire}",
+        method="PUT",
+        json={},
+    ).respond_with_json({"taskId": TASK_ID, "status": "STARTED"}, status=202)
+
+    task = client_139.collections.use(COLLECTION).config.update_property_index(
+        "name",
+        index_name,  # type: ignore
+    )
+    assert task.status == PropertyIndexTaskStatus.STARTED
+    weaviate_139_mock.check_assertions()
+
+
+@pytest.mark.parametrize(
+    "index_name,wire",
+    [
+        (PropertyIndexType.SEARCHABLE, "searchable"),
+        ("searchable", "searchable"),
+        (PropertyIndexType.RANGE_FILTERS, "rangeFilters"),
+        ("rangeFilters", "rangeFilters"),
+    ],
+)
+def test_delete_property_index_enum_and_literal_hit_same_route(
+    weaviate_139_mock: HTTPServer,
+    client_139: weaviate.WeaviateClient,
+    index_name: Union[PropertyIndexType, str],
+    wire: str,
+) -> None:
+    """The enum and literal forms of index_name hit the exact same wire route."""
+    weaviate_139_mock.expect_request(
+        f"{SCHEMA_PATH}/properties/name/index/{wire}",
+        method="DELETE",
+    ).respond_with_json({}, status=200)
+
+    assert (
+        client_139.collections.use(COLLECTION).config.delete_property_index(
+            "name",
+            index_name,  # type: ignore
+        )
+        is True
+    )
+    weaviate_139_mock.check_assertions()
+
+
 def test_delete_property_index_surfaces_server_message(
     weaviate_139_mock: HTTPServer, client_139: weaviate.WeaviateClient
 ) -> None:

weaviate/classes/config.py

@@ -7,6 +7,7 @@
     PQEncoderDistribution,
     PQEncoderType,
     Property,
+    PropertyIndexType,
     Reconfigure,
     ReferenceProperty,
     ReplicationDeletionStrategy,
@@ -37,6 +38,7 @@
     "MultiVectorAggregation",
     "ReplicationDeletionStrategy",
     "Property",
+    "PropertyIndexType",
     "PQEncoderDistribution",
     "PQEncoderType",
     "ReferenceProperty",

weaviate/collections/classes/config.py

@@ -117,6 +117,20 @@
 ]
 
 
+class PropertyIndexType(str, BaseEnum):
+    """The available property index types in Weaviate.
+
+    Attributes:
+        SEARCHABLE: The searchable index, used for keyword (BM25) searches over text properties.
+        FILTERABLE: The filterable index, used for exact-match filtering.
+        RANGE_FILTERS: The rangeable index, used for range filtering.
+    """
+
+    SEARCHABLE = "searchable"
+    FILTERABLE = "filterable"
+    RANGE_FILTERS = "rangeFilters"
+
+
 class ConsistencyLevel(str, BaseEnum):
     """The consistency levels when writing to Weaviate with replication enabled.
 

weaviate/collections/config/async_.pyi

@@ -10,6 +10,7 @@ from weaviate.collections.classes.config import (
     Property,
     PropertyIndexStatus,
     PropertyIndexTask,
+    PropertyIndexType,
     ReferenceProperty,
     ShardStatus,
     ShardTypes,
@@ -93,12 +94,14 @@ class _ConfigCollectionAsync(_ConfigCollectionExecutor[ConnectionAsync]):
     async def add_vector(
         self, *, vector_config: Union[_VectorConfigCreate, List[_VectorConfigCreate]]
     ) -> None: ...
-    async def delete_property_index(self, property_name: str, index_name: IndexName) -> bool: ...
+    async def delete_property_index(
+        self, property_name: str, index_name: Union[PropertyIndexType, IndexName]
+    ) -> bool: ...
     @overload
     async def update_property_index(
         self,
         property_name: str,
-        index_name: IndexName,
+        index_name: Union[PropertyIndexType, IndexName],
         *,
         tokenization: Optional[Tokenization] = None,
         algorithm: Optional[Literal["blockmax"]] = None,
@@ -109,7 +112,7 @@ class _ConfigCollectionAsync(_ConfigCollectionExecutor[ConnectionAsync]):
     async def update_property_index(
         self,
         property_name: str,
-        index_name: IndexName,
+        index_name: Union[PropertyIndexType, IndexName],
         *,
         tokenization: Optional[Tokenization] = None,
         algorithm: Optional[Literal["blockmax"]] = None,
@@ -120,7 +123,7 @@ class _ConfigCollectionAsync(_ConfigCollectionExecutor[ConnectionAsync]):
     async def rebuild_property_index(
         self,
         property_name: str,
-        index_name: IndexName,
+        index_name: Union[PropertyIndexType, IndexName],
         *,
         tenants: Union[List[str], str, None] = None,
         wait_for_completion: Literal[True],
@@ -129,12 +132,12 @@ class _ConfigCollectionAsync(_ConfigCollectionExecutor[ConnectionAsync]):
     async def rebuild_property_index(
         self,
         property_name: str,
-        index_name: IndexName,
+        index_name: Union[PropertyIndexType, IndexName],
         *,
         tenants: Union[List[str], str, None] = None,
         wait_for_completion: Literal[False] = False,
     ) -> PropertyIndexTask: ...
     async def cancel_property_index_task(
-        self, property_name: str, index_name: IndexName
+        self, property_name: str, index_name: Union[PropertyIndexType, IndexName]
     ) -> PropertyIndexTask: ...
     async def get_property_indexes(self) -> CollectionPropertyIndexes: ...

weaviate/collections/config/executor.py

@@ -27,6 +27,7 @@
     PropertyIndexState,
     PropertyIndexStatus,
     PropertyIndexTask,
+    PropertyIndexType,
     PropertyType,
     ReferenceProperty,
     ShardStatus,
@@ -670,7 +671,7 @@ async def _execute() -> None:
     def delete_property_index(
         self,
         property_name: str,
-        index_name: IndexName,
+        index_name: Union[PropertyIndexType, IndexName],
     ) -> executor.Result[bool]:
         """Delete a property index from the collection in Weaviate.
 
@@ -686,6 +687,8 @@ def delete_property_index(
             weaviate.exceptions.UnexpectedStatusCodeError: If Weaviate reports a non-OK status.
             weaviate.exceptions.WeaviateInvalidInputError: If the property or index does not exist.
         """
+        if isinstance(index_name, PropertyIndexType):
+            index_name = cast(IndexName, index_name.value)
         _validate_input(
             [_ValidateArgument(expected=[str], name="property_name", value=property_name)]
         )
@@ -750,7 +753,7 @@ async def _execute() -> PropertyIndexStatus:
     def update_property_index(
         self,
         property_name: str,
-        index_name: IndexName,
+        index_name: Union[PropertyIndexType, IndexName],
         *,
         tokenization: Optional[Tokenization] = None,
         algorithm: Optional[Literal["blockmax"]] = None,
@@ -762,7 +765,7 @@ def update_property_index(
     def update_property_index(
         self,
         property_name: str,
-        index_name: IndexName,
+        index_name: Union[PropertyIndexType, IndexName],
         *,
         tokenization: Optional[Tokenization] = None,
         algorithm: Optional[Literal["blockmax"]] = None,
@@ -773,7 +776,7 @@ def update_property_index(
     def update_property_index(
         self,
         property_name: str,
-        index_name: IndexName,
+        index_name: Union[PropertyIndexType, IndexName],
         *,
         tokenization: Optional[Tokenization] = None,
         algorithm: Optional[Literal["blockmax"]] = None,
@@ -789,7 +792,8 @@ def update_property_index(
 
         Args:
             property_name: The property whose index to create or migrate.
-            index_name: The type of the index, one of `searchable`, `filterable` or `rangeFilters`.
+            index_name: The type of the index, a `PropertyIndexType` value or one of the literals
+                `searchable`, `filterable` or `rangeFilters`.
             tokenization: The tokenization of the index. Required when creating a `searchable` index;
                 optional as a change on an existing `searchable` or `filterable` index. Not valid for
                 `rangeFilters`.
@@ -811,6 +815,8 @@ def update_property_index(
             weaviate.exceptions.ReindexCanceledError: If `wait_for_completion=True` and the reindexing task was cancelled.
         """
         self.__check_property_reindex_support("Collection config update_property_index")
+        if isinstance(index_name, PropertyIndexType):
+            index_name = cast(IndexName, index_name.value)
         _validate_input(
             [_ValidateArgument(expected=[str], name="property_name", value=property_name)]
         )
@@ -878,7 +884,7 @@ async def _execute() -> Union[PropertyIndexTask, PropertyIndexStatus]:
     def rebuild_property_index(
         self,
         property_name: str,
-        index_name: IndexName,
+        index_name: Union[PropertyIndexType, IndexName],
         *,
         tenants: Union[List[str], str, None] = None,
         wait_for_completion: Literal[True],
@@ -888,7 +894,7 @@ def rebuild_property_index(
     def rebuild_property_index(
         self,
         property_name: str,
-        index_name: IndexName,
+        index_name: Union[PropertyIndexType, IndexName],
         *,
         tenants: Union[List[str], str, None] = None,
         wait_for_completion: Literal[False] = False,
@@ -897,7 +903,7 @@ def rebuild_property_index(
     def rebuild_property_index(
         self,
         property_name: str,
-        index_name: IndexName,
+        index_name: Union[PropertyIndexType, IndexName],
         *,
         tenants: Union[List[str], str, None] = None,
         wait_for_completion: bool = False,
@@ -906,7 +912,8 @@ def rebuild_property_index(
 
         Args:
             property_name: The property whose index to rebuild.
-            index_name: The type of the index, one of `searchable`, `filterable` or `rangeFilters`.
+            index_name: The type of the index, a `PropertyIndexType` value or one of the literals
+                `searchable`, `filterable` or `rangeFilters`.
             tenants: The tenant/list of tenants for which to rebuild the index on a multi-tenant
                 collection. If not provided, all tenants are affected.
             wait_for_completion: Whether to wait until the index reports `ready`. By default False.
@@ -923,6 +930,8 @@ def rebuild_property_index(
             weaviate.exceptions.ReindexCanceledError: If `wait_for_completion=True` and the reindexing task was cancelled.
         """
         self.__check_property_reindex_support("Collection config rebuild_property_index")
+        if isinstance(index_name, PropertyIndexType):
+            index_name = cast(IndexName, index_name.value)
         _validate_input(
             [_ValidateArgument(expected=[str], name="property_name", value=property_name)]
         )
@@ -982,7 +991,7 @@ async def _execute() -> Union[PropertyIndexTask, PropertyIndexStatus]:
     def cancel_property_index_task(
         self,
         property_name: str,
-        index_name: IndexName,
+        index_name: Union[PropertyIndexType, IndexName],
     ) -> executor.Result[PropertyIndexTask]:
         """Cancel the live reindexing task of a property index.
 
@@ -993,7 +1002,8 @@ def cancel_property_index_task(
 
         Args:
             property_name: The property whose reindexing task to cancel.
-            index_name: The type of the index, one of `searchable`, `filterable` or `rangeFilters`.
+            index_name: The type of the index, a `PropertyIndexType` value or one of the literals
+                `searchable`, `filterable` or `rangeFilters`.
 
         Returns:
             A `PropertyIndexTask` with status `CANCELLED` if a live task was cancelled or `NO_OP` otherwise.
@@ -1004,6 +1014,8 @@ def cancel_property_index_task(
             weaviate.exceptions.UnexpectedStatusCodeError: If Weaviate reports a non-OK status.
         """
         self.__check_property_reindex_support("Collection config cancel_property_index_task")
+        if isinstance(index_name, PropertyIndexType):
+            index_name = cast(IndexName, index_name.value)
         _validate_input(
             [_ValidateArgument(expected=[str], name="property_name", value=property_name)]
         )

weaviate/collections/config/sync.pyi

@@ -10,6 +10,7 @@ from weaviate.collections.classes.config import (
     Property,
     PropertyIndexStatus,
     PropertyIndexTask,
+    PropertyIndexType,
     ReferenceProperty,
     ShardStatus,
     ShardTypes,
@@ -91,12 +92,14 @@ class _ConfigCollection(_ConfigCollectionExecutor[ConnectionSync]):
     def add_vector(
         self, *, vector_config: Union[_VectorConfigCreate, List[_VectorConfigCreate]]
     ) -> None: ...
-    def delete_property_index(self, property_name: str, index_name: IndexName) -> bool: ...
+    def delete_property_index(
+        self, property_name: str, index_name: Union[PropertyIndexType, IndexName]
+    ) -> bool: ...
     @overload
     def update_property_index(
         self,
         property_name: str,
-        index_name: IndexName,
+        index_name: Union[PropertyIndexType, IndexName],
         *,
         tokenization: Optional[Tokenization] = None,
         algorithm: Optional[Literal["blockmax"]] = None,
@@ -107,7 +110,7 @@ class _ConfigCollection(_ConfigCollectionExecutor[ConnectionSync]):
     def update_property_index(
         self,
         property_name: str,
-        index_name: IndexName,
+        index_name: Union[PropertyIndexType, IndexName],
         *,
         tokenization: Optional[Tokenization] = None,
         algorithm: Optional[Literal["blockmax"]] = None,
@@ -118,7 +121,7 @@ class _ConfigCollection(_ConfigCollectionExecutor[ConnectionSync]):
     def rebuild_property_index(
         self,
         property_name: str,
-        index_name: IndexName,
+        index_name: Union[PropertyIndexType, IndexName],
         *,
         tenants: Union[List[str], str, None] = None,
         wait_for_completion: Literal[True],
@@ -127,12 +130,12 @@ class _ConfigCollection(_ConfigCollectionExecutor[ConnectionSync]):
     def rebuild_property_index(
         self,
         property_name: str,
-        index_name: IndexName,
+        index_name: Union[PropertyIndexType, IndexName],
         *,
         tenants: Union[List[str], str, None] = None,
         wait_for_completion: Literal[False] = False,
     ) -> PropertyIndexTask: ...
     def cancel_property_index_task(
-        self, property_name: str, index_name: IndexName
+        self, property_name: str, index_name: Union[PropertyIndexType, IndexName]
     ) -> PropertyIndexTask: ...
     def get_property_indexes(self) -> CollectionPropertyIndexes: ...