annofabcli 1.106.6__tar.gz → 1.106.7__tar.gz

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

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

{annofabcli-1.106.6 → annofabcli-1.106.7}/annofabcli/annotation/change_annotation_attributes_per_annotation.py

@@ -6,7 +6,7 @@ import logging
 import sys
 from collections import defaultdict
 from pathlib import Path
-from typing import Any, Optional, Union
+from typing import Optional, Union
 
 import annofabapi
 import pandas
@@ -76,7 +76,7 @@ class ChangeAnnotationAttributesPerAnnotationMain(CommandLineWithConfirm):
         self.dump_annotation_obj = DumpAnnotationMain(service, project_id)
         super().__init__(all_yes)
 
-    def change_annotation_attributes_by_frame(self, task_id: str, input_data_id: str, anno_list: list[TargetAnnotation]) -> bool:
+    def change_annotation_attributes_by_frame(self, task_id: str, input_data_id: str, anno_list: list[TargetAnnotation]) -> tuple[int, int]:
         """
         フレームごとにアノテーション属性値を変更する。
 
@@ -85,6 +85,10 @@ class ChangeAnnotationAttributesPerAnnotationMain(CommandLineWithConfirm):
             input_data_id: 入力データID
             additional_data_list: 変更後の属性値(`AdditionalDataListV2`スキーマ)
 
+        Returns:
+            [1]: 属性値の変更に成功したアノテーション数
+            [2]: 属性値を変更できなかった（変更対象のアノテーションが存在しなかった）アノテーション数
+
         """
         editor_annotation, _ = self.service.api.get_editor_annotation(self.project_id, task_id=task_id, input_data_id=input_data_id, query_params={"v": "2"})
 
@@ -94,26 +98,47 @@ class ChangeAnnotationAttributesPerAnnotationMain(CommandLineWithConfirm):
 
         details_map = {detail["annotation_id"]: detail for detail in editor_annotation["details"]}
 
-        def _to_request_body_elm(anno: TargetAnnotation) -> dict[str, Any]:
+        request_body = []
+        non_target_annotation_count = 0
+        for anno in anno_list:
+            if anno.annotation_id not in details_map:
+                logger.warning(
+                    f"task_id='{task_id}', input_data_id='{input_data_id}' :: "
+                    f"annotation_id='{anno.annotation_id}'であるアノテーションが存在しないため、"
+                    "このアノテーションの属性値の変更をスキップします。"
+                )
+                non_target_annotation_count += 1
+                continue
+
+            label_id = details_map[anno.annotation_id]["label_id"]
             additional_data_list = convert_attributes_from_cli_to_additional_data_list_v2(anno.attributes, annotation_specs=self.annotation_specs)
-            return {
-                "data": {
-                    "project_id": editor_annotation["project_id"],
-                    "task_id": editor_annotation["task_id"],
-                    "input_data_id": editor_annotation["input_data_id"],
-                    "updated_datetime": editor_annotation["updated_datetime"],
-                    "annotation_id": anno.annotation_id,
-                    "label_id": details_map[anno.annotation_id]["label_id"],
-                    "additional_data_list": additional_data_list,
-                },
-                "_type": "PutV2",
-            }
-
-        request_body = [_to_request_body_elm(annotation) for annotation in anno_list]
-
-        self.service.api.batch_update_annotations(self.project_id, request_body=request_body)
-        logger.debug(f"task_id='{task_id}', input_data_id='{input_data_id}' :: {len(request_body)}件の属性値を変更しました。")
-        return True
+            request_body.append(
+                {
+                    "data": {
+                        "project_id": editor_annotation["project_id"],
+                        "task_id": editor_annotation["task_id"],
+                        "input_data_id": editor_annotation["input_data_id"],
+                        "updated_datetime": editor_annotation["updated_datetime"],
+                        "annotation_id": anno.annotation_id,
+                        "label_id": label_id,
+                        "additional_data_list": additional_data_list,
+                    },
+                    "_type": "PutV2",
+                }
+            )
+
+        if request_body:
+            self.service.api.batch_update_annotations(self.project_id, request_body=request_body)
+        else:
+            logger.debug(f"task_id='{task_id}', input_data_id='{input_data_id}' :: 変更対象のアノテーションがありませんでした。")
+
+        succeed_to_change_annotation_count = len(request_body)
+        logger.debug(
+            f"task_id='{task_id}', input_data_id='{input_data_id}' :: "
+            f"{succeed_to_change_annotation_count}/{len(anno_list)}件の属性値を変更しました。"
+            f"{non_target_annotation_count}件のアノテーションは存在しなかったため、属性値の変更をスキップしました。"
+        )
+        return succeed_to_change_annotation_count, non_target_annotation_count
 
     def change_annotation_attributes_for_task(self, task_id: str, annotation_list_per_input_data_id: dict[str, list[TargetAnnotation]]) -> tuple[bool, int, int]:
         """
@@ -159,10 +184,9 @@ class ChangeAnnotationAttributesPerAnnotationMain(CommandLineWithConfirm):
 
         for input_data_id, sub_anno_list in annotation_list_per_input_data_id.items():
             try:
-                if self.change_annotation_attributes_by_frame(task_id, input_data_id, sub_anno_list):
-                    succeed_to_change_annotation_count += len(sub_anno_list)
-                else:
-                    failed_to_change_annotation_count += len(sub_anno_list)
+                tmp_succeed_to_change_annotation_count, tmp_failed_to_change_annotation_count = self.change_annotation_attributes_by_frame(task_id, input_data_id, sub_anno_list)
+                succeed_to_change_annotation_count += tmp_succeed_to_change_annotation_count
+                failed_to_change_annotation_count += tmp_failed_to_change_annotation_count
             except Exception:
                 logger.warning(f"task_id='{task_id}', input_data_id='{input_data_id}' :: アノテーションの属性値変更に失敗しました。", exc_info=True)
                 failed_to_change_annotation_count += len(sub_anno_list)

{annofabcli-1.106.6 → annofabcli-1.106.7}/annofabcli/annotation/import_annotation.py

@@ -9,7 +9,6 @@ import uuid
 import zipfile
 from collections.abc import Iterator
 from dataclasses import dataclass
-from functools import partial
 from pathlib import Path
 from typing import Any, Optional, Union
 
@@ -408,6 +407,7 @@ class ImportAnnotationMain(CommandLineWithConfirm):
         is_force: bool,
         is_merge: bool,
         is_overwrite: bool,
+        converter: AnnotationConverter,
     ) -> None:
         self.service = service
         self.facade = AnnofabApiFacade(service)
@@ -417,8 +417,9 @@ class ImportAnnotationMain(CommandLineWithConfirm):
         self.is_force = is_force
         self.is_merge = is_merge
         self.is_overwrite = is_overwrite
+        self.converter = converter
 
-    def put_annotation_for_input_data(self, parser: SimpleAnnotationParser, converter: AnnotationConverter) -> bool:
+    def put_annotation_for_input_data(self, parser: SimpleAnnotationParser) -> bool:
         task_id = parser.task_id
         input_data_id = parser.input_data_id
 
@@ -444,18 +445,18 @@ class ImportAnnotationMain(CommandLineWithConfirm):
 
         logger.info(f"task_id='{task_id}', input_data_id='{input_data_id}' :: {len(simple_annotation.details)} 件のアノテーションを登録します。")
         if self.is_merge:
-            request_body = converter.convert_annotation_details(parser, simple_annotation.details, old_details=old_annotation["details"], updated_datetime=old_annotation["updated_datetime"])
+            request_body = self.converter.convert_annotation_details(parser, simple_annotation.details, old_details=old_annotation["details"], updated_datetime=old_annotation["updated_datetime"])
         else:
-            request_body = converter.convert_annotation_details(parser, simple_annotation.details, old_details=[], updated_datetime=old_annotation["updated_datetime"])
+            request_body = self.converter.convert_annotation_details(parser, simple_annotation.details, old_details=[], updated_datetime=old_annotation["updated_datetime"])
 
         self.service.api.put_annotation(self.project_id, task_id, input_data_id, request_body=request_body, query_params={"v": "2"})
         return True
 
-    def put_annotation_for_task(self, task_parser: SimpleAnnotationParserByTask, converter: AnnotationConverter) -> int:
+    def put_annotation_for_task(self, task_parser: SimpleAnnotationParserByTask) -> int:
         success_count = 0
         for parser in task_parser.lazy_parse():
             try:
-                if self.put_annotation_for_input_data(parser, converter):
+                if self.put_annotation_for_input_data(parser):
                     success_count += 1
             except Exception:  # pylint: disable=broad-except
                 logger.warning(
@@ -465,7 +466,7 @@ class ImportAnnotationMain(CommandLineWithConfirm):
 
         return success_count
 
-    def execute_task(self, task_parser: SimpleAnnotationParserByTask, converter: AnnotationConverter, task_index: Optional[int] = None) -> bool:
+    def execute_task(self, task_parser: SimpleAnnotationParserByTask, task_index: Optional[int] = None) -> bool:
         """
         1個のタスクに対してアノテーションを登録する。
 
@@ -514,7 +515,7 @@ class ImportAnnotationMain(CommandLineWithConfirm):
                 )
                 return False
 
-        result_count = self.put_annotation_for_task(task_parser, converter)
+        result_count = self.put_annotation_for_task(task_parser)
         logger.info(f"{logger_prefix}タスク'{task_parser.task_id}'の入力データ {result_count} 個に対してアノテーションをインポートしました。")
 
         if changed_operator:
@@ -531,11 +532,10 @@ class ImportAnnotationMain(CommandLineWithConfirm):
     def execute_task_wrapper(
         self,
         tpl: tuple[int, SimpleAnnotationParserByTask],
-        converter: AnnotationConverter,
     ) -> bool:
         task_index, task_parser = tpl
         try:
-            return self.execute_task(task_parser, converter=converter, task_index=task_index)
+            return self.execute_task(task_parser, task_index=task_index)
         except Exception:  # pylint: disable=broad-except
             logger.warning(f"task_id='{task_parser.task_id}' のアノテーションのインポートに失敗しました。", exc_info=True)
             return False
@@ -543,18 +543,9 @@ class ImportAnnotationMain(CommandLineWithConfirm):
     def main(
         self,
         iter_task_parser: Iterator[SimpleAnnotationParserByTask],
-        converter: AnnotationConverter,
         target_task_ids: Optional[set[str]] = None,
         parallelism: Optional[int] = None,
     ) -> None:
-        """
-        アノテーションのインポート処理を実行するメイン関数です。
-
-        Notes:
-            `converter`をインスタンス変数でなく引数として渡している理由：
-            `multiprocessing.Pool`でシリアライズ化する際、"TypeError: cannot pickle '_thread.RLock' object"というエラーが発生するため
-        """
-
         def get_iter_task_parser_from_task_ids(_iter_task_parser: Iterator[SimpleAnnotationParserByTask], _target_task_ids: set[str]) -> Iterator[SimpleAnnotationParserByTask]:
             for task_parser in _iter_task_parser:
                 if task_parser.task_id in _target_task_ids:
@@ -571,15 +562,14 @@ class ImportAnnotationMain(CommandLineWithConfirm):
         task_count = 0
         if parallelism is not None:
             with multiprocessing.Pool(parallelism) as pool:
-                func = partial(self.execute_task_wrapper, converter=converter)
-                result_bool_list = pool.map(func, enumerate(iter_task_parser))
+                result_bool_list = pool.map(self.execute_task_wrapper, enumerate(iter_task_parser))
                 success_count = len([e for e in result_bool_list if e])
                 task_count = len(result_bool_list)
 
         else:
             for task_index, task_parser in enumerate(iter_task_parser):
                 try:
-                    result = self.execute_task(task_parser, converter=converter, task_index=task_index)
+                    result = self.execute_task(task_parser, task_index=task_index)
                     if result:
                         success_count += 1
                 except Exception:
@@ -618,6 +608,13 @@ class ImportAnnotation(CommandLine):
             print(f"{COMMON_MESSAGE} argument --annotation: ZIPファイルまたはディレクトリを指定してください。", file=sys.stderr)  # noqa: T201
             return False
 
+        if args.parallelism is not None and annotation_path.is_file() and zipfile.is_zipfile(annotation_path):
+            print(  # noqa: T201
+                f"{COMMON_MESSAGE} argument --parallelism: '--annotation'にZIPファイルを指定した場合は、'--parallelism'を指定できません。",
+                file=sys.stderr,
+            )
+            return False
+
         if args.parallelism is not None and not args.yes:
             print(  # noqa: T201
                 f"{COMMON_MESSAGE} argument --parallelism: '--parallelism'を指定するときは、必ず '--yes' を指定してください。",
@@ -642,7 +639,7 @@ class ImportAnnotation(CommandLine):
         # Simpleアノテーションの読み込み
         if annotation_path.is_dir():
             iter_task_parser = lazy_parse_simple_annotation_dir_by_task(annotation_path)
-        elif zipfile.is_zipfile(str(annotation_path)):
+        elif zipfile.is_zipfile(annotation_path):
             iter_task_parser = lazy_parse_simple_annotation_zip_by_task(annotation_path)
         else:
             logger.warning(f"annotation_path: '{annotation_path}' は、zipファイルまたはディレクトリではありませんでした。")
@@ -659,9 +656,10 @@ class ImportAnnotation(CommandLine):
             is_merge=args.merge,
             is_overwrite=args.overwrite,
             is_force=args.force,
+            converter=converter,
         )
 
-        main_obj.main(iter_task_parser, target_task_ids=target_task_ids, converter=converter, parallelism=args.parallelism)
+        main_obj.main(iter_task_parser, target_task_ids=target_task_ids, parallelism=args.parallelism)
 
 
 def main(args: argparse.Namespace) -> None:
@@ -717,7 +715,9 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
         "--parallelism",
         type=int,
         choices=PARALLELISM_CHOICES,
-        help="並列度。指定しない場合は、逐次的に処理します。指定した場合は、``--yes`` も指定してください。",
+        help="並列度。指定しない場合は、逐次的に処理します。"
+        "ただし ``--annotation`` にZIPファイルを指定した場合は、``--parallelism`` を指定できません。"
+        "また、``--parallelism`` を指定した場合は、``--yes`` も指定してください。",
     )
 
     parser.set_defaults(subcommand_func=main)

{annofabcli-1.106.6 → annofabcli-1.106.7}/annofabcli/task/change_operator.py

@@ -26,10 +26,11 @@ logger = logging.getLogger(__name__)
 
 
 class ChangeOperatorMain:
-    def __init__(self, service: annofabapi.Resource, all_yes: bool) -> None:  # noqa: FBT001
+    def __init__(self, service: annofabapi.Resource, *, all_yes: bool, include_on_hold: bool = False) -> None:
         self.service = service
         self.facade = AnnofabApiFacade(service)
         self.all_yes = all_yes
+        self.include_on_hold = include_on_hold
 
     def confirm_processing(self, confirm_message: str) -> bool:
         """
@@ -55,10 +56,10 @@ class ChangeOperatorMain:
         return yes
 
     def confirm_change_operator(self, task: Task) -> bool:
-        confirm_message = f"task_id = {task.task_id} のタスクの担当者を変更しますか？"
+        confirm_message = f"task_id='{task.task_id}' のタスクの担当者を変更しますか？"
         return self.confirm_processing(confirm_message)
 
-    def change_operator_for_task(
+    def change_operator_for_task(  # noqa: PLR0911
         self,
         project_id: str,
         task_id: str,
@@ -69,7 +70,7 @@ class ChangeOperatorMain:
         logging_prefix = f"{task_index + 1} 件目" if task_index is not None else ""
         dict_task = self.service.wrapper.get_task_or_none(project_id, task_id)
         if dict_task is None:
-            logger.warning(f"{logging_prefix}: task_id='{task_id}'のタスクは存在しないので、スキップします。")
+            logger.warning(f"{logging_prefix} :: task_id='{task_id}'のタスクは存在しないので、スキップします。")
             return False
 
         task: Task = Task.from_dict(dict_task)
@@ -78,14 +79,23 @@ class ChangeOperatorMain:
         if task.account_id is not None:
             now_user_id = self.facade.get_user_id_from_account_id(project_id, task.account_id)
 
-        logger.debug(f"{logging_prefix} : task_id = {task.task_id}, status = {task.status.value}, phase = {task.phase.value}, phase_stage = {task.phase_stage}, user_id = {now_user_id}")
+        logger.debug(f"{logging_prefix} :: task_id='{task.task_id}', status='{task.status.value}', phase='{task.phase.value}', phase_stage='{task.phase_stage}', user_id='{now_user_id}'")
+        if task.account_id == new_account_id:
+            logger.info(f"{logging_prefix} :: task_id='{task_id}' :: タスクの担当者はすでにuser_id='{now_user_id}'のユーザーです。担当者を変更する必要がないのでスキップします。")
+            return False
 
         if task.status in [TaskStatus.COMPLETE, TaskStatus.WORKING]:
-            logger.warning(f"{logging_prefix} : task_id = {task_id} : タスクのstatusがworking or complete なので、担当者を変更できません。")
+            logger.warning(f"{logging_prefix} :: task_id='{task_id}' :: タスクが作業中状態または完了状態なので、担当者を変更できません。 :: status='{task.status.value}'")
+            return False
+
+        if task.status == TaskStatus.ON_HOLD and not self.include_on_hold:
+            logger.warning(
+                f"{logging_prefix} :: task_id='{task_id}' :: タスクが保留中状態なので、担当者を変更できません。保留中状態のタスクの担当者も変更する場合は、'--include_on_hold'を指定してください。"
+            )
             return False
 
         if not match_task_with_query(task, task_query):
-            logger.debug(f"{logging_prefix} : task_id = {task_id} : `--task_query` の条件にマッチしないため、スキップします。task_query={task_query}")
+            logger.debug(f"{logging_prefix} :: task_id='{task_id}' :: `--task_query` の条件にマッチしないため、スキップします。task_query='{task_query}'")
             return False
 
         if not self.confirm_change_operator(task):
@@ -94,11 +104,11 @@ class ChangeOperatorMain:
         try:
             # 担当者を変更する
             self.service.wrapper.change_task_operator(project_id, task_id, operator_account_id=new_account_id)
-            logger.debug(f"{logging_prefix} : task_id = {task_id}, phase={dict_task['phase']} のタスクの担当者を変更しました。")
+            logger.debug(f"{logging_prefix} :: task_id='{task_id}'であるタスクの担当者を変更しました。 :: phase='{dict_task['phase']}'")
             return True  # noqa: TRY300
 
         except requests.exceptions.HTTPError:
-            logger.warning(f"{logging_prefix} : task_id = {task_id} の担当者を変更するのに失敗しました。", exc_info=True)
+            logger.warning(f"{logging_prefix} :: task_id='{task_id}'である担当者を変更するのに失敗しました。", exc_info=True)
             return False
 
     def change_operator_for_task_wrapper(
@@ -118,19 +128,21 @@ class ChangeOperatorMain:
                 new_account_id=new_account_id,
             )
         except Exception:  # pylint: disable=broad-except
-            logger.warning(f"タスク'{task_id}'の担当者の変更に失敗しました。", exc_info=True)
+            logger.warning(f"task_id='{task_id}'であるタスク担当者の変更に失敗しました。", exc_info=True)
             return False
 
     def change_operator(
         self,
         project_id: str,
         task_id_list: list[str],
+        *,
         new_user_id: Optional[str] = None,
         task_query: Optional[TaskQuery] = None,
         parallelism: Optional[int] = None,
     ) -> None:
         """
-        検査コメントを付与して、タスクを差し戻す
+        指定した複数のタスクの担当者を変更します。
+
         Args:
             project_id:
             task_id_list:
@@ -143,13 +155,13 @@ class ChangeOperatorMain:
         if new_user_id is not None:
             new_account_id = self.facade.get_account_id_from_user_id(project_id, new_user_id)
             if new_account_id is None:
-                logger.error(f"ユーザ '{new_user_id}' のaccount_idが見つかりませんでした。終了します。")
+                logger.error(f"user_id='{new_user_id}'であるユーザーは、project_id='{project_id}'のプロジェクトのメンバーではありません。終了します。")
                 return
             else:
-                logger.info(f"{len(task_id_list)} 件のタスクの担当者を、{new_user_id}に変更します。")
+                logger.info(f"{len(task_id_list)} 件のタスクの担当者を、user_id='{new_user_id}'のユーザーに変更します。")
         else:
             new_account_id = None
-            logger.info(f"{len(task_id_list)} 件のタスクの担当者を未割り当てに変更します。")
+            logger.info(f"{len(task_id_list)} 件のタスクの担当者を「未割り当て」に変更します。")
 
         success_count = 0
 
@@ -172,7 +184,7 @@ class ChangeOperatorMain:
                     if result:
                         success_count += 1
                 except Exception:  # pylint: disable=broad-except
-                    logger.warning(f"タスク'{task_id}'の担当者の変更に失敗しました。", exc_info=True)
+                    logger.warning(f"task_id='{task_id}'であるタスクの担当者の変更に失敗しました。", exc_info=True)
                     continue
 
         logger.info(f"{success_count} / {len(task_id_list)} 件 タスクの担当者を変更しました。")
@@ -212,7 +224,7 @@ class ChangeOperator(CommandLine):
         project_id = args.project_id
         super().validate_project(project_id, [ProjectMemberRole.OWNER, ProjectMemberRole.ACCEPTER])
 
-        main_obj = ChangeOperatorMain(self.service, all_yes=self.all_yes)
+        main_obj = ChangeOperatorMain(self.service, all_yes=self.all_yes, include_on_hold=args.include_on_hold)
         main_obj.change_operator(
             project_id,
             task_id_list=task_id_list,
@@ -242,6 +254,12 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
 
     argument_parser.add_task_query()
 
+    parser.add_argument(
+        "--include_on_hold",
+        action="store_true",
+        help="指定した場合、保留中のタスクの担当者も変更します。指定しない場合、保留中のタスクはスキップされます。",
+    )
+
     parser.add_argument(
         "--parallelism",
         type=int,
@@ -255,7 +273,7 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
 def add_parser(subparsers: Optional[argparse._SubParsersAction] = None) -> argparse.ArgumentParser:
     subcommand_name = "change_operator"
     subcommand_help = "タスクの担当者を変更します。"
-    description = "タスクの担当者を変更します。ただし、作業中また完了状態のタスクは、担当者を変更できません。"
+    description = "タスクの担当者を変更します。作業中状態、完了状態のタスクは、担当者を変更できません。保留中状態のタスクは、デフォルトでは担当者を変更できません。"
     epilog = "チェッカーまたはオーナロールを持つユーザで実行してください。"
 
     parser = annofabcli.common.cli.add_parser(subparsers, subcommand_name, subcommand_help, description, epilog=epilog)

{annofabcli-1.106.6 → annofabcli-1.106.7}/docs/command_reference/task/change_operator.rst

@@ -5,7 +5,10 @@ task change_operator
 Description
 =================================
 タスクの担当者を変更します。
-ただし作業中また完了状態のタスクは、担当者を変更できません。
+作業中状態、完了状態のタスクは、担当者を変更できません。
+保留中状態のタスクは、デフォルトでは担当者を変更できません。
+
+
 
 Examples
 =================================
@@ -56,6 +59,19 @@ Examples
      --task_query '{"phase":"acceptance", "status:"not_started"}' --not_assign
 
 
+保留中状態のタスクの担当者を変更する
+----------------------------------------------
+
+保留中状態のタスクは、デフォルトでは担当者を変更できません。
+``--include_on_hold`` を指定すると、保留中状態のタスクも担当者を変更できます。
+
+
+
+.. code-block::
+
+    $ annofabcli task change_operator --project_id prj1 --task_id t1 t2 \
+     --user_id user1 --include_on_hold
+
 
 並列処理
 ----------------------------------------------