Source code for annofabapi.pydantic_models.plugin_detail_annotation_editor

"""


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.input_data_type import InputDataType
from annofabapi.pydantic_models.organization_plugin_compatibility import OrganizationPluginCompatibility




class PluginDetailAnnotationEditor(BaseModel):
    """
    カスタムアノテーションエディタ用のプラグインを表します。
    """

    plugin_compatibility: OrganizationPluginCompatibility | None = None
    url: StrictStr | None = Field(
        default=None,
        description="カスタムアノテーションエディタでタスクを開くための URL です。 プラグインを使用するプロジェクトのタスク一覧などで使用されます。 プラグイン種別がカスタムアノテーションエディタの場合のみ有効です。  この URL には、タスクを特定するための以下のパラメータを必ず埋め込んでください。  * `{projectId}` * `{taskId}`  以下のパラメーターは任意で指定します。  * `{inputDataId}`: アノテーション一覧などから、特定の入力データにフォーカスした状態でタスクを開くときなどに指定します。 * `{annotationId}`: アノテーション一覧などから、特定のアノテーションにフォーカスした状態でタスクを開くときなどに指定します。 ",
    )
    auth_redirect_url: StrictStr | None = Field(
        default=None,
        description="認証後のリダイレクト先。このURLに `?code=xxx` をつけてリダイレクトされます。 url プロパティとは異なり、 `{projectId}` や `{taskId}` といったパラメータの置換は行われません。  詳しくは [requestPluginToken API](#operation/requestPluginToken) を参照してください。 ",
    )
    compatible_input_data_types: List[InputDataType] = Field(
        description="プラグインが対応している入力データです。 プラグイン種別がカスタムアノテーションエディタ、またはカスタムアノテーション仕様の場合のみ有効です。 "
    )
    type: StrictStr | None = Field(default=None, description="`AnnotationEditor` [詳しくはこちら](#section/API-Convention/API-_type) ", alias="_type")
    __properties: ClassVar[List[str]] = ["plugin_compatibility", "url", "auth_redirect_url", "compatible_input_data_types", "_type"]

    model_config = ConfigDict(
        populate_by_name=True,
        validate_assignment=True,
        protected_namespaces=(),
    )



    def to_str(self) -> str:
        """Returns the string representation of the model using alias"""
        return pprint.pformat(self.model_dump(by_alias=True))




    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())




    @classmethod
    def from_json(cls, json_str: str) -> Self | None:
        """Create an instance of PluginDetailAnnotationEditor from a JSON string"""
        return cls.from_dict(json.loads(json_str))




    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 plugin_compatibility
        if self.plugin_compatibility:
            _dict["plugin_compatibility"] = self.plugin_compatibility.to_dict()
        return _dict




    @classmethod
    def from_dict(cls, obj: Dict[str, Any] | None) -> Self | None:
        """Create an instance of PluginDetailAnnotationEditor from a dict"""
        if obj is None:
            return None

        if not isinstance(obj, dict):
            return cls.model_validate(obj)

        _obj = cls.model_validate(
            {
                "plugin_compatibility": OrganizationPluginCompatibility.from_dict(obj["plugin_compatibility"])
                if obj.get("plugin_compatibility") is not None
                else None,
                "url": obj.get("url"),
                "auth_redirect_url": obj.get("auth_redirect_url"),
                "compatible_input_data_types": obj.get("compatible_input_data_types"),
                "_type": obj.get("_type"),
            }
        )
        return _obj