strip down pylintrc config file (#33)

Author: mtmail

examples/demo.py

@@ -1,9 +1,21 @@
+from pprint import pprint
 from opencage.geocoder import OpenCageGeocode
 
-key = 'your-key-here'
+APIKEY = 'your-key-here'
 
-geocoder = OpenCageGeocode(key)
+geocoder = OpenCageGeocode(APIKEY)
 
-query = '182 Clerkenwell Road, London'
-ret = geocoder.geocode(query)
-print(ret._content)
+results = geocoder.reverse_geocode(44.8303087, -0.5761911)
+pprint(results)
+# [{'components': {'city': 'Bordeaux',
+#                  'country': 'France',
+#                  'country_code': 'fr',
+#                  'county': 'Bordeaux',
+#                  'house_number': '11',
+#                  'political_union': 'European Union',
+#                  'postcode': '33800',
+#                  'road': 'Rue Sauteyron',
+#                  'state': 'New Aquitaine',
+#                  'suburb': 'Bordeaux Sud'},
+#   'formatted': '11 Rue Sauteyron, 33800 Bordeaux, France',
+#   'geometry': {'lat': 44.8303087, 'lng': -0.5761911}}]

examples/flask_demo.py

@@ -14,7 +14,8 @@
 def forward(address):
     verbose = json.loads(request.args.get('verbose', "false").lower())
     raw_result = _geocoder.geocode(address)
-    return json.dumps(raw_result if verbose else [{"confidence": r["confidence"], "geometry": r["geometry"]} for r in raw_result if r["confidence"]])
+    formatted = [{"confidence": r["confidence"], "geometry": r["geometry"]} for r in raw_result if r["confidence"]]
+    return json.dumps(raw_result if verbose else formatted)
 
 @app.route("/reverse/<lat>/<lng>/")
 def reverse(lat, lng):

opencage/geocoder.py

@@ -10,9 +10,9 @@
 
 try:
     import aiohttp
-    aiohttp_avaiable = True
+    AIOHTTP_AVAILABLE = True
 except ImportError:
-    aiohttp_avaiable = False
+    AIOHTTP_AVAILABLE = False
 
 def backoff_max_time():
     return int(os.environ.get('BACKOFF_MAX_TIME', '120'))
@@ -62,7 +62,9 @@ def __init__(self, reset_time, reset_to):
 
     def __unicode__(self):
         """Convert exception to a string."""
-        return f"Your rate limit has expired. It will reset to {self.reset_to} on {self.reset_time.isoformat()}"
+        return ("Your rate limit has expired. "
+                f"It will reset to {self.reset_to} on {self.reset_time.isoformat()}"
+                )
 
     __str__ = __unicode__
 
@@ -137,7 +139,7 @@ def __exit__(self, *args):
         return False
 
     async def __aenter__(self):
-        if not aiohttp_avaiable:
+        if not AIOHTTP_AVAILABLE:
             raise AioHttpError("You must install `aiohttp` to use async methods")
 
         self.session = aiohttp.ClientSession()
@@ -156,7 +158,8 @@ def geocode(self, query, **kwargs):
 
         :returns: Dict results
         :raises InvalidInputError: if the query string is not a unicode string
-        :raises RateLimitExceededError: if you have exceeded the number of queries you can make. Exception says when you can try again
+        :raises RateLimitExceededError: if you have exceeded the number of queries you can make.
+        :                                  Exception says when you can try again
         :raises UnknownError: if something goes wrong with the OpenCage API
 
         """
@@ -179,12 +182,12 @@ async def geocode_async(self, query, **kwargs):
 
         :returns: Dict results
         :raises InvalidInputError: if the query string is not a unicode string
-        :raises RateLimitExceededError: if you have exceeded the number of queries you can make. Exception says when you can try again
+        :raises RateLimitExceededError: if exceeded number of queries you can make. You can try again
         :raises UnknownError: if something goes wrong with the OpenCage API
 
         """
 
-        if not aiohttp_avaiable:
+        if not AIOHTTP_AVAILABLE:
             raise AioHttpError("You must install `aiohttp` to use async methods.")
 
         if not self.session:
@@ -206,7 +209,8 @@ def reverse_geocode(self, lat, lng, **kwargs):
         :param lng: Longitude
         :return: Results from OpenCageData
         :rtype: dict
-        :raises RateLimitExceededError: if you have exceeded the number of queries you can make. Exception says when you can try again
+        :raises RateLimitExceededError: if you have exceeded the number of queries you can make.
+        :                                  Exception says when you can try again
         :raises UnknownError: if something goes wrong with the OpenCage API
         """
         return self.geocode(_query_for_reverse_geocoding(lat, lng), **kwargs)
@@ -221,7 +225,7 @@ async def reverse_geocode_async(self, lat, lng, **kwargs):
         :param lng: Longitude
         :return: Results from OpenCageData
         :rtype: dict
-        :raises RateLimitExceededError: if you have exceeded the number of queries you can make. Exception says when you can try again
+        :raises RateLimitExceededError: if exceeded number of queries you can make. You can try again
         :raises UnknownError: if something goes wrong with the OpenCage API
         """
         return await self.geocode_async(_query_for_reverse_geocoding(lat, lng), **kwargs)
@@ -239,8 +243,8 @@ def _opencage_request(self, params):
 
         try:
             response_json = response.json()
-        except ValueError as e:
-            raise UnknownError("Non-JSON result from server") from e
+        except ValueError as excinfo:
+            raise UnknownError("Non-JSON result from server") from excinfo
 
         if response.status_code == 401:
             raise NotAuthorizedError()
@@ -250,8 +254,11 @@ def _opencage_request(self, params):
 
         if response.status_code in (402, 429):
             # Rate limit exceeded
-            reset_time = datetime.utcfromtimestamp(response_json['rate']['reset'])
-            raise RateLimitExceededError(reset_to=int(response_json['rate']['limit']), reset_time=reset_time)
+            reset_time = datetime.utcfromtimestamp(response.json()['rate']['reset'])
+            raise RateLimitExceededError(
+                reset_to=int(response.json()['rate']['limit']),
+                reset_time=reset_time
+            )
 
         if response.status_code == 500:
             raise UnknownError("500 status code from API")
@@ -265,8 +272,8 @@ async def _opencage_async_request(self, params):
         async with self.session.get(self.url, params=params) as response:
             try:
                 response_json = await response.json()
-            except ValueError as e:
-                raise UnknownError("Non-JSON result from server") from e
+            except ValueError as excinfo:
+                raise UnknownError("Non-JSON result from server") from excinfo
 
             if response.status == 401:
                 raise NotAuthorizedError()
@@ -278,7 +285,10 @@ async def _opencage_async_request(self, params):
                 # Rate limit exceeded
                 print(response_json)
                 reset_time = datetime.utcfromtimestamp(response_json['rate']['reset'])
-                raise RateLimitExceededError(reset_to=int(response_json['rate']['limit']), reset_time=reset_time)
+                raise RateLimitExceededError(
+                    reset_to=int(response_json['rate']['limit']),
+                    reset_time=reset_time
+                )
 
             if response.status == 500:
                 raise UnknownError("500 status code from API")
@@ -336,9 +346,10 @@ def floatify_latlng(input_value):
         if len(input_value) == 2 and sorted(input_value.keys()) == ['lat', 'lng']:
             # This dict has only 2 keys 'lat' & 'lon'
             return {'lat': float_if_float(input_value["lat"]), 'lng': float_if_float(input_value["lng"])}
-        else:
-            return dict((key, floatify_latlng(value)) for key, value in input_value.items())
-    elif isinstance(input_value, collections.abc.MutableSequence):
+
+        return dict((key, floatify_latlng(value)) for key, value in input_value.items())
+
+    if isinstance(input_value, collections.abc.MutableSequence):
         return [floatify_latlng(x) for x in input_value]
-    else:
-        return input_value
+
+    return input_value