annofabcli 1.104.1__py3-none-any.whl → 1.105.1__py3-none-any.whl

annofabcli/annotation/annotation_query.py

@@ -105,6 +105,11 @@ def _get_additional_data_v2(additional_data: dict[str, Any], attribute_value: At
         return get_english_message(additional_data["name"])
 
     additional_data_definition_id = additional_data["additional_data_definition_id"]
+    if attribute_value is None:
+        return {
+            "definition_id": additional_data_definition_id,
+            "value": None,
+        }
 
     additional_data_type: str = additional_data["type"]
 

annofabcli/annotation/change_annotation_attributes_per_annotation.py

@@ -0,0 +1,296 @@
+from __future__ import annotations
+
+import argparse
+import json
+import logging
+import sys
+from collections import defaultdict
+from pathlib import Path
+from typing import Any, Optional, Union
+
+import annofabapi
+import pandas
+from annofabapi.models import ProjectMemberRole
+from annofabapi.pydantic_models.task_status import TaskStatus
+from pydantic import BaseModel
+
+import annofabcli
+from annofabcli.annotation.annotation_query import convert_attributes_from_cli_to_additional_data_list_v2
+from annofabcli.annotation.dump_annotation import DumpAnnotationMain
+from annofabcli.common.cli import (
+    COMMAND_LINE_ERROR_STATUS_CODE,
+    ArgumentParser,
+    CommandLine,
+    CommandLineWithConfirm,
+    build_annofabapi_resource_and_login,
+    get_json_from_args,
+)
+from annofabcli.common.facade import AnnofabApiFacade
+
+logger = logging.getLogger(__name__)
+
+
+Attributes = dict[str, Optional[Union[str, int, bool]]]
+"""属性情報"""
+
+
+class TargetAnnotation(BaseModel):
+    task_id: str
+    input_data_id: str
+    annotation_id: str
+    attributes: Attributes
+
+
+def get_annotation_list_per_task_id_input_data_id(anno_list: list[TargetAnnotation]) -> dict[str, dict[str, list[TargetAnnotation]]]:
+    """
+    タスクIDと入力データIDごとにアノテーションをグループ化する。
+
+    Args:
+        anno_list: アノテーションのリスト
+
+    Returns:
+        タスクIDと入力データIDをキーとしたアノテーションの辞書
+    """
+    grouped: dict[str, dict[str, list[TargetAnnotation]]] = defaultdict(lambda: defaultdict(list))
+
+    for annotation in anno_list:
+        grouped[annotation.task_id][annotation.input_data_id].append(annotation)
+    return grouped
+
+
+class ChangeAnnotationAttributesPerAnnotationMain(CommandLineWithConfirm):
+    def __init__(
+        self,
+        service: annofabapi.Resource,
+        *,
+        project_id: str,
+        is_force: bool,
+        all_yes: bool,
+        backup_dir: Optional[Path] = None,
+    ) -> None:
+        self.service = service
+        self.project_id = project_id
+        self.is_force = is_force
+        self.backup_dir = backup_dir
+        self.annotation_specs, _ = self.service.api.get_annotation_specs(project_id, query_params={"v": "3"})
+        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:
+        """
+        フレームごとにアノテーション属性値を変更する。
+
+        Args:
+            task_id: タスクID
+            input_data_id: 入力データID
+            additional_data_list: 変更後の属性値(`AdditionalDataListV2`スキーマ)
+
+        """
+        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"})
+
+        if self.backup_dir is not None:
+            (self.backup_dir / task_id).mkdir(exist_ok=True, parents=True)
+            self.dump_annotation_obj.dump_editor_annotation(editor_annotation, json_path=self.backup_dir / task_id / f"{input_data_id}.json")
+
+        details_map = {detail["annotation_id"]: detail for detail in editor_annotation["details"]}
+
+        def _to_request_body_elm(anno: TargetAnnotation) -> dict[str, Any]:
+            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
+
+    def change_annotation_attributes_for_task(self, task_id: str, annotation_list_per_input_data_id: dict[str, list[TargetAnnotation]]) -> tuple[bool, int, int]:
+        """
+        1個のタスクに含まれるアノテーションの属性値を変更する。
+
+        Args:
+            task_id: タスクID
+            annotation_list_per_input_data_id: 入力データIDごとのアノテーションリスト
+
+        Returns:
+            tuple:
+                [0]: 属性値の変更可能なタスクかどうか
+                [1]: 属性値の変更に成功したアノテーション数
+                [2]: 属性値を変更できなかったアノテーション数
+
+        """
+        annotation_count = sum(len(v) for v in annotation_list_per_input_data_id.values())
+        task = self.service.wrapper.get_task_or_none(self.project_id, task_id)
+
+        succeed_to_change_annotation_count = 0
+        failed_to_change_annotation_count = 0
+
+        if task is None:
+            logger.warning(f"task_id='{task_id}' :: タスクが存在しないため、{annotation_count} 件のアノテーションの属性値の変更をスキップします。")
+            return False, 0, annotation_count
+
+        if task["status"] == TaskStatus.WORKING.value:
+            logger.info(f"task_id='{task_id}' :: タスクが作業中状態のため、{annotation_count} 件のアノテーションの属性値の変更をスキップします。")
+            failed_to_change_annotation_count += annotation_count
+            return False, 0, annotation_count
+
+        if not self.is_force:  # noqa: SIM102
+            if task["status"] == TaskStatus.COMPLETE.value:
+                logger.info(
+                    f"task_id='{task_id}' :: タスクが完了状態のため、アノテーション {annotation_count} 件のアノテーションの属性値の変更をスキップします。"
+                    f"完了状態のタスクのアノテーションを削除するには、`--force`オプションを指定してください。"
+                )
+                failed_to_change_annotation_count += annotation_count
+                return False, 0, annotation_count
+
+        if not self.confirm_processing(f"task_id='{task_id}'に含まれるアノテーション{annotation_count}件の属性値を変更しますか？"):
+            return False, 0, annotation_count
+
+        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)
+            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)
+                continue
+
+        return True, succeed_to_change_annotation_count, failed_to_change_annotation_count
+
+    def change_annotation_attributes(self, anno_list: list[TargetAnnotation]) -> None:
+        """
+        アノテーションごとに属性値を変更する。
+
+        Args:
+            anno_list: 各アノテーションの変更内容リスト
+        """
+        changed_task_count = 0
+        failed_to_change_annotation_count = 0
+        annotation_list_per_task_id_input_data_id = get_annotation_list_per_task_id_input_data_id(anno_list)
+
+        total_task_count = len(annotation_list_per_task_id_input_data_id)
+        total_annotation_count = len(anno_list)
+
+        for task_id, input_data_dict in annotation_list_per_task_id_input_data_id.items():
+            is_changeable_task, succeed_to_change_annotation_count, failed_to_change_annotation_count = self.change_annotation_attributes_for_task(task_id, input_data_dict)
+            if is_changeable_task:
+                changed_task_count += 1
+
+        logger.info(
+            f"{succeed_to_change_annotation_count}/{total_annotation_count} 件のアノテーションの属性値を変更しました。 :: "
+            f"アノテーションが変更されたタスク数は {changed_task_count}/{total_task_count} 件です。"
+            f"{failed_to_change_annotation_count} 件のアノテーションは変更できませんでした。"
+        )
+
+
+class ChangeAttributesPerAnnotation(CommandLine):
+    """
+    アノテーションごとに属性値を個別変更
+    """
+
+    COMMON_MESSAGE = "annofabcli annotation change_attributes_per_annotation: error:"
+
+    def main(self) -> None:
+        args = self.args
+
+        if args.json is not None:
+            annotation_items = get_json_from_args(args.json)
+            if not isinstance(annotation_items, list):
+                print(f"{self.COMMON_MESSAGE} argument --json: JSON形式が不正です。オブジェクトの配列を指定してください。", file=sys.stderr)  # noqa: T201
+                sys.exit(COMMAND_LINE_ERROR_STATUS_CODE)
+
+            target_annotation_list = [TargetAnnotation.model_validate(anno) for anno in annotation_items]
+
+        elif args.csv is not None:
+            df_input = pandas.read_csv(args.csv)
+            target_annotation_list = [
+                TargetAnnotation(task_id=e["task_id"], input_data_id=e["input_data_id"], annotation_id=e["annotation_id"], attributes=json.loads(e["attributes"]))
+                for e in df_input.to_dict(orient="records")
+            ]
+        else:
+            print(f"{self.COMMON_MESSAGE} argument '--json' または '--csv' のいずれかを指定してください。", file=sys.stderr)  # noqa: T201
+            sys.exit(COMMAND_LINE_ERROR_STATUS_CODE)
+
+        project_id = args.project_id
+
+        if args.backup is None:
+            print(  # noqa: T201
+                "間違えてアノテーションを変更してしまっときに復元できるようにするため、'--backup'でバックアップ用のディレクトリを指定することを推奨します。",
+                file=sys.stderr,
+            )
+            if not self.confirm_processing("復元用のバックアップディレクトリが指定されていません。処理を続行しますか？"):
+                sys.exit(COMMAND_LINE_ERROR_STATUS_CODE)
+            backup_dir = None
+        else:
+            backup_dir = Path(args.backup)
+
+        # プロジェクト権限チェック
+        super().validate_project(project_id, [ProjectMemberRole.OWNER, ProjectMemberRole.ACCEPTER])
+
+        main_obj = ChangeAnnotationAttributesPerAnnotationMain(self.service, project_id=project_id, all_yes=args.yes, is_force=args.force, backup_dir=backup_dir)
+        main_obj.change_annotation_attributes(target_annotation_list)
+
+
+def main(args: argparse.Namespace) -> None:
+    service = build_annofabapi_resource_and_login(args)
+    facade = AnnofabApiFacade(service)
+    ChangeAttributesPerAnnotation(service, facade, args).main()
+
+
+def parse_args(parser: argparse.ArgumentParser) -> None:
+    argument_parser = ArgumentParser(parser)
+    argument_parser.add_project_id()
+
+    sample_json_obj = [{"task_id": "t1", "input_data_id": "i1", "annotation_id": "a1", "attributes": {"occluded": True}}]
+    input_group = parser.add_mutually_exclusive_group(required=True)
+    input_group.add_argument(
+        "--json",
+        type=str,
+        help="各アノテーションごとに変更内容を記載したJSONリストを指定します。 ``file://`` を先頭に付けるとJSON形式のファイルを指定できます。\n"
+        f"(例) '{json.dumps(sample_json_obj, ensure_ascii=False)}'",
+    )
+    input_group.add_argument(
+        "--csv",
+        type=str,
+        help="各アノテーションごとに変更内容を記載したCSVファイルを指定します。 \n"
+        "* `task_id`, `input_data_id`, `annotation_id`, `attributes` の4つのカラムが必要です。\n"
+        f"`attributes` カラムには、属性名と値を '{json.dumps({'occluded': True})}' のようにJSON形式で指定します。\n",
+    )
+
+    parser.add_argument(
+        "--force",
+        action="store_true",
+        help="指定した場合は、完了状態のタスクのアノテーションも属性値を変更します。ただし、完了状態のタスクのアノテーションを変更するには、オーナーロールを持つユーザーが実行する必要があります。",
+    )
+
+    parser.add_argument(
+        "--backup",
+        type=Path,
+        required=False,
+        help="アノテーションのバックアップを保存するディレクトリのパス。アノテーションの復元は ``annotation restore`` コマンドで実現できます。",
+    )
+
+    parser.set_defaults(subcommand_func=main)
+
+
+def add_parser(subparsers: Optional[argparse._SubParsersAction] = None) -> argparse.ArgumentParser:
+    subcommand_name = "change_attributes_per_annotation"
+    subcommand_help = "各アノテーションの属性値を変更します。"
+    epilog = "オーナロールまたはチェッカーロールを持つユーザで実行してください。"
+
+    parser = annofabcli.common.cli.add_parser(subparsers, subcommand_name, subcommand_help, epilog=epilog)
+    parse_args(parser)
+    return parser

annofabcli/annotation/delete_annotation.py

@@ -296,8 +296,7 @@ class DeleteAnnotationMain(CommandLineWithConfirm):
             deleted_task_count += 1
             for input_data_id, annotation_ids in sub_grouped.items():
                 # 指定input_data_idの全annotationを取得
-                # TODO どこかのタイミングで、"v=2"のアノテーションを取得するようにする
-                editor_annotation = self.service.wrapper.get_editor_annotation_or_none(self.project_id, task_id=task_id, input_data_id=input_data_id, query_params={"v": "1"})
+                editor_annotation = self.service.wrapper.get_editor_annotation_or_none(self.project_id, task_id=task_id, input_data_id=input_data_id, query_params={"v": "2"})
                 if editor_annotation is None:
                     logger.warning(
                         f"task_id='{task_id}'のタスクに、input_data_id='{input_data_id}'の入力データが含まれていません。 アノテーションの削除をスキップします。 :: annotation_ids={annotation_ids}"

annofabcli/annotation/dump_annotation.py

@@ -27,26 +27,44 @@ class DumpAnnotationMain:
     def dump_editor_annotation(self, editor_annotation: dict[str, Any], json_path: Path) -> None:
         """
         `getEditorAnnotation` APIのレスポンスをファイルに保存する。
+
+        Args:
+            editor_annotation: v1, v2 のどちらの形式でも対応。
         """
         json_path.write_text(json.dumps(editor_annotation, ensure_ascii=False), encoding="utf-8")
-
         details = editor_annotation["details"]
-        outer_details = [e for e in details if e["data_holding_type"] == AnnotationDataHoldingType.OUTER.value]
-        if len(outer_details) == 0:
-            return
 
-        input_data_id = editor_annotation["input_data_id"]
-        outer_dir = json_path.parent / input_data_id
-        outer_dir.mkdir(exist_ok=True, parents=True)
+        if editor_annotation.get("format_version") == "2.0.0":
+            outer_details = [e for e in details if e["body"]["_type"] == "Outer"]
+            if len(outer_details) == 0:
+                return
+
+            input_data_id = editor_annotation["input_data_id"]
+            outer_dir = json_path.parent / input_data_id
+            outer_dir.mkdir(exist_ok=True, parents=True)
+            # 塗りつぶし画像など外部リソースに保存されているファイルをダウンロードする
+            for detail in outer_details:
+                annotation_id = detail["annotation_id"]
+                outer_file_path = outer_dir / f"{annotation_id}"
+                self.service.wrapper.download(detail["body"]["url"], outer_file_path)
+
+        else:
+            outer_details = [e for e in details if e["data_holding_type"] == AnnotationDataHoldingType.OUTER.value]
+            if len(outer_details) == 0:
+                return
+
+            input_data_id = editor_annotation["input_data_id"]
+            outer_dir = json_path.parent / input_data_id
+            outer_dir.mkdir(exist_ok=True, parents=True)
 
-        # 塗りつぶし画像など外部リソースに保存されているファイルをダウンロードする
-        for detail in outer_details:
-            annotation_id = detail["annotation_id"]
-            outer_file_path = outer_dir / f"{annotation_id}"
-            self.service.wrapper.download(detail["url"], outer_file_path)
+            # 塗りつぶし画像など外部リソースに保存されているファイルをダウンロードする
+            for detail in outer_details:
+                annotation_id = detail["annotation_id"]
+                outer_file_path = outer_dir / f"{annotation_id}"
+                self.service.wrapper.download(detail["url"], outer_file_path)
 
     def dump_annotation_for_input_data(self, task_id: str, input_data_id: str, task_dir: Path) -> None:
-        editor_annotation, _ = self.service.api.get_editor_annotation(self.project_id, task_id, input_data_id)
+        editor_annotation, _ = self.service.api.get_editor_annotation(self.project_id, task_id, input_data_id, query_params={"v": "2"})
         json_path = task_dir / f"{input_data_id}.json"
         self.dump_editor_annotation(editor_annotation=editor_annotation, json_path=json_path)
 

annofabcli/annotation/restore_annotation.py

@@ -74,10 +74,17 @@ class RestoreAnnotationMain(CommandLineWithConfirm):
 
         return detail
 
-    def parser_to_request_body(self, parser: SimpleAnnotationParser) -> dict[str, Any]:
+    def editor_annotation_to_request_body_v1(self, editor_annotation: dict[str, Any], parser: SimpleAnnotationParser) -> dict[str, Any]:
+        """
+        `get_editor_annotation`で取得したアノテーション(v1)を、`put_annotation` APIに渡すリクエストボディ(v1)に変換する。
+
+        Args:
+            editor_annotation: `get_editor_annotation`で取得したアノテーション(v1)
+            parser: SimpleAnnotationParserインスタンス。アノテーションのファイルを開くために利用する。
+        """
         # infer_missing=Trueを指定する理由：Optional型のキーが存在しない場合でも、AnnotationV1データクラスのインスタンスを生成できるようにするため
         # https://qiita.com/yuji38kwmt/items/c5b56f70da3b8a70ba31
-        annotation: AnnotationV1 = AnnotationV1.from_dict(parser.load_json(), infer_missing=True)
+        annotation: AnnotationV1 = AnnotationV1.from_dict(editor_annotation, infer_missing=True)
         request_details: list[dict[str, Any]] = []
         for detail in annotation.details:
             request_detail = self._to_annotation_detail_for_request(parser, detail)
@@ -94,15 +101,48 @@ class RestoreAnnotationMain(CommandLineWithConfirm):
 
         return request_body
 
+    def editor_annotation_to_request_body_v2(self, editor_annotation: dict[str, Any], parser: SimpleAnnotationParser) -> dict[str, Any]:
+        """
+        `get_editor_annotation`で取得したアノテーション(v2)を、`put_annotation` APIに渡すリクエストボディ(v2)に変換する。
+
+        Args:
+            editor_annotation: `get_editor_annotation`で取得したアノテーション(v2)
+            parser: SimpleAnnotationParserインスタンス。アノテーションのファイルを開くために利用する。
+        """
+        request_details: list[dict[str, Any]] = []
+        for detail in editor_annotation["details"]:
+            new_detail = copy.deepcopy(detail)
+            new_detail["_type"] = "Import"
+            annotation_id = detail["annotation_id"]
+            detail_body_type = detail["body"]["_type"]
+            if detail_body_type == "Outer":
+                with parser.open_outer_file(annotation_id) as f:
+                    # TODO content typeを確認
+                    s3_path = self.service.wrapper.upload_data_to_s3(self.project_id, f, content_type="application/octet-stream")
+                    new_detail["body"] = {"path": s3_path, "_type": "Outer"}
+                    request_details.append(new_detail)
+            elif detail_body_type == "Inner":
+                request_details.append(new_detail)
+            else:
+                raise ValueError(f"detail_body_type がサポート対象外です。:: detail={detail}")
+
+        request_body = {"project_id": self.project_id, "task_id": parser.task_id, "input_data_id": parser.input_data_id, "details": request_details, "format_version": "2.0.0"}
+
+        return request_body
+
     def put_annotation_for_input_data(self, parser: SimpleAnnotationParser) -> bool:
         task_id = parser.task_id
         input_data_id = parser.input_data_id
 
-        old_annotation, _ = self.service.api.get_editor_annotation(self.project_id, task_id, input_data_id)
-
         logger.info(f"task_id='{task_id}', input_data_id='{input_data_id}' :: アノテーションをリストアします。")
-        request_body = self.parser_to_request_body(parser)
 
+        editor_annotation = parser.load_json()
+        if editor_annotation.get("format_version") == "2.0.0":
+            request_body = self.editor_annotation_to_request_body_v2(editor_annotation, parser)
+        else:
+            request_body = self.editor_annotation_to_request_body_v1(editor_annotation, parser)
+
+        old_annotation, _ = self.service.api.get_editor_annotation(self.project_id, task_id, input_data_id, query_params={"v": "2"})
         updated_datetime = old_annotation["updated_datetime"] if old_annotation is not None else None
         request_body["updated_datetime"] = updated_datetime
         self.service.api.put_annotation(self.project_id, task_id, input_data_id, request_body=request_body)

annofabcli/annotation/subcommand_annotation.py

@@ -2,6 +2,7 @@ import argparse
 from typing import Optional
 
 import annofabcli.annotation.change_annotation_attributes
+import annofabcli.annotation.change_annotation_attributes_per_annotation
 import annofabcli.annotation.change_annotation_properties
 import annofabcli.annotation.copy_annotation
 import annofabcli.annotation.delete_annotation
@@ -21,6 +22,7 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
 
     # サブコマンドの定義
     annofabcli.annotation.change_annotation_attributes.add_parser(subparsers)
+    annofabcli.annotation.change_annotation_attributes_per_annotation.add_parser(subparsers)
     annofabcli.annotation.change_annotation_properties.add_parser(subparsers)
     annofabcli.annotation.copy_annotation.add_parser(subparsers)
     annofabcli.annotation.delete_annotation.add_parser(subparsers)

annofabcli/comment/put_comment.py

@@ -67,7 +67,7 @@ class PutCommentMain(CommandLineWithConfirm):
         """batch_update_comments に渡すリクエストボディを作成する。"""
 
         def _create_dict_annotation_id() -> dict[str, str]:
-            content, _ = self.service.api.get_editor_annotation(self.project_id, task["task_id"], input_data_id)
+            content, _ = self.service.api.get_editor_annotation(self.project_id, task["task_id"], input_data_id, query_params={"v": "2"})
             details = content["details"]
             return {e["annotation_id"]: e["label_id"] for e in details}
 

annofabcli/common/visualize.py

@@ -375,13 +375,10 @@ class AddProps:
 
         * user_id
         * username
-
-        Args:
-            task:
-
-        Returns:
-            Task情報
+        * request.user_id
+        * request.username
 
         """
         self._add_user_info(task_history_event)
+        self._add_user_info(task_history_event["request"])
         return task_history_event

annofabcli/task_history_event/list_all_task_history_event.py

@@ -81,16 +81,34 @@ class ListTaskHistoryEventWithJson(CommandLine):
         main_obj = ListTaskHistoryEventWithJsonMain(self.service)
         task_history_event_list = main_obj.get_task_history_event_list(project_id, task_history_event_json=task_history_event_json, task_id_list=task_id_list)
 
-        logger.debug(f"タスク履歴イベント一覧の件数: {len(task_history_event_list)}")
-
-        if len(task_history_event_list) > 0:
-            if arg_format == FormatArgument.CSV:
+        logger.debug(f"{len(task_history_event_list)} 件のタスク履歴イベントの情報を出力します。")
+
+        if arg_format == FormatArgument.CSV:
+            columns = [
+                "project_id",
+                "task_id",
+                "task_history_id",
+                "created_datetime",
+                "phase",
+                "phase_stage",
+                "status",
+                "account_id",
+                "request.status",
+                "request.account_id",
+                "request.user_id",
+                "request.username",
+                "request.last_updated_datetime",
+                "request.force",
+            ]
+            if len(task_history_event_list) > 0:
                 df = pandas.json_normalize(task_history_event_list)
-                self.print_csv(df)
+                df = df[columns]
             else:
-                self.print_according_to_format(task_history_event_list)
+                df = pandas.DataFrame(columns=columns)
+
+            self.print_csv(df)
         else:
-            logger.warning("タスク履歴イベント一覧の件数が0件であるため、出力しません。")
+            self.print_according_to_format(task_history_event_list)
 
     def main(self) -> None:
         args = self.args

annofabcli/task_history_event/list_worktime.py

@@ -36,6 +36,20 @@ class SimpleTaskHistoryEvent(DataClassJsonMixin):
     status: str
 
 
+@dataclass
+class RequestOfTaskHistoryEvent(DataClassJsonMixin):
+    """operateTask APIによってタスク履歴イベントが生成されたときのリクエストボディ
+
+    ただし、CLIユーザーにとって不要な情報は除いています。
+    """
+
+    status: str
+    force: bool
+    account_id: Optional[str]
+    user_id: Optional[str]
+    username: Optional[str]
+
+
 @dataclass
 class WorktimeFromTaskHistoryEvent(DataClassJsonMixin):
     project_id: str
@@ -48,6 +62,8 @@ class WorktimeFromTaskHistoryEvent(DataClassJsonMixin):
     worktime_hour: float
     start_event: SimpleTaskHistoryEvent
     end_event: SimpleTaskHistoryEvent
+    end_event_request: RequestOfTaskHistoryEvent
+    """operateTask APIによってタスク履歴イベントが生成されたときのリクエストボディ"""
 
 
 class ListWorktimeFromTaskHistoryEventMain:
@@ -123,6 +139,15 @@ class ListWorktimeFromTaskHistoryEventMain:
             user_id = None
             username = None
 
+        end_event_request_account_id = end_event["request"]["account_id"]
+        end_event_request_member = self.visualize.get_project_member_from_account_id(end_event_request_account_id)
+        if end_event_request_member is not None:
+            end_event_request_user_id = end_event_request_member["user_id"]
+            end_event_request_username = end_event_request_member["username"]
+        else:
+            end_event_request_user_id = None
+            end_event_request_username = None
+
         return WorktimeFromTaskHistoryEvent(
             # start_eventとend_eventの以下の属性は同じなので、start_eventの値を参照する
             project_id=start_event["project_id"],
@@ -143,9 +168,16 @@ class ListWorktimeFromTaskHistoryEventMain:
                 created_datetime=end_event["created_datetime"],
                 status=end_event["status"],
             ),
+            end_event_request=RequestOfTaskHistoryEvent(
+                status=end_event["request"]["status"],
+                force=end_event["request"]["force"],
+                account_id=end_event["request"]["account_id"],
+                user_id=end_event_request_user_id,
+                username=end_event_request_username,
+            ),
         )
 
-    def _create_worktime_list(self, task_history_event_list: list[TaskHistoryEvent]) -> list[WorktimeFromTaskHistoryEvent]:
+    def _create_worktime_list(self, task_id: str, task_history_event_list: list[TaskHistoryEvent]) -> list[WorktimeFromTaskHistoryEvent]:
         """タスク履歴イベントから、作業時間のリストを生成する。
 
         Args:
@@ -174,7 +206,12 @@ class ListWorktimeFromTaskHistoryEventMain:
                 TaskStatus.ON_HOLD.value,
                 TaskStatus.COMPLETE.value,
             }:
-                logger.warning(f"作業中状態のタスク履歴イベントに対応するタスク履歴イベントが存在しませんでした。:: start_event={start_event}, next_event={next_event}")
+                logger.warning(
+                    f"task_id='{task_id}' :: 作業開始のイベント（task_history_id='{event['task_history_id']}'）の次のイベント（task_history_id='{next_event['task_history_id']}'）は、"
+                    f"作業終了のイベントではないため、作業時間を算出できません。スキップします。"
+                    f"タスク履歴イベントが不整合な状態なので、Annofabチームに問い合わせてください。 :: "
+                    f"start_event='{start_event}', next_event='{next_event}'"
+                )
                 i += 1
                 continue
 
@@ -204,8 +241,8 @@ class ListWorktimeFromTaskHistoryEventMain:
         task_history_event_dict = self._create_task_history_event_dict(all_task_history_event_list, task_ids=task_id_set, account_ids=account_id_set)
 
         worktime_list = []
-        for subset_event_list in task_history_event_dict.values():
-            subset_worktime_list = self._create_worktime_list(subset_event_list)
+        for task_id, subset_event_list in task_history_event_dict.items():
+            subset_worktime_list = self._create_worktime_list(task_id, subset_event_list)
             worktime_list.extend(subset_worktime_list)
         return worktime_list
 
@@ -230,16 +267,38 @@ class ListWorktimeFromTaskHistoryEvent(CommandLine):
         )
 
         logger.debug(f"作業時間一覧の件数: {len(worktime_list)}")
-
-        if len(worktime_list) > 0:
-            dict_worktime_list = [e.to_dict() for e in worktime_list]
-            if arg_format == FormatArgument.CSV:
-                df = pandas.json_normalize(dict_worktime_list)
-                self.print_csv(df)
+        dict_worktime_list = [e.to_dict() for e in worktime_list]
+
+        if arg_format == FormatArgument.CSV:
+            columns = [
+                "project_id",
+                "task_id",
+                "phase",
+                "phase_stage",
+                "account_id",
+                "user_id",
+                "username",
+                "worktime_hour",
+                "start_event.task_history_id",
+                "start_event.created_datetime",
+                "start_event.status",
+                "end_event.task_history_id",
+                "end_event.created_datetime",
+                "end_event.status",
+                "end_event_request.status",
+                "end_event_request.force",
+                "end_event_request.account_id",
+                "end_event_request.user_id",
+                "end_event_request.username",
+            ]
+
+            if len(dict_worktime_list) > 0:
+                df = pandas.json_normalize(dict_worktime_list)[columns]
             else:
-                self.print_according_to_format(dict_worktime_list)
+                df = pandas.DataFrame(columns=columns)
+            self.print_csv(df)
         else:
-            logger.warning("作業時間一覧の件数が0件であるため、出力しません。")
+            self.print_according_to_format(dict_worktime_list)
 
     def main(self) -> None:
         args = self.args

{annofabcli-1.104.1.dist-info → annofabcli-1.105.1.dist-info}/METADATA

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

{annofabcli-1.104.1.dist-info → annofabcli-1.105.1.dist-info}/RECORD

@@ -2,20 +2,21 @@ annofabcli/__init__.py,sha256=fdBtxy5rOI8zi26jf0hmXS5KTBjQIsm2b9ZUSAIR558,319
 annofabcli/__main__.py,sha256=83jLGTlNGoXaYU3fz9akYXoL3kgfIuaVXo_TkpK72IU,5267
 annofabcli/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 annofabcli/annotation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-annofabcli/annotation/annotation_query.py,sha256=loXcmHhwp0gh_4u5NhvA1x2VAbIT6UJpdIzeFHT5HlY,15566
+annofabcli/annotation/annotation_query.py,sha256=VwfPWpLOpVa2SeEJ264LmCKkBGDJvpX8o7GbWIrDE0o,15712
 annofabcli/annotation/change_annotation_attributes.py,sha256=Zjqax-sb7ujJnTUVv4io0GFmZzfqx0rpN2N1W86uVTs,17092
+annofabcli/annotation/change_annotation_attributes_per_annotation.py,sha256=4OkFOasRpW86akmgZOdKwnt__b-Q6uCwILInxgiy5o8,13878
 annofabcli/annotation/change_annotation_properties.py,sha256=Kp_LZ5sSoVmmjGE80ABVO3InxsXBIxiFFvVcIJNsOMk,18309
 annofabcli/annotation/copy_annotation.py,sha256=Pih2k3vvpgfT3Ovb3gZw2L_8fK_ws_wKR7ARYG5hG_8,18407
-annofabcli/annotation/delete_annotation.py,sha256=Yo73sl96ETMnf6uscJX4h3NU3-cT-OH-rqqXMoLlhbM,23105
+annofabcli/annotation/delete_annotation.py,sha256=hQApNrx2Ci1bBWk0dRGA0oJkIgDHwl6Jy0-33gYF6jo,22989
 annofabcli/annotation/download_annotation_zip.py,sha256=P_ZpdqIaSFEmB8jjpdykcRhh2tVlHxSlXFrYreJjShE,3282
-annofabcli/annotation/dump_annotation.py,sha256=iiTYjbUYEJrgoSfr4oQOepVkba9O4sjvpSKYfuER318,7466
+annofabcli/annotation/dump_annotation.py,sha256=CJ10zJUm9C1M1VhB_ZtdkWPncrZTx9h9JyxmLn7f3lo,8397
 annofabcli/annotation/import_annotation.py,sha256=39w-LwhNrT4-20NR5Hy-cn_cUFVVWVnMp9x1d8aITn0,33369
 annofabcli/annotation/list_annotation.py,sha256=uKcOuGC7lzd6vVbzizkiZtYdXJ7EzY0iifuiqKl2wQM,10707
 annofabcli/annotation/list_annotation_count.py,sha256=T9fbaoxWeDJIVgW_YgHRldbwrVZWiE-57lfJrDQrj80,6474
 annofabcli/annotation/merge_segmentation.py,sha256=kIsCeXtJxzd6nobQPpi0fscaRDlTx3tg1qpy5PDfSJI,18107
 annofabcli/annotation/remove_segmentation_overlap.py,sha256=JeeBY3PUcBqLYiNItEH8Ae9zhEy6cf4LldNr_4yBdjY,15991
-annofabcli/annotation/restore_annotation.py,sha256=_XM1BHIZL-cxwEO6zlqy_wKE3sSS9NJGpU-WzIR2c9k,14616
-annofabcli/annotation/subcommand_annotation.py,sha256=ku9mzb7zZilHcjf1MFV1E7EJ8OvfSUDHpcunM38teto,2122
+annofabcli/annotation/restore_annotation.py,sha256=F0_p1k0Yzx0YVOuLYOS48OWutsN5ysOu3TRa3yhRdTw,17071
+annofabcli/annotation/subcommand_annotation.py,sha256=PfiU4G_Col3quCXKbZpqWoUXGi5p2uB1XI9BKMwaq1I,2288
 annofabcli/annotation_specs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 annofabcli/annotation_specs/add_attribute_restriction.py,sha256=jVA7ltharabR94bf71QuW0x0yVgu6-A7PHn7Dq3kUfg,6825
 annofabcli/annotation_specs/attribute_restriction.py,sha256=tXcCLWVUdmmLWFHLjtSERcgxwFhqk7_zyKZzps0oyso,10123
@@ -37,7 +38,7 @@ annofabcli/comment/delete_comment.py,sha256=NpQVrXrIPI3vjAyOZ-5Mm-Pae_uCHu8BXVEA
 annofabcli/comment/download_comment_json.py,sha256=YfqUnMgvLgVFV7FJPIXwirREkQ2E63fXeCaF4hfwk8c,2338
 annofabcli/comment/list_all_comment.py,sha256=zMZSmVe8P89WDBZE5PZn5SIv5j2OTbnP1kS-HnCxPCI,6483
 annofabcli/comment/list_comment.py,sha256=ikXOtfI9W88w7YC1GQQ1ryq2BatHelIRb8Pa5-fKbSs,6187
-annofabcli/comment/put_comment.py,sha256=aP1VhjwzKLY8zjHOO1ZkHc6ulwpKtAt-10fWpDn3RUo,12000
+annofabcli/comment/put_comment.py,sha256=7q_GQW7nKUqzm9tf7mjhiPHfd0lBFLFvvdyF5Cn9854,12025
 annofabcli/comment/put_comment_simply.py,sha256=OwanjmQy5nqqIw-i0Gt9APdEdftM-EuZW4pRLYbIwQM,8171
 annofabcli/comment/put_inspection_comment.py,sha256=TL8o_K9LCLxqMEVPs9wNK_X4jzEiJwjr327lziQbeAM,3803
 annofabcli/comment/put_inspection_comment_simply.py,sha256=WuySt-BV4oPETBIgLwpCIH-hh8XRetIHPb6Gtnpgs7A,6805
@@ -58,7 +59,7 @@ annofabcli/common/pandas.py,sha256=IW9xqHkdRF1I6YZc7CP_9tkGxJuu1MKEXFILjhaNUU0,4
 annofabcli/common/type_util.py,sha256=i3r5pFtRYQwJrYkl1-lVQi8XOePQxTUX_cAHgBTsagM,224
 annofabcli/common/typing.py,sha256=_AcEogoaMbib0esfN2RvHshAZH0oyRb2Ro9-rbn7NJ8,330
 annofabcli/common/utils.py,sha256=Eb4DS5j_EVdZW_YnsvIgjTbgWcjHd560plck2_WgrCI,9545
-annofabcli/common/visualize.py,sha256=94lPfp6jc9zhCntScuzTv_UvYiokb-l_sCwB9pjW9tA,13612
+annofabcli/common/visualize.py,sha256=mBPCA5vfYNbE3I1m5oHRpo-E1hsNH11KswILtYRCOKQ,13650
 annofabcli/common/annofab/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 annofabcli/common/annofab/annotation_specs.py,sha256=h-YSnuK0riCLoJMmV-KDP3JS-_JMqx0feSvPAB3xCSI,765
 annofabcli/common/annofab/project.py,sha256=BK96o9OO961yfUvcjuHG1DeJ2bMMEYTS5ujtJCvD_4I,891
@@ -205,11 +206,11 @@ annofabcli/task_history/list_task_history.py,sha256=izzY9PzgrgJW0O3ftAoSEfqa9fK5
 annofabcli/task_history/subcommand_task_history.py,sha256=_CvM1ts60GT15iXmsb4CHOyL170ier-q-p9edVuNLvc,1066
 annofabcli/task_history_event/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 annofabcli/task_history_event/download_task_history_event_json.py,sha256=hQLVbQ0HjdiRpXC9tEt_Py3W_b0mo3eVIa-zp0z3fgU,2434
-annofabcli/task_history_event/list_all_task_history_event.py,sha256=mzFqOS1WjC4_QEz6Yyp1ZvU5h-kU_PU82CtnnjQRSlY,6345
-annofabcli/task_history_event/list_worktime.py,sha256=J18uLrQwZuaatkA4dAr83Rz_qAF2xsx2gOFDp6ysimI,12968
+annofabcli/task_history_event/list_all_task_history_event.py,sha256=EeKMyPUxGwYCFtWQHHW954ZserGm8lUqrwNnV1iX9X4,6830
+annofabcli/task_history_event/list_worktime.py,sha256=Y7Pu5DP7scPf7HPt6CTiTvB1_5_Nfi1bStUIaCpkhII,15507
 annofabcli/task_history_event/subcommand_task_history_event.py,sha256=mJVJoT4RXk4HWnY7-Nrsl4If-gtaIIEXd2z7eFZwM2I,1260
-annofabcli-1.104.1.dist-info/METADATA,sha256=sgCezmhchWq4KIhpkiYl40lgFwg0rkPEg4aip9wgPqw,5286
-annofabcli-1.104.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-annofabcli-1.104.1.dist-info/entry_points.txt,sha256=C2uSUc-kkLJpoK_mDL5FEMAdorLEMPfwSf8VBMYnIFM,56
-annofabcli-1.104.1.dist-info/licenses/LICENSE,sha256=pcqWYfxFtxBzhvKp3x9MXNM4xciGb2eFewaRhXUNHlo,1081
-annofabcli-1.104.1.dist-info/RECORD,,
+annofabcli-1.105.1.dist-info/METADATA,sha256=1wpj99TzN1VpD56ObB9viB1goGsbs7qUMSUhQAk3DHY,5286
+annofabcli-1.105.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+annofabcli-1.105.1.dist-info/entry_points.txt,sha256=C2uSUc-kkLJpoK_mDL5FEMAdorLEMPfwSf8VBMYnIFM,56
+annofabcli-1.105.1.dist-info/licenses/LICENSE,sha256=pcqWYfxFtxBzhvKp3x9MXNM4xciGb2eFewaRhXUNHlo,1081
+annofabcli-1.105.1.dist-info/RECORD,,