Skip to content
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

Support 'not' queries with @search endpoint. #1752

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Support 'not' queries with @search endpoint. #1752

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7c26758
Support 'not' queries with @search endpoint.
maethu Feb 20, 2024
7482d60
Merge branch 'main' into mle-support-not-queries-in-search
tisto Sep 5, 2024
761368a
Merge branch 'main' into mle-support-not-queries-in-search
tisto Sep 6, 2024
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
2 changes: 2 additions & 0 deletions news/1752.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Support 'not' queries with @search endpoint.
[mathias.leimgruber]
13 changes: 8 additions & 5 deletions src/plone/restapi/search/query.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,13 +171,16 @@ def parse_complex_query(self, idx_query):
idx_query = idx_query.copy()
parsed_query = {}

try:
qv = idx_query.pop("query")
parsed_query["query"] = self.parse_simple_query(qv)
except KeyError:
if "query" not in idx_query and "not" not in idx_query:
raise QueryParsingError(
"Query for index %r is missing a 'query' key!" % self.index
"Query for index %r is missing a 'query' or 'not' key!" % self.index
)
if "query" in idx_query:
qv = idx_query.pop("query")
parsed_query["query"] = self.parse_simple_query(qv)
if "not" in idx_query:
nt = idx_query.pop("not")
parsed_query["not"] = self.parse_simple_query(nt)

for opt_key, opt_value in idx_query.items():
if opt_key in self.query_options:
Expand Down
116 changes: 116 additions & 0 deletions src/plone/restapi/tests/test_search.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -416,6 +416,53 @@ def test_keyword_index_str_query_and(self):

self.assertEqual(["/plone/folder/doc"], result_paths(response.json()))

@unittest.skipUnless(HAS_PLONE_6, "'not' query support with Plone 6")
def test_keyword_index_not_as_list(self):
query = {"test_list_field.not": ["Keyword1", "Keyword2"]}
response = self.api_session.get("/@search", params=query)

self.assertEqual(
sorted(
[
"/plone",
"/plone/doc-outside-folder",
"/plone/folder",
"/plone/folder2",
"/plone/folder2/doc",
]
),
sorted(result_paths(response.json())),
)

@unittest.skipUnless(HAS_PLONE_6, "'not' query support with Plone 6")
def test_keyword_index_not_as_str(self):
query = {"test_list_field.not": "Keyword1"}
response = self.api_session.get("/@search", params=query)
self.assertEqual(
sorted(
[
"/plone",
"/plone/folder",
"/plone/folder/other-document",
"/plone/folder2",
"/plone/folder2/doc",
"/plone/doc-outside-folder",
]
),
sorted(result_paths(response.json())),
)

@unittest.skipUnless(HAS_PLONE_6, "'not' query support with Plone 6")
def test_keyword_index_query_and_not(self):
query = {
"test_list_field.query": "Keyword2",
"test_list_field.not": "Keyword1",
}
response = self.api_session.get("/@search", params=query)
self.assertEqual(
["/plone/folder/other-document"], result_paths(response.json())
)

# BooleanIndex

def test_boolean_index_query(self):
Expand Down Expand Up @@ -446,6 +493,35 @@ def test_field_index_int_range_query(self):

self.assertEqual(["/plone/folder/doc"], result_paths(response.json()))

@unittest.skipUnless(HAS_PLONE_6, "'not' query support with Plone 6")
def test_field_index_not_as_list(self):
query = {"portal_type.not": ["DXTestDocument", "Plone Site"]}
response = self.api_session.get("/@search", params=query)

self.assertEqual(
sorted(["/plone/folder", "/plone/folder2"]),
sorted(result_paths(response.json())),
)

@unittest.skipUnless(HAS_PLONE_6, "'not' query support with Plone 6")
def test_field_index_not_as_str(self):
query = {"portal_type.not": ["DXTestDocument"]}
response = self.api_session.get("/@search", params=query)

self.assertEqual(
sorted(["/plone/folder", "/plone/folder2", "/plone"]),
sorted(result_paths(response.json())),
)

@unittest.skipUnless(HAS_PLONE_6, "'not' query support with Plone 6")
def test_field_index_query_and_not(self):
query = {
"id.query": ["folder", "folder2"],
"id.not": "folder2",
}
response = self.api_session.get("/@search", params=query)
self.assertEqual(["/plone/folder"], result_paths(response.json()))

# ExtendedPathIndex

def test_extended_path_index_query(self):
Expand Down Expand Up @@ -555,6 +631,46 @@ def test_date_index_ranged_query(self):

self.assertEqual(["/plone/folder/doc"], result_paths(response.json()))

@unittest.skipUnless(HAS_PLONE_6, "'not' query support with Plone 6")
def test_date_index_not_as_list(self):
query = {
"start.not": [date(1950, 1, 1).isoformat(), date(1975, 1, 1).isoformat()]
}
response = self.api_session.get("/@search", params=query)

self.assertEqual(
sorted(
[
"/plone",
"/plone/folder",
"/plone/folder2",
"/plone/doc-outside-folder",
]
),
sorted(result_paths(response.json())),
)

@unittest.skipUnless(HAS_PLONE_6, "'not' query support with Plone 6")
def test_date_index_not_as_date(self):
query = {
"start.not": date(1950, 1, 1).isoformat(),
}
response = self.api_session.get("/@search", params=query)

self.assertEqual(
sorted(
[
"/plone",
"/plone/folder",
"/plone/folder/other-document",
"/plone/folder2",
"/plone/folder2/doc",
"/plone/doc-outside-folder",
]
),
sorted(result_paths(response.json())),
)

# DateRangeIndex

def test_date_range_index_query(self):
Expand Down
Loading