Source code for annofabapi.pydantic_models.single_annotation_detail_v2

"""


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
import re  # noqa: F401
from typing import Any, ClassVar, Dict, List, Set

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

from annofabapi.pydantic_models.additional_data_v2 import AdditionalDataV2
from annofabapi.pydantic_models.annotation_detail_content_output import AnnotationDetailContentOutput


[docs] class SingleAnnotationDetailV2(BaseModel): """ アノテーション情報 """ annotation_id: StrictStr = Field( description="アノテーションID。[値の制約についてはこちら。](#section/API-Convention/APIID) `annotation_type`が`classification`の場合は label_id と同じ値が格納されます。 " ) account_id: StrictStr = Field(description="アカウントID。[値の制約についてはこちら。](#section/API-Convention/APIID) ") label_id: StrictStr = Field(description="ラベルID。[値の制約についてはこちら。](#section/API-Convention/APIID) ") body: AnnotationDetailContentOutput additional_data_list: List[AdditionalDataV2] created_datetime: str = Field(description="作成日時") updated_datetime: str = Field(description="更新日時") __properties: ClassVar[List[str]] = [ "annotation_id", "account_id", "label_id", "body", "additional_data_list", "created_datetime", "updated_datetime", ] model_config = ConfigDict( populate_by_name=True, validate_assignment=True, protected_namespaces=(), )
[docs] def to_str(self) -> str: """Returns the string representation of the model using alias""" return pprint.pformat(self.model_dump(by_alias=True))
[docs] def to_json(self) -> str: """Returns the JSON representation of the model using alias""" # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict())
[docs] @classmethod def from_json(cls, json_str: str) -> Self | None: """Create an instance of SingleAnnotationDetailV2 from a JSON string""" return cls.from_dict(json.loads(json_str))
[docs] def to_dict(self) -> Dict[str, Any]: """Return the dictionary representation of the model using alias. This has the following differences from calling pydantic's `self.model_dump(by_alias=True)`: * `None` is only added to the output dict for nullable fields that were set at model initialization. Other fields with value `None` are ignored. """ excluded_fields: Set[str] = set([]) _dict = self.model_dump( by_alias=True, exclude=excluded_fields, exclude_none=True, ) # override the default output from pydantic by calling `to_dict()` of body if self.body: _dict["body"] = self.body.to_dict() # override the default output from pydantic by calling `to_dict()` of each item in additional_data_list (list) _items = [] if self.additional_data_list: for _item_additional_data_list in self.additional_data_list: if _item_additional_data_list: _items.append(_item_additional_data_list.to_dict()) _dict["additional_data_list"] = _items return _dict
[docs] @classmethod def from_dict(cls, obj: Dict[str, Any] | None) -> Self | None: """Create an instance of SingleAnnotationDetailV2 from a dict""" if obj is None: return None if not isinstance(obj, dict): return cls.model_validate(obj) _obj = cls.model_validate( { "annotation_id": obj.get("annotation_id"), "account_id": obj.get("account_id"), "label_id": obj.get("label_id"), "body": AnnotationDetailContentOutput.from_dict(obj["body"]) if obj.get("body") is not None else None, "additional_data_list": [AdditionalDataV2.from_dict(_item) for _item in obj["additional_data_list"]] if obj.get("additional_data_list") is not None else None, "created_datetime": obj.get("created_datetime"), "updated_datetime": obj.get("updated_datetime"), } ) return _obj