fastgenerateapi 1.2.17__tar.gz → 1.2.18__tar.gz

{fastgenerateapi-1.2.17 → fastgenerateapi-1.2.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastgenerateapi
-Version: 1.2.17
+Version: 1.2.18
 Summary: FastAPIView Class View
 Author: ShiLiang
 Author-email: 2509144896@qq.com

{fastgenerateapi-1.2.17 → fastgenerateapi-1.2.18}/fastgenerateapi/__init__.py

@@ -25,12 +25,14 @@ from fastgenerateapi.channel.websocket_view import WebsocketView
 from fastgenerateapi.channel.consumer import Consumer
 
 # 模型相关类
-from fastgenerateapi.pydantic_utils.base_model import model_config, BaseModel, IdList
+from fastgenerateapi.pydantic_utils.base_model import (
+    model_config, BaseModel, PagePydantic, EmptyPydantic, SearchPydantic, IdList, IdResp)
 
 # 类型提示
 from fastgenerateapi.data_type.tortoise_type import T_Model
 
 # 工具相关
+from fastgenerateapi.controller.filter_controller import FilterUtils
 from fastgenerateapi.api_view.mixin.utils.docx_util import DocxUtil
 from fastgenerateapi.api_view.mixin.utils.file_util import FileUtil
 from fastgenerateapi.api_view.mixin.utils.pdf_util import PdfUtil

{fastgenerateapi-1.2.17 → fastgenerateapi-1.2.18}/fastgenerateapi/__version__.py

@@ -8,7 +8,7 @@
 #                                                  d8888P
 
 
-VERSION = (1, 2, 17)
+VERSION = (1, 2, 18)
 
 __version__ = '.'.join(map(str, VERSION))
 

{fastgenerateapi-1.2.17 → fastgenerateapi-1.2.18}/fastgenerateapi/api_view/get_all_view.py

@@ -90,7 +90,9 @@ class GetAllView(BaseView, GetMixin):
 
     async def set_get_all_model_list(self, model_list: List[T_Model], *args, **kwargs) -> List[T_Model]:
         """
-        对于查询的model，展示数据处理
+        对于查询的model列表进行数据处理
+        使用场景示例：
+            model的某个id通过http请求获取相关信息。此处统一请求，储存在kwargs["extra_filters"]里，在set_get_all_model赋值
         """
         return model_list
 
@@ -225,8 +227,8 @@ class GetAllView(BaseView, GetMixin):
     def _handler_get_all_settings(self):
         if not self.get_all_route:
             return
-        self.search_controller = SearchController(self.get_base_filter(self.search_fields))
-        self.filter_controller = FilterController(self.get_base_filter(self.filter_fields, self.filter_schema))
+        self.search_controller = SearchController(self.get_base_filter(self.search_fields, model_class=self.model_class))
+        self.filter_controller = FilterController(self.get_base_filter(self.filter_fields, self.filter_schema, model_class=self.model_class))
 
         func_type = inspect.signature(self.get_all).return_annotation
         if func_type != inspect._empty and func_type is not None:

{fastgenerateapi-1.2.17 → fastgenerateapi-1.2.18}/fastgenerateapi/api_view/get_relation_view.py

@@ -177,9 +177,9 @@ class GetRelationView(BaseView):
     def _handler_get_relation_settings(self):
         if not self.get_relation_route:
             return
-        self.search_controller = SearchController(self.get_base_filter(self.search_fields))
-        self.filter_controller = FilterController(self.get_base_filter(self.filter_fields))
-        self.filter_relation_controller = FilterController(self.get_base_filter(self.relation_filter_fields))
+        self.search_controller = SearchController(self.get_base_filter(self.search_fields, model_class=self.model_class))
+        self.filter_controller = FilterController(self.get_base_filter(self.filter_fields, model_class=self.model_class))
+        self.filter_relation_controller = FilterController(self.get_base_filter(self.relation_filter_fields, model_class=self.model_class))
 
         func_type = inspect.signature(self.get_relation).return_annotation
         if func_type != inspect._empty and func_type is not None:

{fastgenerateapi-1.2.17 → fastgenerateapi-1.2.18}/fastgenerateapi/api_view/get_tree_view.py

@@ -178,8 +178,8 @@ class GetTreeView(BaseView):
     def _handler_get_tree_settings(self):
         if not self.get_tree_route:
             return
-        self.search_controller = SearchController(self.get_base_filter(self.search_fields))
-        self.filter_controller = FilterController(self.get_base_filter(self.filter_fields))
+        self.search_controller = SearchController(self.get_base_filter(self.search_fields, model_class=self.model_class))
+        self.filter_controller = FilterController(self.get_base_filter(self.filter_fields, model_class=self.model_class))
 
         func_type = inspect.signature(self.get_tree).return_annotation
         if func_type != inspect._empty and func_type is not None:

{fastgenerateapi-1.2.17 → fastgenerateapi-1.2.18}/fastgenerateapi/api_view/mixin/base_mixin.py

@@ -4,6 +4,8 @@ from typing import List, Callable, Any, Union, Optional, Generic, Type
 
 from fastapi import APIRouter
 from fastapi.types import DecoratedCallable
+from tortoise import Model
+
 from fastgenerateapi.utils.exception import NOT_FOUND
 
 from fastgenerateapi.controller.filter_controller import BaseFilter
@@ -48,12 +50,12 @@ class BaseMixin(Generic[T], APIRouter, ABC):
                     getattr(self, route_field_func)()
 
     @staticmethod
-    def get_base_filter(fields: list, schema: Optional[PYDANTIC_SCHEMA] = None) -> list:
+    def get_base_filter(fields: list, schema: Optional[PYDANTIC_SCHEMA] = None, model_class: Optional[Type[Model]] = None) -> list:
         bast_filter_list = []
         if fields:
-            bast_filter_list += [BaseFilter(field) if not isinstance(field, BaseFilter) else field for field in fields]
+            bast_filter_list += [BaseFilter(field, model_class) if not isinstance(field, BaseFilter) else field for field in fields]
         if schema:
-            bast_filter_list += [BaseFilter((field, model_field.alias)) for field, model_field in schema.__fields__.items()]
+            bast_filter_list += [BaseFilter((field, model_field.alias), model_class) for field, model_field in schema.model_fields.items()]
         return bast_filter_list
 
     @staticmethod

{fastgenerateapi-1.2.17 → fastgenerateapi-1.2.18}/fastgenerateapi/api_view/mixin/dbmodel_mixin.py

@@ -22,6 +22,10 @@ class DBModelMixin:
         except:
             return "id"
 
+    @staticmethod
+    def get_model_description(model_class: Optional[Type[Model]]) -> str:
+        return model_class._meta.table_description or model_class.__name__
+
     @staticmethod
     def get_field_description(model_class: Type[Model], fields: Union[str, list, tuple, set]) -> str:
         if fields in ["id", "pk"]:
@@ -39,10 +43,7 @@ class DBModelMixin:
                     description = ""
                     description += DBModelMixin.get_field_description(model_class=model_class, fields=field_list[0])
                     if field_list[1] in DBModelMixin.others_description:
-                        description += DBModelMixin.get_field_description(
-                            model_class=model_class,
-                            fields=field_list[1]
-                        )
+                        description += DBModelMixin.others_description.get(field_list[1], "")
                     else:
                         description += DBModelMixin.get_field_description(
                             model_class=DBModelMixin._get_foreign_key_relation_class(model_class=model_class, field=field_list[0]),
@@ -65,8 +66,29 @@ class DBModelMixin:
                 return ",".join(list(fields))
 
     @staticmethod
-    def get_model_description(model_class: Optional[Type[Model]]) -> str:
-        return model_class._meta.table_description or model_class.__name__
+    def get_model_field_type(model_class: Optional[Type[Model]], field: str) -> type:
+        if field in ["id", "pk"]:
+            return str
+        try:
+            field_info = model_class._meta.fields_map.get(field)
+            field_info_fk = model_class._meta.fields_map.get(field.removesuffix("_id"))
+            if field_info:
+                return field_info.field_type
+            elif field.endswith("_id") and field_info_fk:
+                return str
+            elif "__" in field:
+                field_list = field.split("__", maxsplit=1)
+                if field_list[1] in DBModelMixin.others_description:
+                    return DBModelMixin.get_model_field_type(model_class, field_list[0])
+                else:
+                    return DBModelMixin.get_model_field_type(
+                        model_class=DBModelMixin._get_foreign_key_relation_class(model_class=model_class, field=field_list[0]),
+                        field=field_list[1]
+                    )
+            else:
+                return str
+        except Exception as e:
+            return str
 
     @staticmethod
     def get_model_prefix_name(model_class: Type[Model]) -> str:

{fastgenerateapi-1.2.17 → fastgenerateapi-1.2.18}/fastgenerateapi/api_view/mixin/utils/xlsx_util.py

@@ -89,12 +89,15 @@ class XlsxUtil:
             model_list: List[Model],
             fields: List[str],
             index: Optional[bool] = False,
+            model_handler: Callable = None,
             model_handler_list: List[Callable] = None,
             fields_handler: dict = None,
             filename: Optional[str] = '导出文件.xlsx',
             file_save_path: Optional[str] = None,
             sheet: Optional[str] = None,
             model_class: Optional[Model] = None,
+            *args,
+            **kwargs,
     ) -> StreamingResponse:
         """
         导出excel文件
@@ -102,7 +105,8 @@ class XlsxUtil:
         :param model_list: 模型列表
         :param fields: 字段列表
         :param index: 是否导出序号字段
-        :param model_handler_list: 模型列表
+        :param model_handler: 模型列表的处理方法
+        :param model_handler_list: 单个模型处理方法
         :param fields_handler: 字段处理方法
         :param filename: 导出文件名
         :param file_save_path: 指定文件路径保存，不返回
@@ -128,13 +132,19 @@ class XlsxUtil:
 
             col_width_list = XlsxUtil.write_headers(sh, headers)
 
+            if model_handler:
+                if is_async_callable(model_handler):
+                    model_list = await model_handler(model_list, *args, **kwargs)
+                else:
+                    model_list = model_handler(model_list, *args, **kwargs)
+
             for row, model in enumerate(model_list, start_row + 1):
                 if model_handler_list:
                     for model_handler in model_handler_list:
                         if is_async_callable(model_handler):
-                            model = await model_handler(model)
+                            model = await model_handler(model, *args, **kwargs)
                         else:
-                            model = model_handler(model)
+                            model = model_handler(model, *args, **kwargs)
                 start_col = 1
                 if index:
                     write(sh, row, start_col, str(row-start_row))
@@ -144,9 +154,9 @@ class XlsxUtil:
                     handler = fields_handler.get(field)
                     if handler and hasattr(handler, "__call__"):
                         if is_async_callable(handler):
-                            info = await handler(info)
+                            info = await handler(info, *args, **kwargs)
                         else:
-                            info = handler(info)
+                            info = handler(info, *args, **kwargs)
                     write(sh, row, col, info)
 
             XlsxUtil.adaptive_format(sh, col_width_list, len(headers))

{fastgenerateapi-1.2.17 → fastgenerateapi-1.2.18}/fastgenerateapi/controller/filter_controller.py

@@ -1,11 +1,13 @@
 from datetime import datetime, date, time
-from typing import Union, Any, Optional
+from typing import Union, Any, Optional, Type
 
 from pydantic.fields import FieldInfo
+from tortoise import Model
 from tortoise.expressions import Q
 from tortoise.queryset import QuerySet
 
-from fastgenerateapi.settings.all_settings import settings
+from fastgenerateapi.api_view.mixin.dbmodel_mixin import DBModelMixin
+from fastgenerateapi.pydantic_utils.base_model import alias_generator
 
 
 class FilterUtils:
@@ -53,18 +55,20 @@ class BaseFilter:
         BaseFilter
     """
 
-    def __init__(self, filter_str: Union[str, tuple]):
+    def __init__(self, filter_str: Union[str, tuple], model_class: Optional[Type[Model]] = None):
         """
-        :param filter_str:  Union[str, tuple]
+        :param
+        filter_str:  Union[str, tuple]
             当tuple时，第一个为str，后面参数无顺序和数量要求，可以是 类型、重命名字符串、用于修改传值的方法
-        example：
-            name__contains
-            (create_at__gt, datetime)
-            (create_at__gt, datetime, create_time)
-            (publish_date, datetime, FilterUtils.date_to_datetime_23)
-            (publish_date, datetime, FieldInfo())
+            example：
+                name__contains
+                (create_at__gt, datetime)
+                (create_at__gt, datetime, create_time)
+                (publish_date, datetime, FilterUtils.date_to_datetime_23)
+                (publish_date, datetime, FieldInfo())
+        model_class: 当有值时，会从这里获取到相关的类型和备注
         """
-        field_type = str
+        field_type = None
         model_field = filter_str
         filter_field = None
         field_info = None
@@ -85,6 +89,19 @@ class BaseFilter:
         if not filter_field:
             filter_field = model_field
 
+        if not field_type:
+            if model_class:
+                field_type = DBModelMixin.get_model_field_type(model_class, model_field)
+            else:
+                field_type = str
+
+        if not field_info:
+            description = DBModelMixin.get_field_description(model_class, model_field)
+            field_info = FieldInfo(default=None, title=description, description=description)
+
+        if alias_generator:
+            field_info.alias = alias_generator(filter_field or model_field)
+
         self.field_type = field_type
         self.model_field = model_field
         self.filter_field = filter_field

{fastgenerateapi-1.2.17 → fastgenerateapi-1.2.18}/fastgenerateapi/fastapi_utils/tortoise_utils.py

@@ -12,7 +12,7 @@ def _get_connection(connection_name: Optional[str]) -> BaseDBAsyncClient:
     :param connection_name:
     :return:
     """
-    # tortoise-orm==0.25.1
+    # 来源 tortoise-orm==0.25.1
     # if connection_name:
     #     connection = connections.get(connection_name)
     # elif len(connections.db_config) == 1:
@@ -28,7 +28,7 @@ def _get_connection(connection_name: Optional[str]) -> BaseDBAsyncClient:
         connection = connections.get(connection_name)
     elif len(connections.db_config) >= 1:
         # 默认选排序第一个
-        connection_name = next(iter(connections.db_config.keys()))
+        connection_name = connections.db_config.get("default") or next(iter(connections.db_config.keys()))
         connection = connections.get(connection_name)
     else:
         raise ParamsError(
@@ -42,7 +42,7 @@ def ForeignKeyField(
     model_name: str,
     related_name: Union[str, None, Literal[False]] = None,
     on_delete: OnDelete = CASCADE,
-    db_constraint: bool = True,
+    db_constraint: bool = False,
     null: bool = False,
     **kwargs: Any,
 ) -> Union[ForeignKeyRelation[MODEL], ForeignKeyNullableRelation[MODEL]]:

{fastgenerateapi-1.2.17 → fastgenerateapi-1.2.18}/fastgenerateapi/pydantic_utils/base_model.py

@@ -98,10 +98,6 @@ class PagePydantic(BaseModel):
         return data
 
 
-class IdList(BaseModel):
-    id_list: List[str] = Field([], description="id数组")
-
-
 class EmptyPydantic(BaseModel):
     ...
 
@@ -110,5 +106,10 @@ class SearchPydantic(BaseModel):
     search: Optional[str] = Field(None, description="搜索")
 
 
+class IdList(BaseModel):
+    id_list: List[str] = Field([], description="id数组")
+
 
+class IdResp(BaseModel):
+    id: str = Field(..., description="主键")
 

{fastgenerateapi-1.2.17 → fastgenerateapi-1.2.18}/fastgenerateapi/schemas_factory/filter_schema_factory.py

@@ -1,11 +1,9 @@
-from typing import Type, Union, Optional
+from logging import warning
+from typing import Type, Optional
 
-from fastapi import Query
 from pydantic import BaseModel, create_model
-from pydantic.fields import FieldInfo
 
 from fastgenerateapi.pydantic_utils.base_model import model_config
-from fastgenerateapi.api_view.mixin.dbmodel_mixin import DBModelMixin
 from fastgenerateapi.controller.filter_controller import BaseFilter
 from tortoise import Model
 
@@ -20,8 +18,8 @@ def filter_schema_factory(model_class: Type[Model], fields: list[str, tuple[str,
 
     for base_field in fields or []:
         if not isinstance(base_field, BaseFilter):
-            base_field = BaseFilter(base_field)
-        f = base_field.filter_field
+            base_field = BaseFilter(base_field, model_class)
+        f = base_field.model_field
         t = base_field.field_type
         if base_field.field_info:
             model_fields.update({
@@ -31,16 +29,7 @@ def filter_schema_factory(model_class: Type[Model], fields: list[str, tuple[str,
                 )
             })
         else:
-            description = DBModelMixin.get_field_description(model_class, base_field.model_field)
-            model_fields.update({
-                f: (
-                    Optional[t],
-                    FieldInfo(
-                        title=f"{description}",
-                        default=Query("", description=description),
-                        description=f"{description}"
-                    ))
-            })
+            warning(f"模型{model_class.__name__}筛选参数{base_field.model_field}未起效果")
 
     filter_params_model: Type[BaseModel] = create_model(
         model_class.__name__+"CommonFilterParams",

{fastgenerateapi-1.2.17 → fastgenerateapi-1.2.18}/fastgenerateapi/settings/app_settings.py

@@ -9,9 +9,9 @@ from fastgenerateapi.pydantic_utils.base_settings import BaseSettings
 class AppSettings(BaseSettings):
     # #######################################  请求参数相关  ###############################################
     # 字段配置
-    # 【驼峰格式】 推荐<fastgenerateapi.alias_to_camel> 可选<pydantic.alias_generators.to_snake><会忽略双下划线转单下划线配置>
+    # 【驼峰格式】 推荐<fastgenerateapi.alias_to_camel> 可选<pydantic.alias_generators.to_camel><会忽略双下划线转单下划线配置>
     # 【下划线】<pydantic.alias_generators.to_snake>
-    ALIAS_GENERATOR: Optional[str] = Field(default=None, description="序列化参数命名方法路径")
+    ALIAS_GENERATOR: Optional[str] = Field(default="alias_name", description="序列化参数命名方法路径")
     # 分页对应字段以及配置默认值
     WHETHER_PAGE_FIELD: Optional[str] = Field(default="no_page", description="判断是否分页字段")
     CURRENT_PAGE_FIELD: Optional[str] = Field(default="page", description="当前页字段")

{fastgenerateapi-1.2.17 → fastgenerateapi-1.2.18}/fastgenerateapi/utils/str_util.py

@@ -122,6 +122,13 @@ def alias_to_camel(value: str) -> str:
     return to_camel(value)
 
 
+def alias_name(value: str) -> str:
+    if settings.app_settings.FILTER_UNDERLINE_WHETHER_DOUBLE_TO_SINGLE:
+        value = value.replace("__", "_")
+
+    return value
+
+
 if __name__ == '__main__':
     # test parse_str_to_list
     print(parse_str_to_list("我、你，他,她"))

{fastgenerateapi-1.2.17 → fastgenerateapi-1.2.18}/fastgenerateapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastgenerateapi
-Version: 1.2.17
+Version: 1.2.18
 Summary: FastAPIView Class View
 Author: ShiLiang
 Author-email: 2509144896@qq.com