smartystreets-python-sdk 8.0.0__tar.gz → 8.2.0__tar.gz

{smartystreets_python_sdk-8.0.0 → smartystreets_python_sdk-8.2.0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: smartystreets_python_sdk
-Version: 8.0.0
+Version: 8.2.0
 Summary: An official library to help Python developers easily access the SmartyStreets APIs
 Home-page: https://github.com/smartystreets/smartystreets-python-sdk
-Download-URL: https://github.com/smartystreets/smartystreets-python-sdk/tarball/8.0.0
+Download-URL: https://github.com/smartystreets/smartystreets-python-sdk/tarball/8.2.0
 Author: SmartyStreets SDK Team
 Author-email: support@smartystreets.com
 License: Apache 2

{smartystreets_python_sdk-8.0.0 → smartystreets_python_sdk-8.2.0}/smartystreets_python_sdk/international_autocomplete/__init__.py

@@ -1,3 +1,4 @@
 from .candidate import Candidate
 from .lookup import Lookup
 from .client import Client
+from .language_mode import LanguageMode

{smartystreets_python_sdk-8.0.0 → smartystreets_python_sdk-8.2.0}/smartystreets_python_sdk/international_autocomplete/client.py

@@ -1,6 +1,7 @@
 from smartystreets_python_sdk import Request
 from smartystreets_python_sdk.exceptions import SmartyException
 from smartystreets_python_sdk.international_autocomplete import Candidate
+from smartystreets_python_sdk.international_autocomplete.language_mode import LanguageMode
 
 
 class Client:
@@ -45,6 +46,7 @@ class Client:
             self.add_parameter(request, 'geolocation', 'on')
         self.add_parameter(request, 'include_only_locality', lookup.locality)
         self.add_parameter(request, 'include_only_postal_code', lookup.postal_code)
+        self.add_parameter(request, 'language', self.normalized_language(lookup.language))
 
         for parameter in lookup.custom_parameter_array:
             self.add_parameter(request, parameter, lookup.custom_parameter_array[parameter])
@@ -59,3 +61,9 @@ class Client:
     def add_parameter(request, key, value):
         if value and value != 'none':
             request.parameters[key] = value
+
+    @staticmethod
+    def normalized_language(language):
+        if language is None:
+            return None
+        return LanguageMode.from_value(language).value

{smartystreets_python_sdk-8.0.0 → smartystreets_python_sdk-8.2.0}/smartystreets_python_sdk/international_autocomplete/lookup.py

@@ -1,6 +1,6 @@
 class Lookup:
     def __init__(self, search=None, address_id=None, country=None, max_results=5, max_group_results=100,
-                 geolocation=False, locality=None, postal_code=None):
+                 geolocation=False, locality=None, postal_code=None, language=None):
         """
         In addition to holding all the input data for this lookup, this class also will contain the result
         of the lookup after it comes back from the API.
@@ -10,6 +10,7 @@ class Lookup:
         :param administrative_area: Limit the results to only the administrative area provided
         :param locality: Limit the results to only the locality provided
         :param postal_code: Limit the results to only the postal code provided
+        :param language: The output language, Native or Latin (defaults to the country's language)
         """
         self.result = []
 
@@ -22,6 +23,7 @@ class Lookup:
         self.geolocation = geolocation
         self.locality = locality
         self.postal_code = postal_code
+        self.language = language
 
     def add_custom_parameter(self, parameter, value):
         self.custom_parameter_array[parameter] = value

{smartystreets_python_sdk-8.0.0 → smartystreets_python_sdk-8.2.0}/smartystreets_python_sdk/international_postal_code/__init__.py

@@ -1,3 +1,4 @@
 from .candidate import Candidate
 from .lookup import Lookup
 from .client import Client
+from .language_mode import LanguageMode

{smartystreets_python_sdk-8.0.0 → smartystreets_python_sdk-8.2.0}/smartystreets_python_sdk/international_postal_code/candidate.py

@@ -12,3 +12,4 @@ class Candidate:
         self.double_dependent_locality = obj.get('double_dependent_locality', None)
         self.postal_code = obj.get('postal_code', None)
         self.postal_code_extra = obj.get('postal_code_extra', None)
+        self.thoroughfare = obj.get('thoroughfare', None)

{smartystreets_python_sdk-8.0.0 → smartystreets_python_sdk-8.2.0}/smartystreets_python_sdk/international_postal_code/client.py

@@ -1,5 +1,7 @@
 from smartystreets_python_sdk import Request
 from smartystreets_python_sdk.international_postal_code import Candidate
+from smartystreets_python_sdk.international_postal_code.language_mode import LanguageMode
+from smartystreets_python_sdk.max_results import normalize_max_results
 
 class Client:
     def __init__(self, sender, serializer):
@@ -24,9 +26,11 @@ class Client:
         request = Request()
         self.add_parameter(request, 'input_id', lookup.input_id)
         self.add_parameter(request, 'country', lookup.country)
+        self.add_parameter(request, 'language', self.normalized_language(lookup.language))
         self.add_parameter(request, 'locality', lookup.locality)
         self.add_parameter(request, 'administrative_area', lookup.administrative_area)
         self.add_parameter(request, 'postal_code', lookup.postal_code)
+        self.add_parameter(request, 'max_results', normalize_max_results(lookup.max_results))
         return request
 
     @staticmethod
@@ -37,3 +41,9 @@ class Client:
     def add_parameter(request, key, value):
         if value and value != 'none':
             request.parameters[key] = value
+
+    @staticmethod
+    def normalized_language(language):
+        if language is None:
+            return None
+        return LanguageMode.from_value(language).value

smartystreets_python_sdk-8.2.0/smartystreets_python_sdk/international_postal_code/language_mode.py

@@ -0,0 +1,27 @@
+from enum import Enum
+
+from smartystreets_python_sdk.exceptions import UnprocessableEntityError
+
+
+class LanguageMode(Enum):
+    """
+    A closed set of valid Language values, the closest Python equivalent to an enum-constrained field.
+    """
+    NATIVE = 'native'
+    LATIN = 'latin'
+
+    @staticmethod
+    def from_value(value):
+        """
+        Resolves a LanguageMode instance or a raw value (eg. from user input or config) into a LanguageMode,
+        matching 'native'/'latin' regardless of case.
+        """
+        if isinstance(value, LanguageMode):
+            return value
+
+        for mode in LanguageMode:
+            if str(value).lower() == mode.value:
+                return mode
+
+        raise UnprocessableEntityError(
+            "invalid Language value; must be unset, 'native', or 'latin' (case-insensitive)")

smartystreets_python_sdk-8.2.0/smartystreets_python_sdk/international_postal_code/lookup.py

@@ -0,0 +1,43 @@
+from smartystreets_python_sdk.international_postal_code.language_mode import LanguageMode
+from smartystreets_python_sdk.max_results import normalize_max_results
+
+
+class Lookup:
+    def __init__(self):
+        """
+        In addition to holding all the input data for this lookup, this class also will contain the result
+        of the lookup after it comes back from the API.
+
+        See "https://smartystreets.com/docs/cloud/international-postal-code-api"
+
+        :field self.language: When not set, results are returned using the Latin character set.
+            When set to LanguageMode.NATIVE (JPN only), results are returned in the native character set for that country.
+            When set to LanguageMode.LATIN, results use the Latin character set with accents and other diacritics removed.
+        :field self.max_results: The maximum number of results to return. Sent only when greater than 0.
+        """
+        self.results = []
+
+        self.input_id = None
+        self.country = None
+        self.language = None
+        self.locality = None
+        self.administrative_area = None
+        self.postal_code = None
+        self.max_results = None
+
+    def populate(self, params):
+        if self.input_id:
+            params['input_id'] = self.input_id
+        if self.country:
+            params['country'] = self.country
+        if self.language is not None:
+            params['language'] = LanguageMode.from_value(self.language).value
+        if self.locality:
+            params['locality'] = self.locality
+        if self.administrative_area:
+            params['administrative_area'] = self.administrative_area
+        if self.postal_code:
+            params['postal_code'] = self.postal_code
+        max_results = normalize_max_results(self.max_results)
+        if max_results is not None:
+            params['max_results'] = max_results

{smartystreets_python_sdk-8.0.0 → smartystreets_python_sdk-8.2.0}/smartystreets_python_sdk/international_street/client.py

@@ -1,6 +1,7 @@
 from smartystreets_python_sdk import Request
 from smartystreets_python_sdk.international_street import Candidate
 from smartystreets_python_sdk.international_street.language_mode import LanguageMode
+from smartystreets_python_sdk.max_results import normalize_max_results
 
 
 class Client:
@@ -44,6 +45,7 @@ class Client:
         self.add_parameter(request, 'administrative_area', lookup.administrative_area)
         self.add_parameter(request, 'postal_code', lookup.postal_code)
         self.add_parameter(request, 'features', lookup.features)
+        self.add_parameter(request, 'max_results', normalize_max_results(lookup.max_results))
 
         for parameter in lookup.custom_parameter_array:
             self.add_parameter(request, parameter, lookup.custom_parameter_array[parameter])

smartystreets_python_sdk-8.2.0/smartystreets_python_sdk/international_street/language_mode.py

@@ -0,0 +1,27 @@
+from enum import Enum
+
+from smartystreets_python_sdk.exceptions import UnprocessableEntityError
+
+
+class LanguageMode(Enum):
+    """
+    A closed set of valid Language values, the closest Python equivalent to an enum-constrained field.
+    """
+    NATIVE = 'native'
+    LATIN = 'latin'
+
+    @staticmethod
+    def from_value(value):
+        """
+        Resolves a LanguageMode instance or a raw value (eg. from user input or config) into a LanguageMode,
+        matching 'native'/'latin' regardless of case.
+        """
+        if isinstance(value, LanguageMode):
+            return value
+
+        for mode in LanguageMode:
+            if str(value).lower() == mode.value:
+                return mode
+
+        raise UnprocessableEntityError(
+            "invalid Language value; must be unset, 'native', or 'latin' (case-insensitive)")

{smartystreets_python_sdk-8.0.0 → smartystreets_python_sdk-8.2.0}/smartystreets_python_sdk/international_street/lookup.py

@@ -17,6 +17,7 @@ class Lookup:
         :field self.language: When not set, the output language will match the language of the input values.
             When set to language_mode.NATIVE, the results will always be in the language of the output country.
             When set to language_mode.LATIN, the results will always be provided using a Latin character set.
+        :field self.max_results: The maximum number of candidates to return. Sent only when greater than 0.
         """
         self.result = []
 
@@ -35,6 +36,7 @@ class Lookup:
         self.administrative_area = None
         self.postal_code = None
         self.features = None
+        self.max_results = None
 
     @property
     def missing_country(self):

smartystreets_python_sdk-8.2.0/smartystreets_python_sdk/max_results.py

@@ -0,0 +1,30 @@
+import re
+
+from smartystreets_python_sdk.exceptions import UnprocessableEntityError
+
+_WHOLE_NUMBER = re.compile(r'\s*[+-]?\d+\s*')
+
+
+def normalize_max_results(value):
+    """
+    Shared handling for the max_results input: accepts a whole number (or a string holding one),
+    and returns it as an int only when it is above 0. Returns None when it shouldn't be sent
+    (unset, blank, or 0 and below); anything that isn't a whole number raises.
+    """
+    if value is None or (isinstance(value, str) and not value.strip()):
+        return None
+
+    number = None
+    if isinstance(value, bool):
+        number = None
+    elif isinstance(value, int):
+        number = value
+    elif isinstance(value, float) and value.is_integer():
+        number = int(value)
+    elif isinstance(value, str) and _WHOLE_NUMBER.fullmatch(value):
+        number = int(value)
+
+    if number is None:
+        raise UnprocessableEntityError("invalid max_results value; must be a whole number")
+
+    return number if number > 0 else None

{smartystreets_python_sdk-8.0.0 → smartystreets_python_sdk-8.2.0}/smartystreets_python_sdk.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: smartystreets_python_sdk
-Version: 8.0.0
+Version: 8.2.0
 Summary: An official library to help Python developers easily access the SmartyStreets APIs
 Home-page: https://github.com/smartystreets/smartystreets-python-sdk
-Download-URL: https://github.com/smartystreets/smartystreets-python-sdk/tarball/8.0.0
+Download-URL: https://github.com/smartystreets/smartystreets-python-sdk/tarball/8.2.0
 Author: SmartyStreets SDK Team
 Author-email: support@smartystreets.com
 License: Apache 2

{smartystreets_python_sdk-8.0.0 → smartystreets_python_sdk-8.2.0}/smartystreets_python_sdk.egg-info/SOURCES.txt

@@ -11,6 +11,7 @@ smartystreets_python_sdk/custom_query_sender.py
 smartystreets_python_sdk/errors.py
 smartystreets_python_sdk/exceptions.py
 smartystreets_python_sdk/license_sender.py
+smartystreets_python_sdk/max_results.py
 smartystreets_python_sdk/native_serializer.py
 smartystreets_python_sdk/proxy.py
 smartystreets_python_sdk/request.py
@@ -30,10 +31,12 @@ smartystreets_python_sdk.egg-info/top_level.txt
 smartystreets_python_sdk/international_autocomplete/__init__.py
 smartystreets_python_sdk/international_autocomplete/candidate.py
 smartystreets_python_sdk/international_autocomplete/client.py
+smartystreets_python_sdk/international_autocomplete/language_mode.py
 smartystreets_python_sdk/international_autocomplete/lookup.py
 smartystreets_python_sdk/international_postal_code/__init__.py
 smartystreets_python_sdk/international_postal_code/candidate.py
 smartystreets_python_sdk/international_postal_code/client.py
+smartystreets_python_sdk/international_postal_code/language_mode.py
 smartystreets_python_sdk/international_postal_code/lookup.py
 smartystreets_python_sdk/international_street/__init__.py
 smartystreets_python_sdk/international_street/analysis.py

{smartystreets_python_sdk-8.0.0 → smartystreets_python_sdk-8.2.0}/smartystreets_python_sdk_version/__init__.py

@@ -1,2 +1,2 @@
 __version__ = '0.0.0'  # DO NOT EDIT (this is updated by a build job when a new release is published)
-__version__="8.0.0"
+__version__="8.2.0"

smartystreets_python_sdk-8.0.0/smartystreets_python_sdk/international_postal_code/lookup.py

@@ -1,27 +0,0 @@
-class Lookup:
-    def __init__(self):
-        """
-        In addition to holding all the input data for this lookup, this class also will contain the result
-        of the lookup after it comes back from the API.
-        
-        See "https://smartystreets.com/docs/cloud/international-postal-code-api"
-        """
-        self.results = []
-        
-        self.input_id = None
-        self.country = None
-        self.locality = None
-        self.administrative_area = None
-        self.postal_code = None
-
-    def populate(self, params):
-        if self.input_id:
-            params['input_id'] = self.input_id
-        if self.country:
-            params['country'] = self.country
-        if self.locality:
-            params['locality'] = self.locality
-        if self.administrative_area:
-            params['administrative_area'] = self.administrative_area
-        if self.postal_code:
-            params['postal_code'] = self.postal_code