Add on-hold option to annotation data command

Author: yuji38kwmt

annofabcli/annotation/change_annotation_data_per_annotation.py

@@ -188,12 +188,14 @@ def __init__(
         *,
         project_id: str,
         include_complete_task: bool,
+        include_on_hold_task: bool,
         all_yes: bool,
         backup_dir: Path | None = None,
     ) -> None:
         self.service = service
         self.project_id = project_id
         self.include_complete_task = include_complete_task
+        self.include_on_hold_task = include_on_hold_task
         self.backup_dir = backup_dir
         self.dump_annotation_obj = DumpAnnotationMain(service, project_id)
         super().__init__(all_yes)
@@ -230,6 +232,13 @@ def change_annotation_data_for_task(self, task_id: str, annotation_list_per_inpu
             logger.info(f"task_id='{task_id}' :: タスクが作業中状態のため、{annotation_count} 件のアノテーションのdata変更をスキップします。")
             return False, ChangeAnnotationDataCount(success=0, failed=annotation_count)
 
+        if not self.include_on_hold_task and task["status"] == TaskStatus.ON_HOLD.value:
+            logger.info(
+                f"task_id='{task_id}' :: タスクが保留中状態のため、{annotation_count} 件のアノテーションのdata変更をスキップします。"
+                "保留中状態のタスクのアノテーションも変更するには、`--include_on_hold_task` オプションを指定してください。"
+            )
+            return False, ChangeAnnotationDataCount(success=0, failed=annotation_count)
+
         if not self.include_complete_task:  # noqa: SIM102
             if task["status"] == TaskStatus.COMPLETE.value:
                 logger.info(
@@ -340,6 +349,7 @@ def main(self) -> None:
             project_id=project_id,
             all_yes=args.yes,
             include_complete_task=args.include_complete_task,
+            include_on_hold_task=args.include_on_hold_task,
             backup_dir=backup_dir,
         )
         main_obj.change_annotation_data(target_annotation_list)
@@ -383,6 +393,11 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
         action="store_true",
         help="指定した場合は、完了状態のタスクのアノテーションもdataを変更します。ただし、完了状態のタスクのアノテーションを変更するには、オーナーロールを持つユーザーが実行する必要があります。",
     )
+    parser.add_argument(
+        "--include_on_hold_task",
+        action="store_true",
+        help="指定した場合は、保留中状態のタスクのアノテーションもdataを変更します。指定しない場合、保留中状態のタスクはスキップされます。",
+    )
 
     parser.add_argument(
         "--backup",

docs/command_reference/annotation/change_data_per_annotation.rst

@@ -8,6 +8,7 @@ Description
 
 属性値、ラベル、プロパティは変更しません。
 作業中状態のタスクに含まれるアノテーションは変更できません。
+保留中状態のタスクに含まれるアノテーションは、デフォルトでは変更できません。
 
 外部ファイルが必要な塗りつぶしアノテーションなどは、このコマンドではサポートしていません。
 
@@ -107,6 +108,8 @@ CSVのフォーマットは以下の通りです。
 デフォルトでは完了状態のタスクに含まれるアノテーションは変更できません。完了状態のタスクに含まれるアノテーションも変更する場合は、 ``--include_complete_task`` を指定してください。
 ただし、オーナーロールのユーザーで実行する必要があります。
 
+デフォルトでは保留中状態のタスクに含まれるアノテーションは変更できません。保留中状態のタスクに含まれるアノテーションも変更する場合は、 ``--include_on_hold_task`` を指定してください。
+
 
 
 Usage Details

tests/annotation/test_change_annotation_data_per_annotation.py

@@ -1,8 +1,12 @@
 from __future__ import annotations
 
+from unittest.mock import Mock
+
 import pytest
 
 from annofabcli.annotation.change_annotation_data_per_annotation import (
+    ChangeAnnotationDataCount,
+    ChangeAnnotationDataPerAnnotationMain,
     TargetAnnotationData,
     create_request_body_for_change_data,
     get_annotation_data_list_per_task_id_input_data_id,
@@ -91,6 +95,42 @@ def test_skip_when_annotation_does_not_exist(self) -> None:
         assert actual_request_body == []
         assert actual_failed_count == 1
 
+
+class TestChangeAnnotationDataPerAnnotationMain:
+    def test_change_annotation_data_for_task_skips_on_hold_task_by_default(self) -> None:
+        service = Mock()
+        service.wrapper.get_task_or_none.return_value = {"task_id": "task1", "status": "on_hold"}
+        main_obj = ChangeAnnotationDataPerAnnotationMain(service, project_id="prj1", include_complete_task=False, include_on_hold_task=False, all_yes=True)
+
+        actual_is_changeable, actual_count = main_obj.change_annotation_data_for_task(
+            "task1",
+            {"input1": [TargetAnnotationData(task_id="task1", input_data_id="input1", annotation_id="anno1", data={"_type": "Range", "begin": 1000, "end": 5000})]},
+        )
+
+        assert actual_is_changeable is False
+        assert actual_count == ChangeAnnotationDataCount(success=0, failed=1)
+
+    def test_change_annotation_data_for_task_allows_on_hold_task_when_option_is_enabled(self, monkeypatch: pytest.MonkeyPatch) -> None:
+        service = Mock()
+        service.wrapper.get_task_or_none.return_value = {"task_id": "task1", "status": "on_hold"}
+        main_obj = ChangeAnnotationDataPerAnnotationMain(service, project_id="prj1", include_complete_task=False, include_on_hold_task=True, all_yes=True)
+
+        def change_annotation_data_by_frame(task_id: str, input_data_id: str, anno_list: list[TargetAnnotationData]) -> ChangeAnnotationDataCount:
+            assert task_id == "task1"
+            assert input_data_id == "input1"
+            assert len(anno_list) == 1
+            return ChangeAnnotationDataCount(success=1, failed=0)
+
+        monkeypatch.setattr(main_obj, "change_annotation_data_by_frame", change_annotation_data_by_frame)
+
+        actual_is_changeable, actual_count = main_obj.change_annotation_data_for_task(
+            "task1",
+            {"input1": [TargetAnnotationData(task_id="task1", input_data_id="input1", annotation_id="anno1", data={"_type": "Range", "begin": 1000, "end": 5000})]},
+        )
+
+        assert actual_is_changeable is True
+        assert actual_count == ChangeAnnotationDataCount(success=1, failed=0)
+
     def test_skip_when_data_type_is_changed(self) -> None:
         editor_annotation = {
             "project_id": "prj1",