def get_summary(self, search_item, location_type, csv=False, output_dir=None, extra_param=None):
"""Retrieves adaptation summary product data from the First Street Foundation API given a list of
search_items and returns a list of Adaptation Summary objects.
Args:
search_item (list/file): A First Street Foundation IDs, lat/lng pair, address, or a
file of First Street Foundation IDs
location_type (str): The location lookup type
csv (bool): To output extracted data to a csv or not
output_dir (str): The output directory to save the generated csvs
extra_param (str): Extra parameter to be added to the url
Returns:
A list of Adaptation Summary
Raises:
InvalidArgument: The location provided is empty
TypeError: The location provided is not a string
"""
if not location_type:
raise InvalidArgument(location_type)
elif not isinstance(location_type, str):
raise TypeError("location is not a string")
# Get data from api and create objects
api_datas = self.call_api(search_item, "adaptation", "summary", location_type, extra_param=extra_param)
product = [AdaptationSummary(api_data) for api_data in api_datas]
if csv:
csv_format.to_csv(product, "adaptation", "summary", location_type, output_dir=output_dir)
logging.info("Adaptation Summary Data Ready.")
return product
def get_details_by_location(self, search_item, location_type, csv=False, output_dir=None, extra_param=None):
"""Retrieves adaptation detail product data from the First Street Foundation API given a list of location
search_items and returns a list of Adaptation Detail objects.
Args:
search_item (list/file): A First Street Foundation IDs, lat/lng pair, address, or a
file of First Street Foundation IDs
location_type (str): The location lookup type
csv (bool): To output extracted data to a csv or not
output_dir (str): The output directory to save the generated csvs
extra_param (str): Extra parameter to be added to the url
Returns:
A list of list of Adaptation Summary and Adaptation Detail
Raises:
InvalidArgument: The location provided is empty
TypeError: The location provided is not a string
"""
if not location_type:
raise InvalidArgument(location_type)
elif not isinstance(location_type, str):
raise TypeError("location is not a string")
# Get data from api and create objects
api_datas_summary = self.call_api(search_item, "adaptation", "summary", location_type, extra_param=extra_param)
summary = [AdaptationSummary(api_data) for api_data in api_datas_summary]
search_items = list(set([adaptation for sum_adap in summary if sum_adap.adaptation for
adaptation in sum_adap.adaptation]))
if search_items:
api_datas_detail = self.call_api(search_items, "adaptation", "detail", None, extra_param=extra_param)
else:
api_datas_detail = [{"adaptationId": None, "valid_id": False}]
detail = [AdaptationDetail(api_data) for api_data in api_datas_detail]
if csv:
csv_format.to_csv([summary, detail], "adaptation", "summary_detail", location_type,
output_dir=output_dir)
logging.info("Adaptation Summary Detail Data Ready.")
return [summary, detail]