public/FastapiAdmin
1
0
Fork 0
mirror of https://github.com/fastapiadmin/FastapiAdmin.git synced 2026-09-21 04:46:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor: 优化代码注释和文档字符串格式

Browse Source 
style: 统一代码风格和格式

docs: 完善函数和方法的文档字符串

refactor(base_model): 移除冗余的表名和表参数生成方法

refactor(constant): 更新返回码注释格式

refactor(router_class): 添加路由处理器的详细文档

refactor(database): 完善数据库连接函数的文档

refactor(security): 添加认证类和方法的详细文档

refactor(validator): 更新验证器函数的文档格式

refactor(serialize): 优化序列化工具类的文档

refactor(response): 完善响应类的文档字符串

refactor(dependencies): 添加依赖函数的详细文档

refactor(initialize): 完善初始化脚本的文档

refactor(plugin): 添加生命周期和中间件注册的文档

refactor(service): 完善服务层方法的文档

refactor(controller): 添加控制器方法的详细文档

refactor(crud): 完善CRUD操作的文档字符串

refactor(schema): 简化模型类并移除冗余字段

refactor(param): 更新查询参数类的注释格式

refactor(template): 优化代码生成模板的格式

refactor(console): 添加控制台输出功能的实现

refactor(util): 完善工具函数的文档字符串
This commit is contained in:
zhangtao
2025-10-18 16:31:28 +08:00
parent 0ea88c3320
commit c2ca6d19ac
101 changed files with 6914 additions and 2295 deletions
Download Patch File Download Diff File Expand all files Collapse all files
backend/app/api/v1/module_system/params/controller.py
+104 -1
View File
@@ -25,6 +25,16 @@ async def get_type_detail_controller(
id: int = Path(..., description="参数ID"),
auth: AuthSchema = Depends(AuthPermission(["system:param:query"]))
) -> JSONResponse:
"""
获取参数详情
参数:
- id (int): 参数ID
- auth (AuthSchema): 认证信息模型
返回:
- JSONResponse: 包含参数详情的 JSON 响应
"""
result_dict = await ParamsService.get_obj_detail_service(id=id, auth=auth)
logger.info(f"获取参数详情成功 {id}")
return SuccessResponse(data=result_dict, msg="获取参数详情成功")
@@ -35,6 +45,16 @@ async def get_obj_by_key_controller(
config_key: str = Path(..., description="配置键"),
auth: AuthSchema = Depends(AuthPermission(["system:param:query"]))
) -> JSONResponse:
"""
根据配置键获取参数详情
参数:
- config_key (str): 配置键
- auth (AuthSchema): 认证信息模型
返回:
- JSONResponse: 包含参数详情的 JSON 响应
"""
result_dict = await ParamsService.get_obj_by_key_service(config_key=config_key, auth=auth)
logger.info(f"根据配置键获取参数详情成功 {config_key}")
return SuccessResponse(data=result_dict, msg="根据配置键获取参数详情成功")
@@ -45,6 +65,16 @@ async def get_config_value_by_key_controller(
config_key: str = Path(..., description="配置键"),
auth: AuthSchema = Depends(AuthPermission(["system:param:query"]))
) -> JSONResponse:
"""
根据配置键获取参数值
参数:
- config_key (str): 配置键
- auth (AuthSchema): 认证信息模型
返回:
- JSONResponse: 包含参数值的 JSON 响应
"""
result_value = await ParamsService.get_config_value_by_key_service(config_key=config_key, auth=auth)
logger.info(f"根据配置键获取参数值成功 {config_key}")
return SuccessResponse(data=result_value, msg="根据配置键获取参数值成功")
@@ -56,6 +86,17 @@ async def get_obj_list_controller(
page: PaginationQueryParam = Depends(),
search: ParamsQueryParam = Depends(),
) -> JSONResponse:
"""
获取参数列表
参数:
- auth (AuthSchema): 认证信息模型
- page (PaginationQueryParam): 分页查询参数模型
- search (ParamsQueryParam): 参数查询参数模型
返回:
- JSONResponse: 包含参数列表的 JSON 响应
"""
result_dict_list = await ParamsService.get_obj_list_service(auth=auth, search=search, order_by=page.order_by)
result_dict = await PaginationService.paginate(data_list= result_dict_list, page_no= page.page_no, page_size = page.page_size)
logger.info(f"获取参数列表成功")
@@ -68,6 +109,17 @@ async def create_obj_controller(
redis: Redis = Depends(redis_getter),
auth: AuthSchema = Depends(AuthPermission(["system:param:create"]))
) -> JSONResponse:
"""
创建参数
参数:
- data (ParamsCreateSchema): 参数创建模型
- redis (Redis): Redis 客户端实例
- auth (AuthSchema): 认证信息模型
返回:
- JSONResponse: 包含创建参数结果的 JSON 响应
"""
result_dict = await ParamsService.create_obj_service(auth=auth, redis=redis, data=data)
logger.info(f"创建参数成功: {result_dict}")
return SuccessResponse(data=result_dict, msg="创建参数成功")
@@ -80,6 +132,18 @@ async def update_objs_controller(
redis: Redis = Depends(redis_getter),
auth: AuthSchema = Depends(AuthPermission(["system:param:update"]))
) -> JSONResponse:
"""
修改参数
参数:
- data (ParamsUpdateSchema): 参数更新模型
- id (int): 参数ID
- redis (Redis): Redis 客户端实例
- auth (AuthSchema): 认证信息模型
返回:
- JSONResponse: 包含修改参数结果的 JSON 响应
"""
result_dict = await ParamsService.update_obj_service(auth=auth, redis=redis, id=id, data=data)
logger.info(f"更新参数成功 {result_dict}")
return SuccessResponse(data=result_dict, msg="更新参数成功")
@@ -91,6 +155,17 @@ async def delete_obj_controller(
ids: list[int] = Body(..., description="ID列表"),
auth: AuthSchema = Depends(AuthPermission(["system:param:delete"]))
) -> JSONResponse:
"""
删除参数
参数:
- redis (Redis): Redis 客户端实例
- ids (list[int]): 参数ID列表
- auth (AuthSchema): 认证信息模型
返回:
- JSONResponse: 包含删除参数结果的 JSON 响应
"""
await ParamsService.delete_obj_service(auth=auth, redis=redis, ids=ids)
logger.info(f"删除参数成功: {ids}")
return SuccessResponse(msg="删除参数成功")
@@ -101,7 +176,16 @@ async def export_obj_list_controller(
search: ParamsQueryParam = Depends(),
auth: AuthSchema = Depends(AuthPermission(["system:param:export"]))
) -> StreamingResponse:
# 获取全量数据
"""
导出参数
参数:
- search (ParamsQueryParam): 参数查询参数模型
- auth (AuthSchema): 认证信息模型
返回:
- StreamingResponse: 包含导出参数的 Excel 文件流响应
"""
result_dict_list = await ParamsService.get_obj_list_service(search=search, auth=auth)
export_result = await ParamsService.export_obj_service(data_list=result_dict_list)
logger.info('导出参数成功')
@@ -120,6 +204,16 @@ async def upload_file_controller(
file: UploadFile,
request: Request
) -> JSONResponse:
"""
上传文件
参数:
- file (UploadFile): 上传的文件对象
- request (Request): 请求对象
返回:
- JSONResponse: 包含上传文件结果的 JSON 响应
"""
result_str = await ParamsService.upload_service(base_url=str(request.base_url), file=file)
logger.info(f"上传文件: {result_str}")
return SuccessResponse(data=result_str, msg='上传文件成功')
@@ -129,6 +223,15 @@ async def upload_file_controller(
async def get_init_obj_controller(
redis: Redis = Depends(redis_getter),
) -> JSONResponse:
"""
获取初始化缓存参数
参数:
- redis (Redis): Redis 客户端实例
返回:
- JSONResponse: 获取初始化缓存参数的 JSON 响应
"""
result_dict = await ParamsService.get_init_config_service(redis=redis)
logger.info(f"获取初始化缓存参数成功 {result_dict}")
return SuccessResponse(data=result_dict, msg="获取初始化缓存参数成功")
backend/app/api/v1/module_system/params/crud.py
+62 -7
View File
@@ -12,30 +12,85 @@ class ParamsCRUD(CRUDBase[ParamsModel, ParamsCreateSchema, ParamsUpdateSchema]):
"""配置管理数据层"""
def __init__(self, auth: AuthSchema) -> None:
"""初始化配置CRUD"""
"""
初始化配置CRUD
参数:
- auth (AuthSchema): 认证信息模型
"""
self.auth = auth
super().__init__(model=ParamsModel, auth=auth)
async def get_obj_by_id_crud(self, id: int) -> Optional[ParamsModel]:
"""获取配置管理型详情"""
"""
获取配置管理型详情
参数:
- id (int): 配置管理型ID
返回:
- Optional[ParamsModel]: 配置管理型模型实例
"""
return await self.get(id=id)
async def get_obj_by_key_crud(self, key: str) -> Optional[ParamsModel]:
"""根据key获取配置管理型详情"""
"""
根据key获取配置管理型详情
参数:
- key (str): 配置管理型key
返回:
- Optional[ParamsModel]: 配置管理型模型实例
"""
return await self.get(config_key=key)
async def get_obj_list_crud(self, search: Optional[Dict] = None, order_by: Optional[List[Dict[str, str]]] = None) -> Sequence[ParamsModel]:
"""获取配置管理型列表"""
"""
获取配置管理型列表
参数:
- search (Dict | None): 查询参数对象。
- order_by (List[Dict[str, str]] | None): 排序参数列表。
返回:
- Sequence[ParamsModel]: 配置管理型模型实例列表
"""
return await self.list(search=search, order_by=order_by)
async def create_obj_crud(self, data: ParamsCreateSchema) -> Optional[ParamsModel]:
"""创建配置管理型"""
"""
创建配置管理型
参数:
- data (ParamsCreateSchema): 创建配置管理型负载模型
返回:
- Optional[ParamsModel]: 配置管理型模型实例
"""
return await self.create(data=data)
async def update_obj_crud(self, id: int, data: ParamsUpdateSchema) -> Optional[ParamsModel]:
"""更新配置管理型"""
"""
更新配置管理型
参数:
- id (int): 配置管理型ID
- data (ParamsUpdateSchema): 更新配置管理型负载模型
返回:
- Optional[ParamsModel]: 配置管理型模型实例
"""
return await self.update(id=id, data=data)
async def delete_obj_crud(self, ids: List[int]) -> None:
"""删除配置管理型"""
"""
删除配置管理型
参数:
- ids (List[int]): 配置管理型ID列表
返回:
- None
"""
return await self.delete(ids=ids)
backend/app/api/v1/module_system/params/service.py
+119 -8
View File
@@ -27,12 +27,31 @@ class ParamsService:
"""
@classmethod
async def get_obj_detail_service(cls, auth: AuthSchema, id: int) -> Dict:
"""
获取配置详情
参数:
- auth (AuthSchema): 认证信息模型
- id (int): 配置管理型ID
返回:
- Dict: 配置管理型模型实例字典表示
"""
obj = await ParamsCRUD(auth).get_obj_by_id_crud(id=id)
return ParamsOutSchema.model_validate(obj).model_dump()
@classmethod
async def get_obj_by_key_service(cls, auth: AuthSchema, config_key: str) -> Dict:
"""根据配置键获取配置详情"""
"""
根据配置键获取配置详情
参数:
- auth (AuthSchema): 认证信息模型
- config_key (str): 配置管理型key
返回:
- Dict: 配置管理型模型实例字典表示
"""
obj = await ParamsCRUD(auth).get_obj_by_key_crud(key=config_key)
if not obj:
raise CustomException(msg=f'配置键 {config_key} 不存在')
@@ -40,7 +59,16 @@ class ParamsService:
@classmethod
async def get_config_value_by_key_service(cls, auth: AuthSchema, config_key: str) -> str | None:
"""根据配置键获取配置值"""
"""
根据配置键获取配置值
参数:
- auth (AuthSchema): 认证信息模型
- config_key (str): 配置管理型key
返回:
- str | None: 配置值字符串或None
"""
obj = await ParamsCRUD(auth).get_obj_by_key_crud(key=config_key)
if not obj:
raise CustomException(msg=f'配置键 {config_key} 不存在')
@@ -48,6 +76,17 @@ class ParamsService:
@classmethod
async def get_obj_list_service(cls, auth: AuthSchema, search: Optional[ParamsQueryParam] = None, order_by: Optional[List[Dict[str, str]]]= None) -> List[Dict]:
"""
获取配置管理型列表
参数:
- auth (AuthSchema): 认证信息模型
- search (ParamsQueryParam | None): 查询参数对象
- order_by (List[Dict[str, str]] | None): 排序参数列表
返回:
- List[Dict]: 配置管理型模型实例字典列表表示
"""
obj_list = None
if search:
obj_list = await ParamsCRUD(auth).get_obj_list_crud(search=search.__dict__, order_by=order_by)
@@ -57,6 +96,17 @@ class ParamsService:
@classmethod
async def create_obj_service(cls, auth: AuthSchema, redis: Redis, data: ParamsCreateSchema) -> Dict:
"""
创建配置管理型
参数:
- auth (AuthSchema): 认证信息模型
- redis (Redis): Redis 客户端实例
- data (ParamsCreateSchema): 配置管理型创建模型
返回:
- Dict: 新创建的配置管理型模型实例字典表示
"""
exist_obj = await ParamsCRUD(auth).get(config_key=data.config_key)
if exist_obj:
raise CustomException(msg='创建失败，该配置key已存在')
@@ -82,6 +132,18 @@ class ParamsService:
@classmethod
async def update_obj_service(cls, auth: AuthSchema, redis: Redis, id:int, data: ParamsUpdateSchema) -> Dict:
"""
更新配置管理型
参数:
- auth (AuthSchema): 认证信息模型
- redis (Redis): Redis 客户端实例
- id (int): 配置管理型ID
- data (ParamsUpdateSchema): 配置管理型更新模型
返回:
- Dict: 更新后的配置管理型模型实例字典表示
"""
exist_obj = await ParamsCRUD(auth).get_obj_by_id_crud(id=id)
if not exist_obj:
raise CustomException(msg='更新失败，该数系统配置不存在')
@@ -112,6 +174,17 @@ class ParamsService:
@classmethod
async def delete_obj_service(cls, auth: AuthSchema, redis: Redis, ids: list[int]) -> None:
"""
删除配置管理型
参数:
- auth (AuthSchema): 认证信息模型
- redis (Redis): Redis 客户端实例
- ids (list[int]): 配置管理型ID列表
返回:
- None
"""
if len(ids) < 1:
raise CustomException(msg='删除失败，删除对象不能为空')
for id in ids:
@@ -140,7 +213,15 @@ class ParamsService:
@classmethod
async def export_obj_service(cls, data_list: List[Dict[str, Any]]) -> bytes:
"""导出系统配置列表"""
"""
导出系统配置列表
参数:
- data_list (List[Dict[str, Any]]): 系统配置模型实例字典列表表示
返回:
- bytes: Excel文件二进制数据
"""
mapping_dict = {
'id': '编号',
'config_name': '参数名称',
@@ -165,7 +246,16 @@ class ParamsService:
@classmethod
async def upload_service(cls, base_url: str, file: UploadFile) -> Dict:
"""上传文件"""
"""
上传文件
参数:
- base_url (str): 基础URL
- file (UploadFile): 上传的文件对象
返回:
- Dict: 上传文件的响应模型实例字典表示
"""
filename, filepath, file_url = await UploadUtil.upload_file(file=file, base_url=base_url)
return UploadResponseSchema(
@@ -177,6 +267,15 @@ class ParamsService:
@classmethod
async def init_config_service(cls, redis: Redis) -> None:
"""
初始化系统配置
参数:
- redis (Redis): Redis 客户端实例
返回:
- None
"""
async with AsyncSessionLocal() as session:
async with session.begin():
auth = AuthSchema(db=session)
@@ -202,7 +301,15 @@ class ParamsService:
@classmethod
async def get_init_config_service(cls, redis: Redis) -> List[Dict]:
"""获取系统配置"""
"""
获取系统配置
参数:
- redis (Redis): Redis 客户端实例
返回:
- List[Dict]: 系统配置模型实例字典列表表示
"""
redis_keys = await RedisCURD(redis).get_keys(f"{RedisInitKeyConfig.SYSTEM_CONFIG.key}:*")
redis_configs = await RedisCURD(redis).mget(redis_keys)
configs = []
@@ -220,10 +327,14 @@ class ParamsService:
@classmethod
async def get_system_config_for_middleware(cls, redis: Redis) -> Dict[str, Any]:
"""获取中间件所需的系统配置
"""
获取中间件所需的系统配置
返回：
Dict: 包含演示模式、IP白名单、API白名单和IP黑名单的配置字典
参数:
- redis (Redis): Redis 客户端实例
返回:
- Dict[str, Any]: 包含演示模式、IP白名单、API白名单和IP黑名单的配置字典
"""
# 定义需要获取的配置键
config_keys = [