batch example: check for API key and minimum package version

Author: mtmail

Changes.txt

@@ -1,3 +1,8 @@
+unreleased
+  Batch example: warn if no API key present earlier
+  Batch example: some errors were not printed, e.g. invalid API key
+  Batch example: Check latest version of opencage package is used
+
 v2.3.1 Wed Nov 15 2023
   New error 'SSLError' which is more explicit in case of SSL certificate chain issues
   Allow setting a domain name (only used in test suite)

examples/batch.py

@@ -38,8 +38,10 @@
 import aiohttp
 import backoff
 import certifi
+import pkg_resources
 from tqdm import tqdm
-from opencage.geocoder import OpenCageGeocode, SSLError
+import opencage
+from opencage.geocoder import OpenCageGeocode, OpenCageGeocodeError
 
 # Use certificates from the certifi package instead of those of the operating system
 # https://pypi.org/project/certifi/
@@ -50,8 +52,6 @@
 
 
 
-
-
 API_KEY = ''
 FILENAME_INPUT_CSV = 'file_to_geocode.csv'
 FILENAME_OUTPUT_CSV = 'file_geocoded.csv'
@@ -70,10 +70,25 @@
 
 
 
+# Check OpenCage geocoder is the latest version
+#
+minimum_required_version = '2.3.1'
+package_version = pkg_resources.get_distribution('opencage').version
+if pkg_resources.parse_version(package_version) < pkg_resources.parse_version(minimum_required_version):
+    sys.stderr.write(f"At least version {minimum_required_version} of opencage geocoder package required. ")
+    sys.stderr.write(f"Try upgrading by running 'pip install --upgrade opencage'.\n")
+    sys.exit(1)
 
 
+# Check API key present
+#
+if len(API_KEY) < 32:
+    sys.stderr.write(f"API_KEY '{API_KEY}' does not look valid.\n")
+    sys.exit(1)
 
 
+# Don't overwrite output file
+#
 if os.path.exists(FILENAME_OUTPUT_CSV):
     sys.stderr.write(f"The output file '{FILENAME_OUTPUT_CSV}' already exists.\n")
     sys.exit(1)
@@ -144,6 +159,8 @@ def backoff_hdlr(details):
 async def geocode_one_address(address, address_id):
     async with OpenCageGeocode(API_KEY, domain=API_DOMAIN, sslcontext=sslcontext) as geocoder:
         global FORWARD_OR_REVERSE
+
+        geocoding_results = None
         try:
             if FORWARD_OR_REVERSE == 'reverse' or \
                 (FORWARD_OR_REVERSE == 'guess' and guess_text_is_coordinate_pair(address)):
@@ -159,9 +176,8 @@ async def geocode_one_address(address, address_id):
                 # countrycode, language, etc
                 # see the full list: https://opencagedata.com/api#forward-opt
                 geocoding_results = await geocoder.geocode_async(address, no_annotations=1)
-        except SSLError as exc:
-            sys.stderr.write(str(exc))
-
+        except OpenCageGeocodeError as exc:
+            sys.stderr.write(str(exc) + "\n")
         except Exception as exc:
             traceback.print_exception(exc, file=sys.stderr)