Skip to content

Validate Library Response Dto

immichpy.client.generated.models.validate_library_response_dto.ValidateLibraryResponseDto pydantic-model

Bases: BaseModel

ValidateLibraryResponseDto

Show JSON schema: 
{
  "$defs": {
    "ValidateLibraryImportPathResponseDto": {
      "description": "ValidateLibraryImportPathResponseDto",
      "properties": {
        "importPath": {
          "description": "Import path",
          "title": "Importpath",
          "type": "string"
        },
        "isValid": {
          "description": "Is valid",
          "title": "Isvalid",
          "type": "boolean"
        },
        "message": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Validation message",
          "title": "Message"
        }
      },
      "required": [
        "importPath",
        "isValid"
      ],
      "title": "ValidateLibraryImportPathResponseDto",
      "type": "object"
    }
  },
  "description": "ValidateLibraryResponseDto",
  "properties": {
    "importPaths": {
      "anyOf": [
        {
          "items": {
            "$ref": "#/$defs/ValidateLibraryImportPathResponseDto"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Validation results for import paths",
      "title": "Importpaths"
    }
  },
  "title": "ValidateLibraryResponseDto",
  "type": "object"
}

Config:

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

Fields:

import_paths pydantic-field 

import_paths: Optional[List[ValidateLibraryImportPathResponseDto]] = None

Validation results for import paths

from_dict classmethod 

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

Create an instance of ValidateLibraryResponseDto from a dict

Source code in immichpy/client/generated/models/validate_library_response_dto.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of ValidateLibraryResponseDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "importPaths": [
                ValidateLibraryImportPathResponseDto.from_dict(_item)
                for _item in obj["importPaths"]
            ]
            if obj.get("importPaths") is not None
            else None
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of ValidateLibraryResponseDto from a JSON string

Source code in immichpy/client/generated/models/validate_library_response_dto.py 
55
56
57
58
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of ValidateLibraryResponseDto 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/validate_library_response_dto.py 
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
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 import_paths (list)
    _items = []
    if self.import_paths:
        for _item_import_paths in self.import_paths:
            if _item_import_paths:
                _items.append(_item_import_paths.to_dict())
        _dict["importPaths"] = _items
    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/validate_library_response_dto.py 
50
51
52
53
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/validate_library_response_dto.py 
46
47
48
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))