142 lines
4.9 KiB
Python
142 lines
4.9 KiB
Python
'''
|
|
Python client for the Mapbox Geocoder service.
|
|
'''
|
|
|
|
import json
|
|
import requests
|
|
from mapbox import Geocoder
|
|
from cartodb_services.metrics import Traceable
|
|
from cartodb_services.tools.exceptions import ServiceException
|
|
from cartodb_services.tools.qps import qps_retry
|
|
from cartodb_services.tools.normalize import normalize
|
|
|
|
GEOCODER_NAME = 'geocoder_name'
|
|
EPHEMERAL_GEOCODER = 'mapbox.places'
|
|
PERMANENT_GEOCODER = 'mapbox.places-permanent'
|
|
DEFAULT_GEOCODER = PERMANENT_GEOCODER
|
|
|
|
ENTRY_FEATURES = 'features'
|
|
ENTRY_CENTER = 'center'
|
|
ENTRY_GEOMETRY = 'geometry'
|
|
ENTRY_COORDINATES = 'coordinates'
|
|
ENTRY_TYPE = 'type'
|
|
TYPE_POINT = 'Point'
|
|
|
|
|
|
class MapboxGeocoder(Traceable):
|
|
'''
|
|
Python wrapper for the Mapbox Geocoder service.
|
|
'''
|
|
|
|
def __init__(self, token, logger, service_params=None):
|
|
service_params = service_params or {}
|
|
self._token = token
|
|
self._logger = logger
|
|
self._geocoder_name = service_params.get(GEOCODER_NAME,
|
|
DEFAULT_GEOCODER)
|
|
self._geocoder = Geocoder(access_token=self._token,
|
|
name=self._geocoder_name)
|
|
|
|
def _parse_geocoder_response(self, response):
|
|
json_response = json.loads(response)
|
|
self._logger.debug('--> json response: {}'.format(json_response))
|
|
|
|
if json_response:
|
|
if type(json_response) != list:
|
|
json_response = [json_response]
|
|
|
|
result = []
|
|
for a_json_response in json_response:
|
|
if a_json_response[ENTRY_FEATURES]:
|
|
feature = a_json_response[ENTRY_FEATURES][0]
|
|
result.append(self._extract_lng_lat_from_feature(feature))
|
|
else:
|
|
result.append([])
|
|
return result
|
|
else:
|
|
return []
|
|
|
|
def _extract_lng_lat_from_feature(self, feature):
|
|
geometry = feature[ENTRY_GEOMETRY]
|
|
if geometry[ENTRY_TYPE] == TYPE_POINT:
|
|
location = geometry[ENTRY_COORDINATES]
|
|
else:
|
|
location = feature[ENTRY_CENTER]
|
|
|
|
longitude = location[0]
|
|
latitude = location[1]
|
|
return [longitude, latitude]
|
|
|
|
def _validate_input(self, searchtext, city=None, state_province=None,
|
|
country=None):
|
|
if searchtext and searchtext.strip():
|
|
return True
|
|
elif city:
|
|
return True
|
|
elif state_province:
|
|
return True
|
|
|
|
return False
|
|
|
|
@qps_retry(qps=10)
|
|
def geocode(self, searchtext, city=None, state_province=None,
|
|
country=None):
|
|
"""
|
|
:param searchtext:
|
|
:param city:
|
|
:param state_province:
|
|
:param country: Country ISO 3166 code
|
|
:return: [x, y] on success, [] on error
|
|
"""
|
|
if not self._validate_input(searchtext, city, state_province, country):
|
|
return []
|
|
|
|
address = []
|
|
if searchtext and searchtext.strip():
|
|
address.append(normalize(searchtext))
|
|
if city:
|
|
address.append(normalize(city))
|
|
if state_province:
|
|
address.append(normalize(state_province))
|
|
|
|
country = [country] if country else None
|
|
|
|
free_search = ', '.join(address)
|
|
|
|
return self.geocode_free_text([free_search], country)[0]
|
|
|
|
@qps_retry(qps=10)
|
|
def geocode_free_text(self, free_searches, country=None):
|
|
"""
|
|
:param free_searches: Free text searches
|
|
:param country: Country ISO 3166 code
|
|
:return: list of [x, y] on success, [] on error
|
|
"""
|
|
try:
|
|
free_search = ';'.join(free_searches)
|
|
self._logger.debug('--> free search: {}'.format(free_search))
|
|
response = self._geocoder.forward(address=free_search.decode('utf-8'),
|
|
country=country,
|
|
limit=1)
|
|
|
|
if response.status_code == requests.codes.ok:
|
|
return self._parse_geocoder_response(response.text)
|
|
elif response.status_code == requests.codes.bad_request:
|
|
return []
|
|
elif response.status_code == requests.codes.unprocessable_entity:
|
|
return []
|
|
else:
|
|
raise ServiceException(response.status_code, response)
|
|
except requests.Timeout as te:
|
|
# In case of timeout we want to stop the job because the server
|
|
# could be down
|
|
self._logger.error('Timeout connecting to Mapbox geocoding server',
|
|
te)
|
|
raise ServiceException('Error geocoding {0} using Mapbox'.format(
|
|
free_search), None)
|
|
except requests.ConnectionError as ce:
|
|
# Don't raise the exception to continue with the geocoding job
|
|
self._logger.error('Error connecting to Mapbox geocoding server',
|
|
exception=ce)
|
|
return []
|