ControlledTerm

class pyinaturalist.models.ControlledTerm(id, uuid, blocking, excepted_taxon_ids, is_value, label, ...) → None

Bases: BaseModel

A controlled term, based on the schema of GET /controlled_terms.

Attributes

Methods

__init__(id, uuid, blocking, excepted_taxon_ids, is_value, label, ...) → None

Method generated by attrs for class ControlledTerm.

classmethod copy(obj) → BaseModel

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) → T

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) → list[T]

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) → list[T]

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

Return type:

list[TypeVar(T, bound= BaseModel)]

classmethod get_term_by_label(terms, label) → ControlledTerm | None

Get the term matching the specified label from a collection (case-insensitive)

Return type:

ControlledTerm | None

get_value_by_id(controlled_value_id) → ControlledTermValue | None

Get the value with the specified controlled value ID

Return type:

ControlledTermValue | None

get_value_by_label(label) → ControlledTermValue | None

Get the value matching the specified label (case-insensitive)

Return type:

ControlledTermValue | None

to_dict(keys, recurse) → dict[str, Any]

Convert this object back to dict format

Parameters:

• keys (list[str] | None) – Only keep the specified keys (attribute names)

• recurse (bool) – Recurse into nested model objects

Return type:

dict[str, Any]