8000 add support for sort in collection.find function by denizalpaslan · Pull Request #359 · arangodb/python-arango · GitHub
[go: up one dir, main page]
Skip to content

add support for sort in collection.find function #359

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

Merged
merged 7 commits into from
Jan 31, 2025
Merged

add support for sort in collection.find function #359

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
32cdc62
add support for sort in collection.find function
Jan 26, 2025
107df52
update sort parameter type. add SortValidationError as custom exception
Jan 30, 2025
1149f01
Update arango/collection.py
denizalpaslan Jan 30, 2025
df2ab2f
Update arango/collection.py
denizalpaslan Jan 30, 2025
71776c3
update utils.py and collection.py to raise SortValidationError
Jan 30, 2025
856743a
update utils.py for build_sort_expression to accept Jsons or None
Jan 30, 2025
bedc4d4
Update arango/collection.py
apetenchea Jan 31, 2025
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
Prev Previous commit
update utils.py and collection.py to raise SortValidationError
  • Loading branch information
Deniz Alpaslan committed Jan 30, 2025
commit 71776c3f5baf81f440caf1095658758cc6d19e4d
1 change: 1 addition & 0 deletions arango/collection.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -773,6 +773,7 @@ def find(
:return: Document cursor.
:rtype: arango.cursor.Cursor
:raise arango.exceptions.DocumentGetError: If retrieval fails.
:raise arango.exceptions.SortValidationError: If sort parameters are invalid.
"""
assert isinstance(filters, dict), "filters must be a dict"
assert is_none_or_int(skip), "skip must be a non-negative int"
Expand Down
8 changes: 4 additions & 4 deletions arango/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
from contextlib import contextmanager
from typing import Any, Iterator, Sequence, Union

from arango.exceptions import DocumentParseError
from arango.exceptions import DocumentParseError, SortValidationError
from arango.typings import Json, Jsons


Expand Down Expand Up @@ -135,16 +135,16 @@ def validate_sort_parameters(sort: Sequence[Json]) -> bool:
:type sort: Sequence[Json]
:return: Validation success.
:rtype: bool
:raise arango.exceptions.DocumentGetError: If sort parameters are invalid.
:raise arango.exceptions.SortValidationError: If sort parameters are invalid.
"""
assert isinstance(sort, Sequence)
for param in sort:
if "sort_by" not in param or "sort_order" not in param:
raise DocumentParseError(
raise SortValidationError(
"Each sort parameter must have 'sort_by' and 'sort_order'."
)
if param["sort_order"].upper() not in ["ASC", "DESC"]:
raise DocumentParseError("'sort_order' must be either 'ASC' or 'DESC'")
raise SortValidationError("'sort_order' must be either 'ASC' or 'DESC'")
return True


Expand Down
0