feat: enable keyword-only arguments for the main methods

NightMarcher · NightMarcher · commit 75508c4b10cd · 2024-01-10T18:16:42.000+08:00
diff --git a/examples/service/routers/account.py b/examples/service/routers/account.py
@@ -112,15 +112,16 @@ async def query_last_login_view(
     aids: List[int] = Body(..., embed=True),
 ):
     dicts = await AccountMgr.select_custom_fields(
-        fields=[
+        [
             "id", "extend ->> '$.last_login.ipv4' ipv4",
             "extend ->> '$.last_login.start_datetime' start_datetime",
             "CAST(extend ->> '$.last_login.online_sec' AS SIGNED) online_sec"
         ],
-        wheres=f"id IN ({','.join(map(str, aids))}) AND gender=1",
+        f"id IN ({','.join(map(str, aids))}) AND gender=1",
         # wheres=Q(Q(id__in=aids), Q(gender=1), join_type="AND"),
         # wheres={"id__in": aids, "gender": 1},
         # wheres=[Q(id__in=aids), Q(gender=1)],
+        limit=1
     )
     return {"dicts": dicts}
 
@@ -181,14 +182,14 @@ async def bulk_clone_view(
 ):
     ok = await AccountMgr.insert_into_select(
         wheres=Q(id__in=aids),
-        remain_fields=["gender"],
+        # remain_fields=["gender"],
         assign_field_dict={
             "locale": Cases("id", {3: LocaleEnum.zh_CN, 4: LocaleEnum.en_US, 5: LocaleEnum.fr_FR}, default=""),
             "active": False,
             "name": RawSQL("CONCAT(LEFT(name, 26), ' [NEW]')"),
             "extend": {},
         },
-        to_table="account_bak",
+        # to_table="account_bak",
     )
     return {"ok": ok}
 
diff --git a/fastapi_esql/__init__.py b/fastapi_esql/__init__.py
@@ -23,7 +23,7 @@
     wrap_backticks,
 )
 
-__version__ = "0.0.11"
+__version__ = "0.0.12"
 
 __all__ = [
     "QsParsingError",
diff --git a/fastapi_esql/orm/base_manager.py b/fastapi_esql/orm/base_manager.py
@@ -25,9 +25,8 @@ async def get_by_pk(
 
     @classmethod
     async def create_from_dict(cls, params: Dict[str, Any]) -> Optional[Model]:
-        params["using_db"] = cls.rw_conn
         try:
-            return await cls.model.create(**params)
+            return await cls.model.create(**params, using_db=cls.rw_conn)
         except Exception as e:
             logger.exception(e)
             return None
@@ -63,6 +62,7 @@ async def select_custom_fields(
         cls,
         fields: List[str],
         wheres: Union[str, Q, Dict[str, Any], List[Q]],
+        *,
         index: Optional[str] = None,
         groups: Optional[List[str]] = None,
         having: Optional[str] = None,
@@ -76,13 +76,13 @@ async def select_custom_fields(
             cls.table,
             fields,
             wheres,
-            index,
-            groups,
-            having,
-            orders,
-            offset,
-            limit,
-            cls.model,
+            index=index,
+            groups=groups,
+            having=having,
+            orders=orders,
+            offset=offset,
+            limit=limit,
+            model=cls.model,
         )
         conn = conn or cls.ro_conn
         converters = {
@@ -96,6 +96,7 @@ async def select_one_record(
         cls,
         fields: List[str],
         wheres: Union[str, Q, Dict[str, Any], List[Q]],
+        *,
         index: Optional[str] = None,
         groups: Optional[List[str]] = None,
         having: Optional[str] = None,
@@ -107,13 +108,13 @@ async def select_one_record(
             cls.table,
             fields,
             wheres,
-            index,
-            groups,
-            having,
-            orders,
-            0,
-            1,
-            cls.model,
+            index=index,
+            groups=groups,
+            having=having,
+            orders=orders,
+            offset=0,
+            limit=1,
+            model=cls.model,
         )
         conn = conn or cls.ro_conn
         converters = {
@@ -127,6 +128,7 @@ async def update_json_field(
         cls,
         json_field: str,
         wheres: Union[str, Q, Dict[str, Any], List[Q]],
+        *,
         merge_dict: Optional[Dict[str, Any]] = None,
         path_value_dict: Optional[Dict[str, Any]] = None,
         remove_paths: Optional[List[str]] = None,
@@ -136,11 +138,11 @@ async def update_json_field(
             cls.table,
             json_field,
             wheres,
-            merge_dict,
-            path_value_dict,
-            remove_paths,
-            json_type,
-            cls.model,
+            merge_dict=merge_dict,
+            path_value_dict=path_value_dict,
+            remove_paths=remove_paths,
+            json_type=json_type,
+            model=cls.model,
         )
         return await CursorHandler.sum_row_cnt(sql, cls.rw_conn, logger)
 
@@ -149,6 +151,7 @@ async def upsert_on_duplicate(
         cls,
         dicts: List[Dict[str, Any]],
         insert_fields: List[str],
+        *,
         upsert_fields: Optional[List[str]] = None,
         merge_fields: Optional[List[str]] = None,
         using_values: bool = False,
@@ -157,27 +160,28 @@ async def upsert_on_duplicate(
             cls.table,
             dicts,
             insert_fields,
-            upsert_fields,
-            merge_fields,
-            using_values,
+            upsert_fields=upsert_fields,
+            merge_fields=merge_fields,
+            using_values=using_values,
         )
         return await CursorHandler.sum_row_cnt(sql, cls.rw_conn, logger)
 
     @classmethod
     async def insert_into_select(
         cls,
         wheres: Union[str, Q, Dict[str, Any], List[Q]],
-        remain_fields: List[str],
-        assign_field_dict: Dict[str, Any],
+        *,
+        remain_fields: List[str] = None,
+        assign_field_dict: Dict[str, Any] = None,
         to_table: Optional[str] = None,
     ):
         sql = SQLizer.insert_into_select(
             cls.table,
             wheres,
-            remain_fields,
-            assign_field_dict,
-            to_table,
-            cls.model,
+            remain_fields=remain_fields,
+            assign_field_dict=assign_field_dict,
+            to_table=to_table,
+            model=cls.model,
         )
         return await CursorHandler.exec_if_ok(sql, cls.rw_conn, logger)
 
@@ -187,6 +191,7 @@ async def bulk_update_from_dicts(
         dicts: List[Dict[str, Any]],
         join_fields: List[str],
         update_fields: List[str],
+        *,
         merge_fields: Optional[List[str]] = None,
         using_values: bool = True,
     ):
@@ -195,7 +200,7 @@ async def bulk_update_from_dicts(
             dicts,
             join_fields,
             update_fields,
-            merge_fields,
-            using_values,
+            merge_fields=merge_fields,
+            using_values=using_values,
         )
         return await CursorHandler.sum_row_cnt(sql, cls.rw_conn, logger)
diff --git a/fastapi_esql/utils/sqlizer.py b/fastapi_esql/utils/sqlizer.py
@@ -115,6 +115,7 @@ def select_custom_fields(
         table: str,
         fields: List[str],
         wheres: Union[str, Q, Dict[str, Any], List[Q]],
+        *,
         index: Optional[str] = None,
         groups: Optional[List[str]] = None,
         having: Optional[str] = None,
@@ -156,6 +157,7 @@ def update_json_field(
         table: str,
         json_field: str,
         wheres: Union[str, Q, Dict[str, Any], List[Q]],
+        *,
         merge_dict: Optional[Dict[str, Any]] = None,
         path_value_dict: Optional[Dict[str, Any]] = None,
         remove_paths: Optional[List[str]] = None,
@@ -196,6 +198,7 @@ def upsert_on_duplicate(
         table: str,
         dicts: List[Dict[str, Any]],
         insert_fields: List[str],
+        *,
         upsert_fields: Optional[List[str]] = None,
         merge_fields: Optional[List[str]] = None,
         using_values: bool = False,
@@ -246,8 +249,9 @@ def insert_into_select(
         cls,
         table: str,
         wheres: Union[str, Q, Dict[str, Any], List[Q]],
-        remain_fields: List[str],
-        assign_field_dict: Dict[str, Any],
+        *,
+        remain_fields: List[str] = None,
+        assign_field_dict: Dict[str, Any] = None,
         to_table: Optional[str] = None,
         model: Optional[Model] = None,
     ) -> Optional[str]:
@@ -256,6 +260,8 @@ def insert_into_select(
         if not any([remain_fields, assign_field_dict]):
             raise WrongParamsError("At least one no empty parameter is required between `remain_fields` and `assign_field_dict`")
 
+        remain_fields = remain_fields or []
+        assign_field_dict = assign_field_dict or {}
         fields = [*remain_fields]
         assign_fields = []
         for k, v in assign_field_dict.items():
@@ -313,6 +319,7 @@ def bulk_update_from_dicts(
         dicts: List[Dict[str, Any]],
         join_fields: List[str],
         update_fields: List[str],
+        *,
         merge_fields: Optional[List[str]] = None,
         using_values: bool = True,
     ) -> Optional[str]:
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "fastapi-efficient-sql"
-version = "0.0.11"
+version = "0.0.12"
 description = "Generate bulk DML SQL and execute them based on Tortoise ORM and mysql8.0+, and integrated with FastAPI."
 authors = ["BryanLee <bryanlee@126.com>"]
 keywords = ["sql", "fastapi", "tortoise-orm", "mysql8", "bulk-operation"]

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`wrap_backticks,`
`24`	`24`	`)`
`25`	`25`
`26`		`-__version__ = "0.0.11"`
	`26`	`+__version__ = "0.0.12"`
`27`	`27`
`28`	`28`	`__all__ = [`
`29`	`29`	`"QsParsingError",`