ObservationField#

class pyinaturalist.models.ObservationField(id=None, allowed_values=_Nothing.NOTHING, created_at=_Nothing.NOTHING, datatype=None, description=None, name=None, updated_at=_Nothing.NOTHING, user_id=None, users_count=None, uuid=None, values_count=None)#

Bases: BaseModel

An observation field definition, based on the schema of GET /observation_fields.

Attributes

Name

Type

Description

id

int

Unique record ID

allowed_values

List[str]

created_at

datetime

Date and time the observation field was created

datatype

str

description

str

name

str

updated_at

datetime

Date and time the observation field was last updated

user_id

int

users_count

int

uuid

str

values_count

int

Methods

__init__(id=None, allowed_values=_Nothing.NOTHING, created_at=_Nothing.NOTHING, datatype=None, description=None, name=None, updated_at=_Nothing.NOTHING, user_id=None, users_count=None, uuid=None, values_count=None)#

Method generated by attrs for class ObservationField.

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]