example toolsを追加

yuji38kwmt · yuji38kwmt · commit 7b04de434e89 · 2019-05-16T22:33:38.000+09:00
diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@
 * 「画像を入力データとして登録する」機能など、APIを組み合わせた機能を利用できます。
 
 # Requirements
-* python 3.6+
+* Python 3.6+
 
 # Install
 
diff --git a/annofabapi/utils.py b/annofabapi/utils.py
@@ -8,6 +8,7 @@
 import os
 
 import dateutil
+import dateutil.tz
 import requests
 
 
diff --git a/examples/README.md b/examples/README.md
@@ -2,8 +2,16 @@
 annofabapiモジュールを使ったサンプルコードです。
 pythonコマンドを使ってCLIとして利用できます。
 
+# Requirements
+* Python 3.6+
+* 最新のannofabapiモジュール
+
 # 使い方
 
+## AnnoFabの認証情報の設定
+`.netrc`ファイルにAnnoFabの認証情報を記載してください。
+詳しくは[../README.md](../README.md)を参照してください。
+
 ## Pipenvを使う場合
 
 ```
@@ -41,6 +49,8 @@ $ python invite_user_to_projects.py -h
 
 ## invite_user_to_projects.py
 複数のプロジェクトに、ユーザを招待します。
+各プロジェクトのオーナ権限を持つユーザで実行してください。
+※オーナ権限を持たないプロジェクトの場合はスキップします
 
 ```
 # ORG組織配下のすべてのプロジェクトに、user1をownerロールで割り当てる
@@ -52,7 +62,18 @@ $ python invite_user_to_projects.py --user_id user1 --role owner --project_id pr
 
 ## cancel_acceptance.py
 受け入れ完了タスクを、受け入れ取り消しにします。
+アノテーション仕様を途中で変更したときなどに、利用します。
+
+対象のタスクは、以下のようなtask_idの一覧が記載されたファイルで指定します。
+
+```
+task_id1
+task_id2
+task_id3
+...
+```
 
+プロジェクトのオーナ権限を持つユーザで実行してください。
 
 ```
 # prj1プロジェクトのタスクを、受け入れ取り消しにする。再度受け入れを担当させるユーザは未担当
@@ -62,3 +83,12 @@ $ python cancel_acceptance.py --project_id prj1 --task_id_file file
 $ python cancel_acceptance.py --project_id prj1 --task_id_file file --user_id user1
 ```
 
+## reject_tasks_with_adding_comment.py
+アノテーション仕様を途中で変更したときなどに、利用します。
+
+プロジェクトのチェッカー以上の権限を持つユーザで実行してください。
+
+```
+# prj1プロジェクトのタスクを、差し戻す
+$ python cancel_acceptance.py --project_id prj1 --task_id_file file --comment "auto comment at tool"
+```
diff --git a/examples/cancel_acceptance.py b/examples/cancel_acceptance.py
@@ -10,7 +10,7 @@
 
 import annofabapi
 
-from example_utils import read_lines
+from example_utils import read_lines, ExamplesWrapper
 
 logging_formatter = '%(levelname)s : %(asctime)s : %(name)s : %(funcName)s : %(message)s'
 logging.basicConfig(format=logging_formatter)
@@ -33,8 +33,7 @@ def cancel_acceptance(project_id: str, task_id_list: List[str], acceptor_user_id
         task_id_list: 受け入れ取り消しするtask_id_list
         acceptor_user_id: 再度受入を担当させたいユーザのuser_id
     """
-    acceptor_account_id = get_account_id_from_user_id(project_id,
-                                                      acceptor_user_id) if acceptor_user_id is not None else None
+    acceptor_account_id = examples_wrapper.get_account_id_from_user_id(project_id, acceptor_user_id)
 
     for task_id in task_id_list:
         try:
@@ -88,6 +87,7 @@ def main(args):
     logger.info(args)
 
     service = annofabapi.build_from_netrc()
+    examples_wrapper = ExamplesWrapper(service)
 
     try:
         main(args)
diff --git a/examples/example_utils.py b/examples/example_utils.py
@@ -1,9 +1,131 @@
 from typing import Any, Dict, List, Optional, Tuple, Union
 
+import annofabapi
 
 def read_lines(filepath: str) -> List[str]:
     """ファイルを行単位で読み込む。改行コードを除く"""
     with open(filepath) as f:
         lines = f.readlines()
     return [e.rstrip('\r\n') for e in lines]
 
+class ExamplesWrapper:
+    """
+    Exampleツール用のWrapperクラス
+    Returns:
+
+    """
+    def __init__(self, service: annofabapi.Resource):
+        self.service = service
+
+    def get_account_id_last_annotation_phase(self, task_histories: List[Dict[str, Any]]):
+        """
+        タスク履歴の最後のannotation phaseを担当したaccount_idを取得する. なければNoneを返す
+        Args:
+            task_histories:
+
+        Returns:
+
+
+        """
+        annotation_histories = [e for e in task_histories if e["phase"] == "annotation"]
+        if len(annotation_histories) > 0:
+            last_history = annotation_histories[-1]
+            return last_history["account_id"]
+        else:
+            return None
+
+    def get_account_id_from_user_id(self, project_id: str, user_id: str):
+        """
+        usre_idからaccount_idを取得する
+        Args:
+            project_id:
+            user_id:
+
+        Returns:
+            account_id
+
+        """
+        member, _ = self.service.api.get_project_member(project_id, user_id)
+        return member['account_id']
+
+
+    def change_operator_of_task(self, project_id: str, task_id: str, account_id: str) -> Dict[str, Any]:
+        """
+        タスクの担当者を変更する
+        Args:
+            self:
+            project_id:
+            task_id:
+            account_id:
+
+        Returns:
+            変更後のtask情報
+
+        """
+        task, _ = self.service.api.get_task(project_id, task_id)
+
+        req = {
+            "status": "not_started",
+            "account_id": account_id,
+            "last_updated_datetime": task["updated_datetime"],
+
+        }
+        return self.service.api.operate_task(project_id, task_id, request_body=req)[0]
+
+    def change_to_working_phase(self, project_id: str, task_id: str, account_id: str) -> Dict[str, Any]:
+        """
+        タスクを作業中に変更する
+        Args:
+            self:
+            project_id:
+            task_id:
+            account_id:
+
+        Returns:
+            変更後のtask情報
+
+        """
+        task, _ = self.service.api.get_task(project_id, task_id)
+
+        req = {
+            "status": "working",
+            "account_id": account_id,
+            "last_updated_datetime": task["updated_datetime"],
+
+        }
+        return self.service.api.operate_task(project_id, task_id, request_body=req)[0]
+
+
+    def reject_task(self, project_id: str, task_id: str, account_id: str):
+        """
+        タスクを差し戻したあと、最後のannotation phase担当者に割り当てる。
+        Args:
+            task_id:
+            account_id: 差し戻すときのユーザのaccount_id
+
+        Returns:
+            変更あとのtask情報
+
+        """
+
+        # タスクを差し戻す
+        task, _ = self.service.api.get_task(project_id, task_id)
+        annotator_account_id = self.get_account_id_last_annotation_phase(task["histories_by_phase"])
+
+        req_reject = {
+            "status": "rejected",
+            "account_id": account_id,
+            "last_updated_datetime": task["updated_datetime"],
+
+        }
+        rejected_task, _ = self.service.api.operate_task(project_id, task_id, request_body=req_reject)
+
+        req_change_operator = {
+            "status": "not_started",
+            "account_id": annotator_account_id,
+            "last_updated_datetime": rejected_task["updated_datetime"],
+
+        }
+        updated_task, _ = self.service.api.operate_task(project_id, task["task_id"], request_body=req_change_operator)
+        return updated_task
+
diff --git a/examples/reject_tasks_with_adding_comment.py b/examples/reject_tasks_with_adding_comment.py
@@ -0,0 +1,160 @@
+"""
+検査コメントを付与してタスクを差し戻します。
+"""
+
+import argparse
+import logging
+import time
+from typing import Any, Dict, List, Optional, Tuple, Union
+
+import requests
+import uuid
+import annofabapi
+import annofabapi.utils
+
+from example_utils import read_lines, ExamplesWrapper
+
+logging_formatter = '%(levelname)s : %(asctime)s : %(name)s : %(funcName)s : %(message)s'
+logging.basicConfig(format=logging_formatter)
+logging.getLogger("annofabapi").setLevel(level=logging.DEBUG)
+
+logger = logging.getLogger(__name__)
+logger.setLevel(level=logging.DEBUG)
+
+def add_inspection_comment(project_id: str, task: Dict[str, Any], inspection_comment: str, commenter_account_id: str):
+    """
+    先頭画像の左上に検査コメントを付与する
+    Args:
+        project_id:
+        task:
+        inspection_comment:
+        commenter_account_id:
+
+    Returns:
+        更新した検査コメントの一覧
+
+    """
+    first_input_data_id = task["input_data_id_list"][0]
+    req_inspection = [{
+        "data": {
+            "project_id": project_id,
+            "comment": inspection_comment,
+            "task_id": task["task_id"],
+            "input_data_id": first_input_data_id,
+            "inspection_id": str(uuid.uuid4()),
+            "phase": task["phase"],
+            "commenter_account_id": commenter_account_id,
+            "data": {
+                "x": 0,
+                "y": 0,
+                "_type": "Point"
+            },
+            "status": "annotator_action_required",
+            "created_datetime": annofabapi.utils.str_now()
+        },
+        "_type": "Put",
+
+    }]
+
+    return service.api.batch_update_inspections(project_id, task["task_id"], first_input_data_id, request_body=req_inspection)[0]
+
+
+
+def reject_tasks_with_adding_comment(project_id: str, task_id_list: List[str], inspection_comment: str, commenter_user_id: str):
+    """
+    検査コメントを付与して、タスクを差し戻す
+    Args:
+        project_id:
+        task_id_list:
+        inspection_comment: 検査コメントの中身
+        commenter_user_id: 検査コメントを付与して、タスクを差し戻すユーザのuser_id
+    """
+
+    commenter_account_id = examples_wrapper.get_account_id_from_user_id(project_id, commenter_user_id)
+
+    for task_id in task_id_list:
+        task, _ = service.api.get_task(project_id, task_id)
+        logger.debug(f"task_id = {task_id}, {task['status']}, {task['phase']}")
+        if task["phase"] == "annotation":
+            logger.warning(f"task_id = {task_id} はannofation phaseのため、差し戻しできません。")
+            continue
+
+        try:
+            # 担当者を変更して、作業中にする
+            examples_wrapper.change_operator_of_task(project_id, task_id, commenter_account_id)
+            logger.debug(f"task_id = {task_id}, {commenter_user_id}に担当者変更 完了")
+
+            examples_wrapper.change_to_working_phase(project_id, task_id, commenter_account_id)
+            logger.debug(f"task_id = {task_id}, working statusに変更 完了")
+        except requests.exceptions.HTTPError as e:
+            logger.error(e)
+            logger.info(f"task_id = {task_id} の担当者変更 or 作業phaseへの変更に失敗")
+            continue
+
+        # 少し待たないと検査コメントが登録できない場合があるため
+        time.sleep(3)
+        try:
+            # 検査コメントを付与する
+            add_inspection_comment(project_id, task, inspection_comment, commenter_account_id)
+            logger.debug(f"task_id = {task_id}, 検査コメントの付与 完了")
+        except requests.exceptions.HTTPError as e:
+            logger.error(e)
+            logger.info(f"task_id = {task_id} 検査コメントの付与に失敗")
+            continue
+
+        try:
+            # タスクを差し戻す
+            rejected_task = examples_wrapper.reject_task(project_id, task_id, commenter_account_id)
+
+        except requests.exceptions.HTTPError as e:
+            logger.error(e)
+            logger.info(f"task_id = {task_id} タスクの差し戻しに失敗")
+            continue
+
+        logger.info(f"task_id = {task_id} の差し戻し完了")
+    return
+
+
+
+
+def main(args):
+    task_id_list = read_lines(args.task_id_file)
+    user_id = service.api.login_user_id
+    reject_tasks_with_adding_comment(args.project_id, task_id_list, args.comment, user_id)
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(
+        description="検査コメントを付与してタスクを差し戻します。検査コメントは先頭の画像の左上(0,0)に付与します。AnnoFab認証情報は`.netrc`に記載すること")
+    parser.add_argument('--project_id',
+                        metavar='project_id',
+                        type=str,
+                        required=True,
+                        help='対象のプロジェクトのproject_id')
+
+    parser.add_argument(
+        '--task_id_file',
+        metavar='file',
+        type=str,
+        required=True,
+        help=
+        'task_idの一覧が記載されたファイル。task_idは改行(LF or CRLF)で区切る。')
+
+    parser.add_argument('--comment',
+                        metavar='comment',
+                        type=str,
+                        required=True,
+                        help='差し戻すときに付与する検査コメントの中身')
+
+    args = parser.parse_args()
+
+    logger.info(args)
+
+    service = annofabapi.build_from_netrc()
+    examples_wrapper = ExamplesWrapper(service)
+
+    try:
+        main(args)
+
+    except Exception as e:
+        logger.exception(e)
