maleo-foundation 0.0.21__tar.gz → 0.0.23__tar.gz

{maleo_foundation-0.0.21 → maleo_foundation-0.0.23}/PKG-INFO

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

{maleo_foundation-0.0.21 → maleo_foundation-0.0.23}/maleo_foundation/models/schemas/general.py

@@ -1,25 +1,26 @@
 from __future__ import annotations
 from datetime import date, datetime, timedelta, timezone
 from pydantic import BaseModel, Field, model_validator, field_serializer, FieldSerializationInfo
-from typing import Optional, Union, Any
+from typing import Optional, Any
 from uuid import UUID
-from maleo_foundation.models.enums import BaseEnums
 from maleo_foundation.constants import REFRESH_TOKEN_DURATION_DAYS, ACCESS_TOKEN_DURATION_MINUTES
+from maleo_foundation.models.enums import BaseEnums
+from maleo_foundation.models.types.general import BaseGeneralTypes
 
 class BaseGeneralSchemas:
     class IDs(BaseModel):
-        ids:Optional[list[int]] = Field(None, description="Specific IDs")
+        ids:BaseGeneralTypes.OptionalListOfIntegers = Field(None, description="Specific IDs")
 
     class Search(BaseModel):
-        search:Optional[str] = Field(None, description="Search parameter string.")
+        search:BaseGeneralTypes.OptionalString = Field(None, description="Search parameter string.")
 
     class DateFilter(BaseModel):
         name:str = Field(..., description="Column name.")
-        from_date:Optional[datetime] = Field(None, description="From date.")
-        to_date:Optional[datetime] = Field(None, description="To date.")
+        from_date:BaseGeneralTypes.OptionalDatetime = Field(None, description="From date.")
+        to_date:BaseGeneralTypes.OptionalDatetime = Field(None, description="To date.")
 
     class Statuses(BaseModel):
-        statuses:Optional[list[BaseEnums.StatusType]] = Field(None, description="Data's status")
+        statuses:BaseGeneralTypes.OptionalListOfStatuses = Field(None, description="Data's status")
 
     class SortColumn(BaseModel):
         name:str = Field(..., description="Column name.")
@@ -38,7 +39,7 @@ class BaseGeneralSchemas:
         action:BaseEnums.StatusUpdateAction = Field(..., description="Status update's action to be executed")
 
     class Expand(BaseModel):
-        expand:Optional[list[str]] = Field(None, description="Expanded field(s)")
+        expand:BaseGeneralTypes.OptionalListOfStrings = Field(None, description="Expanded field(s)")
 
     class PrivateKey(BaseModel):
         private_key:str = Field(..., description="Private key in str format.")
@@ -60,13 +61,13 @@ class BaseGeneralSchemas:
     class Timestamps(BaseModel):
         created_at:datetime = Field(..., description="Data's created_at timestamp")
         updated_at:datetime = Field(..., description="Data's updated_at timestamp")
-        deleted_at:Optional[datetime] = Field(..., description="Data's deleted_at timestamp")
-        restored_at:Optional[datetime] = Field(..., description="Data's restored_at timestamp")
-        deactivated_at:Optional[datetime] = Field(..., description="Data's deactivated_at timestamp")
+        deleted_at:BaseGeneralTypes.OptionalDatetime = Field(..., description="Data's deleted_at timestamp")
+        restored_at:BaseGeneralTypes.OptionalDatetime = Field(..., description="Data's restored_at timestamp")
+        deactivated_at:BaseGeneralTypes.OptionalDatetime = Field(..., description="Data's deactivated_at timestamp")
         activated_at:datetime = Field(..., description="Data's activated_at timestamp")
 
         @field_serializer('created_at', 'updated_at', 'deleted_at', 'restored_at', 'deactivated_at', 'activated_at')
-        def serialize_timestamps(self, value:Optional[datetime], info:FieldSerializationInfo) -> str:
+        def serialize_timestamps(self, value:BaseGeneralTypes.OptionalDatetime, info:FieldSerializationInfo) -> str:
             """Serializes datetime/date fields to ISO format."""
             if value is not None:
                 return value.isoformat()
@@ -76,7 +77,7 @@ class BaseGeneralSchemas:
         status:BaseEnums.StatusType = Field(..., description="Data's status")
 
     class Order(BaseModel):
-        order:Optional[int] = Field(..., description="Data's order")
+        order:BaseGeneralTypes.OptionalInteger = Field(..., description="Data's order")
 
     class Key(BaseModel):
         key:str = Field(..., description="Data's key")
@@ -88,8 +89,8 @@ class BaseGeneralSchemas:
         t:BaseEnums.TokenType = Field(..., description="Token Type")
         sr:UUID = Field(..., description="System role")
         u:UUID = Field(..., description="user")
-        o:Optional[UUID] = Field(..., description="Organization")
-        uor:Optional[list[UUID]] = Field(..., description="User Organization Role")
+        o:BaseGeneralTypes.OptionalUUID = Field(..., description="Organization")
+        uor:BaseGeneralTypes.OptionalListOfUUIDs = Field(..., description="User Organization Role")
         iat_dt:datetime = Field(datetime.now(timezone.utc), description="Issued at (datetime)")
         iat:int = Field(None, description="Issued at (integer)")
         exp_dt:datetime = Field(None, description="Expired at (datetime)")

maleo_foundation-0.0.23/maleo_foundation/models/schemas/parameter.py

@@ -0,0 +1,18 @@
+from pydantic import BaseModel, Field
+from maleo_foundation.models.enums import BaseEnums
+from maleo_foundation.models.schemas.general import BaseGeneralSchemas
+from maleo_foundation.models.types.general import BaseGeneralTypes
+from maleo_foundation.models.types.parameter import BaseParameterTypes
+
+class BaseParameterSchemas:
+    class Filters(BaseModel):
+        filters:BaseGeneralTypes.ListOfStrings = Field([], description="Filters for date range, e.g. 'created_at|from::<ISO_DATETIME>|to::<ISO_DATETIME>'.")
+
+    class DateFilters(BaseModel):
+        date_filters:BaseParameterTypes.ListOfDateFilters = Field([], description="Date filters to be applied")
+
+    class Sorts(BaseModel):
+        sorts:BaseGeneralTypes.ListOfStrings = Field(["id.asc"], description="Sorting columns in 'column_name.asc' or 'column_name.desc' format.")
+
+    class SortColumns(BaseModel):
+        sort_columns:BaseParameterTypes.ListOfSortColumns = Field([BaseGeneralSchemas.SortColumn(name="id", order=BaseEnums.SortOrder.ASC)], description="List of columns to be sorted")

{maleo_foundation-0.0.21 → maleo_foundation-0.0.23}/maleo_foundation/models/schemas/result.py

@@ -1,37 +1,35 @@
 from pydantic import BaseModel, Field
 from typing import Literal, Optional, Any
 from maleo_foundation.models.schemas.general import BaseGeneralSchemas
+from maleo_foundation.models.types.general import BaseGeneralTypes
 
 class BaseResultSchemas:
     class Base(BaseModel):
         success:bool = Field(..., description="Success status")
-        code:Optional[str] = Field(None, description="Optional result code")
-        message:Optional[str] = Field(None, description="Optional message")
-        description:Optional[str] = Field(None, description="Optional description")
+        code:BaseGeneralTypes.OptionalString = Field(None, description="Optional result code")
+        message:BaseGeneralTypes.OptionalString = Field(None, description="Optional message")
+        description:BaseGeneralTypes.OptionalString = Field(None, description="Optional description")
         data:Any = Field(..., description="Data")
-        other:Optional[Any] = Field(None, description="Optional other information")
+        other:BaseGeneralTypes.OptionalAny = Field(None, description="Optional other information")
 
     #* ----- ----- ----- Intermediary ----- ----- ----- *#
     class Fail(Base):
-        success:Literal[False] = Field(False, description="Success status")
+        success:BaseGeneralTypes.LiteralFalse = Field(False, description="Success status")
         data:None = Field(None, description="No data")
 
     class Success(Base):
-        success:Literal[True] = Field(True, description="Success status")
+        success:BaseGeneralTypes.LiteralTrue = Field(True, description="Success status")
         data:Any = Field(..., description="Data")
 
     #* ----- ----- ----- Derived ----- ----- ----- *#
     class NoData(Success):
-        success:Literal[True] = Field(True, description="Success status")
         data:None = Field(None, description="No data")
 
     class SingleData(Success):
-        success:Literal[True] = Field(True, description="Success status")
         data:Any = Field(..., description="Fetched single data")
 
     class UnpaginatedMultipleData(Success):
-        success:Literal[True] = Field(True, description="Success status")
-        data:list[Any] = Field(..., description="Unpaginated multiple data")
+        data:BaseGeneralTypes.ListOfAny = Field(..., description="Unpaginated multiple data")
 
     class PaginatedMultipleData(
         UnpaginatedMultipleData,

{maleo_foundation-0.0.21 → maleo_foundation-0.0.23}/maleo_foundation/models/types/__init__.py

@@ -1,9 +1,13 @@
 from __future__ import annotations
+from .general import BaseGeneralTypes
+from .parameter import BaseParameterTypes
 from .query import BaseQueryTypes
 from .service import BaseServiceTypes
 from .client import BaseClientTypes
 
 class BaseTypes:
+    General = BaseGeneralTypes
+    Parameter = BaseParameterTypes
     Query = BaseQueryTypes
     Service = BaseServiceTypes
     Client = BaseClientTypes

maleo_foundation-0.0.23/maleo_foundation/models/types/general.py

@@ -0,0 +1,50 @@
+from datetime import datetime
+from typing import Optional, Union, Literal, List, Any
+from uuid import UUID
+from maleo_foundation.models.enums import BaseEnums
+from maleo_foundation.models.schemas.general import BaseGeneralSchemas
+
+class BaseGeneralTypes:
+    #* Any-related types
+    ListOfAny = List[Any]
+    OptionalAny = Optional[Any]
+
+    #* Boolean-related types
+    LiteralFalse = Literal[False]
+    LiteralTrue = Literal[True]
+
+    #* Float-related types
+    ListOfFloats = List[float]
+    OptionalFloat = Optional[float]
+    OptionalListOfFloats = Optional[List[float]]
+
+    #* Integer-related types
+    ListOfIntegers = List[int]
+    OptionalInteger = Optional[int]
+    OptionalListOfIntegers = Optional[List[int]]
+
+    #* String-related types
+    ListOfStrings = List[str]
+    OptionalString = Optional[str]
+    OptionalListOfStrings = Optional[List[str]]
+
+    #* Datetime-related types
+    OptionalDatetime = Optional[datetime]
+
+    #* UUID-related types
+    ListOfUUIDs = List[UUID]
+    OptionalUUID = Optional[UUID]
+    OptionalListOfUUIDs = Optional[List[UUID]]
+
+    #* Statuses-related types
+    ListOfStatuses = List[BaseEnums.StatusType]
+    OptionalListOfStatuses = Optional[List[BaseEnums.StatusType]]
+
+    #* DateFilter-related types
+    ListOfDateFilters = List[BaseGeneralSchemas.DateFilter]
+
+    #* SortColumn-related types
+    ListOfSortColumns = List[BaseGeneralSchemas.SortColumn]
+
+    #* Miscellanous types
+    IdentifierValue = Union[int, UUID, str]

maleo_foundation-0.0.23/maleo_foundation/models/types/parameter.py

@@ -0,0 +1,9 @@
+from typing import List
+from maleo_foundation.models.schemas.general import BaseGeneralSchemas
+
+class BaseParameterTypes:
+    #* DateFilter-related types
+    ListOfDateFilters = List[BaseGeneralSchemas.DateFilter]
+
+    #* SortColumn-related types
+    ListOfSortColumns = List[BaseGeneralSchemas.SortColumn]

maleo_foundation-0.0.23/maleo_foundation/query.py

@@ -0,0 +1,81 @@
+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 Optional, Type
+from maleo_foundation.db import DatabaseManager
+from maleo_foundation.models.enums import BaseEnums
+from maleo_foundation.models.schemas.general import BaseGeneralSchemas
+
+class BaseQuery:
+    @staticmethod
+    def filter_ids(query:Query, table:Type[DatabaseManager.Base], column:str, ids:Optional[list[int]]) -> 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:list[BaseGeneralSchemas.DateFilter]) -> 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:Optional[list[BaseEnums.StatusType]]) -> 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:Optional[str]) -> 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:list[BaseGeneralSchemas.SortColumn]) -> 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.21 → maleo_foundation-0.0.23}/maleo_foundation.egg-info/PKG-INFO

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

{maleo_foundation-0.0.21 → maleo_foundation-0.0.23}/maleo_foundation.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ pyproject.toml
 maleo_foundation/__init__.py
 maleo_foundation/constants.py
 maleo_foundation/controller.py
+maleo_foundation/query.py
 maleo_foundation.egg-info/PKG-INFO
 maleo_foundation.egg-info/SOURCES.txt
 maleo_foundation.egg-info/dependency_links.txt
@@ -47,6 +48,8 @@ maleo_foundation/models/transfers/results/service/controllers/__init__.py
 maleo_foundation/models/transfers/results/service/controllers/rest.py
 maleo_foundation/models/types/__init__.py
 maleo_foundation/models/types/client.py
+maleo_foundation/models/types/general.py
+maleo_foundation/models/types/parameter.py
 maleo_foundation/models/types/query.py
 maleo_foundation/models/types/service.py
 maleo_foundation/utils/__init__.py

{maleo_foundation-0.0.21 → maleo_foundation-0.0.23}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "maleo_foundation"
-version = "0.0.21"
+version = "0.0.23"
 description = "Foundation package for Maleo"
 authors = [
     { name = "Agra Bima Yuda", email = "agra@nexmedis.com" }

maleo_foundation-0.0.21/maleo_foundation/models/schemas/parameter.py

@@ -1,16 +0,0 @@
-from pydantic import BaseModel, Field
-from maleo_foundation.models.enums import BaseEnums
-from maleo_foundation.models.schemas.general import BaseGeneralSchemas
-
-class BaseParameterSchemas:
-    class Filters(BaseModel):
-        filters:list[str] = Field([], description="Filters for date range, e.g. 'created_at|from::<ISO_DATETIME>|to::<ISO_DATETIME>'.")
-
-    class DateFilters(BaseModel):
-        date_filters:list[BaseGeneralSchemas.DateFilter] = Field([], description="Date filters to be applied")
-
-    class Sorts(BaseModel):
-        sorts:list[str] = Field(["id.asc"], description="Sorting columns in 'column_name.asc' or 'column_name.desc' format.")
-
-    class SortColumns(BaseModel):
-        sort_columns:list[BaseGeneralSchemas.SortColumn] = Field([BaseGeneralSchemas.SortColumn(name="id", order=BaseEnums.SortOrder.ASC)], description="List of columns to be sorted")