""" :class:`GeocoderDotUS` geocoder. """ import csv from base64 import b64encode from geopy.compat import urlencode, py3k, Request from geopy.geocoders.base import ( Geocoder, DEFAULT_FORMAT_STRING, DEFAULT_TIMEOUT, ) from geopy.location import Location from geopy.exc import ConfigurationError from geopy.util import logger, join_filter __all__ = ("GeocoderDotUS", ) class GeocoderDotUS(Geocoder): # pylint: disable=W0223 """ GeocoderDotUS geocoder, documentation at: http://geocoder.us/ Note that GeocoderDotUS does not support SSL. """ def __init__( self, username=None, password=None, format_string=DEFAULT_FORMAT_STRING, timeout=DEFAULT_TIMEOUT, proxies=None, user_agent=None, ): # pylint: disable=R0913 """ :param str username: :param str password: :param str format_string: String containing '%s' where the string to geocode should be interpolated before querying the geocoder. For example: '%s, Mountain View, CA'. The default is just '%s'. :param int timeout: Time, in seconds, to wait for the geocoding service to respond before raising an :class:`geopy.exc.GeocoderTimedOut` exception. .. versionadded:: 0.97 :param dict proxies: If specified, routes this geocoder's requests through the specified proxy. E.g., {"https": "192.0.2.0"}. For more information, see documentation on :class:`urllib2.ProxyHandler`. .. versionadded:: 0.96 :param str user_agent: Use a custom User-Agent header. .. versionadded:: 1.12.0 """ super(GeocoderDotUS, self).__init__( format_string=format_string, timeout=timeout, proxies=proxies, user_agent=user_agent ) if username or password: if not (username and password): raise ConfigurationError( "Username and password must both specified" ) self.authenticated = True self.api = "http://geocoder.us/member/service/namedcsv" else: self.authenticated = False self.api = "http://geocoder.us/service/namedcsv" self.username = username self.password = password def geocode(self, query, exactly_one=True, timeout=None): """ Geocode a location query. :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. .. versionadded:: 0.97 """ query_str = self.format_string % query url = "?".join((self.api, urlencode({'address':query_str}))) logger.debug("%s.geocode: %s", self.__class__.__name__, url) url = Request(url, headers=self._get_headers()) page = self._call_geocoder(url, timeout=timeout, raw=True) content = page.read().decode("utf-8") if py3k else page.read() # pylint: disable=E1101,E1103 places = [ r for r in csv.reader( [content, ] if not isinstance(content, list) else content ) ] if not len(places): return None if exactly_one: return self._parse_result(places[0]) else: result = [self._parse_result(res) for res in places] if None in result: # todo return None return result @staticmethod def _parse_result(result): """ Parse individual results. Different, but lazy actually, so... ok. """ # turn x=y pairs ("lat=47.6", "long=-117.426") # into dict key/value pairs: place = dict( [x.split('=') for x in result if len(x.split('=')) > 1] ) if 'error' in place: if "couldn't find" in place['error']: return None address = [ place.get('number', None), place.get('prefix', None), place.get('street', None), place.get('type', None), place.get('suffix', None) ] city = place.get('city', None) state = place.get('state', None) zip_code = place.get('zip', None) name = join_filter(", ", [ join_filter(" ", address), city, join_filter(" ", [state, zip_code]) ]) latitude = place.get('lat', None) longitude = place.get('long', None) if latitude and longitude: latlon = float(latitude), float(longitude) else: return None return Location(name, latlon, place) def _get_headers(self): headers = {} if self.authenticated: username_password = ":".join((self.username, self.password)) auth = " ".join(( "Basic", b64encode(username_password.encode('utf-8')).decode('utf-8') )) headers["Authorization"] = auth return headers