Merge pull request #97 from kurusugawa-computer/feature/annofab-v0.68.0

Feature/annofab v0.68.0

Author: yuji38kwmt

Pipfile.lock

@@ -1 +1 @@
-__version__ = '0.22.0'
+__version__ = '0.23.0'

annofabapi/__version__.py

@@ -33,6 +33,8 @@ class Point:
 
     y: int
     """"""
+
+
 @dataclass_json
 @dataclass
 class AdditionalData:
@@ -53,6 +55,8 @@ class AdditionalData:
 
     choice: Optional[str]
     """"""
+
+
 @dataclass_json
 @dataclass
 class FullAnnotationAdditionalData:
@@ -70,6 +74,8 @@ class FullAnnotationAdditionalData:
 
     value: Optional[AdditionalDataValue]
     """"""
+
+
 @dataclass_json
 @dataclass
 class FullAnnotationDetail:
@@ -99,6 +105,8 @@ class FullAnnotationDetail:
 
     additional_data_list: Optional[List[FullAnnotationAdditionalData]]
     """"""
+
+
 @dataclass_json
 @dataclass
 class FullAnnotationDetailOld:
@@ -128,6 +136,8 @@ class FullAnnotationDetailOld:
 
     additional_data_list: Optional[List[AdditionalData]]
     """"""
+
+
 @dataclass_json
 @dataclass
 class FullAnnotation:
@@ -166,74 +176,80 @@ class FullAnnotation:
 
     annotation_format_version: Optional[str]
     """アノテーションフォーマットのバージョンです。 アノテーションフォーマットとは、プロジェクト個別のアノテーション仕様ではなく、AnnoFabのアノテーション構造のことです。 したがって、アノテーション仕様を更新しても、このバージョンは変化しません。  バージョンの読み方と更新ルールは、業界慣習の[Semantic Versioning](https://semver.org/)にもとづきます。  JSONに出力されるアノテーションフォーマットのバージョンは、アノテーションZIPが作成される時点のものが使われます。 すなわち、`1.0.0`の時点のタスクで作成したアノテーションであっても、フォーマットが `1.0.1` に上がった次のZIP作成時では `1.0.1` となります。 バージョンを固定してZIPを残しておきたい場合は、プロジェクトが完了した時点でZIPをダウンロードして保管しておくか、またはプロジェクトを「停止中」にします。 """
+
+
 @dataclass_json
 @dataclass
 class SimpleAnnotationDetail:
     """
     
     """
-    label: Optional[str]
+    label: str
     """アノテーション仕様のラベル名です。 """
 
-    annotation_id: Optional[str]
+    annotation_id: str
     """個々のアノテーションにつけられたIDです。 """
 
-    data: Optional[FullAnnotationData]
+    data: FullAnnotationData
     """"""
 
-    attributes: Optional[Dict[str, Any]]
+    attributes: Dict[str, Any]
     """キーに属性の名前、値に各属性の値が入った辞書構造です。 """
+
+
 @dataclass_json
 @dataclass
 class SimpleAnnotation:
     """
     
     """
-    annotation_format_version: Optional[str]
+    annotation_format_version: str
     """アノテーションフォーマットのバージョンです。 アノテーションフォーマットとは、プロジェクト個別のアノテーション仕様ではなく、AnnoFabのアノテーション構造のことです。 したがって、アノテーション仕様を更新しても、このバージョンは変化しません。  バージョンの読み方と更新ルールは、業界慣習の[Semantic Versioning](https://semver.org/)にもとづきます。  JSONに出力されるアノテーションフォーマットのバージョンは、アノテーションZIPが作成される時点のものが使われます。 すなわち、`1.0.0`の時点のタスクで作成したアノテーションであっても、フォーマットが `1.0.1` に上がった次のZIP作成時では `1.0.1` となります。 バージョンを固定してZIPを残しておきたい場合は、プロジェクトが完了した時点でZIPをダウンロードして保管しておくか、またはプロジェクトを「停止中」にします。 """
 
-    project_id: Optional[str]
+    project_id: str
     """プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
 
-    task_id: Optional[str]
+    task_id: str
     """タスクID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
 
-    task_phase: Optional[TaskPhase]
+    task_phase: TaskPhase
     """"""
 
-    task_phase_stage: Optional[int]
+    task_phase_stage: int
     """"""
 
-    task_status: Optional[TaskStatus]
+    task_status: TaskStatus
     """"""
 
-    input_data_id: Optional[str]
+    input_data_id: str
     """入力データID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
 
-    input_data_name: Optional[str]
+    input_data_name: str
     """"""
 
-    details: Optional[List[SimpleAnnotationDetail]]
+    details: List[SimpleAnnotationDetail]
     """"""
 
-    updated_datetime: Optional[str]
+    updated_datetime: str
     """"""
+
+
 @dataclass_json
 @dataclass
 class SingleAnnotationDetail:
     """
     
     """
-    annotation_id: Optional[str]
+    annotation_id: str
     """アノテーションID。[値の制約についてはこちら。](#section/API-Convention/APIID)<br> annotation_type が classification の場合は label_id と同じ値が格納されます。 """
 
-    account_id: Optional[str]
+    account_id: str
     """"""
 
-    label_id: Optional[str]
+    label_id: str
     """"""
 
-    data_holding_type: Optional[AnnotationDataHoldingType]
+    data_holding_type: AnnotationDataHoldingType
     """"""
 
     data: Optional[FullAnnotationData]
@@ -245,31 +261,33 @@ class SingleAnnotationDetail:
     url: Optional[str]
     """data_holding_typeがouterの場合のみ存在し、データへの一時URLが格納される"""
 
-    additional_data_list: Optional[List[AdditionalData]]
+    additional_data_list: List[AdditionalData]
     """"""
 
-    created_datetime: Optional[str]
+    created_datetime: str
     """"""
 
-    updated_datetime: Optional[str]
+    updated_datetime: str
     """"""
+
+
 @dataclass_json
 @dataclass
 class SingleAnnotation:
     """
     
     """
-    project_id: Optional[str]
+    project_id: str
     """プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
 
-    task_id: Optional[str]
+    task_id: str
     """タスクID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
 
-    input_data_id: Optional[str]
+    input_data_id: str
     """入力データID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
 
-    detail: Optional[SingleAnnotationDetail]
+    detail: SingleAnnotationDetail
     """"""
 
-    updated_datetime: Optional[str]
+    updated_datetime: str
     """"""

annofabapi/dataclass/annotation.py

@@ -16,6 +16,8 @@
 
 from annofabapi.models import AdditionalDataDefinitionType, AnnotationType
 
+OneOfbooleanintegerstring = Union[bool, int, str]
+
 
 @dataclass_json
 @dataclass
@@ -34,6 +36,8 @@ class Keybind:
 
     alt: Optional[bool]
     """"""
+
+
 @dataclass_json
 @dataclass
 class LabelBoundingBoxMetadata:
@@ -60,6 +64,8 @@ class LabelBoundingBoxMetadata:
 
     tolerance: Optional[int]
     """"""
+
+
 @dataclass_json
 @dataclass
 class LabelSegmentationMetadata:
@@ -77,6 +83,8 @@ class LabelSegmentationMetadata:
 
     tolerance: Optional[int]
     """"""
+
+
 @dataclass_json
 @dataclass
 class InternationalizationMessageMessages:
@@ -88,6 +96,8 @@ class InternationalizationMessageMessages:
 
     message: Optional[str]
     """"""
+
+
 @dataclass_json
 @dataclass
 class InternationalizationMessage:
@@ -99,6 +109,8 @@ class InternationalizationMessage:
 
     default_lang: Optional[str]
     """"""
+
+
 @dataclass_json
 @dataclass
 class InspectionPhrase:
@@ -110,6 +122,8 @@ class InspectionPhrase:
 
     text: Optional[InternationalizationMessage]
     """"""
+
+
 @dataclass_json
 @dataclass
 class AnnotationSpecsHistory:
@@ -133,6 +147,8 @@ class AnnotationSpecsHistory:
 
     comment: Optional[str]
     """"""
+
+
 @dataclass_json
 @dataclass
 class Color:
@@ -147,6 +163,8 @@ class Color:
 
     blue: Optional[int]
     """"""
+
+
 @dataclass_json
 @dataclass
 class AdditionalDataDefinitionChoices:
@@ -161,6 +179,8 @@ class AdditionalDataDefinitionChoices:
 
     keybind: Optional[List[Keybind]]
     """"""
+
+
 @dataclass_json
 @dataclass
 class AdditionalDataDefinition:
@@ -176,6 +196,9 @@ class AdditionalDataDefinition:
     name: Optional[InternationalizationMessage]
     """"""
 
+    default: Optional[OneOfbooleanintegerstring]
+    """属性の初期値です。  初期値を指定する場合、属性の種類に応じて次の値を指定します。初期値を設定しない場合には空文字を指定します。  * type が flag の場合: 真偽値(`true` or `false`) * type が integer の場合: 整数値 * type が text の場合: 文字列 * type が comment の場合: 文字列 * type が choice の場合: 選択肢(`choices`)の `choice_id` * type が select の場合: 選択肢(`choices`)の `choice_id`  属性の種類に対して有効でない初期値を設定した場合、その設定は無視されます。  なお、トラッキングとリンクには初期値を設定できません。 """
+
     keybind: Optional[List[Keybind]]
     """"""
 
@@ -193,6 +216,8 @@ class AdditionalDataDefinition:
 
     required: Optional[bool]
     """リンク属性において、入力を必須とするかどうか"""
+
+
 @dataclass_json
 @dataclass
 class AnnotationEditorFeature:
@@ -216,6 +241,8 @@ class AnnotationEditorFeature:
 
     fill_near: Optional[bool]
     """"""
+
+
 @dataclass_json
 @dataclass
 class Label:
@@ -251,6 +278,8 @@ class Label:
 
     allow_out_of_image_bounds: Optional[bool]
     """"""
+
+
 @dataclass_json
 @dataclass
 class AnnotationSpecs:

annofabapi/dataclass/annotation_specs.py

@@ -26,6 +26,8 @@ class Resolution:
 
     height: float
     """"""
+
+
 @dataclass_json
 @dataclass
 class InputData:

annofabapi/dataclass/input.py

@@ -26,6 +26,8 @@ class Instruction:
 
     last_updated_datetime: Optional[str]
     """* `GetInstruction` の場合: 最後に作業ガイドを更新した日時。 * `PutInstruction` の場合: 最後に作業ガイドを更新した日時を指定する。まだ一度も保存した事がない場合は指定しない。 """
+
+
 @dataclass_json
 @dataclass
 class InstructionHistory:
@@ -40,6 +42,8 @@ class InstructionHistory:
 
     updated_datetime: Optional[str]
     """"""
+
+
 @dataclass_json
 @dataclass
 class InstructionImage:

annofabapi/dataclass/instruction.py

@@ -50,6 +50,8 @@ class MyOrganization:
 
     my_status: Optional[OrganizationMemberStatus]
     """"""
+
+
 @dataclass_json
 @dataclass
 class MyAccount:

annofabapi/dataclass/my.py

@@ -31,6 +31,8 @@ class OrganizationActivity:
 
     storage_usage_bytes: float
     """"""
+
+
 @dataclass_json
 @dataclass
 class OrganizationSummary:
@@ -39,6 +41,8 @@ class OrganizationSummary:
     """
     last_tasks_updated_datetime: Optional[str]
     """"""
+
+
 @dataclass_json
 @dataclass
 class Organization:

annofabapi/dataclass/organization.py

@@ -25,6 +25,8 @@ class ProjectSummary:
     """
     last_tasks_updated_datetime: Optional[str]
     """"""
+
+
 @dataclass_json
 @dataclass
 class ProjectConfiguration:
@@ -57,6 +59,8 @@ class ProjectConfiguration:
 
     private_storage_aws_iam_role_arn: Optional[str]
     """AWS IAMロール。ビジネスプランでのS3プライベートストレージの認可で使います。 [S3プライベートストレージの認可の設定についてはこちら](/docs/faq/#m0b240)をご覧ください。 """
+
+
 @dataclass_json
 @dataclass
 class Project: