annofabcli 1.114.4__tar.gz → 1.114.6__tar.gz

{annofabcli-1.114.4 → annofabcli-1.114.6}/PKG-INFO

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

{annofabcli-1.114.4 → annofabcli-1.114.6}/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
 

{annofabcli-1.114.4 → annofabcli-1.114.6}/annofabcli/comment/put_comment.py

@@ -9,6 +9,7 @@ from typing import Any
 import annofabapi
 import requests
 from annofabapi.models import CommentType, TaskPhase, TaskStatus
+from annofabapi.pydantic_models.input_data_type import InputDataType
 from dataclasses_json import DataClassJsonMixin
 
 from annofabcli.comment.utils import get_comment_type_name
@@ -18,6 +19,18 @@ from annofabcli.common.type_util import assert_noreturn
 
 logger = logging.getLogger(__name__)
 
+SUPPORTED_ANNOTATION_TYPES_FOR_INSPECTION_DATA = frozenset(
+    [
+        "user_bounding_box",
+        "bounding_box",
+        "polygon",
+        "polyline",
+        "point",
+        "range",
+    ]
+)
+"""検査コメントの座標情報（InspectionData形式）への変換をサポートしているアノテーションタイプ"""
+
 
 @dataclass
 class AddedComment(DataClassJsonMixin):
@@ -28,15 +41,18 @@ class AddedComment(DataClassJsonMixin):
     comment: str
     """コメントの中身"""
 
-    data: dict[str, Any] | None
+    data: dict[str, Any] | None = None
     """コメントを付与する位置や区間"""
 
-    annotation_id: str | None
+    annotation_id: str | None = None
     """コメントに紐付けるアノテーションID"""
 
-    phrases: list[str] | None
+    phrases: list[str] | None = None
     """参照している定型指摘ID"""
 
+    comment_id: str | None = None
+    """コメントID。省略時はUUIDv4が自動生成される。"""
+
 
 AddedCommentsForTask = dict[str, list[AddedComment]]
 """
@@ -51,6 +67,71 @@ keyはtask_id
 """
 
 
+def convert_annotation_body_to_inspection_data(  # noqa: PLR0911
+    annotation_body: dict[str, Any],
+    annotation_type: str,
+    input_data_type: InputDataType,
+) -> dict[str, Any]:
+    """
+    アノテーションのbody部分を、検査コメントの座標情報（`InspectionData`形式）に変換する。
+
+    Args:
+        annotation_body: Annotationの座標情報。AnnotationDetailContentOutputのdict形式
+        annotation_type: アノテーションタイプ。`SUPPORTED_ANNOTATION_TYPES_FOR_INSPECTION_DATA`のいずれかを指定すること。
+        input_data_type: プロジェクトの入力データタイプ。
+
+    Returns:
+        検査コメントの座標情報（`InspectionData`形式）
+    """
+    match input_data_type:
+        case InputDataType.MOVIE:
+            match annotation_type:
+                case "range":
+                    # 区間の開始位置をTime形式に変換
+                    return {"start": annotation_body["data"]["begin"], "end": annotation_body["data"]["end"], "_type": "Time"}
+                case _:
+                    # "Classification"など、Time形式以外のアノテーションタイプ
+                    return {"start": 0, "end": 100, "_type": "Time"}
+
+        case InputDataType.CUSTOM:
+            match annotation_type:
+                case "user_bounding_box":
+                    # 3次元バウンディングボックスの場合、data.dataの文字列をパースして返す
+                    return {"data": annotation_body["data"]["data"], "_type": "Custom"}
+                case _:
+                    # セグメントなど
+                    return {
+                        "data": '{"kind": "CUBOID", "shape": {"dimensions": {"width": 1.0, "height": 1.0, "depth": 1.0}, "location": {"x": 0.0, "y": 0.0, "z": 0.0}, "rotation": {"x": 0.0, "y": 0.0, "z": 0.0}, "direction": {"front": {"x": 1.0, "y": 0.0, "z": 0.0}, "up": {"x": 0.0, "y": 0.0, "z": 1.0}}}, "version": "2"}',  # noqa: E501
+                        "_type": "Custom",
+                    }
+
+        case InputDataType.IMAGE:
+            match annotation_type:
+                case "bounding_box":
+                    # 中心点を計算
+                    left_top = annotation_body["data"]["left_top"]
+                    right_bottom = annotation_body["data"]["right_bottom"]
+                    center_x = (left_top["x"] + right_bottom["x"]) / 2
+                    center_y = (left_top["y"] + right_bottom["y"]) / 2
+                    return {"x": center_x, "y": center_y, "_type": "Point"}
+                case "polygon" | "polyline":
+                    # 先頭の点を取得
+                    points = annotation_body["data"]["points"]
+                    assert len(points) > 0
+                    first_point = points[0]
+                    return {"x": first_point["x"], "y": first_point["y"], "_type": "Point"}
+                case "point":
+                    # 点の形式に変換（pointキーから取り出す）
+                    point = annotation_body["data"]["point"]
+                    return {"x": point["x"], "y": point["y"], "_type": "Point"}
+                case "range":
+                    # 区間の開始位置をTime形式に変換
+                    return {"start": annotation_body["data"]["begin"], "end": annotation_body["data"]["end"], "_type": "Time"}
+                case _:
+                    # 塗りつぶしや分類など
+                    return {"x": 0, "y": 0, "_type": "Point"}
+
+
 class PutCommentMain(CommandLineWithConfirm):
     def __init__(self, service: annofabapi.Resource, project_id: str, comment_type: CommentType, all_yes: bool = False) -> None:  # noqa: FBT001, FBT002
         self.service = service
@@ -60,30 +141,68 @@ class PutCommentMain(CommandLineWithConfirm):
         self.comment_type = comment_type
         self.comment_type_name = get_comment_type_name(comment_type)
 
+        # プロジェクト情報を取得
+        project, _ = self.service.api.get_project(self.project_id)
+        self.input_data_type = InputDataType(project["input_data_type"])
+
+        # アノテーション仕様を取得
+        annotation_specs, _ = self.service.api.get_annotation_specs(self.project_id, query_params={"v": "3"})
+        self.dict_label_id_annotation_type = {label["label_id"]: label["annotation_type"] for label in annotation_specs["labels"]}
+
         CommandLineWithConfirm.__init__(self, all_yes)
 
     def _create_request_body(self, task: dict[str, Any], input_data_id: str, comments: list[AddedComment]) -> list[dict[str, Any]]:
         """batch_update_comments に渡すリクエストボディを作成する。"""
+        task_id = task["task_id"]
+
+        # annotation_idが指定されているがdataがNoneのコメントがあるか確認
+        need_annotation_data = any(c.annotation_id is not None and c.data is None for c in comments)
+
+        dict_annotation_id_label_id: dict[str, str] = {}
+        dict_annotation_id_data: dict[str, dict[str, Any]] = {}
 
-        def _create_dict_annotation_id() -> dict[str, str]:
-            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}
+        if need_annotation_data:
+            # アノテーション詳細を取得
+            editor_annotation, _ = self.service.api.get_editor_annotation(self.project_id, task_id, input_data_id, query_params={"v": "2"})
+            details = editor_annotation["details"]
 
-        dict_annotation_id_label_id = _create_dict_annotation_id()
+            for detail in details:
+                annotation_id = detail["annotation_id"]
+                label_id = detail["label_id"]
+                dict_annotation_id_label_id[annotation_id] = label_id
+
+                # annotation_typeを取得
+                if label_id in self.dict_label_id_annotation_type:
+                    # アノテーション仕様に存在しないラベルを使っているアノテーション（アノテーションを作成してから仕様を変更した場合）もあるので、判定する
+                    annotation_type = self.dict_label_id_annotation_type[label_id]
+                    dict_annotation_id_data[annotation_id] = convert_annotation_body_to_inspection_data(detail["body"], annotation_type, input_data_type=self.input_data_type)
+        else:
+            # annotation_idからlabel_idを取得するためだけにAPIを呼ぶ
+            editor_annotation, _ = self.service.api.get_editor_annotation(self.project_id, task_id, input_data_id, query_params={"v": "2"})
+            details = editor_annotation["details"]
+            dict_annotation_id_label_id = {e["annotation_id"]: e["label_id"] for e in details}
 
-        def _convert(comment: AddedComment) -> dict[str, Any]:
+        def _convert(comment: AddedComment) -> dict[str, Any] | None:
+            data = comment.data
+            annotation_id = comment.annotation_id
+
+            # dataがNoneでannotation_idが指定されている場合、dataを補完
+            if data is None:
+                assert annotation_id is not None
+                data = dict_annotation_id_data[annotation_id]
+
+            assert data is not None
             return {
-                "comment_id": str(uuid.uuid4()),
+                "comment_id": comment.comment_id if comment.comment_id is not None else str(uuid.uuid4()),
                 "phase": task["phase"],
                 "phase_stage": task["phase_stage"],
                 "account_id": self.service.api.account_id,
                 "comment_type": self.comment_type.value,
                 "comment": comment.comment,
                 "comment_node": {
-                    "data": comment.data,
-                    "annotation_id": comment.annotation_id,
-                    "label_id": dict_annotation_id_label_id.get(comment.annotation_id) if comment.annotation_id is not None else None,
+                    "data": data,
+                    "annotation_id": annotation_id,
+                    "label_id": dict_annotation_id_label_id.get(annotation_id) if annotation_id is not None else None,
                     "status": "open",
                     "_type": "Root",
                 },
@@ -91,7 +210,8 @@ class PutCommentMain(CommandLineWithConfirm):
                 "_type": "Put",
             }
 
-        return [_convert(e) for e in comments]
+        converted_comments = [_convert(e) for e in comments]
+        return [c for c in converted_comments if c is not None]
 
     def change_to_working_status(self, project_id: str, task: dict[str, Any]) -> dict[str, Any]:
         """
@@ -129,8 +249,8 @@ class PutCommentMain(CommandLineWithConfirm):
                 logger.warning(f"task_id='{task_id}' :: フェーズが検査/受入でないため検査コメントを付与できません。 :: task_phase='{task['phase']}'")
                 return False
 
-        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
 
@@ -248,7 +368,7 @@ def convert_cli_comments(dict_comments: dict[str, Any], *, comment_type: Comment
         comment: str
         """コメントの中身"""
 
-        data: dict[str, Any]
+        data: dict[str, Any] | None = None
         """コメントを付与する位置や区間"""
 
         annotation_id: str | None = None
@@ -257,6 +377,9 @@ def convert_cli_comments(dict_comments: dict[str, Any], *, comment_type: Comment
         phrases: list[str] | None = None
         """参照している定型指摘ID"""
 
+        comment_id: str | None = None
+        """コメントID。省略時はUUIDv4が自動生成される。"""
+
     @dataclass
     class AddedOnholdComment(DataClassJsonMixin):
         """
@@ -269,13 +392,16 @@ def convert_cli_comments(dict_comments: dict[str, Any], *, comment_type: Comment
         annotation_id: str | None = None
         """コメントに紐付けるアノテーションID"""
 
+        comment_id: str | None = None
+        """コメントID。省略時はUUIDv4が自動生成される。"""
+
     def convert_inspection_comment(comment: dict[str, Any]) -> AddedComment:
         tmp = AddedInspectionComment.from_dict(comment)
-        return AddedComment(comment=tmp.comment, data=tmp.data, annotation_id=tmp.annotation_id, phrases=tmp.phrases)
+        return AddedComment(comment=tmp.comment, data=tmp.data, annotation_id=tmp.annotation_id, phrases=tmp.phrases, comment_id=tmp.comment_id)
 
     def convert_onhold_comment(comment: dict[str, Any]) -> AddedComment:
         tmp = AddedOnholdComment.from_dict(comment)
-        return AddedComment(comment=tmp.comment, annotation_id=tmp.annotation_id, data=None, phrases=None)
+        return AddedComment(comment=tmp.comment, annotation_id=tmp.annotation_id, data=None, phrases=None, comment_id=tmp.comment_id)
 
     if comment_type == CommentType.INSPECTION:
         func_convert = convert_inspection_comment

{annofabcli-1.114.4 → annofabcli-1.114.6}/annofabcli/comment/put_comment_simply.py

@@ -31,6 +31,9 @@ class AddedSimpleComment:
     phrases: list[str] | None = None
     """参照している定型指摘ID"""
 
+    comment_id: str | None = None
+    """コメントID。省略時はUUIDv4が自動生成される。"""
+
 
 class PutCommentSimplyMain(CommandLineWithConfirm):
     def __init__(self, service: annofabapi.Resource, project_id: str, comment_type: CommentType, all_yes: bool = False) -> None:  # noqa: FBT001, FBT002
@@ -49,7 +52,7 @@ class PutCommentSimplyMain(CommandLineWithConfirm):
         def _convert(comment: AddedSimpleComment) -> dict[str, Any]:
             return {
                 "comment": comment.comment,
-                "comment_id": str(uuid.uuid4()),
+                "comment_id": comment.comment_id if comment.comment_id is not None else str(uuid.uuid4()),
                 "phase": task["phase"],
                 "phase_stage": task["phase_stage"],
                 "comment_type": self.comment_type.value,
@@ -90,11 +93,11 @@ class PutCommentSimplyMain(CommandLineWithConfirm):
 
         if self.comment_type == CommentType.INSPECTION:  # noqa: SIM102
             if task["phase"] == TaskPhase.ANNOTATION.value:
-                logger.warning(f"task_id='{task_id}': 教師付フェーズなので、検査コメントを付与できません。")
+                logger.warning(f"task_id='{task_id}' :: フェーズが検査/受入でないため検査コメントを付与できません。 :: task_phase='{task['phase']}'")
                 return False
 
-        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
 

{annofabcli-1.114.4 → annofabcli-1.114.6}/annofabcli/comment/put_inspection_comment.py

@@ -68,7 +68,11 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
     parser.add_argument(
         "--json",
         type=str,
-        help=(f"付与する検査コメントの内容をJSON形式で指定してください。``file://`` を先頭に付けると、JSON形式のファイルを指定できます。\n\n(ex)  ``{json.dumps(SAMPLE_JSON, ensure_ascii=False)}``"),
+        help=(
+            f"付与する検査コメントの内容をJSON形式で指定してください。``file://`` を先頭に付けると、JSON形式のファイルを指定できます。\n\n"
+            f"各コメントには ``comment_id`` を指定することができます。省略した場合は自動的にUUIDv4が生成されます。\n\n"
+            f"(ex)  ``{json.dumps(SAMPLE_JSON, ensure_ascii=False)}``"
+        ),
     )
 
     parser.add_argument(

{annofabcli-1.114.4 → annofabcli-1.114.6}/annofabcli/comment/put_onhold_comment.py

@@ -69,7 +69,11 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
     parser.add_argument(
         "--json",
         type=str,
-        help=(f"付与する保留コメントの情報をJSON形式で指定してください。``file://`` を先頭に付けると、JSON形式のファイルを指定できます。\n\n(ex)  ``{json.dumps(SAMPLE_JSON, ensure_ascii=False)}``"),
+        help=(
+            f"付与する保留コメントの情報をJSON形式で指定してください。``file://`` を先頭に付けると、JSON形式のファイルを指定できます。\n\n"
+            f"各コメントには ``comment_id`` を指定することができます。省略した場合は自動的にUUIDv4が生成されます。\n\n"
+            f"(ex)  ``{json.dumps(SAMPLE_JSON, ensure_ascii=False)}``"
+        ),
     )
 
     parser.add_argument(

{annofabcli-1.114.4 → annofabcli-1.114.6}/annofabcli/input_data/list_all_input_data_merged_task.py

@@ -38,9 +38,9 @@ def _create_dict_tasks_by_input_data_id(task_list: list[dict[str, Any]]) -> dict
         for input_data_index, input_data_id in enumerate(task["input_data_id_list"]):
             new_task = {
                 "task_id": task["task_id"],
-                "task_status": task["status"],
                 "task_phase": task["phase"],
                 "task_phase_stage": task["phase_stage"],
+                "task_status": task["status"],
                 "frame_no": input_data_index + 1,
             }
             result[input_data_id].append(new_task)
@@ -70,7 +70,7 @@ def create_df_input_data_with_merged_task(input_data_list: list[dict[str, Any]])
     """
 
     def get_columns(columns: pandas.Index) -> list[str]:
-        task_columns = ["task_id", "task_status", "task_phase", "task_phase_stage", "frame_no"]
+        task_columns = ["task_id", "task_phase", "task_phase_stage", "task_status", "frame_no"]
         new_columns = columns.drop(task_columns)
         return list(new_columns) + task_columns
 
@@ -93,7 +93,7 @@ def create_df_input_data_with_merged_task(input_data_list: list[dict[str, Any]])
     # ネストしたオブジェクトを`system_metadata.input_duration`のような列名でアクセスできるようにするため
     df_input_data = pandas.json_normalize(new_input_data_list)
 
-    for column in ["task_id", "task_status", "task_phase", "task_phase_stage", "frame_no"]:
+    for column in ["task_id", "task_phase", "task_phase_stage", "task_status", "frame_no"]:
         if column not in df_input_data.columns:
             df_input_data[column] = pandas.NA