Autofix flake8 lint

Author: Samuel Scully

.flake8

@@ -1,4 +1,6 @@
 [flake8]
 max-line-length = 110
 exclude = .git,__pycache__,build,dist
-ignore = 
+ignore = W503
+per-file-ignores =
+    __init__.py: F401

opencage/batch.py

@@ -13,6 +13,7 @@
 import backoff
 from opencage.geocoder import OpenCageGeocode, OpenCageGeocodeError, _query_for_reverse_geocoding, floatify_latlng
 
+
 class OpenCageBatchGeocoder():
 
     """ Called from command_line.py
@@ -83,9 +84,9 @@ async def test_request(self):
                 with suppress(KeyError):
                     free = result['rate']['limit'] == 2500
 
-                return { 'error': None, 'free': free }
+                return {'error': None, 'free': free}
         except Exception as exc:
-            return { 'error': exc }
+            return {'error': exc}
 
     async def read_input(self, csv_input, queue):
         any_warnings = False
@@ -132,18 +133,20 @@ async def read_one_line(self, row, row_id):
         if self.options.command == 'reverse':
 
             if len(address) != 2:
-                self.log(f"Line {row_id} - Expected two comma-separated values for reverse geocoding, got {address}")
+                self.log(
+                    f"Line {row_id} - Expected two comma-separated values for reverse geocoding, got {address}")
             else:
                 # _query_for_reverse_geocoding attempts to convert into numbers. We rather have it fail
                 # now than during the actual geocoding
                 try:
                     _query_for_reverse_geocoding(address[0], address[1])
-                except:
-                    self.log(f"Line {row_id} - Does not look like latitude and longitude: '{address[0]}' and '{address[1]}'")
+                except BaseException:
+                    self.log(
+                        f"Line {row_id} - Does not look like latitude and longitude: '{address[0]}' and '{address[1]}'")
                     warnings = True
                     address = []
 
-        return { 'row_id': row_id, 'address': ','.join(address), 'original_columns': row, 'warnings': warnings }
+        return {'row_id': row_id, 'address': ','.join(address), 'original_columns': row, 'warnings': warnings}
 
     async def worker(self, csv_output, queue, progress):
         while True:
@@ -163,8 +166,8 @@ async def geocode_one_address(self, csv_output, row_id, address, original_column
         def on_backoff(details):
             if not self.options.quiet:
                 sys.stderr.write("Backing off {wait:0.1f} seconds afters {tries} tries "
-                    "calling function {target} with args {args} and kwargs "
-                    "{kwargs}\n".format(**details))
+                                 "calling function {target} with args {args} and kwargs "
+                                 "{kwargs}\n".format(**details))
 
         @backoff.on_exception(backoff.expo,
                               asyncio.TimeoutError,
@@ -175,7 +178,7 @@ async def _geocode_one_address():
             async with OpenCageGeocode(self.options.api_key, domain=self.options.api_domain, sslcontext=self.sslcontext, user_agent_comment=self.user_agent_comment) as geocoder:
                 geocoding_results = None
                 response = None
-                params = { 'no_annotations': 1, 'raw_response': True, **self.options.optional_api_params }
+                params = {'no_annotations': 1, 'raw_response': True, **self.options.optional_api_params}
 
                 try:
                     if self.options.command == 'reverse':
@@ -211,7 +214,13 @@ async def _geocode_one_address():
 
         await _geocode_one_address()
 
-    async def write_one_geocoding_result(self, csv_output, row_id, geocoding_result, raw_response, original_columns):
+    async def write_one_geocoding_result(
+            self,
+            csv_output,
+            row_id,
+            geocoding_result,
+            raw_response,
+            original_columns):
         row = original_columns
 
         for column in self.options.add_columns:
@@ -226,9 +235,12 @@ async def write_one_geocoding_result(self, csv_output, row_id, geocoding_result,
             elif column in geocoding_result['geometry']:
                 row.append(self.deep_get_result_value(geocoding_result, ['geometry', column], ''))
             elif column == 'FIPS':
-                row.append(self.deep_get_result_value(geocoding_result, ['annotations', 'FIPS', 'county'], ''))
+                row.append(
+                    self.deep_get_result_value(
+                        geocoding_result, [
+                            'annotations', 'FIPS', 'county'], ''))
             elif column == 'json':
-                row.append(json.dumps(geocoding_result, separators=(',', ':'))) # Compact JSON
+                row.append(json.dumps(geocoding_result, separators=(',', ':')))  # Compact JSON
             else:
                 row.append('')
 

opencage/command_line.py

@@ -8,6 +8,7 @@
 from opencage.batch import OpenCageBatchGeocoder
 from opencage.version import __version__
 
+
 def main(args=sys.argv[1:]):
     options = parse_args(args)
 
@@ -22,6 +23,7 @@ def main(args=sys.argv[1:]):
 
             geocoder(csv_input=reader, csv_output=writer)
 
+
 def parse_args(args):
     if len(args) == 0:
         print("To display help use 'opencage -h', 'opencage forward -h' or 'opencage reverse -h'", file=sys.stderr)
@@ -33,13 +35,27 @@ def parse_args(args):
     subparsers = parser.add_subparsers(dest='command')
     subparsers.required = True
 
-    subparser_forward = subparsers.add_parser('forward', help="Forward geocode a file (input is address, add coordinates)")
-    subparser_reverse = subparsers.add_parser('reverse', help="Reverse geocode a file (input is coordinates, add full address)")
+    subparser_forward = subparsers.add_parser(
+        'forward', help="Forward geocode a file (input is address, add coordinates)")
+    subparser_reverse = subparsers.add_parser(
+        'reverse', help="Reverse geocode a file (input is coordinates, add full address)")
 
     for subparser in [subparser_forward, subparser_reverse]:
         subparser.add_argument("--api-key", required=True, type=api_key_type, help="Your OpenCage API key")
-        subparser.add_argument("--input", required=True, type=argparse.FileType('r', encoding='utf-8'), help="Input file name", metavar='FILENAME')
-        subparser.add_argument("--output", required=True, type=str, help="Output file name", metavar='FILENAME')
+        subparser.add_argument(
+            "--input",
+            required=True,
+            type=argparse.FileType(
+                'r',
+                encoding='utf-8'),
+            help="Input file name",
+            metavar='FILENAME')
+        subparser.add_argument(
+            "--output",
+            required=True,
+            type=str,
+            help="Output file name",
+            metavar='FILENAME')
 
         add_optional_arguments(subparser)
 
@@ -49,7 +65,10 @@ def parse_args(args):
         if options.overwrite:
             os.remove(options.output)
         else:
-            print(f"Error: The output file '{options.output}' already exists. You can add --overwrite to your command.", file=sys.stderr)
+            print(
+                f"Error: The output file '{
+                    options.output}' already exists. You can add --overwrite to your command.",
+                file=sys.stderr)
             sys.exit(1)
 
     if 0 in options.input_columns:
@@ -60,18 +79,44 @@ def parse_args(args):
 
 
 def add_optional_arguments(parser):
-    parser.add_argument("--headers", action="store_true", help="If the first row should be treated as a header row")
+    parser.add_argument(
+        "--headers",
+        action="store_true",
+        help="If the first row should be treated as a header row")
     default_input_cols = '1,2' if re.match(r'.*reverse', parser.prog) else '1'
-    parser.add_argument("--input-columns", type=comma_separated_type(int), default=default_input_cols, help=f"Comma-separated list of integers (default '{default_input_cols}')", metavar='')
+    parser.add_argument(
+        "--input-columns",
+        type=comma_separated_type(int),
+        default=default_input_cols,
+        help=f"Comma-separated list of integers (default '{default_input_cols}')",
+        metavar='')
     default_add_cols = 'lat,lng,_type,_category,country_code,country,state,county,_normalized_city,postcode,road,house_number,confidence,formatted'
-    parser.add_argument("--add-columns", type=comma_separated_type(str), default=default_add_cols, help=f"Comma-separated list of output columns (default '{default_add_cols}')", metavar='')
-    parser.add_argument("--workers", type=ranged_type(int, 1, 20), default=1, help="Number of parallel geocoding requests (default 1)", metavar='')
-    parser.add_argument("--timeout", type=ranged_type(int, 1, 60), default=10, help="Timeout in seconds (default 10)", metavar='')
-    parser.add_argument("--retries", type=ranged_type(int, 1, 60), default=10, help="Number of retries (default 5)", metavar='')
-    parser.add_argument("--api-domain", type=str, default="api.opencagedata.com", help="API domain (default api.opencagedata.com)", metavar='')
-    parser.add_argument("--optional-api-params", type=comma_separated_dict_type, default="", help="Extra parameters for each request (e.g. language=fr,no_dedupe=1)", metavar='')
-    parser.add_argument("--limit", type=int, default=0, help="Stop after this number of lines in the input", metavar='')
-    parser.add_argument("--unordered", action="store_true", help="Allow the output lines to be in different order (can be faster)")
+    parser.add_argument(
+        "--add-columns",
+        type=comma_separated_type(str),
+        default=default_add_cols,
+        help=f"Comma-separated list of output columns (default '{default_add_cols}')",
+        metavar='')
+    parser.add_argument("--workers", type=ranged_type(int, 1, 20), default=1,
+                        help="Number of parallel geocoding requests (default 1)", metavar='')
+    parser.add_argument("--timeout", type=ranged_type(int, 1, 60), default=10,
+                        help="Timeout in seconds (default 10)", metavar='')
+    parser.add_argument("--retries", type=ranged_type(int, 1, 60), default=10,
+                        help="Number of retries (default 5)", metavar='')
+    parser.add_argument("--api-domain", type=str, default="api.opencagedata.com",
+                        help="API domain (default api.opencagedata.com)", metavar='')
+    parser.add_argument("--optional-api-params", type=comma_separated_dict_type, default="",
+                        help="Extra parameters for each request (e.g. language=fr,no_dedupe=1)", metavar='')
+    parser.add_argument(
+        "--limit",
+        type=int,
+        default=0,
+        help="Stop after this number of lines in the input",
+        metavar='')
+    parser.add_argument(
+        "--unordered",
+        action="store_true",
+        help="Allow the output lines to be in different order (can be faster)")
     parser.add_argument("--dry-run", action="store_true", help="Read the input file but no geocoding")
     parser.add_argument("--no-progress", action="store_true", help="Display no progress bar")
     parser.add_argument("--quiet", action="store_true", help="No progress bar and no messages")
@@ -80,6 +125,7 @@ def add_optional_arguments(parser):
 
     return parser
 
+
 def api_key_type(apikey):
     pattern = re.compile(r"^(oc_gc_)?[0-9a-f]{32}$")
 

opencage/geocoder.py

@@ -17,9 +17,11 @@
 
 DEFAULT_DOMAIN = 'api.opencagedata.com'
 
+
 def backoff_max_time():
     return int(os.environ.get('BACKOFF_MAX_TIME', '120'))
 
+
 class OpenCageGeocodeError(Exception):
 
     """Base class for all errors/exceptions that can happen when geocoding."""
@@ -38,7 +40,7 @@ def __init__(self, bad_value):
         self.bad_value = bad_value
 
     def __unicode__(self):
-        return "Input must be a unicode string, not "+repr(self.bad_value)[:100]
+        return "Input must be a unicode string, not " + repr(self.bad_value)[:100]
 
     __str__ = __unicode__
 
@@ -104,8 +106,8 @@ class SSLError(OpenCageGeocodeError):
     def __unicode__(self):
         """Convert exception to a string."""
         return ("SSL Certificate error connecting to OpenCage API. This is usually due to "
-               "outdated CA root certificates of the operating system. "
-               )
+                "outdated CA root certificates of the operating system. "
+                )
 
     __str__ = __unicode__
 
@@ -131,7 +133,13 @@ class OpenCageGeocode:
 
     session = None
 
-    def __init__(self, key, protocol='https', domain=DEFAULT_DOMAIN, sslcontext=None, user_agent_comment=None):
+    def __init__(
+            self,
+            key,
+            protocol='https',
+            domain=DEFAULT_DOMAIN,
+            sslcontext=None,
+            user_agent_comment=None):
         """Constructor."""
         self.key = key
 
@@ -334,8 +342,8 @@ def _parse_request(self, query, params):
         if not isinstance(query, str):
             raise InvalidInputError(bad_value=query)
 
-        data = { 'q': query, 'key': self.key }
-        data.update(params) # Add user parameters
+        data = {'q': query, 'key': self.key}
+        data.update(params)  # Add user parameters
         return data
 
 

setup.py

@@ -1,4 +1,4 @@
-#/usr/bin/env python
+#!/usr/bin/env python
 
 import os
 import sys

test/__init__.py

@@ -1,2 +1,2 @@
 import sys
-sys.path.insert(0,'.')
+sys.path.insert(0, '.')