From df4c6be8ed3de4da81921d78ece7ce95f61ca50a Mon Sep 17 00:00:00 2001 From: Shohan Dutta Roy Date: Mon, 19 Feb 2024 16:37:57 +0530 Subject: [PATCH] feat: Add support for randomized ordering of fakequeryset (#187) Fixes #111 --- CHANGELOG.txt | 1 + modelcluster/utils.py | 5 +++++ tests/tests/test_cluster.py | 14 ++++++++++++++ 3 files changed, 20 insertions(+) diff --git a/CHANGELOG.txt b/CHANGELOG.txt index c64d093..b88eb71 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -4,6 +4,7 @@ Changelog 6.3 (xx.xx.xxxx) ~~~~~~~~~~~~~~~~ * Support filtering with Q objects (Shohan Dutta Roy) +* Support random ordering with `.order_by("?")` (Shohan Dutta Roy) * Fix: Correctly handle filtering on fields on related models when those fields have names that match a lookup type (Andy Babic) * Fix: Correctly handle null foreign keys when traversing related fields (Andy Babic) diff --git a/modelcluster/utils.py b/modelcluster/utils.py index 80afb00..d3df16f 100644 --- a/modelcluster/utils.py +++ b/modelcluster/utils.py @@ -1,6 +1,7 @@ from functools import lru_cache from django.core.exceptions import FieldDoesNotExist from django.db.models import ManyToManyField, ManyToManyRel, Model +import random REL_DELIMETER = "__" @@ -154,6 +155,10 @@ def sort_by_fields(items, fields): # To get the desired behaviour, we need to order by keys in reverse order # See: https://docs.python.org/2/howto/sorting.html#sort-stability-and-complex-sorts for key in reversed(fields): + if key == '?': + random.shuffle(items) + continue + # Check if this key has been reversed reverse = False if key[0] == '-': diff --git a/tests/tests/test_cluster.py b/tests/tests/test_cluster.py index 6605c37..8cce2ca 100644 --- a/tests/tests/test_cluster.py +++ b/tests/tests/test_cluster.py @@ -780,6 +780,20 @@ def test_ordering_accross_foreignkeys(self): ) ) + def test_random_ordering(self): + beatles = Band(name='The Beatles', members=[ + BandMember(name='John Lennon'), + BandMember(name='Paul McCartney'), + BandMember(name='George Harrison'), + BandMember(name='Ringo Starr'), + ]) + + # Check that all members are returned + self.assertCountEqual( + beatles.members.order_by('?'), + [beatles.members.get(name=name) for name in ['John Lennon', 'Paul McCartney', 'George Harrison', 'Ringo Starr']] + ) + def test_filtering_via_manytomany_raises_exception(self): bay_window = Feature.objects.create(name="Bay window", desirability=6) underfloor_heating = Feature.objects.create(name="Underfloor heading", desirability=10)