feat: enable standard order by (#438)

Enables the standard `UnaryOperator` order by support in addition to the existing `OrderingPair`

Author: cofin

advanced_alchemy/repository/_async.py

@@ -1600,7 +1600,7 @@ async def _list_and_count_window(
                 execution_options=execution_options,
             )
             if order_by is None:
-                order_by = self.order_by or []
+                order_by = self.order_by if self.order_by is not None else []
             statement = self._apply_order_by(statement=statement, order_by=order_by)
             statement = self._apply_filters(*filters, statement=statement)
             statement = self._filter_select_by_kwargs(statement, kwargs)
@@ -1657,7 +1657,7 @@ async def _list_and_count_basic(
                 execution_options=execution_options,
             )
             if order_by is None:
-                order_by = self.order_by or []
+                order_by = self.order_by if self.order_by is not None else []
             statement = self._apply_order_by(statement=statement, order_by=order_by)
             statement = self._apply_filters(*filters, statement=statement)
             statement = self._filter_select_by_kwargs(statement, kwargs)
@@ -1945,7 +1945,7 @@ async def list(
                 execution_options=execution_options,
             )
             if order_by is None:
-                order_by = self.order_by or []
+                order_by = self.order_by if self.order_by is not None else []
             statement = self._apply_order_by(statement=statement, order_by=order_by)
             statement = self._apply_filters(*filters, statement=statement)
             statement = self._filter_select_by_kwargs(statement, kwargs)

advanced_alchemy/repository/_sync.py

@@ -1601,7 +1601,7 @@ def _list_and_count_window(
                 execution_options=execution_options,
             )
             if order_by is None:
-                order_by = self.order_by or []
+                order_by = self.order_by if self.order_by is not None else []
             statement = self._apply_order_by(statement=statement, order_by=order_by)
             statement = self._apply_filters(*filters, statement=statement)
             statement = self._filter_select_by_kwargs(statement, kwargs)
@@ -1656,7 +1656,7 @@ def _list_and_count_basic(
                 execution_options=execution_options,
             )
             if order_by is None:
-                order_by = self.order_by or []
+                order_by = self.order_by if self.order_by is not None else []
             statement = self._apply_order_by(statement=statement, order_by=order_by)
             statement = self._apply_filters(*filters, statement=statement)
             statement = self._filter_select_by_kwargs(statement, kwargs)
@@ -1944,7 +1944,7 @@ def list(
                 execution_options=execution_options,
             )
             if order_by is None:
-                order_by = self.order_by or []
+                order_by = self.order_by if self.order_by is not None else []
             statement = self._apply_order_by(statement=statement, order_by=order_by)
             statement = self._apply_filters(*filters, statement=statement)
             statement = self._filter_select_by_kwargs(statement, kwargs)

advanced_alchemy/repository/_util.py

@@ -5,6 +5,7 @@
     Delete,
     Dialect,
     Select,
+    UnaryExpression,
     Update,
 )
 from sqlalchemy.orm import (
@@ -294,8 +295,8 @@ def _apply_order_by(
         self,
         statement: StatementTypeT,
         order_by: Union[
-            list[tuple[Union[str, InstrumentedAttribute[Any]], bool]],
-            tuple[Union[str, InstrumentedAttribute[Any]], bool],
+            OrderingPair,
+            list[OrderingPair],
         ],
     ) -> StatementTypeT:
         """Apply ordering to a SQL statement.
@@ -311,13 +312,16 @@ def _apply_order_by(
         """
         if not isinstance(order_by, list):
             order_by = [order_by]
-        for order_field, is_desc in order_by:
-            field = get_instrumented_attr(self.model_type, order_field)
-            statement = self._order_by_attribute(statement, field, is_desc)
+        for order_field in order_by:
+            if isinstance(order_field, UnaryExpression):
+                statement = statement.order_by(order_field)  # type: ignore
+            else:
+                field = get_instrumented_attr(self.model_type, order_field[0])
+                statement = self._order_by_attribute(statement, field, order_field[1])
         return statement
 
+    @staticmethod
     def _order_by_attribute(
-        self,
         statement: StatementTypeT,
         field: InstrumentedAttribute[Any],
         is_desc: bool,

advanced_alchemy/repository/memory/_async.py

@@ -85,8 +85,8 @@ def __init__(
         auto_expunge: bool = False,
         auto_refresh: bool = True,
         auto_commit: bool = False,
-        order_by: Union[list[OrderingPair], OrderingPair, None] = None,
-        error_messages: Union[ErrorMessages, None, EmptyType] = Empty,
+        order_by: Optional[Union[list[OrderingPair], OrderingPair]] = None,
+        error_messages: Optional[Union[ErrorMessages, EmptyType]] = Empty,
         wrap_exceptions: bool = True,
         load: Optional[LoadSpec] = None,
         execution_options: Optional[dict[str, Any]] = None,
@@ -115,8 +115,8 @@ def __init_subclass__(cls) -> None:
 
     @staticmethod
     def _get_error_messages(
-        error_messages: Union[ErrorMessages, None, EmptyType] = Empty,
-        default_messages: Union[ErrorMessages, None, EmptyType] = Empty,
+        error_messages: Optional[Union[ErrorMessages, EmptyType]] = Empty,
+        default_messages: Optional[Union[ErrorMessages, EmptyType]] = Empty,
     ) -> Optional[ErrorMessages]:
         if error_messages == Empty:
             error_messages = None
@@ -204,19 +204,20 @@ def set_id_attribute_value(
     def _exclude_unused_kwargs(self, kwargs: dict[str, Any]) -> dict[str, Any]:
         return {key: value for key, value in kwargs.items() if key not in self._exclude_kwargs}
 
-    def _apply_limit_offset_pagination(self, result: list[ModelT], limit: int, offset: int) -> list[ModelT]:
+    @staticmethod
+    def _apply_limit_offset_pagination(result: list[ModelT], limit: int, offset: int) -> list[ModelT]:
         return result[offset:limit]
 
+    @staticmethod
     def _filter_in_collection(
-        self,
         result: list[ModelT],
         field_name: str,
         values: abc.Collection[Any],
     ) -> list[ModelT]:
         return [item for item in result if getattr(item, field_name) in values]
 
+    @staticmethod
     def _filter_not_in_collection(
-        self,
         result: list[ModelT],
         field_name: str,
         values: abc.Collection[Any],
@@ -225,8 +226,8 @@ def _filter_not_in_collection(
             return result
         return [item for item in result if getattr(item, field_name) not in values]
 
+    @staticmethod
     def _filter_on_datetime_field(
-        self,
         result: list[ModelT],
         field_name: str,
         before: Optional[datetime.datetime] = None,
@@ -247,8 +248,8 @@ def _filter_on_datetime_field(
                 result_.append(item)
         return result_
 
+    @staticmethod
     def _filter_by_like(
-        self,
         result: list[ModelT],
         field_name: Union[str, set[str]],
         value: str,
@@ -267,8 +268,8 @@ def _filter_by_like(
             )
         return list(set(items))
 
+    @staticmethod
     def _filter_by_not_like(
-        self,
         result: list[ModelT],
         field_name: Union[str, set[str]],
         value: str,
@@ -294,13 +295,14 @@ def _filter_result_by_kwargs(
         kwargs: Union[dict[Any, Any], Iterable[tuple[Any, Any]]],
     ) -> list[ModelT]:
         kwargs_: dict[Any, Any] = kwargs if isinstance(kwargs, dict) else dict(*kwargs)
-        kwargs_ = self._exclude_unused_kwargs(kwargs_)
+        kwargs_ = self._exclude_unused_kwargs(kwargs_)  # pyright: ignore
         try:
-            return [item for item in result if all(getattr(item, field) == value for field, value in kwargs_.items())]
+            return [item for item in result if all(getattr(item, field) == value for field, value in kwargs_.items())]  # pyright: ignore
         except AttributeError as error:
             raise RepositoryError from error
 
-    def _order_by(self, result: list[ModelT], field_name: str, sort_desc: bool = False) -> list[ModelT]:
+    @staticmethod
+    def _order_by(result: list[ModelT], field_name: str, sort_desc: bool = False) -> list[ModelT]:
         return sorted(result, key=lambda item: getattr(item, field_name), reverse=sort_desc)
 
     def _apply_filters(
@@ -418,7 +420,7 @@ async def get(
         auto_expunge: Optional[bool] = None,
         statement: Union[Select[tuple[ModelT]], StatementLambdaElement, None] = None,
         id_attribute: Union[str, InstrumentedAttribute[Any], None] = None,
-        error_messages: Union[ErrorMessages, None, EmptyType] = Empty,
+        error_messages: Optional[Union[ErrorMessages, EmptyType]] = Empty,
         load: Optional[LoadSpec] = None,
         execution_options: Optional[dict[str, Any]] = None,
         uniquify: Optional[bool] = None,
@@ -430,7 +432,7 @@ async def get_one(
         *filters: Union[StatementFilter, ColumnElement[bool]],
         auto_expunge: Optional[bool] = None,
         statement: Union[Select[tuple[ModelT]], StatementLambdaElement, None] = None,
-        error_messages: Union[ErrorMessages, None, EmptyType] = Empty,
+        error_messages: Optional[Union[ErrorMessages, EmptyType]] = Empty,
         load: Optional[LoadSpec] = None,
         execution_options: Optional[dict[str, Any]] = None,
         uniquify: Optional[bool] = None,
@@ -443,7 +445,7 @@ async def get_one_or_none(
         *filters: Union[StatementFilter, ColumnElement[bool]],
         auto_expunge: Optional[bool] = None,
         statement: Union[Select[tuple[ModelT]], StatementLambdaElement, None] = None,
-        error_messages: Union[ErrorMessages, None, EmptyType] = Empty,
+        error_messages: Optional[Union[ErrorMessages, EmptyType]] = Empty,
         load: Optional[LoadSpec] = None,
         execution_options: Optional[dict[str, Any]] = None,
         uniquify: Optional[bool] = None,
@@ -465,7 +467,7 @@ async def get_or_upsert(
         auto_commit: Optional[bool] = None,
         auto_expunge: Optional[bool] = None,
         auto_refresh: Optional[bool] = None,
-        error_messages: Union[ErrorMessages, None, EmptyType] = Empty,
+        error_messages: Optional[Union[ErrorMessages, EmptyType]] = Empty,
         load: Optional[LoadSpec] = None,
         execution_options: Optional[dict[str, Any]] = None,
         uniquify: Optional[bool] = None,
@@ -501,7 +503,7 @@ async def get_and_update(
         auto_commit: Optional[bool] = None,
         auto_expunge: Optional[bool] = None,
         auto_refresh: Optional[bool] = None,
-        error_messages: Union[ErrorMessages, None, EmptyType] = Empty,
+        error_messages: Optional[Union[ErrorMessages, EmptyType]] = Empty,
         load: Optional[LoadSpec] = None,
         execution_options: Optional[dict[str, Any]] = None,
         uniquify: Optional[bool] = None,
@@ -552,7 +554,7 @@ async def add(
         auto_commit: Optional[bool] = None,
         auto_expunge: Optional[bool] = None,
         auto_refresh: Optional[bool] = None,
-        error_messages: Union[ErrorMessages, None, EmptyType] = Empty,
+        error_messages: Optional[Union[ErrorMessages, EmptyType]] = Empty,
     ) -> ModelT:
         try:
             self.__database__.add(self.model_type, data)
@@ -567,7 +569,7 @@ async def add_many(
         *,
         auto_commit: Optional[bool] = None,
         auto_expunge: Optional[bool] = None,
-        error_messages: Union[ErrorMessages, None, EmptyType] = Empty,
+        error_messages: Optional[Union[ErrorMessages, EmptyType]] = Empty,
     ) -> list[ModelT]:
         for obj in data:
             await self.add(obj)  # pyright: ignore[reportCallIssue]
@@ -582,8 +584,8 @@ async def update(
         auto_commit: Optional[bool] = None,
         auto_expunge: Optional[bool] = None,
         auto_refresh: Optional[bool] = None,
-        id_attribute: Union[str, InstrumentedAttribute[Any], None] = None,
-        error_messages: Union[ErrorMessages, None, EmptyType] = Empty,
+        id_attribute: Optional[Union[str, InstrumentedAttribute[Any]]] = None,
+        error_messages: Optional[Union[ErrorMessages, EmptyType]] = Empty,
         load: Optional[LoadSpec] = None,
         execution_options: Optional[dict[str, Any]] = None,
         uniquify: Optional[bool] = None,
@@ -597,7 +599,7 @@ async def update_many(
         *,
         auto_commit: Optional[bool] = None,
         auto_expunge: Optional[bool] = None,
-        error_messages: Union[ErrorMessages, None, EmptyType] = Empty,
+        error_messages: Optional[Union[ErrorMessages, EmptyType]] = Empty,
         load: Optional[LoadSpec] = None,
         execution_options: Optional[dict[str, Any]] = None,
         uniquify: Optional[bool] = None,
@@ -610,8 +612,8 @@ async def delete(
         *,
         auto_commit: Optional[bool] = None,
         auto_expunge: Optional[bool] = None,
-        id_attribute: Union[str, InstrumentedAttribute[Any], None] = None,
-        error_messages: Union[ErrorMessages, None, EmptyType] = Empty,
+        id_attribute: Optional[Union[str, InstrumentedAttribute[Any]]] = None,
+        error_messages: Optional[Union[ErrorMessages, EmptyType]] = Empty,
         load: Optional[LoadSpec] = None,
         execution_options: Optional[dict[str, Any]] = None,
         uniquify: Optional[bool] = None,
@@ -627,9 +629,9 @@ async def delete_many(
         *,
         auto_commit: Optional[bool] = None,
         auto_expunge: Optional[bool] = None,
-        id_attribute: Union[str, InstrumentedAttribute[Any], None] = None,
+        id_attribute: Optional[Union[str, InstrumentedAttribute[Any]]] = None,
         chunk_size: Optional[int] = None,
-        error_messages: Union[ErrorMessages, None, EmptyType] = Empty,
+        error_messages: Optional[Union[ErrorMessages, EmptyType]] = Empty,
         load: Optional[LoadSpec] = None,
         execution_options: Optional[dict[str, Any]] = None,
         uniquify: Optional[bool] = None,
@@ -646,7 +648,7 @@ async def delete_where(
         *filters: Union[StatementFilter, ColumnElement[bool]],
         auto_commit: Optional[bool] = None,
         auto_expunge: Optional[bool] = None,
-        error_messages: Union[ErrorMessages, None, EmptyType] = Empty,
+        error_messages: Optional[Union[ErrorMessages, EmptyType]] = Empty,
         sanity_check: bool = True,
         load: Optional[LoadSpec] = None,
         execution_options: Optional[dict[str, Any]] = None,
@@ -668,8 +670,8 @@ async def upsert(
         auto_expunge: Optional[bool] = None,
         auto_commit: Optional[bool] = None,
         auto_refresh: Optional[bool] = None,
-        match_fields: Union[list[str], str, None] = None,
-        error_messages: Union[ErrorMessages, None, EmptyType] = Empty,
+        match_fields: Optional[Union[list[str], str]] = None,
+        error_messages: Optional[Union[ErrorMessages, EmptyType]] = Empty,
         load: Optional[LoadSpec] = None,
         execution_options: Optional[dict[str, Any]] = None,
         uniquify: Optional[bool] = None,
@@ -686,8 +688,8 @@ async def upsert_many(
         auto_expunge: Optional[bool] = None,
         auto_commit: Optional[bool] = None,
         no_merge: bool = False,
-        match_fields: Union[list[str], str, None] = None,
-        error_messages: Union[ErrorMessages, None, EmptyType] = Empty,
+        match_fields: Optional[Union[list[str], str]] = None,
+        error_messages: Optional[Union[ErrorMessages, EmptyType]] = Empty,
         load: Optional[LoadSpec] = None,
         execution_options: Optional[dict[str, Any]] = None,
         uniquify: Optional[bool] = None,
@@ -700,8 +702,8 @@ async def list_and_count(
         statement: Union[Select[tuple[ModelT]], StatementLambdaElement, None] = None,
         auto_expunge: Optional[bool] = None,
         count_with_window_function: Optional[bool] = None,
-        order_by: Union[list[OrderingPair], OrderingPair, None] = None,
-        error_messages: Union[ErrorMessages, None, EmptyType] = Empty,
+        order_by: Optional[Union[list[OrderingPair], OrderingPair]] = None,
+        error_messages: Optional[Union[ErrorMessages, EmptyType]] = Empty,
         load: Optional[LoadSpec] = None,
         execution_options: Optional[dict[str, Any]] = None,
         uniquify: Optional[bool] = None,
@@ -727,13 +729,12 @@ class SQLAlchemyAsyncMockSlugRepository(
     async def get_by_slug(
         self,
         slug: str,
-        error_messages: Union[ErrorMessages, None, EmptyType] = Empty,
+        error_messages: Optional[Union[ErrorMessages, EmptyType]] = Empty,
         load: Optional[LoadSpec] = None,
         execution_options: Optional[dict[str, Any]] = None,
         uniquify: Optional[bool] = None,
         **kwargs: Any,
     ) -> Union[ModelT, None]:
-        """Select record by slug value."""
         return await self.get_one_or_none(slug=slug)
 
     async def get_available_slug(