lookerZz/DoubaoTeam
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Merge pull request '添加注释' (#37) from zhutt into main

Browse Source 
Reviewed-on: #37
This commit was merged in pull request #37.
This commit is contained in:
lookerZz
2026-09-22 11:32:19 +08:00
parent b70994d9bb 569443f489
commit 52269842d8
2 changed files with 75 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api/class_api.py
+30 -29
View File
@@ -10,8 +10,8 @@ classes_router = APIRouter()
#以下分别定义增、删、改、查的路由的接口函数，以便api接口函数中执行 #以下分别定义增、删、改、查的路由的接口函数，以便api接口函数中执行
# ————定义班级表"更新"信息的"接口"函数———— # ————定义班级表"新增"信息的接口函数————
@classes_router.post('/',response_model=ClassResponse,summary='新增班级信息') # 定义班级创建路由，POST请求，指定返回数据格式为 ClassResponse @classes_router.post('/',response_model=ClassResponse,summary='新增班级信息') # POST新增请求，指定返回数据格式为 ClassResponse
def post_classes(classes:ClassCreate,db=Depends(get_db)): # 定义更新接口函数，参数classes声明创建请求模型，参数db依赖于数据库会话的上下文管理器 def post_classes(classes:ClassCreate,db=Depends(get_db)): # 定义更新接口函数，参数classes声明创建请求模型，参数db依赖于数据库会话的上下文管理器
c = classes.model_dump() # 变量c用来接收通过model_dump将Pydantic模型对象解析为Python的字典，方便后续解包传参 c = classes.model_dump() # 变量c用来接收通过model_dump将Pydantic模型对象解析为Python的字典，方便后续解包传参
r = post_classes_dao( c , db ) # 变量r用来接收dao层post_classes_dao函数的返回值，执行函数时以变量c的数据和db依赖函数入参 r = post_classes_dao( c , db ) # 变量r用来接收dao层post_classes_dao函数的返回值，执行函数时以变量c的数据和db依赖函数入参
@@ -21,34 +21,35 @@ def post_classes(classes:ClassCreate,db=Depends(get_db)): # 定义更
raise HTTPException(status_code=500,detail='添加失败，服务器繁忙，请稍后添加！') # 抛出 500 内部服务器错误 和提示 raise HTTPException(status_code=500,detail='添加失败，服务器繁忙，请稍后添加！') # 抛出 500 内部服务器错误 和提示
@classes_router.put('/{id}',response_model=ClassResponse,summary='更新班级信息') # ————定义班级表"更新"信息的接口函数————
def put_classes(classes:ClassUpdate,id:int,db=Depends(get_db)): @classes_router.put('/{id}',response_model=ClassResponse,summary='更新班级信息') # put更新请求，指定返回数据格式为 ClassResponse
updates = classes.model_dump( exclude_unset=True ) def put_classes( classes:ClassUpdate , id:int , db=Depends( get_db ) ): # 定义更新接口函数，id参数接收前端输入的数据，参数classes声明更新请求体模型，参数db依赖于数据库会话的上下文管理器
r = update_classes_dao( id, db, updates ) updates = classes.model_dump( exclude_unset=True ) # 变量updates用来接收通过model_dump将Pydantic模型对象解析为Python的字典(只解析输入的数据)，方便后续解包传参
if not r : r = update_classes_dao( id, db, updates ) # 变量r用来接收dao层update_classes_dao函数的返回值，执行函数时以变量c的数据、db依赖函数、和前端更新的数据入参
raise HTTPException(status_code=500, detail='更新失败，该班级已不存在或服务器繁忙，请稍后更新！') if r : # 判断 DAO 层的返回结果，如果为True
return ClassResponse(detail='更新成功', total=1 ,data = updates ) return ClassResponse( detail='更新成功', total=1 ,data = updates ) # 返回成功响应，携带更新的数据给前端
raise HTTPException( status_code=500, detail='更新失败，该班级已不存在或服务器繁忙，请稍后更新！' ) # 如果为False，抛出 500 内部服务器错误 和提示
@classes_router.get('',summary='查询班级信息') # ————定义班级表"查询"信息的接口函数————
def get_classes( id:int|None = None @classes_router.get('',summary='查询班级信息') # get查询请求
, class_no:str|None = None def get_classes( id:int|None = None # id参数接收前端输入的数据，声明是整数，可以为空默认为空
, class_name:str|None = None , class_no:str|None = None # class_no参数接收前端输入的数据，声明是字符串，可以为空默认为空
, page:int = 1 , class_name:str|None = None # class_name参数接收前端输入的数据，声明是字符串，可以为空默认为空
, page_size:int = 5 , page:int = 1 # page参数接收前端输入的数据，声明是整数，默认是1
, db=Depends(get_db) , page_size:int = 5 # page参数接收前端输入的数据，声明是整数，默认是5
, db=Depends(get_db) # 参数db依赖于数据库会话的上下文管理器
): ):
t,r = get_classes_dao( id , class_no , class_name , page , page_size ,db ) t,r = get_classes_dao( id , class_no , class_name , page , page_size ,db ) # 变量t,r用来接收dao层get_classes_dao函数的返回值，执行函数时以前端输入的id , class_no , class_name , page , page_size 、db依赖函数入参
if t != 0 : if t != 0 : # 判断 DAO 层的返回结果，如果为条数不为0
return ClassResponse( total = t, data = r ) return ClassResponse( total = t, data = r ) # 返回成功响应，返回符合条件的总条数，携带符合条件的数据给前端
else : else : # 判断 DAO 层的返回结果，如果为条数为0
return ClassResponse( code = 404,detail = '没有符合条件的班级，请检查输入是否有误') return ClassResponse( code = 404,detail = '没有符合条件的班级，请检查输入是否有误') # 返回404响应，提示没有符合条件的提示给前端
# ————定义班级表"删除"信息的接口函数————
@classes_router.delete('/{id}',response_model=ClassResponse,summary='删除班级信息') @classes_router.delete('/{id}',response_model=ClassResponse,summary='删除班级信息') # delete删除请求，指定返回数据格式为 ClassResponse
def delete_classes(id:int,db=Depends(get_db)): def delete_classes(id:int,db=Depends(get_db)): # 定义删除接口函数，id参数接收前端输入的数据，参数db依赖于数据库会话的上下文管理器
r = delete_classes_dao( id , db ) r = delete_classes_dao( id , db ) # 变量r用来接收dao层delete_classes_dao函数的返回值，执行函数时以以前端输入的id 数据、db依赖函数入参
if r : if r : # 判断 DAO 层的返回结果，如果是True
return ClassResponse( total=1,data='已成功删除班级信息' ) return ClassResponse( total=1,data='已成功删除班级信息' ) # 返回成功响应和提示给前端 # 如果是False
else : raise HTTPException(status_code=500, detail='删除失败，该班级信息已不存在或服务器繁忙，请稍后更新！') # 如果为False，抛出 500 内部服务器错误 和提示
raise HTTPException(status_code=500, detail='删除失败，该班级信息已不存在或服务器繁忙，请稍后更新！')
dao/class_dao.py
+45 -40
View File
@@ -15,47 +15,52 @@ def post_classes_dao( c , db ): # 定义函数，设置两个
db.commit() # 提交事务：将数据真正持久化写入到数据库中 db.commit() # 提交事务：将数据真正持久化写入到数据库中
return True # 返回 True，返回接口，表示操作成功 return True # 返回 True，返回接口，表示操作成功
def update_classes_dao( class_id , db , updates ):
try : # ————定义班级表"更新"信息的函数————
r = db.query(Classes).filter(Classes.id ==class_id , Classes.is_deleted == 0 ).update(updates) def update_classes_dao( class_id , db , updates ): # 定义函数，设置三个形参class_id，db ，updates
except : try : # 执行以下可能报错的代码
db.rollback() db.query(Classes).filter(Classes.id ==class_id , Classes.is_deleted == 0 ).update(updates) # 将接口函数接收的更新数据更新到Classes模型对象，条件是未删除且前端输入的id和数据库id可以匹配上的
return False except : # 捕获异常：
else : db.rollback() # 如果中间出错，回滚事务，防止产生脏数据
db.commit() return False # 返回 False，返回接口，表示操作失败
return r else : # 执行成功：
db.commit() # 提交事务：将数据真正持久化写入到数据库中
return True # 返回 True，返回接口，表示操作成功
def get_classes_dao( class_id, class_no , class_name , page , page_size , db ): # ————定义班级表"查询"信息的函数————
q = db.query( Classes ).filter( Classes.is_deleted == 0 ) def get_classes_dao( class_id, class_no , class_name , page , page_size , db ): # 定义函数，设置六个形参class_id, class_no , class_name , page , page_size , db
if class_id : q = db.query( Classes ).filter( Classes.is_deleted == 0 ) # 初始化查询语句，基础过滤条件为筛选未删除的数据 (is_deleted=0)
q = q.filter( Classes.id == class_id ) if class_id : # 如果传入了班级id参数
if class_no : q = q.filter( Classes.id == class_id ) # 则追加id过滤条件
q = q.filter( Classes.class_no == class_no ) if class_no : # 如果传入了班级no参数
if class_name : q = q.filter( Classes.class_no == class_no ) # 则追加no过滤条件
q = q.filter( Classes.class_name == class_name ) if class_name : # 如果传入了班级name参数
total = q.count() q = q.filter( Classes.class_name == class_name ) # 则追加name过滤条件
r = q.offset( ( page-1 ) * page_size ).limit( page_size ).all() total = q.count() # tatal变量接收满足当前所有过滤条件的数据总条数
return total,[ { 'class_id':i.id r = q.offset( ( page-1 ) * page_size ).limit( page_size ).all() # 变量r用来接收查询取出结果列表，计算分页偏移量（从第几行开始查），设置分页限制条数
, 'class_no':i.class_no return total , [ # 返回 total变量总条数 和 将查询结果列表转换为字典列表的数据
, 'class_name':i.class_name {
, 'start_date':i.start_date 'class_id':i.id # 提取班级ID
, 'end_date':i.end_date , 'class_no':i.class_no # 提取班级编号
, 'created_at':i.created_at , 'class_name':i.class_name # 提取班级名称
, 'update_at':i.update_at , 'start_date':i.start_date # 提取开课日期
, 'remark':i.remark , 'end_date':i.end_date # 提取结课日期
} , 'created_at':i.created_at # 提取创建时间
for i in r , 'update_at':i.update_at # 提取更新时间
] , 'remark':i.remark # 提取备注信息
}
for i in r # 循环遍历查询出的每一行数据 i
]
# ————定义班级表"删除"信息的函数————
def delete_classes_dao( class_id , db ): def delete_classes_dao( class_id , db ): # 定义函数，设置两个个形参class_id，db
try : try : # 执行以下可能报错的代码
db.query( Classes ).filter( Classes.id == class_id , Classes.is_deleted == 0 ).update( {"is_deleted": 1} ) db.query( Classes ).filter( Classes.id == class_id , Classes.is_deleted == 0 ).update( {"is_deleted": 1} ) # 将未删除且前端输入的id和数据库id可以匹配上的数据更新is_deleted字段为1，表示已逻辑删除
except : except : # 捕获异常：
db.rollback() db.rollback() # 如果中间出错，回滚事务，防止产生脏数据
return False return False # 返回 False，返回接口，表示操作失败
else : else : # 执行成功：
db.commit() db.commit() # 提交事务：更新is_deleted字段为1，表示已逻辑删除，前端无法查询到已逻辑删除的数据
return True return True # 返回 True，返回接口，表示操作成功