Source code for annofabapi.pydantic_models.batch_annotation_request_item_put_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, field_validator
from typing_extensions import Self
from annofabapi.pydantic_models.batch_annotation_v2 import BatchAnnotationV2
[docs]
class BatchAnnotationRequestItemPutV2(BaseModel):
"""
アノテーション更新
"""
data: BatchAnnotationV2
type: StrictStr | None = Field(default=None, description="[詳しくはこちら](#section/API-Convention/API-_type) ", alias="_type")
__properties: ClassVar[List[str]] = ["data", "_type"]
[docs]
@field_validator("type")
def type_validate_enum(cls, value):
"""Validates the enum"""
if value is None:
return value
if value not in set(["PutV2"]):
raise ValueError("must be one of enum values ('PutV2')")
return value
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 BatchAnnotationRequestItemPutV2 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 data
if self.data:
_dict["data"] = self.data.to_dict()
return _dict
[docs]
@classmethod
def from_dict(cls, obj: Dict[str, Any] | None) -> Self | None:
"""Create an instance of BatchAnnotationRequestItemPutV2 from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return cls.model_validate(obj)
_obj = cls.model_validate(
{"data": BatchAnnotationV2.from_dict(obj["data"]) if obj.get("data") is not None else None, "_type": obj.get("_type")}
)
return _obj