def test_wrong_sort_format(self, session, sort):
query = session.query(Bar)
order_by = [sort]
with pytest.raises(BadSortFormat) as err:
apply_sort(query, order_by)
expected_error = 'Sort spec `{}` should be a dictionary.'.format(sort)
assert expected_error == error_value(err)
def test_direction_not_provided(self, session):
query = session.query(Bar)
order_by = [{'field': 'name'}]
with pytest.raises(BadSortFormat) as err:
apply_sort(query, order_by)
expected_error = '`field` and `direction` are mandatory attributes.'
assert expected_error == error_value(err)
def test_invalid_direction(self, session):
query = session.query(Bar)
order_by = [{'field': 'name', 'direction': 'invalid_direction'}]
with pytest.raises(BadSortFormat) as err:
apply_sort(query, order_by)
expected_error = 'Direction `invalid_direction` not valid.'
assert expected_error == error_value(err)
def test_invalid_field(self, session):
query = session.query(Bar)
order_by = [{'field': 'invalid_field', 'direction': 'asc'}]
with pytest.raises(FieldNotFound) as err:
apply_sort(query, order_by)
expected_error = (
"Model <class 'test.models.Bar'> has no column `invalid_field`.")
assert expected_error == error_value(err)
def test_ambiguous_query(self, session):
query = session.query(Foo).join(Bar)
order_by = [
{'field': 'count', 'direction': 'asc'}, # ambiguous
{'model': 'Bar', 'field': 'name', 'direction': 'desc'},
]
with pytest.raises(BadSpec) as err:
apply_sort(query, order_by)
assert 'Ambiguous spec. Please specify a model.' == err.value.args[0]
def test_auto_join_to_invalid_model(self, session):
query = session.query(Foo)
order_by = [
{'model': 'Foo', 'field': 'count', 'direction': 'desc'},
{'model': 'Bar', 'field': 'name', 'direction': 'asc'},
{'model': 'Qux', 'field': 'count', 'direction': 'asc'}
]
with pytest.raises(BadSpec) as err:
apply_sort(query, order_by)
assert 'The query does not contain model `Qux`.' == err.value.args[0]
def test_multiple_sort_fields(self, session):
query = session.query(Bar)
order_by = [
{
'field': 'name',
'direction': 'asc'
},
{
'field': 'count',
'direction': 'desc'
},
{
'field': 'id',
'direction': 'desc'
},
]
sorted_query = apply_sort(query, order_by)
result = sorted_query.all()
assert len(result) == 8
assert result[0].id == 1
assert result[1].id == 7
assert result[2].id == 5
assert result[3].id == 3
assert result[4].id == 2
assert result[5].id == 6
assert result[6].id == 4
assert result[7].id == 8
def test_multiple_sort_fields_desc_nulls_last(self, session,
is_postgresql):
if not is_postgresql:
pytest.skip(NULLSLAST_NOT_SUPPORTED)
query = session.query(Bar)
order_by = [
{
'field': 'name',
'direction': 'asc'
},
{
'field': 'count',
'direction': 'desc',
'nullslast': True
},
]
sorted_query = apply_sort(query, order_by)
results = sorted_query.all()
assert [(result.name, result.count) for result in results] == [
('name_1', 40),
('name_1', 30),
('name_1', 5),
('name_1', None),
('name_2', 20),
('name_4', 10),
('name_4', None),
('name_5', 50),
]
def test_eager_load(self, session):
# behaves as if the joinedload wasn't present
query = session.query(Foo).options(joinedload(Foo.bar))
order_by = [
{
'field': 'count',
'direction': 'desc'
},
{
'model': 'Bar',
'field': 'name',
'direction': 'asc'
},
{
'field': 'id',
'direction': 'asc'
},
]
sorted_query = apply_sort(query, order_by)
results = sorted_query.all()
assert [(result.count, result.bar.name, result.id)
for result in results] == [
(2, 'name_1', 5),
(2, 'name_1', 7),
(2, 'name_4', 6),
(2, 'name_5', 8),
(1, 'name_1', 1),
(1, 'name_1', 3),
(1, 'name_2', 2),
(1, 'name_4', 4),
]
def test_noop_if_query_contains_named_models(self, session):
query = session.query(Foo).join(Bar)
order_by = [
{
'model': 'Foo',
'field': 'count',
'direction': 'desc'
},
{
'model': 'Bar',
'field': 'name',
'direction': 'asc'
},
{
'model': 'Foo',
'field': 'id',
'direction': 'asc'
},
]
sorted_query = apply_sort(query, order_by)
results = sorted_query.all()
assert [(result.count, result.bar.name, result.id)
for result in results] == [
(2, 'name_1', 5),
(2, 'name_1', 7),
(2, 'name_4', 6),
(2, 'name_5', 8),
(1, 'name_1', 1),
(1, 'name_1', 3),
(1, 'name_2', 2),
(1, 'name_4', 4),
]
def test_multiple_sort_fields(self, session):
query = session.query(Bar)
order_by = [
{
'field': 'name',
'direction': 'asc'
},
{
'field': 'count',
'direction': 'desc'
},
{
'field': 'id',
'direction': 'desc'
},
]
sorted_query = apply_sort(query, order_by)
results = sorted_query.all()
assert [(result.name, result.count, result.id)
for result in results] == [
('name_1', 5, 1),
('name_1', 3, 3),
('name_1', 2, 7),
('name_1', 2, 5),
('name_2', 10, 2),
('name_4', 15, 6),
('name_4', 12, 4),
('name_5', 1, 8),
]
def test_eager_load(self, session):
# behaves as if the joinedload wasn't present
query = session.query(Foo).options(joinedload(Foo.bar))
order_by = [
{
'field': 'count',
'direction': 'desc'
},
{
'model': 'Bar',
'field': 'name',
'direction': 'asc'
},
{
'field': 'id',
'direction': 'asc'
},
]
sorted_query = apply_sort(query, order_by)
result = sorted_query.all()
assert len(result) == 8
assert result[0].id == 5
assert result[1].id == 7
assert result[2].id == 6
assert result[3].id == 8
assert result[4].id == 1
assert result[5].id == 3
assert result[6].id == 2
assert result[7].id == 4
def test_noop_if_query_contains_named_models(self, session):
query = session.query(Foo).join(Bar)
order_by = [
{
'model': 'Foo',
'field': 'count',
'direction': 'desc'
},
{
'model': 'Bar',
'field': 'name',
'direction': 'asc'
},
{
'model': 'Foo',
'field': 'id',
'direction': 'asc'
},
]
sorted_query = apply_sort(query, order_by)
result = sorted_query.all()
assert len(result) == 8
assert result[0].id == 5
assert result[1].id == 7
assert result[2].id == 6
assert result[3].id == 8
assert result[4].id == 1
assert result[5].id == 3
assert result[6].id == 2
assert result[7].id == 4
def test_no_sort_provided(self, session):
query = session.query(Bar)
order_by = []
filtered_query = apply_sort(query, order_by)
assert query == filtered_query
def test_single_sort_hybrid_method_desc(self, session):
query = session.query(Bar)
order_by = [{'field': 'three_times_count', 'direction': 'desc'}]
sorted_query = apply_sort(query, order_by)
results = sorted_query.all()
assert [result.three_times_count() for result in results] == [
45, 36, 30, 15, 9, 6, 6, 3
]
def test_single_sort_hybrid_property_desc(self, session):
query = session.query(Bar)
order_by = [{'field': 'count_square', 'direction': 'desc'}]
sorted_query = apply_sort(query, order_by)
results = sorted_query.all()
assert [result.count_square for result in results] == [
225, 144, 100, 25, 9, 4, 4, 1
]
def test_multiple_models(self, session):
bar_1 = Bar(id=1, name='name_1', count=15)
bar_2 = Bar(id=2, name='name_2', count=10)
bar_3 = Bar(id=3, name='name_1', count=20)
bar_4 = Bar(id=4, name='name_1', count=10)
qux_1 = Qux(id=1,
name='name_1',
count=15,
created_at=datetime.date(2016, 7, 12),
execution_time=datetime.datetime(2016, 7, 12, 1, 5, 9))
qux_2 = Qux(id=2,
name='name_2',
count=10,
created_at=datetime.date(2016, 7, 13),
execution_time=datetime.datetime(2016, 7, 13, 2, 5, 9))
qux_3 = Qux(id=3,
name='name_1',
count=10,
created_at=None,
execution_time=None)
qux_4 = Qux(id=4,
name='name_1',
count=20,
created_at=datetime.date(2016, 7, 14),
execution_time=datetime.datetime(2016, 7, 14, 3, 5, 9))
session.add_all(
[bar_1, bar_2, bar_3, bar_4, qux_1, qux_2, qux_3, qux_4])
session.commit()
query = session.query(Bar).join(Qux, Bar.id == Qux.id)
order_by = [
{
'model': 'Bar',
'field': 'name',
'direction': 'asc'
},
{
'model': 'Qux',
'field': 'count',
'direction': 'asc'
},
]
sorted_query = apply_sort(query, order_by)
results = sorted_query.all()
assert len(results) == 4
assert results[0].id == 3
assert results[1].id == 1
assert results[2].id == 4
assert results[3].id == 2
def test_single_sort_field_desc(self, session):
query = session.query(Bar)
order_by = [{'field': 'name', 'direction': 'desc'}]
sorted_query = apply_sort(query, order_by)
results = sorted_query.all()
assert [result.name for result in results] == [
'name_5',
'name_4', 'name_4',
'name_2',
'name_1', 'name_1', 'name_1', 'name_1',
]
def test_a_single_dict_can_be_supplied_as_sort_spec(self, session):
query = session.query(Bar)
sort_spec = {'field': 'name', 'direction': 'desc'}
sorted_query = apply_sort(query, sort_spec)
results = sorted_query.all()
assert [result.name for result in results] == [
'name_5',
'name_4', 'name_4',
'name_2',
'name_1', 'name_1', 'name_1', 'name_1',
]
def test_single_sort_field_desc_nulls_last(self, session, is_postgresql):
if not is_postgresql:
pytest.skip(NULLSLAST_NOT_SUPPORTED)
query = session.query(Bar)
order_by = [
{'field': 'count', 'direction': 'desc', 'nullslast': True}
]
sorted_query = apply_sort(query, order_by)
results = sorted_query.all()
assert [result.count for result in results] == [
50, 40, 30, 20, 10, 5, None, None,
]
def test_a_single_dict_can_be_supplied_as_sort_spec(self, session):
query = session.query(Bar)
sort_spec = {'field': 'name', 'direction': 'desc'}
sorted_query = apply_sort(query, sort_spec)
result = sorted_query.all()
assert len(result) == 8
assert result[0].id == 8
assert result[1].id == 4
assert result[2].id == 6
assert result[3].id == 2
assert result[4].id == 1
assert result[5].id == 3
assert result[6].id == 5
assert result[7].id == 7
