utils.can_put_annotation : 引数の追加 (#728)

* add test code

* put

* udate

* add instruction

Author: yuji38kwmt

.github/copilot-instructions.md

@@ -0,0 +1,40 @@
+# copilot-instructions.md
+
+## プロジェクトの目的
+AnnofabのWebAPIのPythonクライアントライブラリです。
+
+## 開発でよく使うコマンド
+* コードのフォーマット: `make format`
+* Lintの実行: `make lint`
+* テストの実行: `make test`
+* ドキュメントの実行: `make docs`
+
+## 技術スタック
+* Python 3.9 以上
+* テストフレームワーク: Pytest v8 以上
+
+## ディレクトリ構造概要
+
+* `annofabcli/**`: アプリケーションのソースコード
+* `tests/**`: テストコード
+    * `tests/data/**`: テストコードが参照するリソース
+* `docs/*`: ドキュメント
+
+## コーディングスタイル
+
+### Python
+* dictから値を取得する際、必須なキーならばブラケット記法を使う。キーが必須がどうか分からない場合は、必須とみなす。
+* できるだけ`os.path`でなく`pathlib.Path`を使う（Lint`flake8-use-pathlib`に従う）
+* Noneの判定、空文字列の判定、長さが0のコレクションの判定は、falsyとして判定するのでなく、`if a is not None:`のように判定内容を明記してください。
+* 型ヒントを`dict`にする場合、`dict[str, Any]`のようにキーと値の型を指定する。
+
+### テストコード
+* Errorの確認は、`pytest.raises`を使用する。エラーメッセージの確認は行わない。
+* 一時ディレクトリを使用する場合は、`tmp_path` fixtureを利用する。
+
+
+## 作業の進め方
+* コードの修正が完了したら`make format`を実行してフォーマットを行い、その後`make lint`を実行してLintエラーがないことを確認する。
+
+## レビュー
+* PRレビューの際は、日本語でレビューを行う

annofabapi/utils.py

@@ -5,7 +5,7 @@
 import dateutil
 import dateutil.tz
 
-from annofabapi.models import Task, TaskHistory, TaskHistoryShort, TaskPhase
+from annofabapi.models import ProjectMemberRole, Task, TaskHistory, TaskHistoryShort, TaskPhase
 
 logger = logging.getLogger(__name__)
 
@@ -145,17 +145,23 @@ def get_number_of_rejections(task_histories: list[TaskHistoryShort], phase: Task
     return rejections_by_phase
 
 
-def can_put_annotation(task: Task, my_account_id: str) -> bool:
+def can_put_annotation(task: Task, my_account_id: str, *, project_member_role: Optional[ProjectMemberRole] = None) -> bool:
     """
     対象タスクが、`put_annotation` APIで、アノテーションを更新できる状態かどうか。
     過去に担当者が割り当たっている場合、または現在の担当者が自分自身の場合は、アノテーションを更新できる。
 
     Args:
         task: 対象タスク
         my_account_id: 自分（ログインしているユーザ）のアカウントID
+        project_member_role: プロジェクトメンバーロール。Noneの場合、プロジェクトオーナであるとみなします。
 
     Returns:
-        Trueならば、タスクの状態を変更せずに`put_annotation` APIを実行できる。
+        Trueならば、タスクの担当者を変更せずに`put_annotation` APIを実行できる。
+        Falseならば、タスクの担当者を変更してから、`put_annotation` APIを実行する必要がある。
     """
-    # ログインユーザはプロジェクトオーナであること前提
-    return len(task["histories_by_phase"]) == 0 or task["account_id"] == my_account_id
+    if project_member_role is None or project_member_role == ProjectMemberRole.OWNER:
+        return len(task["histories_by_phase"]) == 0 or task["account_id"] == my_account_id
+    elif project_member_role in [ProjectMemberRole.ACCEPTER, ProjectMemberRole.WORKER]:
+        return task["account_id"] == my_account_id
+    else:
+        raise ValueError(f"引数'project_member_role'の値は不正です。 :: {project_member_role=}")

tests/test_utils.py

@@ -2,8 +2,9 @@
 
 from typing import Any
 
-from annofabapi.models import TaskPhase
+from annofabapi.models import ProjectMemberRole, TaskPhase
 from annofabapi.utils import (
+    can_put_annotation,
     get_number_of_rejections,
     get_task_history_index_skipped_acceptance,
     get_task_history_index_skipped_inspection,
@@ -614,3 +615,50 @@ def test_get_task_history_index_skipped_inspection_検査1回_教師付で提出
         actual = get_task_history_index_skipped_inspection(task_history_list)
         expected: list[int] = []
         assert all([a == b for a, b in zip(actual, expected)])  # noqa: C419
+
+
+class TestCanPutAnnotation:
+    MY_ACCOUNT_ID = "12345678-abcd-1234-abcd-1234abcd5678"
+    OTHER_ACCOUNT_ID = "87654321-dcba-4321-dcba-4321dcba8765"
+
+    def test_can_put_annotation_project_member_role_none_no_history(self):
+        """project_member_role=None, 履歴なしの場合"""
+        task: dict[str, Any] = {"histories_by_phase": [], "account_id": None}
+        actual = can_put_annotation(task, self.MY_ACCOUNT_ID, project_member_role=None)
+        assert actual is True
+
+    def test_can_put_annotation_project_member_role_owner_with_history_different_account(self):
+        """project_member_role=OWNER, 履歴あり、異なるアカウントID"""
+        task = {
+            "histories_by_phase": [{"phase": "annotation", "phase_stage": 1, "worked": True, "account_id": self.OTHER_ACCOUNT_ID}],
+            "account_id": self.OTHER_ACCOUNT_ID,
+        }
+        actual = can_put_annotation(task, self.MY_ACCOUNT_ID, project_member_role=ProjectMemberRole.OWNER)
+        assert actual is False
+
+    def test_can_put_annotation_project_member_role_owner_with_history_same_account(self):
+        """project_member_role=OWNER, 同じアカウントID"""
+        task = {
+            "histories_by_phase": [{"phase": "annotation", "phase_stage": 1, "worked": True, "account_id": self.MY_ACCOUNT_ID}],
+            "account_id": self.MY_ACCOUNT_ID,
+        }
+        actual = can_put_annotation(task, self.MY_ACCOUNT_ID, project_member_role=ProjectMemberRole.OWNER)
+        assert actual is True
+
+    def test_can_put_annotation_project_member_role_accepter_same_account(self):
+        """project_member_role=ACCEPTER, 同じアカウントID"""
+        task = {
+            "histories_by_phase": [],
+            "account_id": self.MY_ACCOUNT_ID,
+        }
+        actual = can_put_annotation(task, self.MY_ACCOUNT_ID, project_member_role=ProjectMemberRole.ACCEPTER)
+        assert actual is True
+
+    def test_can_put_annotation_project_member_role_worker_same_account(self):
+        """project_member_role=WORKER, 同じアカウントID"""
+        task = {
+            "histories_by_phase": [],
+            "account_id": self.MY_ACCOUNT_ID,
+        }
+        actual = can_put_annotation(task, self.MY_ACCOUNT_ID, project_member_role=ProjectMemberRole.WORKER)
+        assert actual is True