Sound#

class pyinaturalist.models.Sound(id=None, uuid=None, attribution=None, license_code=None, created_at=None, updated_at=None, file_content_type=None, file_url=None, native_sound_id=None, secret_token=None, subtype=None)#

Bases: BaseMedia

An observation sound, based on the schema of sounds from:

Attributes

Name

Type

Description

id

int

Unique record ID

uuid

str

Unversally unique record ID

attribution

str

License attribution

license_code

str

Creative Commons license code

Options: CC-BY, CC-BY-NC, CC-BY-ND, CC-BY-SA, CC-BY-NC-ND, CC-BY-NC-SA, CC0, ALL RIGHTS RESERVED

created_at

str

Date the file was added to iNaturalist

updated_at

str

Date the file was last updated on iNaturalist

file_content_type

str

file_url

str

native_sound_id

str

secret_token

str

subtype

str

mimetype (property)

str

url (property)

str

Methods

__init__(id=None, uuid=None, attribution=None, license_code=None, created_at=None, updated_at=None, file_content_type=None, file_url=None, native_sound_id=None, secret_token=None, subtype=None)#

Method generated by attrs for class Sound.

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

Flatten out potentially nested sound field before initializing

Return type:

Sound

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]