annofabcli 1.106.7__tar.gz → 1.106.8__tar.gz

{annofabcli-1.106.7 → annofabcli-1.106.8}/PKG-INFO

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

{annofabcli-1.106.7 → annofabcli-1.106.8}/annofabcli/annotation/change_annotation_attributes.py

@@ -46,7 +46,7 @@ class ChangeAnnotationAttributesMain(CommandLineWithConfirm):
         service: annofabapi.Resource,
         *,
         project_id: str,
-        is_force: bool,
+        include_completed: 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.is_force = is_force
+        self.include_completed = include_completed
 
         self.dump_annotation_obj = DumpAnnotationMain(service, project_id)
 
@@ -114,9 +114,9 @@ class ChangeAnnotationAttributesMain(CommandLineWithConfirm):
         *,
         backup_dir: Optional[Path] = None,
         task_index: Optional[int] = None,
-    ) -> bool:
+    ) -> tuple[bool, int]:
         """
-        タスクに対してアノテーション属性を変更する。
+        タスクに対してアノテーション属性値を変更する。
 
         Args:
             project_id:
@@ -127,23 +127,24 @@ class ChangeAnnotationAttributesMain(CommandLineWithConfirm):
             backup_dir: アノテーションをバックアップとして保存するディレクトリ。指定しない場合は、バックアップを取得しない。
 
         Returns:
-            アノテーションの属性を変更するAPI ``change_annotation_attributes`` を実行したか否か
+            tuple[0]: 成功した場合はTrue、失敗した場合はFalse
+            tuple[1]: 変更したアノテーションの個数
         """
         logger_prefix = f"{task_index + 1!s} 件目: " if task_index is not None else ""
         dict_task = self.service.wrapper.get_task_or_none(self.project_id, task_id)
         if dict_task is None:
             logger.warning(f"task_id = '{task_id}' は存在しません。")
-            return False
+            return False, 0
 
         task: Task = Task.from_dict(dict_task)
         if task.status == TaskStatus.WORKING:
             logger.warning(f"task_id='{task_id}': タスクが作業中状態のため、スキップします。")
-            return False
+            return False, 0
 
-        if not self.is_force:  # noqa: SIM102
+        if not self.include_completed:  # noqa: SIM102
             if task.status == TaskStatus.COMPLETE:
-                logger.warning(f"task_id='{task_id}': タスクが完了状態のため、スキップします。")
-                return False
+                logger.warning(f"task_id='{task_id}': タスクが完了状態のため、スキップします。完了状態のタスクのアノテーション属性値を変更するには、 ``--include_completed`` を指定してください。")
+                return False, 0
 
         annotation_list = self.get_annotation_list_for_task(task_id, annotation_query)
         logger.info(
@@ -151,17 +152,17 @@ class ChangeAnnotationAttributesMain(CommandLineWithConfirm):
         )
         if len(annotation_list) == 0:
             logger.info(f"{logger_prefix}task_id='{task_id}'には変更対象のアノテーションが存在しないので、スキップします。")
-            return False
+            return False, 0
 
-        if not self.confirm_processing(f"task_id='{task_id}' のアノテーション属性を変更しますか？"):
-            return False
+        if not self.confirm_processing(f"task_id='{task_id}' のアノテーション属性値を変更しますか？"):
+            return False, 0
 
         if backup_dir is not None:
             self.dump_annotation_obj.dump_annotation_for_task(task_id, output_dir=backup_dir)
 
         self.change_annotation_attributes(annotation_list, additional_data_list)
         logger.info(f"{logger_prefix}task_id='{task_id}': {len(annotation_list)} 個のアノテーションの属性値を変更しました。")
-        return True
+        return True, len(annotation_list)
 
     def change_attributes_for_task_wrapper(
         self,
@@ -170,7 +171,7 @@ class ChangeAnnotationAttributesMain(CommandLineWithConfirm):
         additional_data_list: list[dict[str, Any]],
         *,
         backup_dir: Optional[Path] = None,
-    ) -> bool:
+    ) -> tuple[bool, int]:
         task_index, task_id = tpl
         try:
             return self.change_attributes_for_task(
@@ -181,8 +182,8 @@ class ChangeAnnotationAttributesMain(CommandLineWithConfirm):
                 task_index=task_index,
             )
         except Exception:  # pylint: disable=broad-except
-            logger.warning(f"タスク'{task_id}'のアノテーションの属性の変更に失敗しました。", exc_info=True)
-            return False
+            logger.warning(f"タスク'{task_id}'のアノテーションの属性値の変更に失敗しました。", exc_info=True)
+            return False, 0
 
     def change_annotation_attributes_for_task_list(
         self,
@@ -209,8 +210,9 @@ class ChangeAnnotationAttributesMain(CommandLineWithConfirm):
 
         if backup_dir is not None:
             backup_dir.mkdir(exist_ok=True, parents=True)
-
         success_count = 0
+        # 変更したアノテーションの個数
+        changed_annotation_count = 0
         if parallelism is not None:
             func = functools.partial(
                 self.change_attributes_for_task_wrapper,
@@ -219,26 +221,28 @@ class ChangeAnnotationAttributesMain(CommandLineWithConfirm):
                 backup_dir=backup_dir,
             )
             with multiprocessing.Pool(parallelism) as pool:
-                result_bool_list = pool.map(func, enumerate(task_id_list))
-                success_count = len([e for e in result_bool_list if e])
+                result_tuple_list = pool.map(func, enumerate(task_id_list))
+                success_count = len([e for e in result_tuple_list if e[0]])
+                changed_annotation_count = sum(e[1] for e in result_tuple_list)
 
         else:
             for task_index, task_id in enumerate(task_id_list):
                 try:
-                    result = self.change_attributes_for_task(
+                    result, sub_changed_annotation_count = self.change_attributes_for_task(
                         task_id,
                         annotation_query=annotation_query,
                         additional_data_list=additional_data_list,
                         backup_dir=backup_dir,
                         task_index=task_index,
                     )
+                    changed_annotation_count += sub_changed_annotation_count
                     if result:
                         success_count += 1
                 except Exception:
-                    logger.warning(f"タスク'{task_id}'のアノテーションの属性の変更に失敗しました。", exc_info=True)
+                    logger.warning(f"タスク'{task_id}'のアノテーションの属性値の変更に失敗しました。", exc_info=True)
                     continue
 
-        logger.info(f"{success_count} / {len(task_id_list)} 件のタスクに対してアノテーションの属性を変更しました。")
+        logger.info(f"{success_count} / {len(task_id_list)} 件のタスクに対して {changed_annotation_count} 件のアノテーションの属性値を変更しました。")
 
 
 class ChangeAttributesOfAnnotation(CommandLine):
@@ -310,15 +314,15 @@ class ChangeAttributesOfAnnotation(CommandLine):
             backup_dir = Path(args.backup)
 
         super().validate_project(project_id, [ProjectMemberRole.OWNER, ProjectMemberRole.ACCEPTER])
-        if args.force:  # noqa: SIM102
+        if args.include_completed:  # noqa: SIM102
             if not self.facade.contains_any_project_member_role(project_id, [ProjectMemberRole.OWNER]):
                 print(  # noqa: T201
-                    f"{self.COMMON_MESSAGE} argument --force : '--force' 引数を利用するにはプロジェクトのオーナーロールを持つユーザーで実行する必要があります。",
+                    f"{self.COMMON_MESSAGE} argument --include_completed : '--include_completed' 引数を利用するにはプロジェクトのオーナーロールを持つユーザーで実行する必要があります。",
                     file=sys.stderr,
                 )
                 sys.exit(COMMAND_LINE_ERROR_STATUS_CODE)
 
-        main_obj = ChangeAnnotationAttributesMain(self.service, project_id=project_id, is_force=args.force, all_yes=args.yes)
+        main_obj = ChangeAnnotationAttributesMain(self.service, project_id=project_id, include_completed=args.include_completed, all_yes=args.yes)
         main_obj.change_annotation_attributes_for_task_list(
             task_id_list,
             annotation_query=annotation_query,
@@ -358,7 +362,7 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
     )
 
     parser.add_argument(
-        "--force",
+        "--include_completed",
         action="store_true",
         help="完了状態のタスクのアノテーション属性も変更します。ただし、オーナーロールを持つユーザーでしか実行できません。",
     )
@@ -381,10 +385,11 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
 
 def add_parser(subparsers: Optional[argparse._SubParsersAction] = None) -> argparse.ArgumentParser:
     subcommand_name = "change_attributes"
-    subcommand_help = "アノテーションの属性を変更します。"
+    subcommand_help = "アノテーションの属性値を変更します。"
     description = (
-        "アノテーションの属性を一括で変更します。ただし、作業中状態のタスクのアノテーションの属性は変更できません。"
-        "間違えてアノテーション属性を変更したときに復元できるようにするため、 ``--backup`` でバックアップ用のディレクトリを指定することを推奨します。"
+        "アノテーションの属性値を一括で変更します。ただし、作業中状態のタスクに含まれるアノテーションは変更できません。"
+        "完了状態のタスクに含まれるアノテーションは、デフォルトでは変更できません。"
+        "間違えてアノテーション属性値を変更したときに復元できるようにするため、 ``--backup`` でバックアップ用のディレクトリを指定することを推奨します。"
     )
     epilog = "オーナロールまたはチェッカーロールを持つユーザで実行してください。"
 

{annofabcli-1.106.7 → annofabcli-1.106.8}/docs/command_reference/annotation/change_attributes.rst

@@ -4,8 +4,8 @@ annotation change_attributes
 
 Description
 =================================
-アノテーションの属性を一括で変更します。
-ただし、作業中状態のタスクのアノテーションは、属性を変更できません。
+アノテーションの属性値を一括で変更します。
+ただし、作業中状態のタスクのアノテーションは、属性値を変更できません。
 
 
 
@@ -26,9 +26,9 @@ Examples
 ``--annotation_query`` のサンプルは、`Command line options <../../user_guide/command_line_options.html#annotation-query-aq>`_ を参照してください。
 
 
-``--attributes`` に、変更後の属性を指定してください。フォーマットは ``--annotation_query`` の ``attributes`` キーの値と同じフォーマットです。
+``--attributes`` に、変更後の属性値を指定してください。フォーマットは ``--annotation_query`` の ``attributes`` キーの値と同じフォーマットです。
 
-以下のコマンドは、ラベル名（英語）の値が"car"であるアノテーションに対して、属性名(英語)が"occluded"である値をfalse（"occluded"チェックボックスをOFF）に変更します。
+以下のコマンドは、ラベル名（英語）の値が"car"であるアノテーションに対して、属性名(英語)が"occluded"である属性値をfalse（"occluded"チェックボックスをOFF）に変更します。
 
 .. code-block::
 
@@ -43,9 +43,9 @@ Examples
 
 .. note::
 
-    間違えてアノテーションを変更したときに復元できるようにするため、``--backup`` を指定することを推奨します。
+    間違えてアノテーション属性値を変更したときに復元できるようにするため、``--backup`` を指定することを推奨します。
 
-デフォルトでは完了状態のタスクのアノテーションは変更できません。完了状態のタスクのアノテーションも変更する場合は、``--force`` を指定してください。
+デフォルトでは完了状態のタスクのアノテーション属性値は変更できません。完了状態のタスクのアノテーション属性値も変更する場合は、 ``--include_completed`` を指定してください。
 ただし、オーナーロールであるユーザーで実行する必要があります。