diff --git a/api/class_api.py b/api/class_api.py index d5af66f..e581d82 100644 --- a/api/class_api.py +++ b/api/class_api.py @@ -1,25 +1,54 @@ -from fastapi import APIRouter,Depends,HTTPException -from schemas.class_schema import * -from core.database import get_db -from dao.class_dao import * +# 班级api模块 +from fastapi import APIRouter,Depends,HTTPException # 导入fastapi模块下的APIRouter,Depends,HTTPException +from schemas.class_schema import * # 从schemas包下的class_schema模块导入所有请求体、响应体 +from core.database import get_db # 从core包下的database模块导入get_db上下文管理器，调用get_db函数可以自动开启关闭与数据库的会话 +from dao.class_dao import * # 从dao包下的class_dao模块导入所有函数 +# 实例化班级路由对象 classes_router = APIRouter() -@classes_router.post('/',response_model=ClassResponse) -def post_classes(classes:ClassCreate,db=Depends(get_db)): - c = classes.model_dump() - r = post_classes_dao( c , db ) - if r : - return ClassResponse( total=1,data=c ) - else : - raise HTTPException(status_code=500,detail='添加失败，服务器繁忙，请稍后添加！') + +#以下分别定义增、删、改、查的路由的接口函数，以便api接口函数中执行 + +# ————定义班级表"更新"信息的"接口"函数———— +@classes_router.post('/',response_model=ClassResponse,summary='新增班级信息') # 定义班级创建路由，POST请求，指定返回数据格式为 ClassResponse +def post_classes(classes:ClassCreate,db=Depends(get_db)): # 定义更新接口函数，参数classes声明创建请求模型，参数db依赖于数据库会话的上下文管理器 + c = classes.model_dump() # 变量c用来接收通过model_dump将Pydantic模型对象解析为Python的字典，方便后续解包传参 + r = post_classes_dao( c , db ) # 变量r用来接收dao层post_classes_dao函数的返回值，执行函数时以变量c的数据和db依赖函数入参 + if r : # 判断 DAO 层的返回结果，如果为True + return ClassResponse( total=1,data=c ) # 返回成功响应，携带新增的数据给前端 + else : # 如果为False + raise HTTPException(status_code=500,detail='添加失败，服务器繁忙，请稍后添加！') # 抛出 500 内部服务器错误 和提示 -@classes_router.put('/{id}',response_model=ClassResponse) -def put_classes(id:int,classes:ClassUpdate,db=Depends(get_db)): +@classes_router.put('/{id}',response_model=ClassResponse,summary='更新班级信息') +def put_classes(classes:ClassUpdate,id:int,db=Depends(get_db)): updates = classes.model_dump( exclude_unset=True ) - r = update_classes_dao( id , db , updates ) - if r : - return ClassResponse( total=1,data=updates ) + r = update_classes_dao( id, db, updates ) + if not r : + raise HTTPException(status_code=500, detail='更新失败，该班级已不存在或服务器繁忙，请稍后更新！') + return ClassResponse(detail='更新成功', total=1 ,data = updates ) + + +@classes_router.get('',summary='查询班级信息') +def get_classes( id:int|None = None + , class_no:str|None = None + , class_name:str|None = None + , page:int = 1 + , page_size:int = 5 + , db=Depends(get_db) + ): + t,r = get_classes_dao( id , class_no , class_name , page , page_size ,db ) + if t != 0 : + return ClassResponse( total = t, data = r ) else : - raise HTTPException(status_code=500, detail='更新失败，该班级已不存在或服务器繁忙，请稍后更新！') \ No newline at end of file + return ClassResponse( code = 404,detail = '没有符合条件的班级，请检查输入是否有误') + + +@classes_router.delete('/{id}',response_model=ClassResponse,summary='删除班级信息') +def delete_classes(id:int,db=Depends(get_db)): + r = delete_classes_dao( id , db ) + if r : + return ClassResponse( total=1,data='已成功删除班级信息' ) + else : + raise HTTPException(status_code=500, detail='删除失败，该班级信息已不存在或服务器繁忙，请稍后更新！') \ No newline at end of file diff --git a/dao/class_dao.py b/dao/class_dao.py index e1f93a0..870745d 100644 --- a/dao/class_dao.py +++ b/dao/class_dao.py @@ -1,29 +1,61 @@ -from models.class_model import Classes +# 班级dao模块 +from models.class_model import Classes # 从models包里的class_model班级模块导入Classes表模型类 +#以下分别定义增、删、改、查的依赖函数，以便api接口函数中执行 -def post_classes_dao( c , db ): - try : - cc = Classes( **c ) - db.add( cc ) - except : - db.rollback() - return False - else : - db.commit() - return True +# ————定义班级表"新增"信息的函数———— +def post_classes_dao( c , db ): # 定义函数，设置两个形参c，db + try : # 执行以下可能报错的代码 + cc = Classes( **c ) # 将接口函数接收的字典数据解包，实例化为 Classes 模型对象 + db.add( cc ) # 将模型对象加入当前数据库会话（尚未真正写入数据库） + except : # 捕获异常： + db.rollback() # 如果中间出错，回滚事务，防止产生脏数据 + return False # 返回 False，返回接口，表示操作失败 + else : # 执行成功： + db.commit() # 提交事务：将数据真正持久化写入到数据库中 + return True # 返回 True，返回接口，表示操作成功 def update_classes_dao( class_id , db , updates ): try : - db.query( Classes ).filter( Classes.id==class_id , Classes.is_deleted==0 ) .update( updates ) + r = db.query(Classes).filter(Classes.id ==class_id , Classes.is_deleted == 0 ).update(updates) + except : + db.rollback() + return False + else : + db.commit() + return r + + +def get_classes_dao( class_id, class_no , class_name , page , page_size , db ): + q = db.query( Classes ).filter( Classes.is_deleted == 0 ) + if class_id : + q = q.filter( Classes.id == class_id ) + if class_no : + q = q.filter( Classes.class_no == class_no ) + if class_name : + q = q.filter( Classes.class_name == class_name ) + total = q.count() + r = q.offset( ( page-1 ) * page_size ).limit( page_size ).all() + return total,[ { 'class_id':i.id + , 'class_no':i.class_no + , 'class_name':i.class_name + , 'start_date':i.start_date + , 'end_date':i.end_date + , 'created_at':i.created_at + , 'update_at':i.update_at + , 'remark':i.remark + } + for i in r + ] + + + +def delete_classes_dao( class_id , db ): + try : + db.query( Classes ).filter( Classes.id == class_id , Classes.is_deleted == 0 ).update( {"is_deleted": 1} ) except : db.rollback() return False else : db.commit() return True - -# def get_classes_dao( class_id , class_name , db ): -# try : -# r = db.query( Classes ).filter( Classes.id==class_id , Classes.is_deleted==0 ) .all() -# except : -# db.rollback() \ No newline at end of file diff --git a/models/class_model.py b/models/class_model.py index dc6ce4a..23c9bc1 100644 --- a/models/class_model.py +++ b/models/class_model.py @@ -1,3 +1,4 @@ +# 班级model模块 from sqlalchemy import * # 导入sqlalchemy模块下所有的类，以便下面创建班级表模型和声明表的字段 from datetime import datetime # 导入datetime模块下的datetime类 from core.database import Base # 从core软件包下的database模块导入Base @@ -50,4 +51,4 @@ class Classes( Base ): # 在python里的名字 , default = 0 # 声明默认值是"0，未删除" , server_default = text("0") , nullable = False # 声明是"非空" - ) + ) \ No newline at end of file diff --git a/schemas/class_schema.py b/schemas/class_schema.py index 05029b6..cd30de2 100644 --- a/schemas/class_schema.py +++ b/schemas/class_schema.py @@ -1,24 +1,28 @@ +# 班级schema模块 from pydantic import BaseModel # 导入pydantic模块下的BaseModel类 from datetime import datetime,date # 导入datetime模块下的datetime,date类 + # ————定义"创建班级"的"请求体"模型———— -class ClassCreate( BaseModel ): - class_no: str - class_name: str +class ClassCreate( BaseModel ): # "创建"班级信息的请求体模型 + class_no: str # 班级编号"，不可为空 + class_name: str # 班级名字"，不可为空 + start_date : date|None = None # 班级开课日期"，可以为空，默认为空 + end_date : date|None = None # 班级结课日期"，可以为空，默认为空 + remark : str|None = None # 班级备注"，可以为空，默认为空 # ————定义"更新班级"的"请求体"模型———— -class ClassUpdate( BaseModel ): - class_no: str|None = None - class_name: str|None = None - start_date : date|None = None - end_date : date|None = None - created_at : datetime|None = None - update_at : datetime|None = None +class ClassUpdate( BaseModel ): # "更新"班级信息的请求体模型 + class_no: str|None = None # 班级编号，可以为空，默认为空 + class_name: str|None = None # 班级名字，可以为空，默认为空 + start_date : date|None = None # 班级开课日期，可以为空，默认为空 + end_date : date|None = None # 班级结课日期，可以为空，默认为空 + remark: str|None = None # 班级备注，可以为空，默认为空 # ————定义"班级"的"响应体"模型———— -class ClassResponse( BaseModel ): - code:int = 200 - detail:str = '执行成功' - total:int = 0 - data:str|dict|list|tuple +class ClassResponse( BaseModel ): # 班级信息的响应体模型 + code:int = 200 # 状态码，默认200 + detail:str = '执行成功' # 提示信息 + total:int = 0 # 数据总条数，默认为0 + data:str|dict|list|tuple # 返回的数据 \ No newline at end of file