Merge branch 'master' of github.com:piccolo-orm/piccolo_api

docs/source/api_reference/index.rst

@@ -8,6 +8,13 @@ LoginHooks
 
 .. autoclass:: LoginHooks
 
+OrderBy
+-------
+
+.. currentmodule:: piccolo_api.crud.endpoints
+
+.. autoclass:: OrderBy
+
 CAPTCHA
 -------
 

docs/source/crud/piccolo_crud.rst

@@ -192,13 +192,13 @@ A query which fetches all movies, sorted by duration:
 
     GET /movie/?__order=duration
 
-You can reverse the sort by prepending '-' to the field. For example:
+You can reverse the sort by prepending ``'-'`` to the field. For example:
 
 .. code-block::
 
     GET /movie/?__order=-duration
 
-Multiple columns can be used for the sort:
+Multiple columns can be used for the sort. Just separate them with a comma:
 
 .. code-block::
 

piccolo_api/crud/endpoints.py

@@ -72,10 +72,38 @@ class CustomJSONResponse(Response):
     media_type = "application/json"
 
 
-@dataclass
+class HashableDict(dict):
+    def __key(self):
+        return tuple((k, self[k]) for k in sorted(self))
+
+    def __hash__(self):
+        return hash(self.__key())
+
+    def __eq__(self, other):
+        return self.__key() == other.__key()
+
+
 class OrderBy:
-    column: Column
-    ascending: bool
+    def __init__(self, column: Column, ascending: bool = True):
+        self.column = column
+        self.ascending = ascending
+
+    def to_dict(self) -> HashableDict:
+        """
+        Serialise this class into something which can be converted to JSON
+        (used by Piccolo Admin).
+        """
+        column = ".".join(
+            [i._meta.name for i in self.column._meta.call_chain]
+            + [self.column._meta.name]
+        )
+        return HashableDict(column=column, ascending=self.ascending)
+
+    def __eq__(self, value: t.Any) -> bool:
+        if not isinstance(value, OrderBy):
+            return False
+
+        return self.to_dict() == value.to_dict()
 
 
 @dataclass

tests/crud/test_crud_endpoints.py

@@ -1803,3 +1803,40 @@ def test_page_sized_results(self):
 
         response = client.get("/?__page_size=99&__page=1&__range_header=true")
         self.assertEqual(response.headers.get("Content-Range"), "movie 0-2/3")
+
+
+class TestOrderBy(TestCase):
+    def test_eq(self):
+        # Same column, same ascending
+        self.assertEqual(
+            OrderBy(column=Movie.name, ascending=True),
+            OrderBy(column=Movie.name, ascending=True),
+        )
+
+        # Same column, different ascending
+        self.assertNotEqual(
+            OrderBy(column=Movie.name, ascending=True),
+            OrderBy(column=Movie.name, ascending=False),
+        )
+
+        # Different column, same ascending
+        self.assertNotEqual(
+            OrderBy(column=Movie.name, ascending=True),
+            OrderBy(column=Movie.id, ascending=True),
+        )
+
+    def test_to_dict(self):
+        self.assertDictEqual(
+            OrderBy(column=Movie.name, ascending=True).to_dict(),
+            {"column": "name", "ascending": True},
+        )
+
+        self.assertDictEqual(
+            OrderBy(column=Role.movie.name, ascending=True).to_dict(),
+            {"column": "movie.name", "ascending": True},
+        )
+
+        self.assertDictEqual(
+            OrderBy(column=Role.movie.name, ascending=False).to_dict(),
+            {"column": "movie.name", "ascending": False},
+        )