Source code for annofabapi.pydantic_models.annotation_data_v1

"""


No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.
"""

from __future__ import annotations

import json
import pprint
from typing import Any, Dict, Set, Union

from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
from typing_extensions import Self

from annofabapi.pydantic_models.full_annotation_data import FullAnnotationData

ANNOTATIONDATAV1_ONE_OF_SCHEMAS = ["FullAnnotationData", "str"]


[docs] class AnnotationDataV1(BaseModel): """ アノテーションの座標値や区間などのデータ。 APIのレスポンスから参照される場合は、`FullAnnotationDataString`形式です。 [putAnnotation](#operation/putAnnotation) APIのリクエストボディは、`FullAnnotationDataString`形式または`FullAnnotationData`形式に対応しています。 """ # data type: str oneof_schema_1_validator: StrictStr | None = Field( default=None, description='アノテーション座標値や区間などの文字列表現です。 アノテーション種類(`annotation_type`)とデータ格納形式(`data_holding_type`)に応じて、以下のとおり表現が変わります。 <table> <tr><th>annotation_type</th><th>data_holding_type</th><th>文字列表現</th></tr> <tr><td>bounding_box</td><td>inner</td><td><code>"左上x,左上y,右下x,右下y"</code></td></tr> <tr><td>point</td><td>inner</td><td><code>"x1,y1"</code></td></tr> <tr><td>polygon / polyline</td><td>inner</td><td><code>"x1,y1,x2,y2, ... "</code></td></tr> <tr><td>range </td><td>inner</td><td><code>"開始時間(ミリ秒),終了時間(ミリ秒) "</code></td></tr> <tr><td>classification</td><td>inner</td><td><code>null</code></td></tr> <tr><td>segmentation</td><td>outer</td><td><code>null</code></td></tr> <tr><td>segmentation_v2</td><td>outer</td><td><code>null</code></td></tr> </table> ', ) # data type: FullAnnotationData oneof_schema_2_validator: FullAnnotationData | None = None actual_instance: Union[FullAnnotationData, str] | None = None one_of_schemas: Set[str] = {"FullAnnotationData", "str"} model_config = ConfigDict( validate_assignment=True, protected_namespaces=(), ) def __init__(self, *args, **kwargs) -> None: if args: if len(args) > 1: raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") if kwargs: raise ValueError("If a position argument is used, keyword arguments cannot be used.") super().__init__(actual_instance=args[0]) else: super().__init__(**kwargs)
[docs] @field_validator("actual_instance") def actual_instance_must_validate_oneof(cls, v): instance = AnnotationDataV1.model_construct() error_messages = [] match = 0 # validate data type: str try: instance.oneof_schema_1_validator = v match += 1 except (ValidationError, ValueError) as e: error_messages.append(str(e)) # validate data type: FullAnnotationData if not isinstance(v, FullAnnotationData): error_messages.append(f"Error! Input type `{type(v)}` is not `FullAnnotationData`") else: match += 1 if match > 1: # more than 1 match raise ValueError( "Multiple matches found when setting `actual_instance` in AnnotationDataV1 with oneOf schemas: FullAnnotationData, str. Details: " + ", ".join(error_messages) ) elif match == 0: # no match raise ValueError( "No match found when setting `actual_instance` in AnnotationDataV1 with oneOf schemas: FullAnnotationData, str. Details: " + ", ".join(error_messages) ) else: return v
[docs] @classmethod def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: return cls.from_json(json.dumps(obj))
[docs] @classmethod def from_json(cls, json_str: str) -> Self: """Returns the object represented by the json string""" instance = cls.model_construct() error_messages = [] match = 0 # deserialize data into str try: # validation instance.oneof_schema_1_validator = json.loads(json_str) # assign value to actual_instance instance.actual_instance = instance.oneof_schema_1_validator match += 1 except (ValidationError, ValueError) as e: error_messages.append(str(e)) # deserialize data into FullAnnotationData try: instance.actual_instance = FullAnnotationData.from_json(json_str) match += 1 except (ValidationError, ValueError) as e: error_messages.append(str(e)) if match > 1: # more than 1 match raise ValueError( "Multiple matches found when deserializing the JSON string into AnnotationDataV1 with oneOf schemas: FullAnnotationData, str. Details: " + ", ".join(error_messages) ) elif match == 0: # no match raise ValueError( "No match found when deserializing the JSON string into AnnotationDataV1 with oneOf schemas: FullAnnotationData, str. Details: " + ", ".join(error_messages) ) else: return instance
[docs] def to_json(self) -> str: """Returns the JSON representation of the actual instance""" if self.actual_instance is None: return "null" if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): return self.actual_instance.to_json() else: return json.dumps(self.actual_instance)
[docs] def to_dict(self) -> Union[Dict[str, Any], FullAnnotationData, str] | None: """Returns the dict representation of the actual instance""" if self.actual_instance is None: return None if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): return self.actual_instance.to_dict() else: # primitive type return self.actual_instance
[docs] def to_str(self) -> str: """Returns the string representation of the actual instance""" return pprint.pformat(self.model_dump())