Skip to content

Tag Create Dto

immichpy.client.generated.models.tag_create_dto.TagCreateDto pydantic-model

Bases: BaseModel

TagCreateDto

Show JSON schema: 
{
  "description": "TagCreateDto",
  "properties": {
    "color": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Tag color (hex)",
      "title": "Color"
    },
    "name": {
      "description": "Tag name",
      "title": "Name",
      "type": "string"
    },
    "parentId": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Parent tag ID",
      "title": "Parentid"
    }
  },
  "required": [
    "name"
  ],
  "title": "TagCreateDto",
  "type": "object"
}

Config:

  • populate_by_name: True
  • validate_assignment: True
  • protected_namespaces: ()

Fields:

Validators:

color pydantic-field 

color: Optional[Annotated[str, Field(strict=True)]] = None

Tag color (hex)

name pydantic-field 

name: StrictStr

Tag name

parent_id pydantic-field 

parent_id: Optional[UUID] = None

Parent tag ID

color_validate_regular_expression pydantic-validator 

color_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/tag_create_dto.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
@field_validator("color")
def color_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if value is None:
        return value

    if not re.match(
        r"^#?([0-9A-F]{3}|[0-9A-F]{4}|[0-9A-F]{6}|[0-9A-F]{8})$", value
    ):
        raise ValueError(
            r"must validate the regular expression /^#?([0-9A-F]{3}|[0-9A-F]{4}|[0-9A-F]{6}|[0-9A-F]{8})$/"
        )
    return value

from_dict classmethod 

from_dict(obj: Optional[Dict[str, Any]]) -> Optional[Self]

Create an instance of TagCreateDto from a dict

Source code in immichpy/client/generated/models/tag_create_dto.py 
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of TagCreateDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "color": obj.get("color"),
            "name": obj.get("name"),
            "parentId": obj.get("parentId"),
        }
    )
    return _obj

from_json classmethod 

from_json(json_str: str) -> Optional[Self]

Create an instance of TagCreateDto from a JSON string

Source code in immichpy/client/generated/models/tag_create_dto.py 
70
71
72
73
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of TagCreateDto from a JSON string"""
    return cls.from_dict(json.loads(json_str))

to_dict 

to_dict() -> 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.
Source code in immichpy/client/generated/models/tag_create_dto.py 
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
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,
    )
    # set to None if parent_id (nullable) is None
    # and model_fields_set contains the field
    if self.parent_id is None and "parent_id" in self.model_fields_set:
        _dict["parentId"] = None

    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/tag_create_dto.py 
65
66
67
68
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 

to_str() -> str

Returns the string representation of the model using alias

Source code in immichpy/client/generated/models/tag_create_dto.py 
61
62
63
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))