Skip to content

setting_body

😸 Cheshire-Cat API

Production ready AI assistant framework

The version of the OpenAPI document: 1.3.1 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

SettingBody

Bases: BaseModel

SettingBody

Source code in cheshire_cat_api/models/setting_body.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
class SettingBody(BaseModel):
    """
    SettingBody
    """ # noqa: E501
    name: StrictStr
    value: Value
    category: Optional[StrictStr] = None
    __properties: ClassVar[List[str]] = ["name", "value", "category"]

    model_config = {
        "populate_by_name": True,
        "validate_assignment": True
    }


    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:
        """Create an instance of SettingBody 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.
        """
        _dict = self.model_dump(
            by_alias=True,
            exclude={
            },
            exclude_none=True,
        )
        # override the default output from pydantic by calling `to_dict()` of value
        if self.value:
            _dict['value'] = self.value.to_dict()
        # set to None if category (nullable) is None
        # and model_fields_set contains the field
        if self.category is None and "category" in self.model_fields_set:
            _dict['category'] = None

        return _dict

    @classmethod
    def from_dict(cls, obj: Dict) -> Self:
        """Create an instance of SettingBody from a dict"""
        if obj is None:
            return None

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

        _obj = cls.model_validate({
            "name": obj.get("name"),
            "value": Value.from_dict(obj.get("value")) if obj.get("value") is not None else None,
            "category": obj.get("category")
        })
        return _obj

from_dict(obj) classmethod

Create an instance of SettingBody from a dict

Source code in cheshire_cat_api/models/setting_body.py 
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
@classmethod
def from_dict(cls, obj: Dict) -> Self:
    """Create an instance of SettingBody from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate({
        "name": obj.get("name"),
        "value": Value.from_dict(obj.get("value")) if obj.get("value") is not None else None,
        "category": obj.get("category")
    })
    return _obj

from_json(json_str) classmethod

Create an instance of SettingBody from a JSON string

Source code in cheshire_cat_api/models/setting_body.py 
53
54
55
56
@classmethod
def from_json(cls, json_str: str) -> Self:
    """Create an instance of SettingBody from a JSON string"""
    return cls.from_dict(json.loads(json_str))

to_dict()

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.
Source code in cheshire_cat_api/models/setting_body.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
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.
    """
    _dict = self.model_dump(
        by_alias=True,
        exclude={
        },
        exclude_none=True,
    )
    # override the default output from pydantic by calling `to_dict()` of value
    if self.value:
        _dict['value'] = self.value.to_dict()
    # set to None if category (nullable) is None
    # and model_fields_set contains the field
    if self.category is None and "category" in self.model_fields_set:
        _dict['category'] = None

    return _dict

to_json()

Returns the JSON representation of the model using alias

Source code in cheshire_cat_api/models/setting_body.py 
48
49
50
51
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())

to_str()

Returns the string representation of the model using alias

Source code in cheshire_cat_api/models/setting_body.py 
44
45
46
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))