batch example: print exception, write doesnt work (#45)

Author: mtmail

README.md

@@ -36,24 +36,24 @@ key = 'your-api-key-here'
 geocoder = OpenCageGeocode(key)
 ```
 
-Pass a string containing the query or address to be geocoded to the modules's `geocode` method:
+Pass a string containing the query or address to be geocoded to the modules' `geocode` method:
 
 ```python
-query = "82 Clerkenwell Road, London"
-result = geocoder.geocode(query)
+query = '82 Clerkenwell Road, London'
+results = geocoder.geocode(query)
 ```
 
 You can add [additional parameters](https://opencagedata.com/api#forward):
 
 ```python
-result = geocoder.geocode('London', no_annotations=1, language='es')
+results = geocoder.geocode('London', no_annotations=1, language='es')
 ```
 
-You can use the proximity parameter to provide the geocoder with a hint:
+For example you can use the proximity parameter to provide the geocoder with a hint:
 
 ```python
-result = geocoder.geocode('London', proximity='42.828576, -81.406643')
-print(result[0]['formatted'])
+results = geocoder.geocode('London', proximity='42.828576, -81.406643')
+print(results[0]['formatted'])
 # u'London, ON N6A 3M8, Canada'
 ```
 
@@ -63,7 +63,7 @@ print(result[0]['formatted'])
 Turn a lat/long into an address with the ``reverse_geocode`` method:
 
 ```python
-results = geocoder.reverse_geocode(51.51024, -0.10303)
+result = geocoder.reverse_geocode(51.51024, -0.10303)
 ```
 
 ### Sessions

examples/batch.py

@@ -12,36 +12,37 @@
 import csv
 import backoff
 import asyncio
+import traceback
 from opencage.geocoder import OpenCageGeocode, AioHttpError
 
 api_key = ''
 infile = 'file_to_geocode.csv'
 outfile = 'file_geocoded.csv'
 
-max_items = 100        # Set to 0 for unlimited
+max_items = 100        # How man lines to read from the input file. Set to 0 for unlimited
 num_workers = 3        # For 10 requests per second try 2-5
 timeout = 5            # For individual HTTP requests. In seconds, default is 1
 retry_max_tries = 10   # How often to retry if a HTTP request times out
 retry_max_time = 60    # Limit in seconds for retries
 
 csv_writer = csv.writer(open(outfile, 'w', newline=''))
 
-async def write_one_geocoding_result(geocoding_result, address, address_id):
-  if geocoding_result != None:
-    geocoding_result = geocoding_result[0]
+async def write_one_geocoding_result(geocoding_results, address, address_id):
+  if geocoding_results != None and len(geocoding_results):
+    first_result = geocoding_results[0]
     row = [
       address_id,
-      geocoding_result['geometry']['lat'],
-      geocoding_result['geometry']['lng'],
-      # Any of these components might be empty :
-      geocoding_result['components'].get('country', ''),
-      geocoding_result['components'].get('county', ''),
-      geocoding_result['components'].get('city', ''),
-      geocoding_result['components'].get('postcode', ''),
-      geocoding_result['components'].get('road', ''),
-      geocoding_result['components'].get('house_number', ''),
-      geocoding_result['confidence'],
-      geocoding_result['formatted']
+      first_result['geometry']['lat'],
+      first_result['geometry']['lng'],
+      # Any of the components might be empty:
+      first_result['components'].get('country', ''),
+      first_result['components'].get('county', ''),
+      first_result['components'].get('city', ''),
+      first_result['components'].get('postcode', ''),
+      first_result['components'].get('road', ''),
+      first_result['components'].get('house_number', ''),
+      first_result['confidence'],
+      first_result['formatted']
     ]
 
   else:
@@ -77,11 +78,19 @@ def backoff_hdlr(details):
                       on_backoff=backoff_hdlr)
 async def geocode_one_address(address, address_id):
   async with OpenCageGeocode(api_key) as geocoder:
-    geocoding_result = await geocoder.geocode_async(address)
+    # address -> coordinates
+    geocoding_results = await geocoder.geocode_async(address)
+
+    # coordinates -> address, e.g. '40.78,-73.97' => 101, West 91st Street, New York
+    # lon_lat = address.split(',')
+    # geocoding_result = await geocoder.reverse_geocode_async(lon_lat[0], lon_lat[1])
+    # returns a single result so we convert it to a list
+    # geocoding_results = [geocoding_result]
+
     try:
-      await write_one_geocoding_result(geocoding_result, address, address_id)
+      await write_one_geocoding_result(geocoding_results, address, address_id)
     except Exception as e:
-      sys.stderr.write(e)
+      traceback.print_exception(e, file=sys.stderr)
 
 
 

opencage/geocoder.py

@@ -115,7 +115,7 @@ class OpenCageGeocode:
 
         >>> geocoder.geocode("London")
 
-    Reverse geocode a latitude & longitude into a point:
+    Reverse geocode a latitude & longitude into a place:
 
         >>> geocoder.reverse_geocode(51.5104, -0.1021)
 
@@ -152,7 +152,7 @@ async def __aexit__(self, *args):
 
     def geocode(self, query, **kwargs):
         """
-        Given a string to search for, return the results from OpenCage's Geocoder.
+        Given a string to search for, return the list (array) of results from OpenCage's Geocoder.
 
         :param string query: String to search for
 
@@ -176,7 +176,7 @@ async def geocode_async(self, query, **kwargs):
         """
         Aync version of `geocode`.
 
-        Given a string to search for, return the results from OpenCage's Geocoder.
+        Given a string to search for, return the list (array) of results from OpenCage's Geocoder.
 
         :param string query: String to search for