ControlledTermCount#

class pyinaturalist.models.ControlledTermCount(id=None, uuid=None, count=0, histogram=_Nothing.NOTHING, controlled_attribute=None, controlled_value=None)#

Bases: BaseModel

A count + histogram of a controlled term and value

Attributes

Name

Type

Description

id

int

Unique record ID

uuid

str

Unversally unique record ID

count

int

histogram

Dict[int, int]

term (property)

str

value (property)

str

controlled_attribute (LazyProperty)

ControlledTerm

controlled_value (LazyProperty)

ControlledTermValue

Methods

__init__(id=None, uuid=None, count=0, histogram=_Nothing.NOTHING, controlled_attribute=None, controlled_value=None)#

Method generated by attrs for class ControlledTermCount.

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, user_id=None, **kwargs)#

Rename some response fields before initializing

Return type:

ControlledTermCount

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]