添加部分注释

DAPlatform/dao/Data.py

@@ -47,6 +47,7 @@ def find_data(id):
     else:
         return Result(1, "find success", data.url)
 
+
 # 根据数据id寻找slice_id
 def find_slice_id(id):
     try:
@@ -56,6 +57,7 @@ def find_slice_id(id):
     else:
         return Result(1, "find success", data.slice_id)
 
+
 # 查找某分片下的文件（用于查看某分片下的文件信息）
 def find_data_by_slice(slice_id):
     try:
@@ -79,7 +81,7 @@ def find_data_by_slice(slice_id):
         return Result(1, "find success", list)
 
 
-# 查找某分片下的文件同时返回文件是否已被标注（用于查看某分片下的文件信息）
+# 查找某分片下的文件同时返回文件是否已被标注（用于查看我的任务分片下的文件信息）
 def find_data_by_slice_state(slice_id, executor):
     try:
         find = Data.select(Data.data_id, Data.name, Data.size, Data.url).where(

DAPlatform/dao/Relation.py

@@ -54,7 +54,7 @@ def set_grade(user_id, slice_id, data_id, score):
         return Result(1, "grade success", {})
 
 
-# 查找Relation中与用户id 任务id相关的分片列表
+# 查找Relation中与用户id 任务id相关的分片列表（待审核）
 def find_slice_by_task(taskid, user_id):
     try:
         slice_list = Relation.select(Relation.slice_id).where(Relation.user_id == user_id, Relation.flag == 1)

DAPlatform/dao/Slice.py

@@ -71,6 +71,7 @@ def delete_slice_by_task(task_id):
         return Result(1, "delete success", {})
 
 
+# 查找待审核的分片
 def find_slice_by_check(task_id):
     try:
         find = Slice.select(Slice.task_id, Slice.slice_id, Slice.document_number, Slice.type, Slice.model_id, Slice.illustration).where(
@@ -108,7 +109,7 @@ def find_slice_by_check(task_id):
         return Result(1, "find success", list)
 
 
-# 查找某任务下的分片(用于在分片列表中显示）
+# 查找某任务下的分片(用于在任务大厅分片列表中显示）
 def find_slice_by_task(task_id):
     try:
         find = Slice.select(Slice.slice_id, Slice.document_number, Slice.type, Slice.model_id, Slice.illustration).where(
@@ -142,7 +143,7 @@ def find_slice_by_task(task_id):
         return Result(1, "find success", list)
 
 
-# 查找某任务下用户选择的分片(用于在分片列表中显示）
+# 查找某任务下用户选择的分片(用于在我的任务分片列表中显示）
 def find_slice_by_task_user(task_id, user_id):
     try:
         slice_list = Relation.find_slice_by_executor(user_id)
@@ -278,6 +279,7 @@ def find_task_by_slice(slice_id):
     else:
         return s.task_id
 
+
 # 通过sliceid查找type
 def find_type_by_slice(slice_id):
     try:
@@ -287,6 +289,7 @@ def find_type_by_slice(slice_id):
     else:
         return s.type
 
+
 # 通过一个sliceid数组查找taskid
 def find_task_by_slicelist(slice_list):
     try:

DAPlatform/dao/Task.py

@@ -28,7 +28,7 @@ class Task(Model):
         database = mysql
 
 
-# 新建任务
+# 创建任务的函数（参数：发布任务者id、任务名称；返回值：若创建成功返回任务id）
 def create_task(publish_id, task_name):
     try:
         task = Task(publish_id=publish_id, task_name=task_name)
@@ -39,19 +39,8 @@ def create_task(publish_id, task_name):
         return Result(1, "create success", task.task_id, 0)
 
 
-# 判断该用户是否完成该任务
-def judge_completed(taskid, user_id):
-    ret = Slice.find_slice_by_judge(taskid, user_id)
-    list = ret.data
-    for item in list:
-        completedNum = item['completedNum']
-        totalNum = item['totalNum']
-        if completedNum != totalNum:
-            return 0
-    return 1
-
-
 # 根据任务名称查找任务（任务大厅搜索功能）
+# 参数：任务关键词、任务数组的范围
 def find_task_by_name(task_name, start, num):
     try:
         find = Task.select(Task.task_id, Task.task_name, Task.publish_id, Task.publish_time).where(
@@ -183,6 +172,18 @@ def find_task_completed(executor, start, num):
         return Result(1, "find success", list, math.ceil(len(find) / num))
 
 
+# 判断该用户是否完成该任务
+def judge_completed(taskid, user_id):
+    ret = Slice.find_slice_by_judge(taskid, user_id)
+    list = ret.data
+    for item in list:
+        completedNum = item['completedNum']
+        totalNum = item['totalNum']
+        if completedNum != totalNum:
+            return 0
+    return 1
+
+
 # 寻找标注者选择的任务（从Relation表中找到用户id标注的分片，再利用分片表获取任务列表）
 def find_task_my_task(executor, start, num):
     try:
@@ -210,7 +211,7 @@ def find_task_my_task(executor, start, num):
         return Result(1, "find success", list, math.ceil(len(find) / num))
 
 
-# 删除任务
+# 根据id删除任务
 def delete_task(task_id):
     try:
         Task.delete().where(Task.task_id == task_id).execute()

DAPlatform/views/task.py

@@ -9,15 +9,15 @@ task = Blueprint("task", __name__, url_prefix="/api/task")
 # 各个界面获取任务列表的接口
 @task.route("/getTasks", methods=["GET"])
 def get_tasks():
-    pagesize = int(request.args['pageSize'])
-    currentpage = int(request.args['currentPage'])
-    keyword = request.args.get('keyword')
-    executor = request.args.get('executor')
-    creator = request.args.get('creator')
-    state = request.args.get('state')
+    pagesize = int(request.args['pageSize'])  # 任务列表单页可容纳最大任务数
+    currentpage = int(request.args['currentPage'])  # 任务列表当前页数
+    keyword = request.args.get('keyword')  # 搜索任务时的搜索关键词
+    executor = request.args.get('executor')  # 任务标注者id
+    creator = request.args.get('creator')  # 任务发布者id
+    state = request.args.get('state')   # 任务状态：已完成、待审核等
     # get函数用于可选参数，在未接收到参数时返回空值
     if keyword:
-        ret = Task.find_task_by_name(keyword, pagesize*(currentpage-1), pagesize)
+        ret = Task.find_task_by_name(keyword, pagesize * (currentpage - 1), pagesize)
     elif creator:
         if state:
             ret = Task.find_task_check(creator, pagesize * (currentpage - 1), pagesize)
@@ -29,7 +29,7 @@ def get_tasks():
         else:
             ret = Task.find_task_my_task(executor, pagesize * (currentpage - 1), pagesize)
     else:
-        ret = Task.find_task(pagesize*(currentpage-1), pagesize)
+        ret = Task.find_task(pagesize * (currentpage - 1), pagesize)
     res = {
         'code': ret.code,
         'message': ret.message,