TypeDAL 3.17.1__py3-none-any.whl → 3.17.2__py3-none-any.whl

typedal/__about__.py

@@ -5,4 +5,4 @@ This file contains the Version info for this package.
 # SPDX-FileCopyrightText: 2023-present Robin van der Noord <robinvandernoord@gmail.com>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "3.17.1"
+__version__ = "3.17.2"

typedal/core.py

@@ -60,6 +60,7 @@ from .types import (
     FieldSettings,
     Metadata,
     OpRow,
+    OrderBy,
     PaginateDict,
     Pagination,
     Query,
@@ -1146,6 +1147,12 @@ class TableMeta(type):
         """
         return QueryBuilder(self).where(*a, **kw)
 
+    def orderby(self: Type[T_MetaInstance], *fields: OrderBy) -> "QueryBuilder[T_MetaInstance]":
+        """
+        See QueryBuilder.orderby!
+        """
+        return QueryBuilder(self).orderby(*fields)
+
     def cache(self: Type[T_MetaInstance], *deps: Any, **kwargs: Any) -> "QueryBuilder[T_MetaInstance]":
         """
         See QueryBuilder.cache!
@@ -2678,6 +2685,22 @@ class QueryBuilder(typing.Generic[T_MetaInstance]):
         """
         return self._extend(select_args=list(fields), select_kwargs=options)
 
+    def orderby(self, *fields: OrderBy) -> "QueryBuilder[T_MetaInstance]":
+        """
+        Order the query results by specified fields.
+
+        Args:
+            fields: field(s) to order by. Supported:
+                table.name - sort by name, ascending
+                ~table.name - sort by name, descending
+                <random> - sort randomly
+                table.name|table.id - sort by two fields (first name, then id)
+
+        Returns:
+            QueryBuilder: A new QueryBuilder instance with the ordering applied.
+        """
+        return self.select(orderby=fields)
+
     def where(
         self,
         *queries_or_lambdas: Query | typing.Callable[[Type[T_MetaInstance]], Query] | dict[str, Any],

typedal/types.py

@@ -218,6 +218,8 @@ class CacheFn(typing.Protocol):
 CacheModel = typing.Callable[[str, CacheFn, int], Rows]
 CacheTuple = tuple[CacheModel, int]
 
+OrderBy: typing.TypeAlias = Expression | str
+
 
 class SelectKwargs(TypedDict, total=False):
     """
@@ -226,7 +228,7 @@ class SelectKwargs(TypedDict, total=False):
 
     join: Optional[list[Expression]]
     left: Optional[list[Expression]]
-    orderby: Optional[Expression | str | Table]
+    orderby: OrderBy | typing.Iterable[OrderBy] | None
     limitby: Optional[tuple[int, int]]
     distinct: bool | Field | Expression
     orderby_on_limitby: bool

{typedal-3.17.1.dist-info → typedal-3.17.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: TypeDAL
-Version: 3.17.1
+Version: 3.17.2
 Summary: Typing support for PyDAL
 Project-URL: Documentation, https://typedal.readthedocs.io/
 Project-URL: Issues, https://github.com/trialandsuccess/TypeDAL/issues

{typedal-3.17.1.dist-info → typedal-3.17.2.dist-info}/RECORD

@@ -1,19 +1,19 @@
-typedal/__about__.py,sha256=qAZyDEIwd6mDBYvr4cbjRjrTOK9zmsnsE0z1CgbpiGM,207
+typedal/__about__.py,sha256=8QxLmIYG_8pjN9osMaqR9cgfFChPa8chMgVGeo0Jc4k,207
 typedal/__init__.py,sha256=mCU8C3xPYiGcai4PYIoZNJSkFa1jb0MHkV8s2XXqEeY,484
 typedal/caching.py,sha256=6YUzUMpan56nSy3D-Jl0FS-8V4LbTnpRSoDJHj6yPYo,11782
 typedal/cli.py,sha256=e08L8k6q1NGSzpKs7ywin0uwkK7Kz07I4REVjHdbyyE,19267
 typedal/config.py,sha256=0qy1zrTUdtmXPM9jHzFnSR1DJsqGJqcdG6pvhzKQHe0,11625
-typedal/core.py,sha256=OfmymoVBUX72srUpRhs1870My-jPnPbjWDubdpMBbUU,117708
+typedal/core.py,sha256=P2mi-j3YLw135iTbTRMKlx8_9EhxcWjmrH15qisBKpU,118519
 typedal/fields.py,sha256=bZIgjl3Lj7eMqFCyt-bogsS_BqIs3cETEUH4W59qiXw,8425
 typedal/for_py4web.py,sha256=KIIu8XgnAfRQCJfZCra79k8SInOHiFuLDKUv3hzTJng,1908
 typedal/for_web2py.py,sha256=xn7zo6ImsmTkH6LacbjLQl2oqyBvP0zLqRxEJvMQk1w,1929
 typedal/helpers.py,sha256=fvej53MqWG1n78-uTuxUEfLDpKrXJDOaIysogBFT3ns,11298
 typedal/mixins.py,sha256=NiGp-3Lr1lllWjP-whUhc_2HXwCS_ROB0bs5N_s9wk4,7976
 typedal/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-typedal/types.py,sha256=1FIgv1s0be0E8r5Wd9E1nvDvK4ETV8u2NlfI7_P6UUY,6752
+typedal/types.py,sha256=P5O0WMADoNm6eDBQZUs9eTK4Puzqz5ZDCFofCIl84Cg,6805
 typedal/web2py_py4web_shared.py,sha256=UYmD0_aK1bSVBt_f3j59Mxq-zOmQNkYkb8sPDUibq68,1539
 typedal/serializers/as_json.py,sha256=3JZlFhPrdvZVFAmH7P5DUAz8-TIk-br0F1CjKG3PFDM,2246
-typedal-3.17.1.dist-info/METADATA,sha256=d_6jgk1GPhrjkjP2XhqIDNN0bfI1cJ-GwohpNNby_Z8,10461
-typedal-3.17.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-typedal-3.17.1.dist-info/entry_points.txt,sha256=m1wqcc_10rHWPdlQ71zEkmJDADUAnZtn7Jac_6mbyUc,44
-typedal-3.17.1.dist-info/RECORD,,
+typedal-3.17.2.dist-info/METADATA,sha256=GyezlYlNCyUG9Iw8fXLc8xo4e3LmAKho_FIVLNx1abc,10461
+typedal-3.17.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+typedal-3.17.2.dist-info/entry_points.txt,sha256=m1wqcc_10rHWPdlQ71zEkmJDADUAnZtn7Jac_6mbyUc,44
+typedal-3.17.2.dist-info/RECORD,,