Feature/120 new specs

anno3d/annofab/constant.py

@@ -17,3 +17,9 @@ class IgnoreAdditionalDef:
 
 default_ignore_additional = IgnoreAdditionalDef("__3dpc-editor-default-ignore", "無視", "ignore", True)
 default_non_ignore_additional = IgnoreAdditionalDef("__3dpc-editor-non-default-ignore", "無視", "ignore", False)
+
+# Annofabで定義されている標準三次元エディタプラグインのID（dev / production共通）
+builtin_3d_editor_plugin_id = "bdc16348-107e-4fbc-af4a-e482bc84a60f"
+
+# Annofabで定義されている標準三次元エディタ用拡張仕様プラグインのID（dev / production共通）
+builtin_3d_extended_specs_plugin_id = "703ababa-96ac-4920-8afb-d4f2bddac7e3"

anno3d/annofab/model.py

@@ -1,12 +1,13 @@
+import typing
 from dataclasses import dataclass, field
 from typing import Dict, List, Optional, Tuple, Union
 
 from annofabapi.dataclass.annotation_specs import (
     AdditionalDataDefinitionV2,
     AdditionalDataRestriction,
-    AnnotationSpecsV2,
+    AnnotationSpecsV3,
     InspectionPhrase,
-    LabelV2,
+    LabelV3,
 )
 from annofabapi.dataclass.job import ProjectJobInfo
 from annofabapi.dataclass.project import Project
@@ -18,12 +19,14 @@
 @dataclass
 class Label(DataClassJsonMixin):
     label_id: str
+    annotation_type: str
     ja_name: str
     en_name: str
     color: Tuple[int, int, int] = field(
         # `Label.schema()`を実行するとエラーが発生するため、mm_fieldをした。https://github.com/lidatong/dataclasses-json/issues/318
         metadata=config(mm_field=fields.Tuple((fields.Integer(), fields.Integer(), fields.Integer())))
     )
+    field_values: Dict[str, typing.Any]
     metadata: Dict[str, str]
 
 
@@ -73,47 +76,149 @@ class CuboidAnnotationDetailData(DataClassJsonMixin):
     version: str = "2"
 
 
+class UnknownDataField(fields.Field):
+    """
+    FullAnnotationDataUnknownのdataのserialize / deserialize定義
+    FullAnnotationDataUnknownのdataは文字列型で、3d-editorのCuboidの場合、json形式文字列を埋めないといけないが、str型だと不便。
+    なので、dump / load時に文字列との相互変換をするような定義をしておく
+    """
+
+    _type: typing.Any
+
+    def __init__(self, cls: typing.Type, **additional_metadata) -> None:
+        """
+
+        Args:
+            cls: 実際の型
+            **additional_metadata:
+        """
+
+        super().__init__(**additional_metadata)
+        self._type = cls
+
+    def encode(self, value: typing.Any) -> str:
+        return typing.cast(str, value.to_json(ensure_ascii=False))
+
+    def _serialize(self, value: typing.Any, attr: Union[str, None], obj: typing.Any, **kwargs) -> str:
+        return self.encode(value)
+
+    def decode(self, value: str) -> typing.Any:
+        return self._type.from_json(value)
+
+    def _deserialize(
+        self, value: str, attr: Union[str, None], data: Union[typing.Mapping[str, typing.Any], None], **kwargs
+    ) -> typing.Any:
+        return self.decode(value)
+
+
+cuboid_data_field = UnknownDataField(CuboidAnnotationDetailData)
+
+
+@dataclass
+class CuboidFullAnnotationData(DataClassJsonMixin):
+    data: CuboidAnnotationDetailData = field(
+        metadata=config(mm_field=cuboid_data_field, encoder=cuboid_data_field.encode, decoder=cuboid_data_field.decode)
+    )
+    _type: str = "Unknown"
+
+
+@dataclass
+class CuboidAnnotationDetailBody(DataClassJsonMixin):
+    """Cuboid用 AnnotationDetailContentInputInner"""
+
+    data: CuboidFullAnnotationData
+    _type: str = "Inner"
+
+    @classmethod
+    def from_detail_data(cls, data: CuboidAnnotationDetailData) -> "CuboidAnnotationDetailBody":
+        return CuboidAnnotationDetailBody(data=CuboidFullAnnotationData(data=data))
+
+    @classmethod
+    def from_shape(cls, shape: CuboidShape) -> "CuboidAnnotationDetailBody":
+        return cls.from_detail_data(CuboidAnnotationDetailData(shape))
+
+
+@dataclass
+class AnnotationPropsForEditor:
+    can_delete: bool
+
+
 @dataclass
-class CuboidAnnotationDetail(DataClassJsonMixin):
+class CuboidAnnotationDetailCreate(DataClassJsonMixin):
+    """Cuboid用AnnotationDetailV2Createに対応する型"""
+
     annotation_id: str
-    account_id: str
     label_id: str
-    is_protected: bool
-    data: CuboidAnnotationDetailData
-    data_holding_type: str = "inner"
+    body: CuboidAnnotationDetailBody
+    editor_props: AnnotationPropsForEditor
+    additional_data_list: list = field(default_factory=list)  # 型を定義してないので空を前提としておく
+    _type: str = "Create"
 
 
 @dataclass
 class CuboidAnnotations(DataClassJsonMixin):
+    """CLIからCuboidAnnotationを生成する場合に利用する AnnotationV2Input"""
+
     project_id: str
     task_id: str
     input_data_id: str
-    details: List[CuboidAnnotationDetail]
+    details: List[CuboidAnnotationDetailCreate]
+    format_version: str = "2.0.0"
+
+
+@dataclass
+class OneIntegerFieldValue(DataClassJsonMixin):
+    """
+    LabelV3.field_valuesに格納される値の種別の一つ
+    整数値を一つだけ保持するValue
+    """
+
+    value: int
+    _type: str = "OneIntegerFieldValue"
+
+
+@dataclass
+class CuboidFieldValues(DataClassJsonMixin):
+    """Cuboid用LabelV3のfield_values値 常に空"""
+
+
+@dataclass
+class SegmentFieldValues(DataClassJsonMixin):
+    """Segment用LabelV3のfield_values値"""
+
+    layer: OneIntegerFieldValue
+    """セグメントがどのレイヤーに所属するかを表す値。 0以上の整数値"""
+
+    @staticmethod
+    def from_values(layer: int) -> "SegmentFieldValues":
+        return SegmentFieldValues(OneIntegerFieldValue(layer))
 
 
 @dataclass
-class AnnotationSpecsRequestV2(DataClassJsonMixin):
-    labels: List[LabelV2]
+class AnnotationSpecsRequestV3(DataClassJsonMixin):
+    labels: List[LabelV3]
     additionals: List[AdditionalDataDefinitionV2]
     restrictions: List[AdditionalDataRestriction]
     inspection_phrases: List[InspectionPhrase]
     comment: str
     auto_marking: bool
+    annotation_type_version: Optional[str]
     format_version: str
     last_updated_datetime: Optional[str]
     option: Union[AnnotationSpecsMovieOption, None]
     metadata: Optional[Dict[str, str]]
 
     @staticmethod
-    def from_specs(specs: AnnotationSpecsV2) -> "AnnotationSpecsRequestV2":
-        return AnnotationSpecsRequestV2(
+    def from_specs(specs: AnnotationSpecsV3) -> "AnnotationSpecsRequestV3":
+        return AnnotationSpecsRequestV3(
             labels=specs.labels if specs.labels is not None else [],
             additionals=specs.additionals if specs.additionals is not None else [],
             restrictions=specs.restrictions if specs.restrictions is not None else [],
             inspection_phrases=specs.inspection_phrases if specs.inspection_phrases is not None else [],
             comment="",
             auto_marking=False,
-            format_version=specs.format_version if specs.format_version is not None else "2.1.0",
+            annotation_type_version=specs.annotation_type_version,
+            format_version=specs.format_version if specs.format_version is not None else "3.0.0",
             last_updated_datetime=specs.updated_datetime,
             option=specs.option,
             metadata=specs.metadata,