Annotation

class pyinaturalist.models.Annotation(id=None, concatenated_attr_val=None, controlled_attribute_id=None, controlled_value_id=None, user_id=None, uuid=None, vote_score=None, votes=NOTHING, user=None)

Bases: pyinaturalist.models.base.BaseModel

An annotation, meaning a controlled term value applied by a user to an observation. Based on the schema of annotations from GET /observations.

Attributes

Name	Type	Description
id	int	Unique record ID
concatenated_attr_val	str
controlled_attribute_id	int
controlled_value_id	int
user_id	int
uuid	str
vote_score	int
votes	List
values (property)	List[str]	Split pipe-delimited annotation values into separate tokens
user (LazyProperty)	User	User who added the annotation

Methods

__init__(id=None, concatenated_attr_val=None, controlled_attribute_id=None, controlled_value_id=None, user_id=None, uuid=None, vote_score=None, votes=NOTHING, user=None)

Method generated by attrs for class Annotation.

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

to_json()

Convert this object back to JSON (dict) format

Return type

Dict[str, Any]