Converters

Summary

Classes

Functions

convert_all_coordinates(results)	Convert coordinate pairs in response items from strings to floats, if valid
convert_all_place_coordinates(response)	Convert locations for both standard and community-contributed places to floats
convert_all_timestamps(results)	Replace all date/time info with datetime objects, where possible
convert_generic_timestamps(result)	Replace generic created/updated info that's returned by multiple endpoints.
convert_histogram(result)	Convert histogram keys (bin labels) to the appropriate type depending on interval
convert_isoformat(value)	Convert a date, datetime, or timestamps to a string in ISO 8601 format.
convert_lat_long(obj)	Convert a coordinate pair as a dict, list, or string into a pair of floats, if valid
convert_lat_long_dict(result)	Convert a coordinate pair dict within a response to floats, if valid
convert_lat_long_list(result)	Convert a coordinate pairs in a response item from strings to floats, if valid
convert_observation_timestamps(result)	Replace observation date/time info with datetime objects
ensure_file_obj(value[, session])	Load data into a file-like object, if it isn't already.
ensure_list(value[, split_str_list, delimiter])	Convert an object, response, or (optionally) comma-separated string into a list
format_dimensions(dimensions)	Simplify a 'dimensions' dict into a (width, height) tuple
format_file_size(n_bytes)	Convert a file size in bytes into a human-readable format
format_license(value)	Format a Creative Commons license code
get_histogram_interval(result)	Get the histogram interval from the result keys.
safe_split(value[, delimiter])	Split a pipe-(or other token)-delimited string
try_date(timestamp, **kwargs)	Parse a date string into a date, if valid; return None otherwise
try_datetime(timestamp, **kwargs)	Parse a date/time string into a datetime, if valid; return None otherwise
try_float(value)	Convert a value to a float, if valid; return None otherwise
try_float_pair(*values)	Convert a pair of coordinate values to floats, if both are valid; return None otherwise
try_int(value)	Convert a value to a int, if valid; return None otherwise
try_int_or_float(value)	Convert a value to either an int or a float, if valid; return None otherwise

Module Contents

Type conversion utilities used for both requests and responses

pyinaturalist.converters.convert_all_coordinates(results) → List[Dict[str, Any]]

Convert coordinate pairs in response items from strings to floats, if valid

Parameters:

results (List[Dict[str, Any]]) – Results from API response; expects coordinates in either ‘location’ key or ‘latitude’ and ‘longitude’ keys

Return type:

List[Dict[str, Any]]

pyinaturalist.converters.convert_all_place_coordinates(response) → Dict[str, Any]

Convert locations for both standard and community-contributed places to floats

Return type:

Dict[str, Any]

pyinaturalist.converters.convert_all_timestamps(results) → List[Dict[str, Any]]

Replace all date/time info with datetime objects, where possible

Return type:

List[Dict[str, Any]]

pyinaturalist.converters.convert_generic_timestamps(result) → Dict[str, Any]

Replace generic created/updated info that’s returned by multiple endpoints. Note: Compared to observation timestamps, these are generally more reliable. These seem to be consistently in ISO 8601 format.

Return type:

Dict[str, Any]

pyinaturalist.converters.convert_histogram(result) → Dict[date | datetime | int, int]

Convert histogram keys (bin labels) to the appropriate type depending on interval

Return type:

Dict[Union[date, datetime, int], int]

pyinaturalist.converters.convert_isoformat(value) → str

Convert a date, datetime, or timestamps to a string in ISO 8601 format. If it’s a datetime and doesn’t already have tzinfo, set it to the system’s local timezone.

Raises:

dateutil.parser._parser.ParserError –

Return type:

str

pyinaturalist.converters.convert_lat_long(obj) → Tuple[float, float] | None

Convert a coordinate pair as a dict, list, or string into a pair of floats, if valid

Return type:

Optional[Tuple[float, float]]

pyinaturalist.converters.convert_lat_long_dict(result) → Dict[str, Any]

Convert a coordinate pair dict within a response to floats, if valid

Return type:

Dict[str, Any]

pyinaturalist.converters.convert_lat_long_list(result)

Convert a coordinate pairs in a response item from strings to floats, if valid

pyinaturalist.converters.convert_observation_timestamps(result) → Dict[str, Any]

Replace observation date/time info with datetime objects

Return type:

Dict[str, Any]

pyinaturalist.converters.ensure_file_obj(value, session=None) → IO

Load data into a file-like object, if it isn’t already. Accepts local file paths and URLs.

Return type:

IO

pyinaturalist.converters.ensure_list(value, split_str_list=False, delimiter=',') → MutableSequence[Any]

Convert an object, response, or (optionally) comma-separated string into a list

Return type:

MutableSequence[Any]

pyinaturalist.converters.format_dimensions(dimensions) → Tuple[int, int]

Simplify a ‘dimensions’ dict into a (width, height) tuple

Return type:

Tuple[int, int]

pyinaturalist.converters.format_file_size(n_bytes) → str

Convert a file size in bytes into a human-readable format

Return type:

str

pyinaturalist.converters.format_license(value) → str | None

Format a Creative Commons license code

Return type:

Optional[str]

pyinaturalist.converters.get_histogram_interval(result) → str

Get the histogram interval from the result keys.

The key containing histogram data will be the name of the interval requested example: {'month_of_year': {'1': 5, ...}}

Return type:

str

pyinaturalist.converters.safe_split(value, delimiter='|') → List[str]

Split a pipe-(or other token)-delimited string

Return type:

List[str]

pyinaturalist.converters.try_date(timestamp, **kwargs) → date | None

Parse a date string into a date, if valid; return None otherwise

Return type:

Optional[date]

pyinaturalist.converters.try_datetime(timestamp, **kwargs) → datetime | None

Parse a date/time string into a datetime, if valid; return None otherwise

Return type:

Optional[datetime]

pyinaturalist.converters.try_float(value) → float | None

Convert a value to a float, if valid; return None otherwise

Return type:

Optional[float]

pyinaturalist.converters.try_float_pair(*values) → Tuple[float, float] | None

Convert a pair of coordinate values to floats, if both are valid; return None otherwise

Return type:

Optional[Tuple[float, float]]

pyinaturalist.converters.try_int(value) → float | None

Convert a value to a int, if valid; return None otherwise

Return type:

Optional[float]

pyinaturalist.converters.try_int_or_float(value) → int | float | None

Convert a value to either an int or a float, if valid; return None otherwise

Return type:

Union[int, float, None]