ControlledTerm#
- class pyinaturalist.models.ControlledTerm(id=None, is_value=None, multivalued=None, label=None, ontology_uri=None, uri=None, uuid=None, taxon_ids=NOTHING, values=NOTHING)#
Bases:
pyinaturalist.models.base.BaseModel
A controlled term, based on the schema of GET /controlled_terms.
Attributes
Name
Type
Description
id
Unique record ID
is_value
multivalued
label
ontology_uri
uri
uuid
taxon_ids
value_labels (
property
)Combined labels from all controlled term values
_row (
property
)_str_attrs (
property
)values (
LazyProperty
)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, values=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
- 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).
- classmethod from_json_file(value)#
Initialize a collection of model objects from a JSON string, file path, or file-like object
- classmethod from_json_list(value, **kwargs)#
Initialize a collection of model objects from an API response or response results