Source code for annofabapi.pydantic_models.count
"""
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, StrictInt, StrictStr
from typing_extensions import Self
[docs]
class Count(BaseModel):
"""
Count
"""
key: StrictStr | None = Field(default=None, description="集約対象の `field` の値です。 ")
count: StrictInt | None = Field(default=None, description="集約対象 `field` の値が `key` の値と等しかったリソースの件数です。 ")
aggregations: List[AggregationResult] | None = Field(
default=None, description="この集約のサブ集約です。サブ集約がないときは空の配列になります。 "
)
__properties: ClassVar[List[str]] = ["key", "count", "aggregations"]
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 Count 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 aggregations (list)
_items = []
if self.aggregations:
for _item_aggregations in self.aggregations:
if _item_aggregations:
_items.append(_item_aggregations.to_dict())
_dict["aggregations"] = _items
return _dict
[docs]
@classmethod
def from_dict(cls, obj: Dict[str, Any] | None) -> Self | None:
"""Create an instance of Count from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return cls.model_validate(obj)
_obj = cls.model_validate(
{
"key": obj.get("key"),
"count": obj.get("count"),
"aggregations": [AggregationResult.from_dict(_item) for _item in obj["aggregations"]]
if obj.get("aggregations") is not None
else None,
}
)
return _obj
from annofabapi.pydantic_models.aggregation_result import AggregationResult
# TODO: Rewrite to not use raise_errors
Count.model_rebuild(raise_errors=False)