feat: add new function convert_dicts

Author: NightMarcher

examples/service/routers/account.py

@@ -3,9 +3,8 @@
 
 from faker import Faker
 from fastapi import APIRouter, Body, Query
-from fastapi_esql import Cases, RawSQL
+from fastapi_esql import Cases, Q, RawSQL
 from pydantic import BaseModel, Field
-from tortoise.queryset import Q
 
 from examples.service.constants.enums import GenderEnum, LocaleEnum
 from examples.service.managers.demo.account import AccountMgr
@@ -45,11 +44,20 @@ async def update_view(
 async def query_by_id_view(
     aid: int = Query(...),
 ):
+    meta = AccountMgr.model._meta
+    print(dir(meta))
+    print("db_complex_fields", meta.db_complex_fields, "", sep="\n")
+    print("db_default_fields", meta.db_default_fields, "", sep="\n")
+    print("db_fields", meta.db_fields, "", sep="\n")
+    print("db_native_fields", meta.db_native_fields, "", sep="\n")
+    print("fields_map", meta.fields_map, "", sep="\n")
     # account = await AccountMgr.get_by_pk(aid)
     account = await AccountMgr.select_one_record(
         fields=["*"],
         wheres=Q(id=aid),
+        convert_fields=["active", "gender", "locale", "extend"],
     )
+    print(account)
     return {"account": account}
 
 

fastapi_esql/__init__.py

@@ -17,6 +17,7 @@
     RawSQL,
     SQLizer,
     Singleton,
+    convert_dicts,
     timing,
 )
 
@@ -34,6 +35,7 @@
     "RawSQL",
     "SQLizer",
     "Singleton",
+    "convert_dicts",
     "timing",
 ]
 

fastapi_esql/const/error.py

@@ -1,6 +1,6 @@
-class WrongParamsError(Exception):
+class QsParsingError(Exception):
     ...
 
 
-class QsParsingError(Exception):
+class WrongParamsError(Exception):
     ...

fastapi_esql/orm/base_manager.py

@@ -69,6 +69,7 @@ async def select_custom_fields(
         orders: Optional[List[str]] = None,
         offset: Optional[int] = None,
         limit: Optional[int] = None,
+        convert_fields: Optional[List[str]] = None,
         conn: Optional[BaseDBAsyncClient] = None,
     ):
         sql = SQLizer.select_custom_fields(
@@ -84,7 +85,11 @@ async def select_custom_fields(
             cls.model,
         )
         conn = conn or cls.ro_conn
-        return await CursorHandler.fetch_dicts(sql, conn, logger)
+        converters = {
+            f: cls.model._meta.fields_map[f].to_python_value
+            for f in convert_fields if f in cls.model._meta.db_fields
+        } if convert_fields else None
+        return await CursorHandler.fetch_dicts(sql, conn, logger, converters)
 
     @classmethod
     async def select_one_record(
@@ -95,6 +100,7 @@ async def select_one_record(
         groups: Optional[List[str]] = None,
         having: Optional[str] = None,
         orders: Optional[List[str]] = None,
+        convert_fields: Optional[List[str]] = None,
         conn: Optional[BaseDBAsyncClient] = None,
     ):
         sql = SQLizer.select_custom_fields(
@@ -110,7 +116,11 @@ async def select_one_record(
             cls.model,
         )
         conn = conn or cls.ro_conn
-        return await CursorHandler.fetch_one(sql, conn, logger)
+        converters = {
+            f: cls.model._meta.fields_map[f].to_python_value
+            for f in convert_fields if f in cls.model._meta.db_fields
+        } if convert_fields else None
+        return await CursorHandler.fetch_one(sql, conn, logger, converters)
 
     @classmethod
     async def update_json_field(

fastapi_esql/utils/__init__.py

@@ -1,3 +1,4 @@
+from .converter import convert_dicts
 from .cursor_handler import CursorHandler
 from .decorator import timing
 from .metaclass import Singleton

fastapi_esql/utils/converter.py

@@ -0,0 +1,16 @@
+from logging import getLogger
+from typing import Dict, Callable
+
+logger = getLogger(__name__)
+
+
+def convert_dicts(dicts, converters: Dict[str, Callable]):
+    if not converters:
+        return
+    for d in dicts:
+        for f, cvt in converters.items():
+            v = d[f]
+            try:
+                d[f] = cvt(v)
+            except Exception as e:
+                logger.warning(f"Converting value `{v}` by `{cvt.__name__}` failed => {e}")

fastapi_esql/utils/cursor_handler.py

@@ -1,8 +1,10 @@
 from logging import Logger
-from typing import Any, Dict, List, Optional
+from typing import Any, Dict, List, Optional, Callable
 
 from tortoise import BaseDBAsyncClient
 
+from .converter import convert_dicts
+
 
 class CursorHandler:
 
@@ -12,9 +14,12 @@ async def fetch_dicts(
         sql: str,
         conn: BaseDBAsyncClient,
         logger: Logger,
+        converters: Dict[str, Callable] = None,
     ) -> Optional[List[Dict[str, Any]]]:
         try:
-            return await conn.execute_query_dict(sql)
+            dicts = await conn.execute_query_dict(sql)
+            convert_dicts(dicts, converters)
+            return dicts
         except Exception as e:
             logger.exception(f"{e} SQL=>{sql}")
             return None
@@ -25,9 +30,11 @@ async def fetch_one(
         sql: str,
         conn: BaseDBAsyncClient,
         logger: Logger,
+        converters: Dict[str, Callable] = None,
     ) -> Optional[Dict[str, Any]]:
         try:
             dicts = await conn.execute_query_dict(sql)
+            convert_dicts(dicts, converters)
             if dicts:
                 return dicts[0]
             return {}

fastapi_esql/utils/sqlizer.py

@@ -50,7 +50,7 @@ def resolve_wheres(
         model: Optional[Model] = None,
     ) -> str:
         if not model and not isinstance(wheres, str):
-            raise WrongParamsError("Parameter `wheres` only supports str if no model exists")
+            raise WrongParamsError("Parameter `wheres` only supports `str` if no model exists")
 
         if isinstance(wheres, str):
             return wheres
@@ -61,10 +61,10 @@ def resolve_wheres(
         elif isinstance(wheres, list):
             qs = [q for q in wheres if isinstance(q, Q)]
         else:
-            raise WrongParamsError("Parameter `wheres` only support str, Q, Dict[str, Any] and List[Q]")
+            raise WrongParamsError("Parameter `wheres` only support `str`, `Q`, `Dict[str, Any]` and `List[Q]`")
 
         if not qs:
-            raise QsParsingError("Parsing `wheres` for QuerySet failed")
+            raise QsParsingError("Parsing `wheres` for `QuerySet` failed")
 
         modifier = QueryModifier()
         for q in qs: