IconPhoto

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

Bases: pyinaturalist.models.photo.Photo

Class used for displaying an iconic taxon in place of a taxon photo

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
icon_url (property)	Optional[str]	Image URL (32px icon size)

Methods

__init__(id=None, attribution=None, license_code=None, original_dimensions=(0, 0), url=None)

Method generated by attrs for class IconPhoto.

classmethod copy(obj)

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_iconic_taxon(iconic_taxon_name)

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')

Display the image with the system’s default image viewer. Requires pillow.

to_dict(**kwargs)

Convert this object back to dict format

Return type

Dict[str, Any]

url_size(size)

Return type

str