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, interval)	Convert keys to 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_histogram`(response)	Convert a response containing time series data into a single `{date: value}` dict
`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
`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 coordinat 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)¶

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

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

Return type:: Dict[str, Any]

pyinaturalist.converters.convert_all_timestamps(results)¶

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

Return type:: List[Dict[str, Any]]

pyinaturalist.converters.convert_generic_timestamps(result)¶

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, interval)¶: Convert keys to appropriate type depending on interval

pyinaturalist.converters.convert_isoformat(value)¶

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.