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

Add feature: sort queryparams can be relationship fileds #111

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

Add feature: sort queryparams can be relationship fileds #111

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
bf85573
Add feature:
Aug 15, 2018
a17d9e7
add missing ')'
Aug 15, 2018
05106a4
Modify testcase
Aug 15, 2018
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
7 changes: 6 additions & 1 deletion flask_rest_jsonapi/data_layers/alchemy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -452,7 +452,12 @@ def sort_query(self, query, sort_info):
field = sort_opt['field']
if not hasattr(self.model, field):
raise InvalidSort("{} has no attribute {}".format(self.model.__name__, field))
query = query.order_by(getattr(getattr(self.model, field), sort_opt['order'])())
if sort_opt['relationship']:
relationField = getattr(self.model, field)
relationClass = relationField.mapper.class_
query = query.join(relationField).order_by(getattr(getattr(relationClass, 'id'), sort_opt['order'])())
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is not good to use the id field because it can not exists. For example I never name my primary keys as id.

else:
query = query.order_by(getattr(getattr(self.model, field), sort_opt['order'])())
return query

def paginate_query(self, query, paginate_info):
Expand Down
6 changes: 4 additions & 2 deletions flask_rest_jsonapi/querystring.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,14 +165,16 @@ def sorting(self):
if self.qs.get('sort'):
sorting_results = []
for sort_field in self.qs['sort'].split(','):
relationship = False
field = sort_field.replace('-', '')
if field not in self.schema._declared_fields:
raise InvalidSort("{} has no attribute {}".format(self.schema.__name__, field))
if field in get_relationships(self.schema):
raise InvalidSort("You can't sort on {} because it is a relationship field".format(field))
#raise InvalidSort("You can't sort on {} because it is a relationship field".format(field))
relationship = True
field = get_model_field(self.schema, field)
order = 'desc' if sort_field.startswith('-') else 'asc'
sorting_results.append({'field': field, 'order': order})
sorting_results.append({'field': field, 'order': order, 'relationship': relationship})
return sorting_results

return []
Expand Down
46 changes: 43 additions & 3 deletions tests/test_sqlalchemy_data_layer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,9 +389,9 @@ def test_query_string_manager(person_schema):
qsm = QSManager(query_string, person_schema)
with pytest.raises(BadRequest):
qsm.pagination
qsm.qs['sort'] = 'computers'
with pytest.raises(InvalidSort):
qsm.sorting
#qsm.qs['sort'] = 'computers'
#with pytest.raises(InvalidSort):
#qsm.sorting


def test_resource(app, person_model, person_schema, session, monkeypatch):
Expand Down Expand Up @@ -474,6 +474,46 @@ def test_get_list(client, register_routes, person, person_2):
response = client.get('/persons' + '?' + querystring, content_type='application/vnd.api+json')
assert response.status_code == 200

def test_get_list_sort_relationship(client, register_routes, person, person_2):
with client:
querystring = urlencode({'page[number]': 1,
'page[size]': 1,
'fields[person]': 'name,birth_date',
'sort': '-computers',
'include': 'computers.owner',
'filter': json.dumps(
[
{
'and': [
{
'name': 'computers',
'op': 'any',
'val': {
'name': 'serial',
'op': 'eq',
'val': '0000'
}
},
{
'or': [
{
'name': 'name',
'op': 'like',
'val': '%test%'
},
{
'name': 'name',
'op': 'like',
'val': '%test2%'
}
]
}
]
}
])})
response = client.get('/persons' + '?' + querystring, content_type='application/vnd.api+json')
assert response.status_code == 200


def test_get_list_disable_pagination(client, register_routes):
with client:
Expand Down