Skip to content

Commit

Permalink
Corrected warning for when both the page_number and the page_offset p…
Browse files Browse the repository at this point in the history
…arameters are set.
  • Loading branch information
JPBergsma authored and ml-evs committed May 10, 2022
1 parent c346847 commit 52296b8
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 8 deletions.
10 changes: 8 additions & 2 deletions optimade/server/entry_collections/entry_collections.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,11 @@
from optimade.server.exceptions import BadRequest, Forbidden, NotFound
from optimade.server.mappers import BaseResourceMapper
from optimade.server.query_params import EntryListingQueryParams, SingleEntryQueryParams
from optimade.server.warnings import FieldValueNotRecognized, UnknownProviderProperty
from optimade.server.warnings import (
FieldValueNotRecognized,
UnknownProviderProperty,
QueryParamNotUsed,
)


def create_collection(
Expand Down Expand Up @@ -335,8 +339,10 @@ def handle_query_params(
if getattr(params, "page_offset", False):
if getattr(params, "page_number", False):
warnings.warn(
"Only one of the query parameters 'page_number' and 'page_offset' should be set - 'page_number' will be ignored."
message="Only one of the query parameters 'page_number' and 'page_offset' should be set - 'page_number' will be ignored.",
category=QueryParamNotUsed,
)

cursor_kwargs["skip"] = params.page_offset
elif getattr(params, "page_number", False):
if isinstance(params.page_number, int):
Expand Down
16 changes: 10 additions & 6 deletions tests/server/middleware/test_query_param.py
Original file line number Diff line number Diff line change
Expand Up @@ -149,11 +149,15 @@ def test_page_number_and_offset(check_response):
check_response(request, expected_ids=expected_ids)


def test_page_number_and_offset_both_set(check_error_response):
def test_page_number_and_offset_both_set(check_response):
request = "/structures?sort=last_modified&page_number=2&page_limit=5&page_offset=5"
check_error_response(
request,
expected_status=400,
expected_title="Bad Request",
expected_detail="Only one of the query parameters 'page-number' and 'page_offsest' should be set.",
expected_ids = ["mpf_30", "mpf_110", "mpf_200", "mpf_220", "mpf_259"]
expected_warnings = [
{
"title": "QueryParamNotUsed",
"detail": "Only one of the query parameters 'page_number' and 'page_offset' should be set - 'page_number' will be ignored.",
}
]
check_response(
request, expected_ids=expected_ids, expected_warnings=expected_warnings
)

0 comments on commit 52296b8

Please sign in to comment.