Skip to content

Fix empty list filter raising IndexError instead of WeaviateInvalidInputError #1942

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
metawake wants to merge 1 commit into
base: main
Choose a base branch
from
+78 −3
Open

Fix empty list filter raising IndexError instead of WeaviateInvalidInputError #1942

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions test/collection/test_filter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,36 @@ def test_empty_input_contains_all() -> None:
wvc.query.Filter.by_property("test").contains_all([])


def test_empty_list_equal() -> None:
with pytest.raises(weaviate.exceptions.WeaviateInvalidInputError):
wvc.query.Filter.by_property("test").equal([])


def test_empty_list_not_equal() -> None:
with pytest.raises(weaviate.exceptions.WeaviateInvalidInputError):
wvc.query.Filter.by_property("test").not_equal([])


def test_empty_list_less_than() -> None:
with pytest.raises(weaviate.exceptions.WeaviateInvalidInputError):
wvc.query.Filter.by_property("test").less_than([])


def test_empty_list_less_or_equal() -> None:
with pytest.raises(weaviate.exceptions.WeaviateInvalidInputError):
wvc.query.Filter.by_property("test").less_or_equal([])


def test_empty_list_greater_than() -> None:
with pytest.raises(weaviate.exceptions.WeaviateInvalidInputError):
wvc.query.Filter.by_property("test").greater_than([])


def test_empty_list_greater_or_equal() -> None:
with pytest.raises(weaviate.exceptions.WeaviateInvalidInputError):
wvc.query.Filter.by_property("test").greater_or_equal([])


def test_filter_lists() -> None:
f1 = wvc.query.Filter.by_property("test").equal("test")
f2 = wvc.query.Filter.by_creation_time().greater_or_equal(datetime.datetime.now())
Expand Down
36 changes: 36 additions & 0 deletions weaviate/collections/classes/filters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,18 +220,42 @@ def contains_none(self, val: FilterValuesList) -> _Filters:

def equal(self, val: FilterValues) -> _Filters:
"""Filter on whether the property is equal to the given value."""
if isinstance(val, list) and len(val) == 0:
raise WeaviateInvalidInputError(
"Filtering on empty lists is not supported by Weaviate. "
"To filter by property length, use "
"Filter.by_property('prop', length=True).equal(0)"
)
return _FilterValue(target=self._target_path(), value=val, operator=_Operator.EQUAL)

def not_equal(self, val: FilterValues) -> _Filters:
"""Filter on whether the property is not equal to the given value."""
if isinstance(val, list) and len(val) == 0:
raise WeaviateInvalidInputError(
"Filtering on empty lists is not supported by Weaviate. "
"To filter by property length, use "
"Filter.by_property('prop', length=True).equal(0)"
)
return _FilterValue(target=self._target_path(), value=val, operator=_Operator.NOT_EQUAL)

def less_than(self, val: FilterValues) -> _Filters:
"""Filter on whether the property is less than the given value."""
if isinstance(val, list) and len(val) == 0:
raise WeaviateInvalidInputError(
"Filtering on empty lists is not supported by Weaviate. "
"To filter by property length, use "
"Filter.by_property('prop', length=True).equal(0)"
)
return _FilterValue(target=self._target_path(), value=val, operator=_Operator.LESS_THAN)

def less_or_equal(self, val: FilterValues) -> _Filters:
"""Filter on whether the property is less than or equal to the given value."""
if isinstance(val, list) and len(val) == 0:
raise WeaviateInvalidInputError(
"Filtering on empty lists is not supported by Weaviate. "
"To filter by property length, use "
"Filter.by_property('prop', length=True).equal(0)"
)
return _FilterValue(
target=self._target_path(),
value=val,
Expand All @@ -240,6 +264,12 @@ def less_or_equal(self, val: FilterValues) -> _Filters:

def greater_than(self, val: FilterValues) -> _Filters:
"""Filter on whether the property is greater than the given value."""
if isinstance(val, list) and len(val) == 0:
raise WeaviateInvalidInputError(
"Filtering on empty lists is not supported by Weaviate. "
"To filter by property length, use "
"Filter.by_property('prop', length=True).equal(0)"
)
return _FilterValue(
target=self._target_path(),
value=val,
Expand All @@ -248,6 +278,12 @@ def greater_than(self, val: FilterValues) -> _Filters:

def greater_or_equal(self, val: FilterValues) -> _Filters:
"""Filter on whether the property is greater than or equal to the given value."""
if isinstance(val, list) and len(val) == 0:
raise WeaviateInvalidInputError(
"Filtering on empty lists is not supported by Weaviate. "
"To filter by property length, use "
"Filter.by_property('prop', length=True).equal(0)"
)
return _FilterValue(
target=self._target_path(),
value=val,
Expand Down
15 changes: 12 additions & 3 deletions weaviate/collections/filters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,9 @@ def __filter_to_text(value: FilterValues) -> Optional[str]:

@staticmethod
def __filter_to_text_list(value: FilterValues) -> Optional[base_pb2.TextArray]:
if not isinstance(value, list) or not (
if not isinstance(value, list) or len(value) == 0:
return None
if not (
isinstance(value[0], TIME)
or isinstance(value[0], str)
or isinstance(value[0], uuid_lib.UUID)
Expand All @@ -135,14 +137,14 @@ def __filter_to_text_list(value: FilterValues) -> Optional[base_pb2.TextArray]:

@staticmethod
def __filter_to_bool_list(value: FilterValues) -> Optional[base_pb2.BooleanArray]:
if not isinstance(value, list) or not isinstance(value[0], bool):
if not isinstance(value, list) or len(value) == 0 or not isinstance(value[0], bool):
return None

return base_pb2.BooleanArray(values=cast(List[bool], value))

@staticmethod
def __filter_to_float_list(value: FilterValues) -> Optional[base_pb2.NumberArray]:
if not isinstance(value, list) or not isinstance(value[0], float):
if not isinstance(value, list) or len(value) == 0 or not isinstance(value[0], float):
return None

return base_pb2.NumberArray(values=cast(List[float], value))
Expand All @@ -152,6 +154,7 @@ def __filter_to_int_list(value: FilterValues) -> Optional[base_pb2.IntArray]:
# bool is a subclass of int in Python, so the check must ensure it's not a bool
if (
not isinstance(value, list)
or len(value) == 0
or not isinstance(value[0], int)
or isinstance(value[0], bool)
):
Expand Down Expand Up @@ -224,6 +227,12 @@ def __parse_filter(value: FilterValues) -> Dict[str, Any]:
if isinstance(value, float):
return {"valueNumber": value}
if isinstance(value, list):
if len(value) == 0:
raise WeaviateInvalidInputError(
"Filtering on empty lists is not supported by Weaviate. "
"To filter by property length, use "
"Filter.by_property('prop', length=True).equal(0)"
)
if isinstance(value[0], str):
return {"valueTextArray": value}
if isinstance(value[0], uuid_lib.UUID):
Expand Down
Loading