Skip to content

Places Response Dto

immichpy.client.generated.models.places_response_dto.PlacesResponseDto pydantic-model

Bases: BaseModel

PlacesResponseDto

Show JSON schema: 
{
  "description": "PlacesResponseDto",
  "properties": {
    "admin1name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Administrative level 1 name (state/province)",
      "title": "Admin1Name"
    },
    "admin2name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Administrative level 2 name (county/district)",
      "title": "Admin2Name"
    },
    "latitude": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "integer"
        }
      ],
      "description": "Latitude coordinate",
      "title": "Latitude"
    },
    "longitude": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "integer"
        }
      ],
      "description": "Longitude coordinate",
      "title": "Longitude"
    },
    "name": {
      "description": "Place name",
      "title": "Name",
      "type": "string"
    }
  },
  "required": [
    "latitude",
    "longitude",
    "name"
  ],
  "title": "PlacesResponseDto",
  "type": "object"
}

Config:

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

Fields:

admin1name pydantic-field 

admin1name: Optional[StrictStr] = None

Administrative level 1 name (state/province)

admin2name pydantic-field 

admin2name: Optional[StrictStr] = None

Administrative level 2 name (county/district)

latitude pydantic-field 

latitude: Union[StrictFloat, StrictInt]

Latitude coordinate

longitude pydantic-field 

longitude: Union[StrictFloat, StrictInt]

Longitude coordinate

name pydantic-field 

name: StrictStr

Place name

from_dict classmethod 

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

Create an instance of PlacesResponseDto from a dict

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

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

    _obj = cls.model_validate(
        {
            "admin1name": obj.get("admin1name"),
            "admin2name": obj.get("admin2name"),
            "latitude": obj.get("latitude"),
            "longitude": obj.get("longitude"),
            "name": obj.get("name"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of PlacesResponseDto from a JSON string

Source code in immichpy/client/generated/models/places_response_dto.py 
62
63
64
65
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of PlacesResponseDto 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/places_response_dto.py 
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,
    )
    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/places_response_dto.py 
57
58
59
60
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/places_response_dto.py 
53
54
55
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))