Comment

class pyinaturalist.models.Comment(id=None, body='', created_at=_Nothing.NOTHING, hidden=None, uuid=None, user=None)

Bases: BaseModel

An observation comment, based on the schema of comments from GET /observations.

Attributes

Name	Type	Description
id	int	Unique record ID
body	str	Comment text
created_at	datetime	Date and time the comment was created
hidden	bool	Indicates if the comment is hidden
uuid	str	Universally unique identifier
truncated_body (property)	Any	Comment text, truncated
username (property)	str
user (LazyProperty)	User	User that added the comment or ID

Methods

__init__(id=None, body='', created_at=_Nothing.NOTHING, hidden=None, uuid=None, user=None)

Method generated by attrs for class Comment.

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_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, **kwargs)

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

Return type:

List[TypeVar(T, bound= BaseModel)]

to_dict(keys=None, recurse=True)

Convert this object back to dict format

Parameters:

• keys (Optional[List[str]]) – Only keep the specified keys (attribute names)

• recurse (bool) – Recurse into nested model objects

Return type:

Dict[str, Any]