added fixed user agent to headers for every geocoder call, configurab…

…le for Nominatim added tests for custom and default user agents removed caveman debugging print artifact ;-) moved __version__ to own module in order to avoid circular imports refactored the default user agent into a constant added customizable user agent to arcgis added customizable user agent to baidu added customizable user agent to bing added customizable user agent to databc added customizable user agent to dot_us added customizable user agent to geocodefarm added customizable user agent to geonames added customizable user agent to googleV3 added customizable user agent to ignfrance added customizable user agent to navidata added customizable user agent to opencage added customizable user agent to openmapquest added customizable user agent to placefinder added customizable user agent to smartystreets added customizable user agent to what3words added customizable user agent to yandex a pep improvement mostly a dummy commit for a travis retriggering... fixed some bad merges
geopy · Aug 31, 2015 · 7fda9f1 · 7fda9f1
1 parent b2fee93
commit 7fda9f1
Show file tree

Hide file tree

Showing 41 changed files with 233 additions and 36 deletions.
diff --git a/geopy/__init__.py b/geopy/__init__.py
@@ -13,4 +13,4 @@
 from geopy.geocoders import * # pylint: disable=W0401
 
 
-__version__ = "1.10.0"
+from geopy.version import GEOPY_VERSION as __version__
diff --git a/geopy/geocoders/arcgis.py b/geopy/geocoders/arcgis.py
@@ -29,7 +29,8 @@ class ArcGIS(Geocoder):  # pylint: disable=R0921,R0902,W0223
 
     def __init__(self, username=None, password=None, referer=None, # pylint: disable=R0913
                  token_lifetime=60, scheme=DEFAULT_SCHEME,
-                 timeout=DEFAULT_TIMEOUT, proxies=None):
+                 timeout=DEFAULT_TIMEOUT, proxies=None,
+                user_agent=None):
         """
         Create a ArcGIS-based geocoder.
 
@@ -63,7 +64,7 @@ def __init__(self, username=None, password=None, referer=None, # pylint: disable
             :class:`urllib2.ProxyHandler`.
         """
         super(ArcGIS, self).__init__(
-            scheme=scheme, timeout=timeout, proxies=proxies
+            scheme=scheme, timeout=timeout, proxies=proxies, user_agent=user_agent
         )
         if username or password or referer:
             if not (username and password and referer):

diff --git a/geopy/geocoders/baidu.py b/geopy/geocoders/baidu.py
@@ -28,6 +28,7 @@ def __init__(
             scheme='http',
             timeout=DEFAULT_TIMEOUT,
             proxies=None,
+            user_agent=None
         ):
         """
         Initialize a customized Baidu geocoder using the v2 API.
@@ -47,7 +48,7 @@ def __init__(
             :class:`urllib2.ProxyHandler`.
         """
         super(Baidu, self).__init__(
-            scheme=scheme, timeout=timeout, proxies=proxies
+            scheme=scheme, timeout=timeout, proxies=proxies, user_agent=user_agent
         )
         self.api_key = api_key
         self.scheme = scheme

diff --git a/geopy/geocoders/base.py b/geopy/geocoders/base.py
@@ -15,6 +15,7 @@
     ProxyHandler,
     URLError,
     install_opener,
+    Request,
 )
 from geopy.point import Point
 from geopy.exc import (
@@ -28,7 +29,7 @@
     GeocoderUnavailable,
     GeocoderParseError,
 )
-from geopy.util import decode_page
+import geopy.util as gu
 
 
 __all__ = (
@@ -44,6 +45,8 @@
 DEFAULT_SCHEME = 'https'
 DEFAULT_TIMEOUT = 1
 DEFAULT_WKID = 4326
+DEFAULT_USER_AGENT = "geopy/" + gu.get_version()
+
 
 ERROR_CODE_MAP = {
     400: GeocoderQueryError,
@@ -70,7 +73,8 @@ def __init__(
             format_string=DEFAULT_FORMAT_STRING,
             scheme=DEFAULT_SCHEME,
             timeout=DEFAULT_TIMEOUT,
-            proxies=None
+            proxies=None,
+            user_agent=None
         ):
         """
         Mostly-common geocoder validation, proxies, &c. Not all geocoders
@@ -84,6 +88,7 @@ def __init__(
             )
         self.proxies = proxies
         self.timeout = timeout
+        self.headers = {'User-Agent': user_agent or DEFAULT_USER_AGENT}
 
         if self.proxies:
             install_opener(
@@ -129,7 +134,8 @@ def _call_geocoder(
         requester = requester or self.urlopen
 
         try:
-            page = requester(url, timeout=(timeout or self.timeout), **kwargs)
+            req = Request(url=url, headers=self.headers)
+            page = requester(req, timeout=(timeout or self.timeout), **kwargs)
         except Exception as error: # pylint: disable=W0703
             message = (
                 str(error) if not py3k
@@ -166,12 +172,12 @@ def _call_geocoder(
         else:
             status_code = None
         if status_code in ERROR_CODE_MAP:
-            raise ERROR_CODE_MAP[page.status_code]("\n%s" % decode_page(page))
+            raise ERROR_CODE_MAP[page.status_code]("\n%s" % gu.decode_page(page))
 
         if raw:
             return page
 
-        page = decode_page(page)
+        page = gu.decode_page(page)
 
         if deserializer is not None:
             try:

diff --git a/geopy/geocoders/bing.py b/geopy/geocoders/bing.py
@@ -40,6 +40,7 @@ def __init__(
             scheme=DEFAULT_SCHEME,
             timeout=DEFAULT_TIMEOUT,
             proxies=None,
+            user_agent=None,
         ):  # pylint: disable=R0913
         """Initialize a customized Bing geocoder with location-specific
         address information and your Bing Maps API key.
@@ -70,7 +71,7 @@ def __init__(
 
             .. versionadded:: 0.96
         """
-        super(Bing, self).__init__(format_string, scheme, timeout, proxies)
+        super(Bing, self).__init__(format_string, scheme, timeout, proxies, user_agent=user_agent)
         self.api_key = api_key
         self.api = "%s://dev.virtualearth.net/REST/v1/Locations" % self.scheme
 

diff --git a/geopy/geocoders/databc.py b/geopy/geocoders/databc.py
@@ -19,7 +19,7 @@ class DataBC(Geocoder):
         http://www.data.gov.bc.ca/dbc/geographic/locate/geocoding.page
     """
 
-    def __init__(self, scheme=DEFAULT_SCHEME, timeout=DEFAULT_TIMEOUT, proxies=None):
+    def __init__(self, scheme=DEFAULT_SCHEME, timeout=DEFAULT_TIMEOUT, proxies=None, user_agent=None):
         """
         Create a DataBC-based geocoder.
 
@@ -35,7 +35,7 @@ def __init__(self, scheme=DEFAULT_SCHEME, timeout=DEFAULT_TIMEOUT, proxies=None)
             :class:`urllib2.ProxyHandler`.
         """
         super(DataBC, self).__init__(
-            scheme=scheme, timeout=timeout, proxies=proxies
+            scheme=scheme, timeout=timeout, proxies=proxies, user_agent=user_agent
         )
         self.api = '%s://apps.gov.bc.ca/pub/geocoder/addresses.geojson' % self.scheme
 

diff --git a/geopy/geocoders/dot_us.py b/geopy/geocoders/dot_us.py
@@ -33,6 +33,7 @@ def __init__(
             format_string=DEFAULT_FORMAT_STRING,
             timeout=DEFAULT_TIMEOUT,
             proxies=None,
+            user_agent=None,
         ):  # pylint: disable=R0913
         """
         :param string username:
@@ -58,7 +59,7 @@ def __init__(
             .. versionadded:: 0.96
         """
         super(GeocoderDotUS, self).__init__(
-            format_string=format_string, timeout=timeout, proxies=proxies
+            format_string=format_string, timeout=timeout, proxies=proxies, user_agent=user_agent
         )
         if username or password:
             if not (username and password):

diff --git a/geopy/geocoders/geocodefarm.py b/geopy/geocoders/geocodefarm.py
@@ -26,6 +26,7 @@ def __init__(
             format_string=DEFAULT_FORMAT_STRING,
             timeout=DEFAULT_TIMEOUT,
             proxies=None,
+            user_agent=None,
         ):  # pylint: disable=R0913
         """
         Create a geocoder for GeocodeFarm.
@@ -46,7 +47,7 @@ def __init__(
             :class:`urllib2.ProxyHandler`.
         """
         super(GeocodeFarm, self).__init__(
-            format_string, 'https', timeout, proxies
+            format_string, 'https', timeout, proxies, user_agent=user_agent
         )
         self.api_key = api_key
         self.format_string = format_string

diff --git a/geopy/geocoders/geonames.py b/geopy/geocoders/geonames.py
@@ -31,7 +31,8 @@ def __init__(
             country_bias=None,
             username=None,
             timeout=DEFAULT_TIMEOUT,
-            proxies=None
+            proxies=None,
+            user_agent=None,
         ):
         """
         :param string country_bias:
@@ -52,7 +53,7 @@ def __init__(
             .. versionadded:: 0.96
         """
         super(GeoNames, self).__init__(
-            scheme='http', timeout=timeout, proxies=proxies
+            scheme='http', timeout=timeout, proxies=proxies, user_agent=user_agent
         )
         if username == None:
             raise ConfigurationError(

diff --git a/geopy/geocoders/googlev3.py b/geopy/geocoders/googlev3.py
@@ -44,7 +44,8 @@ def __init__(
             client_id=None,
             secret_key=None,
             timeout=DEFAULT_TIMEOUT,
-            proxies=None
+            proxies=None,
+            user_agent=None,
         ):  # pylint: disable=R0913
         """
         Initialize a customized Google geocoder.
@@ -80,7 +81,7 @@ def __init__(
             .. versionadded:: 0.96
         """
         super(GoogleV3, self).__init__(
-            scheme=scheme, timeout=timeout, proxies=proxies
+            scheme=scheme, timeout=timeout, proxies=proxies, user_agent=user_agent
         )
         if client_id and not secret_key:
             raise ConfigurationError('Must provide secret_key with client_id.')

diff --git a/geopy/geocoders/ignfrance.py b/geopy/geocoders/ignfrance.py
@@ -50,6 +50,7 @@ def __init__(
             scheme=DEFAULT_SCHEME,
             timeout=DEFAULT_TIMEOUT,
             proxies=None,
+            user_agent=None,
     ):  # pylint: disable=R0913
         """
         Initialize a customized IGN France geocoder.
@@ -88,7 +89,7 @@ def __init__(
 
         """
         super(IGNFrance, self).__init__(
-            scheme=scheme, timeout=timeout, proxies=proxies
+            scheme=scheme, timeout=timeout, proxies=proxies, user_agent=user_agent
         )
 
         # Catch if no api key with username and password

diff --git a/geopy/geocoders/navidata.py b/geopy/geocoders/navidata.py
@@ -29,6 +29,7 @@ def __init__(
             domain='api.navidata.pl',
             timeout=DEFAULT_TIMEOUT,
             proxies=None,
+            user_agent=None,
     ):
         """
             .. versionadded:: 1.8.0
@@ -49,7 +50,7 @@ def __init__(
 
         """
         super(NaviData, self).__init__(
-            scheme="http", timeout=timeout, proxies=proxies
+            scheme="http", timeout=timeout, proxies=proxies, user_agent=user_agent
         )
 
         self.api_key = api_key

diff --git a/geopy/geocoders/opencage.py b/geopy/geocoders/opencage.py
@@ -30,6 +30,7 @@ def __init__(
             scheme=DEFAULT_SCHEME,
             timeout=DEFAULT_TIMEOUT,
             proxies=None,
+            user_agent=None,
     ):  # pylint: disable=R0913
         """
         Initialize a customized Open Cage Data geocoder.
@@ -52,7 +53,7 @@ def __init__(
 
         """
         super(OpenCage, self).__init__(
-            scheme=scheme, timeout=timeout, proxies=proxies
+            scheme=scheme, timeout=timeout, proxies=proxies, user_agent=user_agent
         )
 
         self.api_key = api_key

diff --git a/geopy/geocoders/openmapquest.py b/geopy/geocoders/openmapquest.py
@@ -29,6 +29,7 @@ def __init__(
             scheme=DEFAULT_SCHEME,
             timeout=DEFAULT_TIMEOUT,
             proxies=None,
+            user_agent=None,
         ):  # pylint: disable=R0913
         """
         Initialize an Open MapQuest geocoder with location-specific
@@ -60,7 +61,7 @@ def __init__(
             .. versionadded:: 0.96
         """
         super(OpenMapQuest, self).__init__(
-            format_string, scheme, timeout, proxies
+            format_string, scheme, timeout, proxies, user_agent=user_agent
         )
         self.api_key = api_key or ''
         self.api = "%s://open.mapquestapi.com/nominatim/v1/search" \

diff --git a/geopy/geocoders/osm.py b/geopy/geocoders/osm.py
@@ -42,7 +42,8 @@ def __init__(
             timeout=DEFAULT_TIMEOUT,
             proxies=None,
             domain='nominatim.openstreetmap.org',
-            scheme=DEFAULT_SCHEME
+            scheme=DEFAULT_SCHEME,
+            user_agent=None
     ):  # pylint: disable=R0913
         """
         :param string format_string: String containing '%s' where the
@@ -74,7 +75,7 @@ def __init__(
             .. versionadded:: 1.8.2
         """
         super(Nominatim, self).__init__(
-            format_string, scheme, timeout, proxies
+            format_string, scheme, timeout, proxies, user_agent=user_agent
         )
         self.country_bias = country_bias
         self.format_string = format_string
@@ -84,7 +85,6 @@ def __init__(
         self.api = "%s://%s/search" % (self.scheme, self.domain)
         self.reverse_api = "%s://%s/reverse" % (self.scheme, self.domain)
 
-
     def geocode(
             self,
             query,
@@ -157,7 +157,7 @@ def geocode(
         params.update({
             'format': 'json'
         })
-        
+
         # `viewbox` apparently replaces `view_box`
         if self.view_box:
             params['viewbox'] = ','.join(self.view_box)

diff --git a/geopy/geocoders/placefinder.py b/geopy/geocoders/placefinder.py
@@ -29,7 +29,8 @@ def __init__(
             consumer_key,
             consumer_secret,
             timeout=DEFAULT_TIMEOUT,
-            proxies=None
+            proxies=None,
+            user_agent=None,
         ):  # pylint: disable=R0913
         """
         :param string consumer_key: Key provided by Yahoo.
@@ -54,7 +55,7 @@ def __init__(
                 ' Install with `pip install geopy -e ".[placefinder]"`.'
             )
         super(YahooPlaceFinder, self).__init__(
-            timeout=timeout, proxies=proxies
+            timeout=timeout, proxies=proxies, user_agent=user_agent
         )
         self.consumer_key = (
             unicode(consumer_key)

diff --git a/geopy/geocoders/smartystreets.py b/geopy/geocoders/smartystreets.py
@@ -25,7 +25,8 @@ def __init__(
             candidates=1,
             scheme=DEFAULT_SCHEME,
             timeout=DEFAULT_TIMEOUT,
-            proxies=None
+            proxies=None,
+            user_agent=None,
         ):  # pylint: disable=R0913
         """
         Initialize a customized SmartyStreets LiveAddress geocoder.
@@ -64,7 +65,7 @@ def __init__(
             .. versionadded:: 0.96
         """
         super(LiveAddress, self).__init__(
-            timeout=timeout, proxies=proxies
+            timeout=timeout, proxies=proxies, user_agent=user_agent
         )
         if scheme == "http":
             raise ConfigurationError("LiveAddress now requires `https`.")

diff --git a/geopy/geocoders/what3words.py b/geopy/geocoders/what3words.py
@@ -36,6 +36,7 @@ def __init__(
             scheme=DEFAULT_SCHEME,
             timeout=DEFAULT_TIMEOUT,
             proxies=None,
+            user_agent=None,
     ):
         """
         Initialize a What3Words geocoder with 3-word or OneWord-address and
@@ -69,7 +70,8 @@ def __init__(
             format_string,
             scheme,
             timeout,
-            proxies
+            proxies,
+            user_agent=user_agent,
         )
         self.api_key = api_key
         self.api = (

diff --git a/geopy/geocoders/yandex.py b/geopy/geocoders/yandex.py
@@ -27,7 +27,8 @@ def __init__(
             api_key=None,
             lang=None,
             timeout=DEFAULT_TIMEOUT,
-            proxies=None
+            proxies=None,
+            user_agent=None,
         ):
         """
         Create a Yandex-based geocoder.
@@ -50,7 +51,7 @@ def __init__(
             :class:`urllib2.ProxyHandler`.
         """
         super(Yandex, self).__init__(
-            scheme='http', timeout=timeout, proxies=proxies
+            scheme='http', timeout=timeout, proxies=proxies, user_agent=user_agent
         )
         self.api_key = api_key
         self.lang = lang