Source code for annofabapi.pydantic_models.system_metadata

"""


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
from typing import Any, Dict, Set, Union

from pydantic import BaseModel, ConfigDict, ValidationError, field_validator
from typing_extensions import Self

from annofabapi.pydantic_models.system_metadata_custom import SystemMetadataCustom
from annofabapi.pydantic_models.system_metadata_image import SystemMetadataImage
from annofabapi.pydantic_models.system_metadata_movie import SystemMetadataMovie

SYSTEMMETADATA_ONE_OF_SCHEMAS = ["SystemMetadataCustom", "SystemMetadataImage", "SystemMetadataMovie"]


[docs] class SystemMetadata(BaseModel): """ Annofabが設定したメタデータです。 `metadata`プロパティとは違い、ユーザー側では値を編集できません。 * `SystemMetadataImage`: 画像プロジェクト用のメタデータ * `SystemMetadataMovie`: 動画プロジェクト用のメタデータ * `SystemMetadataCustom`: カスタムプロジェクト用のメタデータ """ # data type: SystemMetadataImage oneof_schema_1_validator: SystemMetadataImage | None = None # data type: SystemMetadataMovie oneof_schema_2_validator: SystemMetadataMovie | None = None # data type: SystemMetadataCustom oneof_schema_3_validator: SystemMetadataCustom | None = None actual_instance: Union[SystemMetadataCustom, SystemMetadataImage, SystemMetadataMovie] | None = None one_of_schemas: Set[str] = {"SystemMetadataCustom", "SystemMetadataImage", "SystemMetadataMovie"} model_config = ConfigDict( validate_assignment=True, protected_namespaces=(), ) discriminator_value_class_map: Dict[str, str] = {} def __init__(self, *args, **kwargs) -> None: if args: if len(args) > 1: raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") if kwargs: raise ValueError("If a position argument is used, keyword arguments cannot be used.") super().__init__(actual_instance=args[0]) else: super().__init__(**kwargs)
[docs] @field_validator("actual_instance") def actual_instance_must_validate_oneof(cls, v): instance = SystemMetadata.model_construct() error_messages = [] match = 0 # validate data type: SystemMetadataImage if not isinstance(v, SystemMetadataImage): error_messages.append(f"Error! Input type `{type(v)}` is not `SystemMetadataImage`") else: match += 1 # validate data type: SystemMetadataMovie if not isinstance(v, SystemMetadataMovie): error_messages.append(f"Error! Input type `{type(v)}` is not `SystemMetadataMovie`") else: match += 1 # validate data type: SystemMetadataCustom if not isinstance(v, SystemMetadataCustom): error_messages.append(f"Error! Input type `{type(v)}` is not `SystemMetadataCustom`") else: match += 1 if match > 1: # more than 1 match raise ValueError( "Multiple matches found when setting `actual_instance` in SystemMetadata with oneOf schemas: SystemMetadataCustom, SystemMetadataImage, SystemMetadataMovie. Details: " + ", ".join(error_messages) ) elif match == 0: # no match raise ValueError( "No match found when setting `actual_instance` in SystemMetadata with oneOf schemas: SystemMetadataCustom, SystemMetadataImage, SystemMetadataMovie. Details: " + ", ".join(error_messages) ) else: return v
[docs] @classmethod def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: return cls.from_json(json.dumps(obj))
[docs] @classmethod def from_json(cls, json_str: str) -> Self: """Returns the object represented by the json string""" instance = cls.model_construct() error_messages = [] match = 0 # deserialize data into SystemMetadataImage try: instance.actual_instance = SystemMetadataImage.from_json(json_str) match += 1 except (ValidationError, ValueError) as e: error_messages.append(str(e)) # deserialize data into SystemMetadataMovie try: instance.actual_instance = SystemMetadataMovie.from_json(json_str) match += 1 except (ValidationError, ValueError) as e: error_messages.append(str(e)) # deserialize data into SystemMetadataCustom try: instance.actual_instance = SystemMetadataCustom.from_json(json_str) match += 1 except (ValidationError, ValueError) as e: error_messages.append(str(e)) if match > 1: # more than 1 match raise ValueError( "Multiple matches found when deserializing the JSON string into SystemMetadata with oneOf schemas: SystemMetadataCustom, SystemMetadataImage, SystemMetadataMovie. Details: " + ", ".join(error_messages) ) elif match == 0: # no match raise ValueError( "No match found when deserializing the JSON string into SystemMetadata with oneOf schemas: SystemMetadataCustom, SystemMetadataImage, SystemMetadataMovie. Details: " + ", ".join(error_messages) ) else: return instance
[docs] def to_json(self) -> str: """Returns the JSON representation of the actual instance""" if self.actual_instance is None: return "null" if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): return self.actual_instance.to_json() else: return json.dumps(self.actual_instance)
[docs] def to_dict(self) -> Union[Dict[str, Any], SystemMetadataCustom, SystemMetadataImage, SystemMetadataMovie] | None: """Returns the dict representation of the actual instance""" if self.actual_instance is None: return None if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): return self.actual_instance.to_dict() else: # primitive type return self.actual_instance
[docs] def to_str(self) -> str: """Returns the string representation of the actual instance""" return pprint.pformat(self.model_dump())