ControlledTerm

class pyinaturalist.models.ControlledTerm(id=None, is_value=None, multivalued=None, label=None, ontology_uri=None, uri=None, uuid=None, taxon_ids=_Nothing.NOTHING, excepted_taxon_ids=_Nothing.NOTHING, values=_Nothing.NOTHING)

Bases: BaseModel

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

Attributes

Name

Type

Description

id

int

Unique record ID

is_value

bool

multivalued

bool

label

str

ontology_uri

str

uri

str

uuid

str

taxon_ids

List[int]

excepted_taxon_ids

List[int]

value_labels (property)

str

Combined labels from all controlled term values

values (LazyProperty)

List[ControlledTermValue]

Allowed values for this controlled term

Methods

__init__(id=None, is_value=None, multivalued=None, label=None, ontology_uri=None, uri=None, uuid=None, taxon_ids=_Nothing.NOTHING, excepted_taxon_ids=_Nothing.NOTHING, values=_Nothing.NOTHING)

Method generated by attrs for class ControlledTerm.

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)]

get_value_by_id(controlled_value_id)

Get the value with the specified controlled value ID

Return type:

Optional[ControlledTermValue]

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]