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
Unique record ID
concatenated_attr_val
controlled_attribute_id
controlled_value_id
user_id
uuid
vote_score
votes
values (
property
)Split pipe-delimited annotation values into separate tokens
user (
LazyProperty
)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 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)#
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).
- 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)#
Initialize a collection of model objects from an API response or response results