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

Reviewed-on: #43

api/class_api.py

@@ -47,18 +47,19 @@ def get_classes( id:int|None = None                                  # id参数
         return ClassResponse( code = 404,detail = '没有符合条件的班级，请检查输入是否有误')    # 返回404响应，提示没有符合条件的提示给前端
 
 
-@classes_router.get('/student-count', summary='查询每个班级学生人数')
-def get_class_student_count( class_id:int|None = None
+# ————定定义查询符合查询条件的班级的总学生人数信息的接口函数————
+@classes_router.get('/student-count', summary='查询每个班级学生人数')           # get查询请求
+def get_class_student_count( class_id:int|None = None                            # id参数接收前端输入的数据，声明是整数，可以为空默认为空
                            , 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='没有班级数据')
+    t,r = get_class_student_count_dao(class_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 r:                                                  # 判断 DAO 层的返回结果，如果为True
+        return ClassResponse(total=t, data=r)              # 返回成功响应，携带符合条件的数据给前端
+    return ClassResponse(code=404, detail='没有班级数据')    # 如果 DAO 层返回的结果为False，返回404响应，提示没有符合条件的提示给前端
 
 
 

dao/class_dao.py

@@ -37,7 +37,7 @@ def get_classes_dao( class_id, class_no , class_name , page , page_size , db ):
         q = q.filter( Classes.class_no == class_no )                              # 则追加no过滤条件
     if class_name :                                                               # 如果传入了班级name参数
         q = q.filter( Classes.class_name == class_name )                          # 则追加name过滤条件
-    total = q.count()                                                             # tatal变量接收满足当前所有过滤条件的数据总条数
+    total = q.count()                                                             # total变量接收满足当前所有过滤条件的数据总条数
     r = q.offset( ( page-1 ) * page_size  ).limit( page_size ).all()              # 变量r用来接收查询取出结果列表，计算分页偏移量（从第几行开始查），设置分页限制条数
     return total , [                                                              # 返回 total变量总条数 和 将查询结果列表转换为字典列表的数据
                      {
@@ -54,28 +54,30 @@ 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')
+# ————定义查询符合查询条件的班级的总学生人数信息的函数————
+from sqlalchemy import func, and_ ,desc             # 从sqlalchemy模块导入func聚合函数的类、and_函数，降序排序desc函数
+from models.student import Student                  # 从models包下的student模块导入Student表模型类
+
+def get_class_student_count_dao(class_id,class_no,class_name,page,page_size,db):       # 定义函数，设置六个形参class_id, class_no , class_name , page , page_size , db
+    q = db.query (  Classes.id.label('class_id')                  # 查询班级ID(别名class_id)
+                  , Classes.class_no                              # 班级编号
+                  , Classes.class_name                            # 班级名称
+                  , func.count(Student.id).label('student_count') # 统计班级未删除的学生人数(别名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变量总条数 和 将查询结果列表转换为字典列表的数据
+                  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)    # 按班级ID、编号、名称进行分组聚合
+    q = q.order_by(  desc('student_count') )                            # 按学生人数（别名）进行降序排列
+    total = q.count()                                     # total变量接收满足当前所有过滤条件的数据总条数
+    r = q.offset( ( page-1 ) * page_size  ).limit( page_size ).all()    # 变量r用来接收查询取出结果列表，计算分页偏移量（从第几行开始查），设置分页限制条数
+    return total,[                                          # 返回 total变量总条数 和 将查询结果列表转换为字典列表的数据
                    {
                        'class_id':i.class_id                  # 提取班级ID
                      , 'class_no':i.class_no                  # 提取班级编号