Photo

class pyinaturalist.models.Photo(id=None, attribution=None, license_code=None, original_dimensions=(0, 0), url=None)

Bases: pyinaturalist.models.base.BaseModel

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_dimensions	Tuple[int, int]	Dimensions of original image
url	str	Image URL; see properties for URLs of specific image sizes
dimensions_str (property)	str	Dimensions as a string, formatted as {width}x{height}
has_cc_license (property)	bool	Determine if this photo has a Creative Commons license
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)
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_dimensions=(0, 0), url=None)

Method generated by attrs for class Photo.

classmethod from_json(value, **kwargs)

Initialize a single model object from an API response or response result.

Omits any invalid fields and None values, so default factories are used instead (e.g. for empty dicts and lists).

Return type

TypeVar(T, bound= BaseModel)

classmethod from_json_file(value)

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)

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

Return type

List[TypeVar(T, bound= BaseModel)]

open(size='large')

Download the image and return as a file-like object

Return type

BinaryIO

show(size='large')

Download and display the image with the system’s default image viewer. Requires pillow.

to_json()

Convert this object back to JSON (dict) format

Return type

Dict[str, Any]

url_size(size)

Return type

Optional[str]