Skip to content

Commit 0851fe3

Browse files
tsmith023tsmith023
authored
Merge pull request #1993 from renaudcepre/fix/export-public-filter-return-type
feat: export FilterReturn from weaviate.classes.query
2 parents f77f81b + b878db5 commit 0851fe3

76 files changed

Lines changed: 775 additions & 772 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎integration/test_collection_aggregate.py‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
Property,
2424
ReferenceProperty,
2525
)
26-
from weaviate.collections.classes.filters import Filter, _Filters
26+
from weaviate.collections.classes.filters import Filter, FilterReturn
2727
from weaviate.collections.classes.grpc import Move
2828
from weaviate.collections.classes.tenants import Tenant
2929
from weaviate.exceptions import (
@@ -153,7 +153,9 @@ def test_aggregation_groupby_no_results(collection_factory: CollectionFactory) -
153153
Filter.by_property("uuids").contains_any([UUID2]),
154154
],
155155
)
156-
def test_over_all_with_filters(collection_factory: CollectionFactory, filter_: _Filters) -> None:
156+
def test_over_all_with_filters(
157+
collection_factory: CollectionFactory, filter_: FilterReturn
158+
) -> None:
157159
collection = collection_factory(
158160
properties=[
159161
Property(name="text", data_type=DataType.TEXT),

‎integration/test_collection_filter.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
from integration.conftest import CollectionFactory
1010
from weaviate.collections.classes.config import Configure, DataType, Property, ReferenceProperty
1111
from weaviate.collections.classes.data import DataObject
12-
from weaviate.collections.classes.filters import Filter, _Filters, _FilterValue
12+
from weaviate.collections.classes.filters import Filter, FilterReturn, _FilterValue
1313
from weaviate.collections.classes.grpc import MetadataQuery, QueryReference, Sort
1414
from weaviate.collections.classes.internal import ReferenceToMulti
1515
from weaviate.types import UUID
@@ -34,7 +34,7 @@
3434
)
3535
def test_filters_text(
3636
collection_factory: CollectionFactory,
37-
weaviate_filter: _Filters,
37+
weaviate_filter: FilterReturn,
3838
results: List[int],
3939
) -> None:
4040
collection = collection_factory(
@@ -160,7 +160,7 @@ def test_filter_with_wrong_types(
160160
)
161161
def test_filters_nested(
162162
collection_factory: CollectionFactory,
163-
weaviate_filter: _Filters,
163+
weaviate_filter: FilterReturn,
164164
results: List[int],
165165
) -> None:
166166
collection = collection_factory(
@@ -401,7 +401,7 @@ def test_filters_contains(
401401
],
402402
)
403403
def test_ref_filters(
404-
collection_factory: CollectionFactory, weaviate_filter: _Filters, results: List[int]
404+
collection_factory: CollectionFactory, weaviate_filter: FilterReturn, results: List[int]
405405
) -> None:
406406
to_collection = collection_factory(
407407
name="Target",

‎weaviate/classes/query.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
from weaviate.collections.classes.aggregate import Metrics
2-
from weaviate.collections.classes.filters import Filter
2+
from weaviate.collections.classes.filters import Filter, FilterReturn
33
from weaviate.collections.classes.generative import GenerativeConfig
44
from weaviate.collections.classes.grpc import (
55
BM25OperatorFactory as BM25Operator,
@@ -22,6 +22,7 @@
2222

2323
__all__ = [
2424
"Filter",
25+
"FilterReturn",
2526
"GeoCoordinate",
2627
"GenerativeConfig",
2728
"GroupBy",

‎weaviate/collections/aggregations/base_executor.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
_MetricsText,
3131
)
3232
from weaviate.collections.classes.config import ConsistencyLevel
33-
from weaviate.collections.classes.filters import _Filters
33+
from weaviate.collections.classes.filters import FilterReturn
3434
from weaviate.collections.classes.grpc import Move
3535
from weaviate.collections.classes.types import GeoCoordinate
3636
from weaviate.collections.filters import _FilterToREST
@@ -326,13 +326,13 @@ def _add_groupby_to_builder(
326326
def _base(
327327
self,
328328
return_metrics: Optional[List[_Metrics]],
329-
filters: Optional[_Filters],
329+
filters: Optional[FilterReturn],
330330
total_count: bool,
331331
) -> AggregateBuilder:
332332
_validate_input(
333333
[
334334
_ValidateArgument([List[_Metrics], None], "return_metrics", return_metrics),
335-
_ValidateArgument([_Filters, None], "filters", filters),
335+
_ValidateArgument([FilterReturn, None], "filters", filters),
336336
_ValidateArgument([bool], "total_count", total_count),
337337
]
338338
)

‎weaviate/collections/aggregations/hybrid/async_.pyi‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ from weaviate.collections.classes.aggregate import (
66
GroupByAggregate,
77
PropertiesMetrics,
88
)
9-
from weaviate.collections.classes.filters import _Filters
9+
from weaviate.collections.classes.filters import FilterReturn
1010
from weaviate.collections.classes.grpc import BM25OperatorOptions
1111
from weaviate.connect.v4 import ConnectionAsync
1212
from weaviate.types import NUMBER
@@ -24,7 +24,7 @@ class _HybridAsync(_HybridExecutor[ConnectionAsync]):
2424
query_properties: Optional[List[str]] = None,
2525
object_limit: Optional[int] = None,
2626
bm25_operator: Optional[BM25OperatorOptions] = None,
27-
filters: Optional[_Filters] = None,
27+
filters: Optional[FilterReturn] = None,
2828
group_by: Literal[None] = None,
2929
target_vector: Optional[str] = None,
3030
max_vector_distance: Optional[float] = None,
@@ -41,7 +41,7 @@ class _HybridAsync(_HybridExecutor[ConnectionAsync]):
4141
query_properties: Optional[List[str]] = None,
4242
object_limit: Optional[int] = None,
4343
bm25_operator: Optional[BM25OperatorOptions] = None,
44-
filters: Optional[_Filters] = None,
44+
filters: Optional[FilterReturn] = None,
4545
group_by: Union[str, GroupByAggregate],
4646
target_vector: Optional[str] = None,
4747
max_vector_distance: Optional[float] = None,
@@ -58,7 +58,7 @@ class _HybridAsync(_HybridExecutor[ConnectionAsync]):
5858
query_properties: Optional[List[str]] = None,
5959
object_limit: Optional[int] = None,
6060
bm25_operator: Optional[BM25OperatorOptions] = None,
61-
filters: Optional[_Filters] = None,
61+
filters: Optional[FilterReturn] = None,
6262
group_by: Optional[Union[str, GroupByAggregate]] = None,
6363
target_vector: Optional[str] = None,
6464
max_vector_distance: Optional[float] = None,

‎weaviate/collections/aggregations/hybrid/executor.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
GroupByAggregate,
88
PropertiesMetrics,
99
)
10-
from weaviate.collections.classes.filters import _Filters
10+
from weaviate.collections.classes.filters import FilterReturn
1111
from weaviate.collections.classes.grpc import BM25OperatorOptions
1212
from weaviate.collections.filters import _FilterToGRPC
1313
from weaviate.connect import executor
@@ -27,7 +27,7 @@ def hybrid(
2727
query_properties: Optional[List[str]] = None,
2828
object_limit: Optional[int] = None,
2929
bm25_operator: Optional[BM25OperatorOptions] = None,
30-
filters: Optional[_Filters] = None,
30+
filters: Optional[FilterReturn] = None,
3131
group_by: Literal[None] = None,
3232
target_vector: Optional[str] = None,
3333
max_vector_distance: Optional[float] = None,
@@ -45,7 +45,7 @@ def hybrid(
4545
query_properties: Optional[List[str]] = None,
4646
object_limit: Optional[int] = None,
4747
bm25_operator: Optional[BM25OperatorOptions] = None,
48-
filters: Optional[_Filters] = None,
48+
filters: Optional[FilterReturn] = None,
4949
group_by: Union[str, GroupByAggregate],
5050
target_vector: Optional[str] = None,
5151
max_vector_distance: Optional[float] = None,
@@ -63,7 +63,7 @@ def hybrid(
6363
query_properties: Optional[List[str]] = None,
6464
object_limit: Optional[int] = None,
6565
bm25_operator: Optional[BM25OperatorOptions] = None,
66-
filters: Optional[_Filters] = None,
66+
filters: Optional[FilterReturn] = None,
6767
group_by: Optional[Union[str, GroupByAggregate]] = None,
6868
target_vector: Optional[str] = None,
6969
max_vector_distance: Optional[float] = None,
@@ -80,7 +80,7 @@ def hybrid(
8080
query_properties: Optional[List[str]] = None,
8181
object_limit: Optional[int] = None,
8282
bm25_operator: Optional[BM25OperatorOptions] = None,
83-
filters: Optional[_Filters] = None,
83+
filters: Optional[FilterReturn] = None,
8484
group_by: Optional[Union[str, GroupByAggregate]] = None,
8585
target_vector: Optional[str] = None,
8686
max_vector_distance: Optional[float] = None,

‎weaviate/collections/aggregations/hybrid/sync.pyi‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ from weaviate.collections.classes.aggregate import (
66
GroupByAggregate,
77
PropertiesMetrics,
88
)
9-
from weaviate.collections.classes.filters import _Filters
9+
from weaviate.collections.classes.filters import FilterReturn
1010
from weaviate.collections.classes.grpc import BM25OperatorOptions
1111
from weaviate.connect.v4 import ConnectionSync
1212
from weaviate.types import NUMBER
@@ -24,7 +24,7 @@ class _Hybrid(_HybridExecutor[ConnectionSync]):
2424
query_properties: Optional[List[str]] = None,
2525
object_limit: Optional[int] = None,
2626
bm25_operator: Optional[BM25OperatorOptions] = None,
27-
filters: Optional[_Filters] = None,
27+
filters: Optional[FilterReturn] = None,
2828
group_by: Literal[None] = None,
2929
target_vector: Optional[str] = None,
3030
max_vector_distance: Optional[float] = None,
@@ -41,7 +41,7 @@ class _Hybrid(_HybridExecutor[ConnectionSync]):
4141
query_properties: Optional[List[str]] = None,
4242
object_limit: Optional[int] = None,
4343
bm25_operator: Optional[BM25OperatorOptions] = None,
44-
filters: Optional[_Filters] = None,
44+
filters: Optional[FilterReturn] = None,
4545
group_by: Union[str, GroupByAggregate],
4646
target_vector: Optional[str] = None,
4747
max_vector_distance: Optional[float] = None,
@@ -58,7 +58,7 @@ class _Hybrid(_HybridExecutor[ConnectionSync]):
5858
query_properties: Optional[List[str]] = None,
5959
object_limit: Optional[int] = None,
6060
bm25_operator: Optional[BM25OperatorOptions] = None,
61-
filters: Optional[_Filters] = None,
61+
filters: Optional[FilterReturn] = None,
6262
group_by: Optional[Union[str, GroupByAggregate]] = None,
6363
target_vector: Optional[str] = None,
6464
max_vector_distance: Optional[float] = None,

‎weaviate/collections/aggregations/near_image/async_.pyi‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ from weaviate.collections.classes.aggregate import (
66
GroupByAggregate,
77
PropertiesMetrics,
88
)
9-
from weaviate.collections.classes.filters import _Filters
9+
from weaviate.collections.classes.filters import FilterReturn
1010
from weaviate.connect.v4 import ConnectionAsync
1111
from weaviate.types import BLOB_INPUT, NUMBER
1212

@@ -21,7 +21,7 @@ class _NearImageAsync(_NearImageExecutor[ConnectionAsync]):
2121
certainty: Optional[NUMBER] = None,
2222
distance: Optional[NUMBER] = None,
2323
object_limit: Optional[int] = None,
24-
filters: Optional[_Filters] = None,
24+
filters: Optional[FilterReturn] = None,
2525
group_by: Literal[None] = None,
2626
target_vector: Optional[str] = None,
2727
total_count: bool = True,
@@ -35,7 +35,7 @@ class _NearImageAsync(_NearImageExecutor[ConnectionAsync]):
3535
certainty: Optional[NUMBER] = None,
3636
distance: Optional[NUMBER] = None,
3737
object_limit: Optional[int] = None,
38-
filters: Optional[_Filters] = None,
38+
filters: Optional[FilterReturn] = None,
3939
group_by: Union[str, GroupByAggregate],
4040
target_vector: Optional[str] = None,
4141
total_count: bool = True,
@@ -49,7 +49,7 @@ class _NearImageAsync(_NearImageExecutor[ConnectionAsync]):
4949
certainty: Optional[NUMBER] = None,
5050
distance: Optional[NUMBER] = None,
5151
object_limit: Optional[int] = None,
52-
filters: Optional[_Filters] = None,
52+
filters: Optional[FilterReturn] = None,
5353
group_by: Optional[Union[str, GroupByAggregate]] = None,
5454
target_vector: Optional[str] = None,
5555
total_count: bool = True,

‎weaviate/collections/aggregations/near_image/executor.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
GroupByAggregate,
88
PropertiesMetrics,
99
)
10-
from weaviate.collections.classes.filters import _Filters
10+
from weaviate.collections.classes.filters import FilterReturn
1111
from weaviate.collections.filters import _FilterToGRPC
1212
from weaviate.connect import executor
1313
from weaviate.connect.v4 import ConnectionType
@@ -25,7 +25,7 @@ def near_image(
2525
certainty: Optional[NUMBER] = None,
2626
distance: Optional[NUMBER] = None,
2727
object_limit: Optional[int] = None,
28-
filters: Optional[_Filters] = None,
28+
filters: Optional[FilterReturn] = None,
2929
group_by: Literal[None] = None,
3030
target_vector: Optional[str] = None,
3131
total_count: bool = True,
@@ -40,7 +40,7 @@ def near_image(
4040
certainty: Optional[NUMBER] = None,
4141
distance: Optional[NUMBER] = None,
4242
object_limit: Optional[int] = None,
43-
filters: Optional[_Filters] = None,
43+
filters: Optional[FilterReturn] = None,
4444
group_by: Union[str, GroupByAggregate],
4545
target_vector: Optional[str] = None,
4646
total_count: bool = True,
@@ -55,7 +55,7 @@ def near_image(
5555
certainty: Optional[NUMBER] = None,
5656
distance: Optional[NUMBER] = None,
5757
object_limit: Optional[int] = None,
58-
filters: Optional[_Filters] = None,
58+
filters: Optional[FilterReturn] = None,
5959
group_by: Optional[Union[str, GroupByAggregate]] = None,
6060
target_vector: Optional[str] = None,
6161
total_count: bool = True,
@@ -69,7 +69,7 @@ def near_image(
6969
certainty: Optional[NUMBER] = None,
7070
distance: Optional[NUMBER] = None,
7171
object_limit: Optional[int] = None,
72-
filters: Optional[_Filters] = None,
72+
filters: Optional[FilterReturn] = None,
7373
group_by: Optional[Union[str, GroupByAggregate]] = None,
7474
target_vector: Optional[str] = None,
7575
total_count: bool = True,

‎weaviate/collections/aggregations/near_image/sync.pyi‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ from weaviate.collections.classes.aggregate import (
66
GroupByAggregate,
77
PropertiesMetrics,
88
)
9-
from weaviate.collections.classes.filters import _Filters
9+
from weaviate.collections.classes.filters import FilterReturn
1010
from weaviate.connect.v4 import ConnectionSync
1111
from weaviate.types import BLOB_INPUT, NUMBER
1212

@@ -21,7 +21,7 @@ class _NearImage(_NearImageExecutor[ConnectionSync]):
2121
certainty: Optional[NUMBER] = None,
2222
distance: Optional[NUMBER] = None,
2323
object_limit: Optional[int] = None,
24-
filters: Optional[_Filters] = None,
24+
filters: Optional[FilterReturn] = None,
2525
group_by: Literal[None] = None,
2626
target_vector: Optional[str] = None,
2727
total_count: bool = True,
@@ -35,7 +35,7 @@ class _NearImage(_NearImageExecutor[ConnectionSync]):
3535
certainty: Optional[NUMBER] = None,
3636
distance: Optional[NUMBER] = None,
3737
object_limit: Optional[int] = None,
38-
filters: Optional[_Filters] = None,
38+
filters: Optional[FilterReturn] = None,
3939
group_by: Union[str, GroupByAggregate],
4040
target_vector: Optional[str] = None,
4141
total_count: bool = True,
@@ -49,7 +49,7 @@ class _NearImage(_NearImageExecutor[ConnectionSync]):
4949
certainty: Optional[NUMBER] = None,
5050
distance: Optional[NUMBER] = None,
5151
object_limit: Optional[int] = None,
52-
filters: Optional[_Filters] = None,
52+
filters: Optional[FilterReturn] = None,
5353
group_by: Optional[Union[str, GroupByAggregate]] = None,
5454
target_vector: Optional[str] = None,
5555
total_count: bool = True,

0 commit comments

Comments
 (0)