Type hinting changes for mypy compatibility (#140)

This commit includes the following changes :

- Add py.typed in manifest files, for including type stubs on dist files.
- Added mypy.ini file with configurations
- Made some generic class changes for mypy to realize the relationships bwn abstract and implemented classes
- Added no-strict-optionals for some packages in mypy.ini, will enhance to remove them slowly

Author: nikhilym

ask-sdk-core/MANIFEST.in

@@ -2,4 +2,5 @@ include README.rst
 include CHANGELOG.rst
 include LICENSE
 include requirements.txt
-recursive-exclude tests *
+recursive-exclude tests *
+recursive-include ask_sdk_core py.typed

ask-sdk-core/ask_sdk_core/api_client.py

@@ -27,7 +27,7 @@
 from .exceptions import ApiClientException
 
 if typing.TYPE_CHECKING:
-    from typing import Callable, Dict, List, Tuple
+    from typing import Callable, Dict, List, Tuple, Optional
     from ask_sdk_model.services import ApiClientRequest
 
 
@@ -66,15 +66,14 @@ def invoke(self, request):
                 raise ApiClientException(
                     "Requests against non-HTTPS endpoints are not allowed.")
 
+            raw_data = None  # type: Optional[str]
             if request.body:
                 body_content_type = http_headers.get("Content-type", None)
                 if (body_content_type is not None and
                         "json" in body_content_type):
                     raw_data = json.dumps(request.body)
                 else:
                     raw_data = request.body
-            else:
-                raw_data = None
 
             http_response = http_method(
                 url=request.url, headers=http_headers, data=raw_data)
@@ -101,7 +100,11 @@ def _resolve_method(self, request):
             if invalid http request method is being called
         """
         try:
-            return getattr(requests, request.method.lower())
+            if request.method is not None:
+                return getattr(requests, request.method.lower())
+            else:
+                raise ApiClientException(
+            "Invalid request method: {}".format(request.method))
         except AttributeError:
             raise ApiClientException(
                 "Invalid request method: {}".format(request.method))

ask-sdk-core/ask_sdk_core/attributes_manager.py

@@ -22,7 +22,7 @@
 from .exceptions import AttributesManagerException
 
 if typing.TYPE_CHECKING:
-    from typing import Dict, Optional
+    from typing import Dict, Optional, Any
     from ask_sdk_model import RequestEnvelope
 
 
@@ -102,14 +102,13 @@ def __init__(self, request_envelope, persistence_adapter=None):
         self._persistence_adapter = persistence_adapter
         self._persistence_attributes = {}  # type: Dict
         self._request_attributes = {}  # type: Dict
-        if not self._request_envelope.session:
-            self._session_attributes = None  # type: Optional[Dict]
+        if request_envelope.session is None:
+            self._session_attributes = None  # type: Optional[Dict[str, Any]]
+        elif request_envelope.session.attributes is None:
+            self._session_attributes = {}
         else:
-            if not self._request_envelope.session.attributes:
-                self._session_attributes = {}
-            else:
-                self._session_attributes = deepcopy(
-                    request_envelope.session.attributes)
+            self._session_attributes = deepcopy(
+                request_envelope.session.attributes)
         self._persistent_attributes_set = False
 
     @property
@@ -134,7 +133,7 @@ def request_attributes(self, request_attributes):
 
     @property
     def session_attributes(self):
-        # type: () -> Dict[str, object]
+        # type: () -> Optional[Dict[str, Any]]
         """Attributes stored at the Session level of the skill lifecycle.
 
         :return: session attributes extracted from request envelope

ask-sdk-core/ask_sdk_core/serialize.py

@@ -41,7 +41,8 @@
     long = int
 
 if typing.TYPE_CHECKING:
-    from typing import TypeVar, Dict, List, Tuple, Union, Any
+    from typing import (
+        TypeVar, Dict, List, Tuple, Union, Any, Optional)
     T = TypeVar('T')
 
 
@@ -125,7 +126,7 @@ def serialize(self, obj):  # type: ignore
         return {key: self.serialize(val) for key, val in iteritems(obj_dict)}
 
     def deserialize(self, payload, obj_type):
-        # type: (str, Union[T, str]) -> Any
+        # type: (Optional[str], Union[T, str]) -> Any
         """Deserializes payload into an instance of provided ``obj_type``.
 
         The ``obj_type`` parameter can be a primitive type, a generic
@@ -169,7 +170,7 @@ class should also have the ``__init__`` method with default
         return self.__deserialize(payload, obj_type)
 
     def __deserialize(self, payload, obj_type):
-        # type: (str, Union[T, str]) -> Any
+        # type: (Optional[str], Union[T, str]) -> Any
         """Deserializes payload into a model object.
 
         :param payload: data to be deserialized.

ask-sdk-core/ask_sdk_core/skill.py

@@ -34,7 +34,7 @@
 if typing.TYPE_CHECKING:
     from typing import List, Dict, Any
     from ask_sdk_model.services import ApiClient
-    from ask_sdk_model import RequestEnvelope
+    from ask_sdk_model import RequestEnvelope, Response
     from ask_sdk_runtime.dispatch_components import (
         GenericRequestMapper, GenericHandlerAdapter, GenericExceptionMapper,
         AbstractRequestInterceptor, AbstractResponseInterceptor)
@@ -204,7 +204,7 @@ def invoke(self, request_envelope, context):
             template_factory=template_factory)
 
         response = self.request_dispatcher.dispatch(
-            handler_input=handler_input)
+            handler_input=handler_input)  # type: Response
         session_attributes = None
 
         if request_envelope.session is not None:

ask-sdk-core/ask_sdk_core/skill_builder.py

@@ -50,7 +50,8 @@ def skill_configuration(self):
         """Create the skill configuration object using the
         registered components.
         """
-        self.runtime_configuration = self.runtime_configuration_builder.get_runtime_configuration()
+        self.runtime_configuration = self.runtime_configuration_builder.get_runtime_configuration() 
+        self.runtime_configuration = typing.cast(SkillConfiguration, self.runtime_configuration)
         self.runtime_configuration.custom_user_agent = self.custom_user_agent
         self.runtime_configuration.skill_id = self.skill_id
         self.runtime_configuration = self.__populate_missing_attributes(

ask-sdk-core/ask_sdk_core/utils/view_resolver.py

@@ -22,11 +22,11 @@
 import re
 
 if typing.TYPE_CHECKING:
-    from typing import Any, Sequence
+    from typing import Any, Sequence, Optional
 
 
 def split_locale(locale):
-    # type: (str) -> Sequence[str]
+    # type: (str) -> Sequence[Optional[str]]
     """Function to extract language and country codes from the locale.
 
     :param locale: A string indicating the user’s locale. For example: en-US.

ask-sdk-core/ask_sdk_core/view_resolvers/locale_template_enumerator.py

@@ -42,7 +42,7 @@ class LocaleTemplateEnumerator(AbstractTemplateEnumerator):
     __instance = None
 
     def __new__(cls):
-        # type: (Type[object]) -> AbstractTemplateEnumerator
+        # type: (Type[object]) -> LocaleTemplateEnumerator
         """Creating a singleton class to re-use same enumerator instance for
         different locale and template values.
         """

ask-sdk-dynamodb-persistence-adapter/MANIFEST.in

@@ -2,4 +2,5 @@ include README.rst
 include CHANGELOG.rst
 include LICENSE
 include requirements.txt
-recursive-exclude tests *
+recursive-exclude tests *
+recursive-include ask_sdk_dynamodb py.typed

ask-sdk-jinja-renderer/MANIFEST.in

@@ -2,4 +2,5 @@ include README.rst
 include CHANGELOG.rst
 include LICENSE
 include requirements.txt
-recursive-exclude tests *
+recursive-exclude tests *
+recursive-include ask_sdk_jinja_renderer py.typed