Source code for annofabapi.pydantic_models.additional_data_definition_v1_choices_inner

"""


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.internationalization_message import InternationalizationMessage
from annofabapi.pydantic_models.keybind import Keybind


[docs] class AdditionalDataDefinitionV1ChoicesInner(BaseModel): """ AdditionalDataDefinitionV1ChoicesInner """ choice_id: StrictStr = Field(description="選択肢ID。[値の制約についてはこちら。](#section/API-Convention/APIID) ") name: InternationalizationMessage keybind: List[Keybind] | None = Field(default=None, description="ショートカットキー") __properties: ClassVar[List[str]] = ["choice_id", "name", "keybind"] 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 AdditionalDataDefinitionV1ChoicesInner 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 name if self.name: _dict["name"] = self.name.to_dict() # override the default output from pydantic by calling `to_dict()` of each item in keybind (list) _items = [] if self.keybind: for _item_keybind in self.keybind: if _item_keybind: _items.append(_item_keybind.to_dict()) _dict["keybind"] = _items return _dict
[docs] @classmethod def from_dict(cls, obj: Dict[str, Any] | None) -> Self | None: """Create an instance of AdditionalDataDefinitionV1ChoicesInner from a dict""" if obj is None: return None if not isinstance(obj, dict): return cls.model_validate(obj) _obj = cls.model_validate( { "choice_id": obj.get("choice_id"), "name": InternationalizationMessage.from_dict(obj["name"]) if obj.get("name") is not None else None, "keybind": [Keybind.from_dict(_item) for _item in obj["keybind"]] if obj.get("keybind") is not None else None, } ) return _obj