Photo¶

class pyinaturalist.models.Photo(id=None, attribution=None, license_code=None, original_filename=None, created_at=None, updated_at=None, observation_id=None, original_dimensions=(0, 0), url=None, user_id=None, uuid=None) → None¶

Bases: BaseMedia

An observation photo, based on the schema of photos from:

GET /observations
GET /taxa <https://api.inaturalist.org/v1/docs/#!/Taxa/get_taxa>

Attributes

Name	Type	Description
id	`int`	Unique record ID
attribution	`str`	License attribution
license_code	`str`	Creative Commons license code Options: `CC-BY`, `CC-BY-NC`, `CC-BY-ND`, `CC-BY-SA`, `CC-BY-NC-ND`, `CC-BY-NC-SA`, `CC0`, `ALL RIGHTS RESERVED`
original_filename	`str`	Original filename uploaded to iNaturalist
created_at	`str`	Date the file was added to iNaturalist
updated_at	`str`	Date the file was last updated on iNaturalist
observation_id	`int`	Associated observation ID
original_dimensions	`Tuple`[`int`, `int`]	Dimensions of original image
url	`str`	Image URL; see properties for URLs of specific image sizes
user_id	`int`	Associated user ID
uuid	`str`

dimensions_str (`property`)	`str`	Dimensions as a string, formatted as `{width}x{height}`
info_url (`property`)	`str`	Photo info URL on iNaturalist.org
large_url (`property`)	`Optional`[`str`]	Image URL (large size)
medium_url (`property`)	`Optional`[`str`]	Image URL (medium size)
mimetype (`property`)	`str`	MIME type of the image
original_url (`property`)	`Optional`[`str`]	Image URL (original size)
small_url (`property`)	`Optional`[`str`]	Image URL (small size)
square_url (`property`)	`Optional`[`str`]	Image URL (thumbnail size)
thumbnail_url (`property`)	`Optional`[`str`]	Image URL (thumbnail size)

Methods

__init__(id=None, attribution=None, license_code=None, original_filename=None, created_at=None, updated_at=None, observation_id=None, original_dimensions=(0, 0), url=None, user_id=None, uuid=None) → None¶: Method generated by attrs for class Photo.

classmethod copy(obj) → BaseModel¶

Copy a model object. This is defined as a classmethod to easily initialize a subclass from a parent class instance. For copying an instance to the same type, copy.deepcopy() can be used.

Return type:: BaseModel

classmethod from_json(value, **kwargs) → Photo¶

Flatten out potentially nested photo field before initializing

Return type:: Photo

classmethod from_json_file(value) → List[T]¶

Initialize a collection of model objects from a JSON string, file path, or file-like object

Return type:: List[TypeVar(T, bound= BaseModel)]

classmethod from_json_list(value, **kwargs) → List[T]¶

Initialize a collection of model objects from an API response or response results

Return type:: List[TypeVar(T, bound= BaseModel)]

open(size='large') → BinaryIO¶

Download the image and return as a file-like object

Return type:: BinaryIO

show(size='large')¶: Display the image with the system’s default image viewer. Requires pillow.

to_dict(keys=None, recurse=True) → Dict[str, Any]¶

Convert this object back to dict format

Parameters:

keys (Optional[List[str]]) – Only keep the specified keys (attribute names)
recurse (bool) – Recurse into nested model objects

Return type:

Dict[str, Any]

url_size(size) → str | None¶

Return type:: Optional[str]