BaseModel#

class pyinaturalist.models.BaseModel(id=None)#

Bases: object

Base class for data models

Attributes

Name	Type	Description
id	`int`	Unique record ID

_row (`property`)	`Dict`[`str`, `Any`]	Get values and headers to display as a row in a table
_str_attrs (`property`)	`List`[`str`]	Get the subset of attribute names to show in the model’s string representation

Methods

__init__(id=None)#: Method generated by attrs for class BaseModel.

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(recurse=True)#

Convert this object back to dict format

Return type: Dict[str, Any]