Skip to content

Crop Parameters

immichpy.client.generated.models.crop_parameters.CropParameters pydantic-model

Bases: BaseModel

CropParameters

Show JSON schema: 
{
  "description": "CropParameters",
  "properties": {
    "height": {
      "anyOf": [
        {
          "minimum": 1,
          "type": "number"
        },
        {
          "minimum": 1,
          "type": "integer"
        }
      ],
      "description": "Height of the crop",
      "title": "Height"
    },
    "width": {
      "anyOf": [
        {
          "minimum": 1,
          "type": "number"
        },
        {
          "minimum": 1,
          "type": "integer"
        }
      ],
      "description": "Width of the crop",
      "title": "Width"
    },
    "x": {
      "anyOf": [
        {
          "minimum": 0,
          "type": "number"
        },
        {
          "minimum": 0,
          "type": "integer"
        }
      ],
      "description": "Top-Left X coordinate of crop",
      "title": "X"
    },
    "y": {
      "anyOf": [
        {
          "minimum": 0,
          "type": "number"
        },
        {
          "minimum": 0,
          "type": "integer"
        }
      ],
      "description": "Top-Left Y coordinate of crop",
      "title": "Y"
    }
  },
  "required": [
    "height",
    "width",
    "x",
    "y"
  ],
  "title": "CropParameters",
  "type": "object"
}

Config:

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

Fields:

  • height (Union[Annotated[float, Field(strict=True, ge=1)], Annotated[int, Field(strict=True, ge=1)]])
  • width (Union[Annotated[float, Field(strict=True, ge=1)], Annotated[int, Field(strict=True, ge=1)]])
  • x (Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]])
  • y (Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]])

height pydantic-field 

height: Union[Annotated[float, Field(strict=True, ge=1)], Annotated[int, Field(strict=True, ge=1)]]

Height of the crop

width pydantic-field 

width: Union[Annotated[float, Field(strict=True, ge=1)], Annotated[int, Field(strict=True, ge=1)]]

Width of the crop

x pydantic-field 

x: Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]]

Top-Left X coordinate of crop

y pydantic-field 

y: Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]]

Top-Left Y coordinate of crop

from_dict classmethod 

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

Create an instance of CropParameters from a dict

Source code in immichpy/client/generated/models/crop_parameters.py 
 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 CropParameters from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "height": obj.get("height"),
            "width": obj.get("width"),
            "x": obj.get("x"),
            "y": obj.get("y"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of CropParameters from a JSON string

Source code in immichpy/client/generated/models/crop_parameters.py 
64
65
66
67
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of CropParameters 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/crop_parameters.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
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/crop_parameters.py 
59
60
61
62
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/crop_parameters.py 
55
56
57
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))