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

Reviewed-on: #42

api/class_api.py

@@ -46,6 +46,23 @@ def get_classes( id:int|None = None                                  # id参数
     else :                                                     # 判断 DAO 层的返回结果，如果为条数为0
         return ClassResponse( code = 404,detail = '没有符合条件的班级，请检查输入是否有误')    # 返回404响应，提示没有符合条件的提示给前端
 
+
+@classes_router.get('/student-count', summary='查询每个班级学生人数')
+def get_class_student_count( class_id:int|None = None
+                           , class_no:str|None = None                            # class_no参数接收前端输入的数据，声明是字符串，可以为空默认为空
+                           , class_name:str|None = None                          # class_name参数接收前端输入的数据，声明是字符串，可以为空默认为空
+                           , page:int = 1                                        # page参数接收前端输入的数据，声明是整数，默认是1
+                           , page_size:int = 5                                   # page参数接收前端输入的数据，声明是整数，默认是5
+                           , db=Depends(get_db)                                  # 参数db依赖于数据库会话的上下文管理器
+                           ):
+    t,r = get_class_student_count_dao(class_id,class_no,class_name,page,page_size,db)
+    if r:
+        return ClassResponse(total=t, data=r)
+    return ClassResponse(code=404, detail='没有班级数据')
+
+
+
+
 # ————定义班级表"删除"信息的接口函数————
 @classes_router.delete('/{id}',response_model=ClassResponse,summary='删除班级信息')   # delete删除请求，指定返回数据格式为 ClassResponse
 def delete_classes(id:int,db=Depends(get_db)):                                           # 定义删除接口函数，id参数接收前端输入的数据，参数db依赖于数据库会话的上下文管理器

dao/class_dao.py

@@ -54,6 +54,38 @@ def get_classes_dao( class_id, class_no , class_name , page , page_size , db ):
                     ]
 
 
+from sqlalchemy import func, and_,desc
+from models.student import Student
+
+def get_class_student_count_dao(class_id,class_no,class_name,page,page_size,db):
+    q = db.query (  Classes.id.label('class_id')
+                  , Classes.class_no
+                  , Classes.class_name
+                  , func.count(Student.id).label('student_count')
+                  ) .\
+                  outerjoin(  Student, and_(Classes.id == Student.class_id,Student.is_deleted == 0)).\
+                  filter(Classes.is_deleted == 0)
+    if class_id :                                                                 # 如果传入了班级id参数
+        q = q.filter( Classes.id == class_id )                                    # 则追加id过滤条件
+    if class_no :                                                                 # 如果传入了班级no参数
+        q = q.filter( Classes.class_no == class_no )                              # 则追加no过滤条件
+    if class_name :                                                               # 如果传入了班级name参数
+        q = q.filter( Classes.class_name == class_name )                          # 则追加name过滤条件
+    q = q.group_by(Classes.id, Classes.class_no, Classes.class_name)
+    q = q.order_by(  desc('student_count') )
+    total = q.count()                                                             # tatal变量接收满足当前所有过滤条件的数据总条数
+    r = q.offset( ( page-1 ) * page_size  ).limit( page_size ).all()
+    return total,[                                                              # 返回 total变量总条数 和 将查询结果列表转换为字典列表的数据
+                   {
+                       'class_id':i.class_id                  # 提取班级ID
+                     , 'class_no':i.class_no                  # 提取班级编号
+                     , 'class_name':i.class_name              # 提取班级名称
+                     , 'student_count':i.student_count        # 提取开课日期
+                    }
+                       for i in r                             # 循环遍历查询出的每一行数据 i
+                 ]
+
+
 # ————定义班级表"删除"信息的函数————
 def delete_classes_dao( class_id , db  ):    # 定义函数，设置两个个形参class_id，db
     try :                                       # 执行以下可能报错的代码

schemas/class_schema.py

@@ -25,4 +25,4 @@ class ClassResponse( BaseModel ):        # 班级信息的响应体模型
     code:int = 200                       # 状态码，默认200
     detail:str = '执行成功'                # 提示信息
     total:int = 0                        # 数据总条数，默认为0
-    data:str|dict|list|tuple             # 返回的数据
+    data:str|dict|list|tuple = ''            # 返回的数据