maleo-foundation 0.0.45__py3-none-any.whl → 0.0.47__py3-none-any.whl

maleo_foundation/query.py

@@ -9,6 +9,20 @@ from maleo_foundation.types import BaseTypes
 from maleo_foundation.extended_types import ExtendedTypes
 
 class BaseQuery:
+    @staticmethod
+    def filter_column(query:Query, table:Type[DatabaseManager.Base], column:str, value:BaseTypes.OptionalAny) -> Query:
+        if not value:
+            return query
+        column_attr = getattr(table, column, None)
+        if not column_attr:
+            return query
+        if isinstance(value, list):
+            value_filters = [column_attr == val for val in value]
+            query = query.filter(or_(*value_filters))
+            return query
+        query = query.filter(column_attr == value)
+        return query
+
     @staticmethod
     def filter_ids(query:Query, table:Type[DatabaseManager.Base], column:str, ids:BaseTypes.OptionalListOfIntegers) -> Query:
         if ids is not None:

maleo_foundation/utils/__init__.py

@@ -2,8 +2,12 @@ from __future__ import annotations
 from .formatter import BaseFormatter
 from .logger import BaseLogger
 from .exceptions import BaseExceptions
+from .controller import BaseControllerUtils
+from .query import BaseQueryUtils
 
 class BaseUtils:
     Formatter = BaseFormatter
     Logger = BaseLogger
-    Exceptions = BaseExceptions
+    Exceptions = BaseExceptions
+    Controller = BaseControllerUtils
+    Query = BaseQueryUtils

maleo_foundation/utils/controller.py

@@ -0,0 +1,50 @@
+from fastapi import status
+from typing import Type, Any
+from maleo_foundation.enums import BaseEnums
+from maleo_foundation.models.responses import BaseResponses
+from maleo_foundation.models.transfers.results.service.controllers.rest import BaseServiceRESTControllerResults
+from maleo_foundation.models.transfers.parameters.service import BaseServiceParametersTransfers
+from maleo_foundation.expanded_types.service import ExpandedServiceTypes
+
+class BaseControllerUtils:
+    @staticmethod
+    def check_unique_existence(
+        check:BaseServiceParametersTransfers.UniqueFieldCheck,
+        get_single_parameters_class:Type[ExpandedServiceTypes.GetSingleParameter],
+        get_single_service_function:ExpandedServiceTypes.SyncGetSingleFunction,
+        create_failed_response_class:Type[BaseResponses.Fail],
+        update_failed_response_class:Type[BaseResponses.Fail],
+        **additional_get_parameters:Any
+    ) -> BaseServiceRESTControllerResults:
+        """Generic helper function to check if a unique value exists in the database."""
+
+        #* Return early if nullable and no new value
+        if check.nullable and check.new_value is None:
+            return BaseServiceRESTControllerResults(success=True, content=None)
+
+        #* Return early if values are unchanged on update
+        if check.operation == BaseEnums.OperationType.UPDATE and check.old_value == check.new_value:
+            return BaseServiceRESTControllerResults(success=True, content=None)
+
+        #* Prepare parameters to query for existing data
+        get_single_parameters = get_single_parameters_class(identifier=check.field, value=check.new_value)
+
+        #* Query the existing data using provided function
+        service_result:ExpandedServiceTypes.GetSingleResult = get_single_service_function(parameters=get_single_parameters, **additional_get_parameters)
+        if not service_result.success:
+            content = BaseResponses.ServerError.model_validate(service_result.model_dump(exclude_unset=True)).model_dump()
+            return BaseServiceRESTControllerResults(success=False, content=content, status_code=status.HTTP_500_INTERNAL_SERVER_ERROR)
+
+        #* Handle case if duplicate is found
+        if service_result.data:
+            description = f"External error: {check.field} of '{check.new_value}' already exists in the database"
+            other = check.suggestion or f"Select another {check.field} value"
+            if check.operation == BaseEnums.OperationType.CREATE:
+                content = create_failed_response_class(description=description, other=other).model_dump()
+            elif check.operation == BaseEnums.OperationType.UPDATE:
+                content = update_failed_response_class(description=description, other=other).model_dump()
+
+            return BaseServiceRESTControllerResults(success=False, content=content, status_code=status.HTTP_400_BAD_REQUEST)
+
+        #* No duplicates found
+        return BaseServiceRESTControllerResults(success=True, content=None)

maleo_foundation/utils/query.py

@@ -0,0 +1,95 @@
+from sqlalchemy import Column, Table
+from sqlalchemy.orm import Query
+from sqlalchemy.orm.attributes import InstrumentedAttribute
+from sqlalchemy.sql.expression import or_, asc, cast, desc
+from sqlalchemy.types import DATE, String, TEXT, TIMESTAMP
+from typing import Type
+from maleo_foundation.db import DatabaseManager
+from maleo_foundation.types import BaseTypes
+from maleo_foundation.extended_types import ExtendedTypes
+
+class BaseQueryUtils:
+    @staticmethod
+    def filter_column(query:Query, table:Type[DatabaseManager.Base], column:str, value:BaseTypes.OptionalAny) -> Query:
+        if not value:
+            return query
+        column_attr = getattr(table, column, None)
+        if not column_attr:
+            return query
+        if isinstance(value, list):
+            value_filters = [column_attr == val for val in value]
+            query = query.filter(or_(*value_filters))
+            return query
+        query = query.filter(column_attr == value)
+        return query
+
+    @staticmethod
+    def filter_ids(query:Query, table:Type[DatabaseManager.Base], column:str, ids:BaseTypes.OptionalListOfIntegers) -> Query:
+        if ids is not None:
+            column_attr = getattr(table, column, None)
+            if column_attr:
+                id_filters = [column_attr == id for id in ids]
+                query = query.filter(or_(*id_filters))
+        return query
+    
+    @staticmethod
+    def filter_timestamps(query:Query, table:Type[DatabaseManager.Base], date_filters:ExtendedTypes.ListOfDateFilters) -> Query:
+        if date_filters and len(date_filters) > 0:
+            for date_filter in date_filters:
+                try:
+                    table:Table = table.__table__
+                    column:Column = table.columns[date_filter.name]
+                    column_attr:InstrumentedAttribute = getattr(table, date_filter.name)
+                    if isinstance(column.type, (TIMESTAMP, DATE)):
+                        if date_filter.from_date and date_filter.to_date:
+                            query = query.filter(column_attr.between(date_filter.from_date, date_filter.to_date))
+                        elif date_filter.from_date:
+                            query = query.filter(column_attr >= date_filter.from_date)
+                        elif date_filter.to_date:
+                            query = query.filter(column_attr <= date_filter.to_date)
+                except KeyError:
+                    continue
+        return query
+    
+    @staticmethod
+    def filter_statuses(query:Query, table:Type[DatabaseManager.Base], statuses:BaseTypes.OptionalListOfStatuses) -> Query:
+        if statuses is not None:
+            status_filters = [table.status == status for status in statuses]
+            query = query.filter(or_(*status_filters))
+        return query
+    
+    @staticmethod
+    def filter_search(query:Query, table:Type[DatabaseManager.Base], search:BaseTypes.OptionalString) -> Query:
+        if search:
+            search_term = f"%{search}%" #* Use wildcard for partial matching
+            search_filters = []
+            sqla_table:Table = table.__table__
+            for name, attr in vars(table).items():
+                try:
+                    column: Column = sqla_table.columns[name]
+                    if not isinstance(attr, InstrumentedAttribute):
+                        continue
+                    if isinstance(column.type, (String, TEXT)):
+                        search_filters.append(cast(attr, TEXT).ilike(search_term))
+                except KeyError:
+                    continue
+            if search_filters:
+                query = query.filter(or_(*search_filters))
+        return query
+    
+    @staticmethod
+    def sort(query:Query, table:Type[DatabaseManager.Base], sort_columns:ExtendedTypes.ListOfSortColumns) -> Query:
+        for sort_column in sort_columns:
+            try:
+                sort_col = getattr(table, sort_column.name)
+                sort_col = asc(sort_col) if sort_column.order.value.lower() == "asc" else desc(sort_col)
+                query = query.order_by(sort_col)
+            except AttributeError:
+                continue
+        return query
+
+    @staticmethod
+    def paginate(query:Query, page:int, limit:int) -> Query:
+        offset:int = (page - 1) * limit #* Calculate offset based on page
+        query = query.limit(limit=limit).offset(offset=offset)
+        return query

{maleo_foundation-0.0.45.dist-info → maleo_foundation-0.0.47.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maleo_foundation
-Version: 0.0.45
+Version: 0.0.47
 Summary: Foundation package for Maleo
 Author-email: Agra Bima Yuda <agra@nexmedis.com>
 License: MIT

{maleo_foundation-0.0.45.dist-info → maleo_foundation-0.0.47.dist-info}/RECORD

@@ -3,7 +3,7 @@ maleo_foundation/constants.py,sha256=aBmEfWlBqZxi0k-n6h2NM1YRLOjMnheEiLyQcjP-zCQ
 maleo_foundation/controller.py,sha256=9ceIEajWLouLBph2NQe7L7tQNnQyyW_ETojilSeFv6M,2991
 maleo_foundation/enums.py,sha256=uXA5fLFeDXwlspUjU4DXSB68dfanxEwIJhsAMZXhsYo,2359
 maleo_foundation/extended_types.py,sha256=pIKt-_9tby4rmune3fmWcCW_mohaNRh_1lywBmdc-L4,301
-maleo_foundation/query.py,sha256=qJV9-QX5bphsmijXf4I8cuwMnqlJkm0dxypJ9Qz1eS8,3850
+maleo_foundation/query.py,sha256=O8U-RknKlihONxnjlKLQ02Q2aarH2GzEf2T4VABCMe4,4393
 maleo_foundation/types.py,sha256=D_EtYK-sNeELSbc-ngX65iuQCRhZQB4TtV73P6Gl76o,1206
 maleo_foundation/clients/__init__.py,sha256=W8vydJYeDEi6gdmOZSBFSSDsfZJtb8C05CHErZgsZ30,188
 maleo_foundation/clients/logging.py,sha256=JaAYfLkci97bTb6Wt5YO1uxQK5afIMuR8kin0q5rlIM,1145
@@ -46,12 +46,14 @@ maleo_foundation/models/transfers/results/service/general.py,sha256=G4x-MhQI7Km9
 maleo_foundation/models/transfers/results/service/query.py,sha256=Wj9GCWk7FrKP0EoK55vJcr9YJ42Lo24mLXbRk9j0IJw,2566
 maleo_foundation/models/transfers/results/service/controllers/__init__.py,sha256=HZJWMy2dskzOCzLmp_UaL9rjbQ-sDMI7sd2bXb-4QOU,175
 maleo_foundation/models/transfers/results/service/controllers/rest.py,sha256=wCuFyOTQkuBs2cqjPsWnPy0XIsCfMqGByhrSy57qp7Y,1107
-maleo_foundation/utils/__init__.py,sha256=tfgaHZI2PDgxEVSQztfnDMN5S6L5Y4FcK5v_Wkf5snE,245
+maleo_foundation/utils/__init__.py,sha256=FavmL5XYGCm955EAKiWWcXYeU15p5rSzfcglpV2yI6c,387
+maleo_foundation/utils/controller.py,sha256=hapDGng4q5XTfaG18M3bbFsFGqEOlkNKRzGf8BMKrhs,2996
 maleo_foundation/utils/exceptions.py,sha256=mcvBwHm6uWpVQkPtO1T2j-GaTYEiyPOeGxiDL9-sjNA,3639
 maleo_foundation/utils/logger.py,sha256=sK95UC5jLKKuAV8lu8pFnoQfLRB0nPtCbmAC5CJLgO8,3338
+maleo_foundation/utils/query.py,sha256=qKNcjf5J7_Q7NjA79BO6_TpZVdYcF8YIO68F9M501ew,4398
 maleo_foundation/utils/formatter/__init__.py,sha256=iKf5YCbEdg1qKnFHyKqqcQbqAqEeRUf8mhI3v3dQoj8,78
 maleo_foundation/utils/formatter/case.py,sha256=TmvvlfzGdC_omMTB5vAa40TZBxQ3hnr-SYeo0M52Rlg,1352
-maleo_foundation-0.0.45.dist-info/METADATA,sha256=o37CqDWclV1BNBghPffqhbQAYP7WMnIIZug2HEujbj8,3160
-maleo_foundation-0.0.45.dist-info/WHEEL,sha256=pxyMxgL8-pra_rKaQ4drOZAegBVuX-G_4nRHjjgWbmo,91
-maleo_foundation-0.0.45.dist-info/top_level.txt,sha256=_iBos3F_bhEOdjOnzeiEYSrCucasc810xXtLBXI8cQc,17
-maleo_foundation-0.0.45.dist-info/RECORD,,
+maleo_foundation-0.0.47.dist-info/METADATA,sha256=u2R6BiNSqzVrxOPsFQgRx9WsB15xvdmatl0NRvd6Eqw,3160
+maleo_foundation-0.0.47.dist-info/WHEEL,sha256=pxyMxgL8-pra_rKaQ4drOZAegBVuX-G_4nRHjjgWbmo,91
+maleo_foundation-0.0.47.dist-info/top_level.txt,sha256=_iBos3F_bhEOdjOnzeiEYSrCucasc810xXtLBXI8cQc,17
+maleo_foundation-0.0.47.dist-info/RECORD,,