Source code for annofabapi.pydantic_models.put_annotation_request
"""
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.annotation_detail_v1 import AnnotationDetailV1
[docs]
class PutAnnotationRequest(BaseModel):
"""
PutAnnotationRequest
"""
project_id: StrictStr = Field(description="プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) ")
task_id: StrictStr = Field(description="タスクID。[値の制約についてはこちら。](#section/API-Convention/APIID) ")
input_data_id: StrictStr = Field(description="入力データID。[値の制約についてはこちら。](#section/API-Convention/APIID) ")
details: List[AnnotationDetailV1] = Field(description="矩形、ポリゴン、全体アノテーションなど個々のアノテーションの配列。")
updated_datetime: str | None = Field(default=None, description="新規作成時は未指定、更新時は必須(更新前の日時) ")
__properties: ClassVar[List[str]] = ["project_id", "task_id", "input_data_id", "details", "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 PutAnnotationRequest 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 each item in details (list)
_items = []
if self.details:
for _item_details in self.details:
if _item_details:
_items.append(_item_details.to_dict())
_dict["details"] = _items
return _dict
[docs]
@classmethod
def from_dict(cls, obj: Dict[str, Any] | None) -> Self | None:
"""Create an instance of PutAnnotationRequest from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return cls.model_validate(obj)
_obj = cls.model_validate(
{
"project_id": obj.get("project_id"),
"task_id": obj.get("task_id"),
"input_data_id": obj.get("input_data_id"),
"details": [AnnotationDetailV1.from_dict(_item) for _item in obj["details"]] if obj.get("details") is not None else None,
"updated_datetime": obj.get("updated_datetime"),
}
)
return _obj