Source code for annofabapi.pydantic_models.task_history_short
"""
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, StrictBool, StrictStr
from typing_extensions import Annotated, Self
from annofabapi.pydantic_models.task_phase import TaskPhase
[docs]
class TaskHistoryShort(BaseModel):
"""
タスクのあるフェーズを誰が担当したかを表します。
"""
phase: TaskPhase
phase_stage: Annotated[int, Field(strict=True, ge=1)]
account_id: StrictStr = Field(description="アカウントID。[値の制約についてはこちら。](#section/API-Convention/APIID) ")
worked: StrictBool | None = Field(default=False, description="そのフェーズでタスクの作業を行ったかどうか(行った場合はtrue)")
__properties: ClassVar[List[str]] = ["phase", "phase_stage", "account_id", "worked"]
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 TaskHistoryShort 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,
)
return _dict
[docs]
@classmethod
def from_dict(cls, obj: Dict[str, Any] | None) -> Self | None:
"""Create an instance of TaskHistoryShort from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return cls.model_validate(obj)
_obj = cls.model_validate(
{
"phase": obj.get("phase"),
"phase_stage": obj.get("phase_stage") if obj.get("phase_stage") is not None else 1,
"account_id": obj.get("account_id"),
"worked": obj.get("worked") if obj.get("worked") is not None else False,
}
)
return _obj