Merge pull request #66 from bennylope/auto_load_api_version

Change default for auto_load_api_version

Closes gh-65

Author: bennylope

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+exclude: "docs|.git|.tox|build|dist"
+default_stages: [ pre-commit ]
+fail_fast: true
+
+repos:
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: "v0.11.13"
+    hooks:
+      - id: ruff-format
+      - id: ruff-check
+

pyproject.toml

@@ -39,6 +39,9 @@ tests = [
 docs = [
     "Sphinx==7.0.1",
 ]
+dev = [
+    "pre-commit>=4.2.0",
+]
 
 [project.urls]
 Homepage = "https://github.com/bennylope/pygeocodio"

src/geocodio/__init__.py

@@ -9,6 +9,12 @@
 from geocodio.data import Address  # noqa
 from geocodio.data import Location  # noqa
 from geocodio.data import LocationCollection  # noqa
-from geocodio.data import LocationCollectionDict # noqa
+from geocodio.data import LocationCollectionDict  # noqa
 
-__all__ = [GeocodioClient, Address, Location, LocationCollection, LocationCollectionDict]
+__all__ = [
+    GeocodioClient,
+    Address,
+    Location,
+    LocationCollection,
+    LocationCollectionDict,
+]

src/geocodio/client.py

@@ -9,7 +9,7 @@
 
 logger = logging.getLogger(__name__)
 
-DEFAULT_API_VERSION = "1.6"
+DEFAULT_API_VERSION = "1.9"
 
 
 def error_response(response):
@@ -59,23 +59,51 @@ class GeocodioClient(object):
     Client connection for Geocod.io API
     """
 
-    def __init__(self, key, order="lat", version=None, hipaa_enabled=False, auto_load_api_version=True, timeout=None, custom_base_domain=None):
-        """
+    def __init__(
+        self,
+        key,
+        order="lat",
+        version=None,
+        hipaa_enabled=False,
+        auto_load_api_version=False,
+        timeout=None,
+        custom_base_domain=None,
+    ):
+        """Initialize and configure the client.
+
+        Args:
+            key: Geocodio API key
+            order: one of `lat` or `lng` to determine the ordering
+                    of latitude and longitude. The default is `lat`
+                    (lat, lng); using `lng` (lng, lat) uses a PostGIS
+                    compatible ordering
+            version: the Geocodio API version
+            hipaa_enabled: whether to use HIPAA API (if you don't know,
+                    then you don't need it!)
+            auto_load_api_version: whether to automatically select the
+                    latest API version from the Geocodio API. This *may*
+                    result in errors, i.e. during a new API version
+                    rollout.
+            timeout: request timeout
+            custom_base_domain: custom API domain
+
         """
         if custom_base_domain is None:
             self.hipaa_enabled = hipaa_enabled
             self.BASE_DOMAIN = "https://api{hipaa_append}.geocod.io".format(
-                hipaa_append=('-hipaa' if self.hipaa_enabled else ''))
+                hipaa_append=("-hipaa" if self.hipaa_enabled else "")
+            )
         else:
             self.BASE_DOMAIN = custom_base_domain
-        
 
         if version is None and auto_load_api_version:
             version = self._parse_curr_api_version(self.BASE_DOMAIN)
         # Fall back to manual default API version if couldn't be found or isn't overridden
         self.version = version or DEFAULT_API_VERSION
 
-        self.BASE_URL = "{domain}/v{version}/{{verb}}".format(domain=self.BASE_DOMAIN, version=self.version)
+        self.BASE_URL = "{domain}/v{version}/{{verb}}".format(
+            domain=self.BASE_DOMAIN, version=self.version
+        )
         self.API_KEY = key
         if order not in ("lat", "lng"):
             raise ValueError("Order but be either `lat` or `lng`")
@@ -105,7 +133,11 @@ def _req(self, method="get", verb=None, headers={}, params={}, data={}):
         request_headers.update(headers)
         request_params.update(params)
         return getattr(requests, method)(
-            url, params=request_params, headers=request_headers, data=data, timeout=self.timeout
+            url,
+            params=request_params,
+            headers=request_headers,
+            data=data,
+            timeout=self.timeout,
         )
 
     def parse(self, address):
@@ -237,13 +269,19 @@ def geocode(self, address_data=None, components_data=None, **kwargs):
         use_components = components_data is not None and address_data is None
         param_data = components_data if use_components else address_data
 
-        use_batch = isinstance(param_data, list) or (not use_components and isinstance(param_data, dict)) or (
-                    use_components and isinstance(param_data, dict) and all(
-                        isinstance(c, dict) for c in param_data.values()))
+        use_batch = (
+            isinstance(param_data, list)
+            or (not use_components and isinstance(param_data, dict))
+            or (
+                use_components
+                and isinstance(param_data, dict)
+                and all(isinstance(c, dict) for c in param_data.values())
+            )
+        )
         if use_batch:
             return self.batch_geocode(param_data, **kwargs)
         else:
-            param_key = 'components' if use_components else 'address'
+            param_key = "components" if use_components else "address"
             kwargs.update({param_key: param_data})
             return self.geocode_address(**kwargs)
 

src/geocodio/data.py

@@ -120,7 +120,9 @@ def __init__(self, results_list, order="lat"):
         for index, result in enumerate(results_list):
             results.append(Location(result["response"], order=order))
             orig_query = result["query"]
-            lookup_key = json.dumps(orig_query) if isinstance(orig_query, dict) else orig_query
+            lookup_key = (
+                json.dumps(orig_query) if isinstance(orig_query, dict) else orig_query
+            )
             lookups[lookup_key] = index
 
         super().__init__(results)
@@ -135,7 +137,9 @@ def __getitem__(self, item):
             try:
                 ind = self.lookups[key]
             except KeyError as e:
-                raise IndexError("Invalid Index From Lookup For Location Collection") from e
+                raise IndexError(
+                    "Invalid Index From Lookup For Location Collection"
+                ) from e
         return super().__getitem__(ind)
 
     def get(self, key, default=None):
@@ -178,7 +182,9 @@ def __init__(self, results_list, order="lat"):
         for key, result in results_list.items():
             results[key] = Location(result["response"], order=order)
             orig_query = result["query"]
-            lookup_key = json.dumps(orig_query) if isinstance(orig_query, dict) else orig_query
+            lookup_key = (
+                json.dumps(orig_query) if isinstance(orig_query, dict) else orig_query
+            )
             lookups[lookup_key] = key
 
         super().__init__(results)
@@ -187,7 +193,9 @@ def __init__(self, results_list, order="lat"):
 
     def __contains__(self, value):
         key = LocationCollectionUtils.get_lookup_key(value)
-        return super().__contains__(key) or (key in self.lookups and super().__contains__(self.lookups[key]))
+        return super().__contains__(key) or (
+            key in self.lookups and super().__contains__(self.lookups[key])
+        )
 
     def __getitem__(self, item):
         key = LocationCollectionUtils.get_lookup_key(item)
@@ -209,11 +217,11 @@ def coords(self):
         """
         Returns a dict of tuples for the best matched coordinates.
         """
-        return {k: l.coords for k, l in self.items()}
+        return {k: v.coords for k, v in self.items()}
 
     @property
     def formatted_addresses(self):
         """
         Returns a dict of formatted addresses from the Location list
         """
-        return {k: l.formatted_address for k, l in self.items()}
+        return {k: v.formatted_address for k, v in self.items()}