Photo#
- class pyinaturalist.models.Photo(id=None, attribution=None, license_code=None, observation_id=None, original_dimensions=(0, 0), url=None, user_id=None, uuid=None)#
Bases:
pyinaturalist.models.base.BaseModel
An observation photo, based on the schema of photos from:
GET /taxa <https://api.inaturalist.org/v1/docs/#!/Taxa/get_taxa>
Attributes
Name
Type
Description
id
Unique record ID
attribution
License attribution
license_code
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
observation_id
Associated observation ID
original_dimensions
Dimensions of original image
url
Image URL; see properties for URLs of specific image sizes
user_id
Associated user ID
uuid
ext (
property
)File extension from URL
dimensions_str (
property
)Dimensions as a string, formatted as
{width}x{height}
has_cc_license (
property
)Determine if this photo has a Creative Commons license
info_url (
property
)Photo info URL on iNaturalist.org
large_url (
property
)Image URL (large size)
medium_url (
property
)Image URL (medium size)
mimetype (
property
)MIME type of the image
original_url (
property
)Image URL (original size)
small_url (
property
)Image URL (small size)
square_url (
property
)Image URL (thumbnail size)
thumbnail_url (
property
)Image URL (thumbnail size)
_row (
property
)_str_attrs (
property
)Methods
- __init__(id=None, attribution=None, license_code=None, observation_id=None, original_dimensions=(0, 0), url=None, user_id=None, uuid=None)#
Method generated by attrs for class Photo.
- 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
- classmethod from_json(value, **kwargs)#
Flatten out potentially nested photo field before initializing
- Return type
- classmethod from_json_file(value)#
Initialize a collection of model objects from a JSON string, file path, or file-like object
- classmethod from_json_list(value, **kwargs)#
Initialize a collection of model objects from an API response or response results
- show(size='large')#
Display the image with the system’s default image viewer. Requires
pillow
.