annofabcli 1.114.5__tar.gz → 1.114.7__tar.gz

{annofabcli-1.114.5 → annofabcli-1.114.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: annofabcli
-Version: 1.114.5
+Version: 1.114.7
 Summary: Utility Command Line Interface for AnnoFab
 Author: Kurusugawa Computer Inc.
 License: MIT

{annofabcli-1.114.5 → annofabcli-1.114.7}/annofabcli/annotation/change_annotation_attributes.py

@@ -46,7 +46,7 @@ class ChangeAnnotationAttributesMain(CommandLineWithConfirm):
         service: annofabapi.Resource,
         *,
         project_id: str,
-        include_completed: bool,
+        include_complete_task: bool,
         all_yes: bool,
     ) -> None:
         self.service = service
@@ -54,7 +54,7 @@ class ChangeAnnotationAttributesMain(CommandLineWithConfirm):
         CommandLineWithConfirm.__init__(self, all_yes)
 
         self.project_id = project_id
-        self.include_completed = include_completed
+        self.include_complete_task = include_complete_task
 
         self.dump_annotation_obj = DumpAnnotationMain(service, project_id)
 
@@ -141,9 +141,9 @@ class ChangeAnnotationAttributesMain(CommandLineWithConfirm):
             logger.warning(f"task_id='{task_id}': タスクが作業中状態のため、スキップします。")
             return False, 0
 
-        if not self.include_completed:  # noqa: SIM102
+        if not self.include_complete_task:  # noqa: SIM102
             if task.status == TaskStatus.COMPLETE:
-                logger.warning(f"task_id='{task_id}': タスクが完了状態のため、スキップします。完了状態のタスクのアノテーション属性値を変更するには、 ``--include_completed`` を指定してください。")
+                logger.warning(f"task_id='{task_id}': タスクが完了状態のため、スキップします。完了状態のタスクのアノテーション属性値を変更するには、 ``--include_complete_task`` を指定してください。")
                 return False, 0
 
         annotation_list = self.get_annotation_list_for_task(task_id, annotation_query)
@@ -314,15 +314,15 @@ class ChangeAttributesOfAnnotation(CommandLine):
             backup_dir = Path(args.backup)
 
         super().validate_project(project_id, [ProjectMemberRole.OWNER, ProjectMemberRole.ACCEPTER])
-        if args.include_completed:  # noqa: SIM102
+        if args.include_complete_task:  # noqa: SIM102
             if not self.facade.contains_any_project_member_role(project_id, [ProjectMemberRole.OWNER]):
                 print(  # noqa: T201
-                    f"{self.COMMON_MESSAGE} argument --include_completed : '--include_completed' 引数を利用するにはプロジェクトのオーナーロールを持つユーザーで実行する必要があります。",
+                    f"{self.COMMON_MESSAGE} argument --include_complete_task : '--include_complete_task' 引数を利用するにはプロジェクトのオーナーロールを持つユーザーで実行する必要があります。",
                     file=sys.stderr,
                 )
                 sys.exit(COMMAND_LINE_ERROR_STATUS_CODE)
 
-        main_obj = ChangeAnnotationAttributesMain(self.service, project_id=project_id, include_completed=args.include_completed, all_yes=args.yes)
+        main_obj = ChangeAnnotationAttributesMain(self.service, project_id=project_id, include_complete_task=args.include_complete_task, all_yes=args.yes)
         main_obj.change_annotation_attributes_for_task_list(
             task_id_list,
             annotation_query=annotation_query,
@@ -362,7 +362,7 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
     )
 
     parser.add_argument(
-        "--include_completed",
+        "--include_complete_task",
         action="store_true",
         help="完了状態のタスクのアノテーション属性も変更します。ただし、オーナーロールを持つユーザーでしか実行できません。",
     )

{annofabcli-1.114.5 → annofabcli-1.114.7}/annofabcli/annotation/create_classification_annotation.py

@@ -33,7 +33,8 @@ class CreateClassificationAnnotationMain(CommandLineWithConfirm):
         project_id: str,
         all_yes: bool,
         is_change_operator_to_me: bool,
-        include_completed: bool,
+        include_complete_task: bool,
+        include_on_hold_task: bool,
     ) -> None:
         self.service = service
         self.facade = AnnofabApiFacade(service)
@@ -41,7 +42,8 @@ class CreateClassificationAnnotationMain(CommandLineWithConfirm):
 
         self.project_id = project_id
         self.is_change_operator_to_me = is_change_operator_to_me
-        self.include_completed = include_completed
+        self.include_complete_task = include_complete_task
+        self.include_on_hold_task = include_on_hold_task
 
         # アノテーション仕様を取得
         annotation_specs_v3, _ = self.service.api.get_annotation_specs(self.project_id, query_params={"v": "3"})
@@ -69,10 +71,18 @@ class CreateClassificationAnnotationMain(CommandLineWithConfirm):
             logger.info(f"タスク'{task_id}'は作業中状態のため、全体アノテーションの作成をスキップします。")
             return None, False, None
 
-        if not self.include_completed:  # noqa: SIM102
+        if not self.include_complete_task:  # noqa: SIM102
             if task["status"] == TaskStatus.COMPLETE.value:
                 logger.info(
-                    f"タスク'{task_id}'は完了状態のため、全体アノテーションの作成をスキップします。完了状態のタスクに全体アノテーションを作成するには、 ``--include_completed`` を指定してください。"
+                    f"タスク'{task_id}'は完了状態のため、全体アノテーションの作成をスキップします。"
+                    f"完了状態のタスクに全体アノテーションを作成するには、 ``--include_complete_task`` を指定してください。"
+                )
+                return None, False, None
+
+        if not self.include_on_hold_task:  # noqa: SIM102
+            if task["status"] == TaskStatus.ON_HOLD.value:
+                logger.info(
+                    f"タスク'{task_id}'は保留状態のため、全体アノテーションの作成をスキップします。保留状態のタスクに全体アノテーションを作成するには、 ``--include_on_hold_task`` を指定してください。"
                 )
                 return None, False, None
 
@@ -324,11 +334,11 @@ class CreateClassificationAnnotation(CommandLine):
 
         super().validate_project(project_id, [ProjectMemberRole.OWNER, ProjectMemberRole.ACCEPTER])
 
-        if args.include_completed:  # noqa: SIM102
+        if args.include_complete_task:  # noqa: SIM102
             if not self.facade.contains_any_project_member_role(project_id, [ProjectMemberRole.OWNER]):
                 print(  # noqa: T201
-                    "annofabcli annotation create_classification: error: argument --include_completed : "
-                    "'--include_completed' 引数を利用するにはプロジェクトのオーナーロールを持つユーザーで実行する必要があります。",
+                    "annofabcli annotation create_classification: error: argument --include_complete_task : "
+                    "'--include_complete_task' 引数を利用するにはプロジェクトのオーナーロールを持つユーザーで実行する必要があります。",
                     file=sys.stderr,
                 )
                 sys.exit(COMMAND_LINE_ERROR_STATUS_CODE)
@@ -341,7 +351,8 @@ class CreateClassificationAnnotation(CommandLine):
             project_id=project_id,
             all_yes=self.all_yes,
             is_change_operator_to_me=args.change_operator_to_me,
-            include_completed=args.include_completed,
+            include_complete_task=args.include_complete_task,
+            include_on_hold_task=args.include_on_hold_task,
         )
 
         main_obj.main(task_ids, labels, parallelism=args.parallelism)
@@ -377,11 +388,17 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
     )
 
     parser.add_argument(
-        "--include_completed",
+        "--include_complete_task",
         action="store_true",
         help="完了状態のタスクにも全体アノテーションを作成します。ただし、オーナーロールを持つユーザーでしか実行できません。",
     )
 
+    parser.add_argument(
+        "--include_on_hold_task",
+        action="store_true",
+        help="保留状態のタスクにも全体アノテーションを作成します。",
+    )
+
     parser.add_argument(
         "--parallelism",
         type=int,

{annofabcli-1.114.5 → annofabcli-1.114.7}/annofabcli/annotation/delete_annotation.py

@@ -46,7 +46,7 @@ class DeleteAnnotationMain(CommandLineWithConfirm):
     """アノテーション削除処理用のクラス
 
     Args:
-        is_force: 完了状態のタスクを削除するかどうか
+        include_complete_task: 完了状態のタスクを削除するかどうか
     """
 
     def __init__(
@@ -54,12 +54,12 @@ class DeleteAnnotationMain(CommandLineWithConfirm):
         service: annofabapi.Resource,
         project_id: str,
         *,
-        is_force: bool,
+        include_complete_task: bool,
         all_yes: bool,
     ) -> None:
         self.service = service
         self.facade = AnnofabApiFacade(service)
-        self.is_force = is_force
+        self.include_complete_task = include_complete_task
         CommandLineWithConfirm.__init__(self, all_yes)
         self.project_id = project_id
         self.dump_annotation_obj = DumpAnnotationMain(service, project_id)
@@ -133,9 +133,9 @@ class DeleteAnnotationMain(CommandLineWithConfirm):
             logger.info(f"task_id='{task_id}' :: タスクが作業中状態のため、スキップします。")
             return
 
-        if not self.is_force:  # noqa: SIM102
+        if not self.include_complete_task:  # noqa: SIM102
             if task.status == TaskStatus.COMPLETE:
-                logger.info(f"task_id='{task_id}' :: タスクが完了状態のため、スキップします。完了状態のタスクのアノテーションを削除するには、`--include_completed`オプションを指定してください。")
+                logger.info(f"task_id='{task_id}' :: タスクが完了状態のため、スキップします。完了状態のタスクのアノテーションを削除するには、`--include_complete_task`オプションを指定してください。")
                 return
 
         annotation_list = self.get_annotation_list_for_task(task_id, annotation_query=annotation_query)
@@ -182,7 +182,7 @@ class DeleteAnnotationMain(CommandLineWithConfirm):
             if task.status == TaskStatus.WORKING:
                 continue
 
-            if not self.is_force and task.status == TaskStatus.COMPLETE:
+            if not self.include_complete_task and task.status == TaskStatus.COMPLETE:
                 continue
 
             # アノテーション一覧を取得して、削除対象があるかチェック
@@ -316,11 +316,11 @@ class DeleteAnnotationMain(CommandLineWithConfirm):
                 failed_to_delete_annotation_count += annotation_count
                 continue
 
-            if not self.is_force:  # noqa: SIM102
+            if not self.include_complete_task:  # noqa: SIM102
                 if task["status"] == TaskStatus.COMPLETE.value:
                     logger.info(
                         f"task_id='{task_id}' :: タスクが完了状態のため、アノテーション {annotation_count} 件の削除をスキップします。"
-                        f"完了状態のタスクのアノテーションを削除するには、`--include_completed`オプションを指定してください。"
+                        f"完了状態のタスクのアノテーションを削除するには、`--include_complete_task`オプションを指定してください。"
                     )
                     failed_to_delete_annotation_count += annotation_count
                     continue
@@ -376,14 +376,14 @@ class DeleteAnnotation(CommandLine):
         else:
             backup_dir = Path(args.backup)
 
-        if args.include_completed:
-            # --include_completedオプションが指定されている場合は、完了状態のタスクも削除する
-            # 完了状態のタスクを削除するには、オーナーロールである必要があるため、`args.include_completed`で条件を分岐する
+        if args.include_complete_task:
+            # --include_complete_taskオプションが指定されている場合は、完了状態のタスクも削除する
+            # 完了状態のタスクを削除するには、オーナーロールである必要があるため、`args.include_complete_task`で条件を分岐する
             super().validate_project(project_id, [ProjectMemberRole.OWNER])
         else:
             super().validate_project(project_id, [ProjectMemberRole.OWNER, ProjectMemberRole.ACCEPTER])
 
-        main_obj = DeleteAnnotationMain(self.service, project_id, all_yes=args.yes, is_force=args.include_completed)
+        main_obj = DeleteAnnotationMain(self.service, project_id, all_yes=args.yes, include_complete_task=args.include_complete_task)
 
         if args.json is not None:
             dict_annotation_list = get_json_from_args(args.json)
@@ -479,7 +479,7 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
     )
 
     parser.add_argument(
-        "--include_completed",
+        "--include_complete_task",
         action="store_true",
         help="指定した場合は、完了状態のタスクのアノテーションも削除します。ただし、完了状態のタスクを削除するには、オーナーロールを持つユーザーが実行する必要があります。",
     )
@@ -499,7 +499,7 @@ def add_parser(subparsers: argparse._SubParsersAction | None = None) -> argparse
         "タスク配下のアノテーションを削除します。ただし、作業中状態のタスクのアノテーションは削除できません。"
         "間違えてアノテーションを削除したときに復元できるようにするため、 ``--backup`` でバックアップ用のディレクトリを指定することを推奨します。"
     )
-    epilog = "オーナーまたはチェッカーロールを持つユーザで実行してください。ただし``--include_completed``オプションを指定した場合は、オーナーロールを持つユーザで実行してください。"
+    epilog = "オーナーまたはチェッカーロールを持つユーザで実行してください。ただし``--include_complete_task``オプションを指定した場合は、オーナーロールを持つユーザで実行してください。"
 
     parser = annofabcli.common.cli.add_parser(subparsers, subcommand_name, subcommand_help, description, epilog=epilog)
     parse_args(parser)

{annofabcli-1.114.5 → annofabcli-1.114.7}/annofabcli/annotation/import_annotation.py

@@ -410,9 +410,11 @@ class ImportAnnotationMain(CommandLineWithConfirm):
         *,
         project_id: str,
         all_yes: bool,
-        is_force: bool,
+        change_operator_to_me: bool,
         is_merge: bool,
         is_overwrite: bool,
+        include_complete_task: bool,
+        include_on_hold_task: bool,
         converter: AnnotationConverter,
     ) -> None:
         self.service = service
@@ -420,9 +422,11 @@ class ImportAnnotationMain(CommandLineWithConfirm):
         CommandLineWithConfirm.__init__(self, all_yes)
 
         self.project_id = project_id
-        self.is_force = is_force
+        self.change_operator_to_me = change_operator_to_me
         self.is_merge = is_merge
         self.is_overwrite = is_overwrite
+        self.include_complete_task = include_complete_task
+        self.include_on_hold_task = include_on_hold_task
         self.converter = converter
 
     def put_annotation_for_input_data(self, parser: SimpleAnnotationParser) -> int:
@@ -487,7 +491,7 @@ class ImportAnnotationMain(CommandLineWithConfirm):
 
         return success_input_data_count, success_annotation_count
 
-    def execute_task(self, task_parser: SimpleAnnotationParserByTask, task_index: int | None = None) -> bool:
+    def execute_task(self, task_parser: SimpleAnnotationParserByTask, task_index: int | None = None) -> bool:  # noqa: PLR0911
         """
         1個のタスクに対してアノテーションを登録する。
 
@@ -499,26 +503,39 @@ class ImportAnnotationMain(CommandLineWithConfirm):
 
         """
         task_id = task_parser.task_id
-        if not self.confirm_processing(f"task_id='{task_id}' のアノテーションをインポートしますか？"):
-            return False
-
-        logger_prefix = f"{task_index + 1!s} 件目: " if task_index is not None else ""
-        logger.info(f"{logger_prefix}task_id='{task_id}' に対して処理します。")
+        logger_prefix = f"{task_index + 1!s} 件目 :: task_id='{task_id}' :: " if task_index is not None else ""
 
         task = self.service.wrapper.get_task_or_none(self.project_id, task_id)
         if task is None:
-            logger.warning(f"task_id='{task_id}'であるタスクは存在しません。")
+            logger.warning(f"{logger_prefix}タスクは存在しません。")
+            return False
+
+        logger.debug(f"{logger_prefix}phase='{task['phase']}', status='{task['status']}'")
+        if task["status"] == TaskStatus.WORKING.value:
+            logger.info(f"{logger_prefix}タスクは作業中のため、処理をスキップします。 :: status={task['status']}")
+            return False
+
+        if not self.include_complete_task and task["status"] == TaskStatus.COMPLETE.value:
+            logger.info(f"{logger_prefix}タスクは完了状態のため、処理をスキップします。完了状態のタスクを処理する場合は、 '--include_complete_task'を指定してください。 :: status={task['status']}")
             return False
 
-        if task["status"] in [TaskStatus.WORKING.value, TaskStatus.COMPLETE.value]:
-            logger.info(f"タスク'{task_id}'は作業中または受入完了状態のため、インポートをスキップします。 status={task['status']}")
+        if not self.include_on_hold_task and task["status"] == TaskStatus.ON_HOLD.value:
+            logger.info(
+                f"{logger_prefix}タスクは保留中状態のため、処理をスキップします。保留中状態のタスクにアノテーションをインポートする場合は、 "
+                f"'--include_on_hold_task'を指定してください。 :: status={task['status']}"
+            )
             return False
 
+        if not self.confirm_processing(f"task_id='{task_id}'のタスク（phase={task['phase']}, status={task['status']}）にアノテーションをインポートしますか？"):
+            return False
+
+        logger.info(f"{logger_prefix}タスクにアノテーションをインポートします。")
+
         old_account_id: str | None = None
         changed_operator = False
-        if self.is_force:
+        if self.change_operator_to_me:
             if not can_put_annotation(task, self.service.api.account_id):
-                logger.debug(f"タスク'{task_id}' の担当者を自分自身に変更します。")
+                logger.debug(f"{logger_prefix}担当者を自分自身に変更します。")
                 old_account_id = task["account_id"]
                 task = self.service.wrapper.change_task_operator(
                     self.project_id,
@@ -532,7 +549,7 @@ class ImportAnnotationMain(CommandLineWithConfirm):
             if not can_put_annotation(task, self.service.api.account_id):
                 logger.debug(
                     f"タスク'{task_id}'は、過去に誰かに割り当てられたタスクで、現在の担当者が自分自身でないため、アノテーションのインポートをスキップします。"
-                    f"担当者を自分自身に変更してアノテーションを登録する場合は `--force` を指定してください。"
+                    f"担当者を自分自身に変更してアノテーションを登録する場合は `--change_operator_to_me` を指定してください。"
                 )
                 return False
 
@@ -678,7 +695,9 @@ class ImportAnnotation(CommandLine):
             all_yes=self.all_yes,
             is_merge=args.merge,
             is_overwrite=args.overwrite,
-            is_force=args.force,
+            change_operator_to_me=args.change_operator_to_me,
+            include_complete_task=args.include_complete_task,
+            include_on_hold_task=args.include_on_hold_task,
             converter=converter,
         )
 
@@ -700,7 +719,7 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
         "--annotation",
         type=Path,
         required=True,
-        help="Simpleアノテーションと同じフォルダ構成のzipファイル or ディレクトリのパスを指定してください。タスクの状態が作業中/完了の場合はインポートしません。",
+        help="Simpleアノテーションと同じフォルダ構成のzipファイル or ディレクトリのパスを指定してください。",
     )
 
     argument_parser.add_task_id(required=False)
@@ -722,9 +741,23 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
     )
 
     parser.add_argument(
-        "--force",
+        "--change_operator_to_me",
         action="store_true",
-        help="過去に割り当てられていて現在の担当者が自分自身でない場合、タスクの担当者を自分自身に変更してからアノテーションをインポートします。",
+        help="タスクの担当者を自分自身に変更しないとアノテーションをインポートできない場合（担当者が自分自身でない AND 担当者が割れ当てられたことがあるタスク）は、タスクの担当者を自分自身に変更します。アノテーションをインポートが完了したら、担当者を元に戻します。"  # noqa: E501
+        "未指定の場合は、そのようなタスクのアノテーションインポートはスキップされます。",
+    )
+
+    parser.add_argument(
+        "--include_complete_task",
+        action="store_true",
+        help="完了状態のタスクに対してもアノテーションをインポートします。未指定の場合は、完了状態のタスクはスキップされます。",
+    )
+
+    parser.add_argument(
+        "--include_on_hold_task",
+        action="store_true",
+        help="保留中状態のタスクに対してもアノテーションをインポートします。ただし、アノテーションインポート後は保留中状態でなくなる可能性があります。"
+        "未指定の場合は、保留中状態のタスクはスキップされます。",
     )
 
     parser.add_argument(
@@ -749,7 +782,12 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
 def add_parser(subparsers: argparse._SubParsersAction | None = None) -> argparse.ArgumentParser:
     subcommand_name = "import"
     subcommand_help = "アノテーションをインポートします。"
-    description = "アノテーションをインポートします。アノテーションのフォーマットは、Simpleアノテーションと同じフォルダ構成のzipファイルまたはディレクトリです。ただし、作業中/完了状態のタスクはインポートできません。"  # noqa: E501
+    description = (
+        "アノテーションをインポートします。アノテーションのフォーマットは、Simpleアノテーションと同じフォルダ構成のzipファイルまたはディレクトリです。"
+        "ただし、作業中状態のタスクはインポートできません。"
+        "``--include_complete_task`` を指定すれば、完了状態のタスクにもインポートできます。"
+        "``--include_on_hold_task`` を指定すれば、保留中状態のタスクにもインポートできます。"
+    )
     epilog = "オーナロールを持つユーザで実行してください。"
 
     parser = annofabcli.common.cli.add_parser(subparsers, subcommand_name, subcommand_help, description, epilog=epilog)

{annofabcli-1.114.5 → annofabcli-1.114.7}/annofabcli/comment/delete_comment.py

@@ -95,8 +95,8 @@ class DeleteCommentMain(CommandLineWithConfirm):
         task: dict[str, Any],
     ) -> bool:
         task_id = task["task_id"]
-        if task["status"] not in [TaskStatus.NOT_STARTED.value, TaskStatus.WORKING.value, TaskStatus.BREAK.value]:
-            logger.warning(f"task_id='{task_id}' : タスクの状態が未着手,作業中,休憩中 以外の状態なので、コメントを削除できません。（task_status='{task['status']}'）")
+        if task["status"] not in [TaskStatus.NOT_STARTED.value, TaskStatus.BREAK.value]:
+            logger.warning(f"task_id='{task_id}' : タスクの状態が未着手,休憩中 以外の状態なので、コメントを削除できません。（task_status='{task['status']}'）")
             return False
         return True