from functools import partial from urllib.parse import urlencode from geopy.exc import ( GeocoderAuthenticationFailure, GeocoderQuotaExceeded, GeocoderServiceError, ) from geopy.geocoders.base import DEFAULT_SENTINEL, Geocoder from geopy.location import Location from geopy.util import logger __all__ = ("GeocodeFarm", ) class GeocodeFarm(Geocoder): """Geocoder using the GeocodeFarm API. Documentation at: https://www.geocode.farm/geocoding/free-api-documentation/ """ geocode_path = '/v3/json/forward/' reverse_path = '/v3/json/reverse/' def __init__( self, api_key=None, *, timeout=DEFAULT_SENTINEL, proxies=DEFAULT_SENTINEL, user_agent=None, ssl_context=DEFAULT_SENTINEL, adapter_factory=None, scheme=None ): """ :param str api_key: (optional) The API key required by GeocodeFarm to perform geocoding requests. :param int timeout: See :attr:`geopy.geocoders.options.default_timeout`. :param dict proxies: See :attr:`geopy.geocoders.options.default_proxies`. :param str user_agent: See :attr:`geopy.geocoders.options.default_user_agent`. :type ssl_context: :class:`ssl.SSLContext` :param ssl_context: See :attr:`geopy.geocoders.options.default_ssl_context`. :param callable adapter_factory: See :attr:`geopy.geocoders.options.default_adapter_factory`. .. versionadded:: 2.0 :param str scheme: See :attr:`geopy.geocoders.options.default_scheme`. """ super().__init__( scheme=scheme, timeout=timeout, proxies=proxies, user_agent=user_agent, ssl_context=ssl_context, adapter_factory=adapter_factory, ) self.api_key = api_key domain = 'www.geocode.farm' self.api = ( "%s://%s%s" % (self.scheme, domain, self.geocode_path) ) self.reverse_api = ( "%s://%s%s" % (self.scheme, domain, self.reverse_path) ) def geocode(self, query, *, exactly_one=True, timeout=DEFAULT_SENTINEL): """ Return a location point by address. :param str query: The address or query you wish to geocode. :param bool exactly_one: Return one result or a list of results, if available. :param int timeout: Time, in seconds, to wait for the geocoding service to respond before raising a :class:`geopy.exc.GeocoderTimedOut` exception. Set this only if you wish to override, on this call only, the value set during the geocoder's initialization. :rtype: ``None``, :class:`geopy.location.Location` or a list of them, if ``exactly_one=False``. """ params = { 'addr': query, } if self.api_key: params['key'] = self.api_key url = "?".join((self.api, urlencode(params))) logger.debug("%s.geocode: %s", self.__class__.__name__, url) callback = partial(self._parse_json, exactly_one=exactly_one) return self._call_geocoder(url, callback, timeout=timeout) def reverse(self, query, *, exactly_one=True, timeout=DEFAULT_SENTINEL): """ Return an address by location point. :param query: The coordinates for which you wish to obtain the closest human-readable addresses. :type query: :class:`geopy.point.Point`, list or tuple of ``(latitude, longitude)``, or string as ``"%(latitude)s, %(longitude)s"``. :param bool exactly_one: Return one result or a list of results, if available. GeocodeFarm's API will always return at most one result. :param int timeout: Time, in seconds, to wait for the geocoding service to respond before raising a :class:`geopy.exc.GeocoderTimedOut` exception. Set this only if you wish to override, on this call only, the value set during the geocoder's initialization. :rtype: ``None``, :class:`geopy.location.Location` or a list of them, if ``exactly_one=False``. """ try: lat, lon = self._coerce_point_to_string(query).split(',') except ValueError: raise ValueError("Must be a coordinate pair or Point") params = { 'lat': lat, 'lon': lon } if self.api_key: params['key'] = self.api_key url = "?".join((self.reverse_api, urlencode(params))) logger.debug("%s.reverse: %s", self.__class__.__name__, url) callback = partial(self._parse_json, exactly_one=exactly_one) return self._call_geocoder(url, callback, timeout=timeout) def _parse_code(self, results): # Parse each resource. places = [] for result in results.get('RESULTS'): coordinates = result.get('COORDINATES', {}) address = result.get('ADDRESS', {}) latitude = coordinates.get('latitude', None) longitude = coordinates.get('longitude', None) placename = address.get('address_returned', None) if placename is None: placename = address.get('address', None) if placename is None: placename = result.get('formatted_address', None) if latitude and longitude: latitude = float(latitude) longitude = float(longitude) places.append(Location(placename, (latitude, longitude), result)) return places def _parse_json(self, api_result, exactly_one): if api_result is None: return None geocoding_results = api_result["geocoding_results"] self._check_for_api_errors(geocoding_results) if "NO_RESULTS" in geocoding_results.get("STATUS", {}).get("status", ""): return None places = self._parse_code(geocoding_results) if exactly_one: return places[0] else: return places def _check_for_api_errors(self, geocoding_results): """ Raise any exceptions if there were problems reported in the api response. """ status_result = geocoding_results.get("STATUS", {}) if "NO_RESULTS" in status_result.get("status", ""): return api_call_success = status_result.get("status", "") == "SUCCESS" if not api_call_success: access_error = status_result.get("access") access_error_to_exception = { 'API_KEY_INVALID': GeocoderAuthenticationFailure, 'OVER_QUERY_LIMIT': GeocoderQuotaExceeded, } exception_cls = access_error_to_exception.get( access_error, GeocoderServiceError ) raise exception_cls(access_error)