Merge pull request #7 from studio3104/typehinting

Apply type hints

Author: studio3104

pytest_chalice/fixtures.py

@@ -1,10 +1,15 @@
 # -*- coding: utf-8 -*-
 
+from typing import Iterator
+
 import pytest
 
+from chalice import Chalice
+
 from .handlers import RequestHandler
 
 
 @pytest.fixture
 def client(app):
+    # type: (Chalice) -> Iterator[Chalice]
     yield RequestHandler(app)

pytest_chalice/handlers.py

@@ -1,9 +1,12 @@
 # -*- coding: utf-8 -*-
 
+from typing import Any, Callable, Dict
+
 import json
 from logging import getLogger
 import re
 
+from chalice import Chalice
 from chalice.config import Config
 from chalice.local import LocalGateway
 
@@ -16,18 +19,22 @@
 
 class InternalLocalGateway(LocalGateway):
     def __init__(self, *args, **kwargs):
+        # type: (Any, Any) -> None
         self.custom_context = {}
         super(InternalLocalGateway, self).__init__(*args, **kwargs)
 
     @property
     def custom_context(self):
+        # type: () -> Dict[str, Any]
         return self.__custom_context
 
     @custom_context.setter
     def custom_context(self, context):
+        # type: (Dict[str, Any]) -> None
         self.__custom_context = context
 
     def _generate_lambda_event(self, *args, **kwargs):
+        # type: (Any, Any) -> Dict[str, Any]
         event = super(InternalLocalGateway, self)._generate_lambda_event(*args, **kwargs)
         event['requestContext'].update(self.custom_context)
         return event
@@ -38,6 +45,7 @@ def _generate_lambda_event(self, *args, **kwargs):
 
 class ResponseHandler(object):
     def __init__(self, values):
+        # type: (Dict[str, Any]) -> None
         self.values = {}
 
         for key, value in values.items():
@@ -46,10 +54,11 @@ def __init__(self, values):
 
         try:
             self.values['json'] = json.loads(self.values['body'])
-        except JSONDecodeError:
+        except JSONDecodeError:  # type: ignore
             logger.info('Response body is NOT JSON decodable: {}'.format(self.values['body']))
 
     def __getattr__(self, key):
+        # type: (str) -> Any
         try:
             return self.values[key]
         except KeyError:
@@ -60,10 +69,12 @@ class RequestHandler(object):
     METHODS = ('get', 'head', 'post', 'options', 'put', 'delete', 'trace', 'patch', 'link', 'unlink')
 
     def __init__(self, app):
+        # type: (Chalice) -> None
         self.local_gateway = InternalLocalGateway(app, Config())
 
     @property
     def custom_context(self):
+        # type: () -> Dict[str, Any]
         return self.local_gateway.custom_context
 
     # As of Chalice version 1.8.0,
@@ -75,13 +86,16 @@ def custom_context(self):
     # Not only for this purpose, it's an interface provided to allow custom contexts in unit tests.
     @custom_context.setter
     def custom_context(self, context):
+        # type: (Dict[str, Any]) -> None
         self.local_gateway.custom_context = context
 
     def __getattr__(self, method):
+        # type: (str) -> Callable
         if method not in self.METHODS:
             raise AttributeError("'{}' object has no attribute '{}'".format(self.__class__.__name__, method))
 
         def request(path, headers={}, body=''):
+            # type: (str, Dict[str, str], str) -> ResponseHandler
             response = self.local_gateway.handle_request(method=method.upper(), path=path, headers=headers, body=body)
             return ResponseHandler(response)
 

pytest_chalice/plugin.py

@@ -1,9 +1,12 @@
 # -*- coding: utf-8 -*-
 
+from _pytest.config import Config
+
 from .fixtures import client  # noqa
 
 
 def pytest_configure(config):
+    # type: (Config) -> None
     config.addinivalue_line(
         'markers',
         'app: A Chalice application object',

tests/conftest.py

@@ -1,5 +1,7 @@
 # -*- coding: utf-8 -*-
 
+from typing import Any, Dict, Iterator, Union
+
 import pytest
 
 from chalice import Chalice
@@ -9,19 +11,23 @@
 
 @pytest.fixture
 def app():
+    # type: () -> Iterator[Union[Iterator, Iterator[Chalice]]]
     app = Chalice(__name__)
 
     @app.route('/', methods=('GET', 'HEAD', 'POST', 'OPTIONS', 'PUT', 'DELETE', 'TRACE', 'PATCH', 'LINK', 'UNLINK'))
     def index():
+        # type: () -> Dict[str, str]
         return {'hello': 'world'}
 
     @app.route('/context')
     def context():
+        # type: () -> Dict[str, Dict[str, Any]]
         context = app.current_request.context
         return {'context': context}
 
     @app.route('/string')
     def string():
+        # type: () -> str
         return 'Foo'
 
     yield app

tests/test_chalice.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 
 import pytest
+from pytest_chalice.handlers import RequestHandler
 
 
 class TestRequest:
@@ -13,16 +14,19 @@ def test_json_response(self, method, client):
         assert response.json == {'hello': 'world'}
 
     def test_invalid_method(self, client):
+        # type: (RequestHandler) -> None
         with pytest.raises(AttributeError, match=r' object has no attribute '):
             client.invalid_method('/')
 
     def test_string_response_dont_have_json_attribute(self, client):
+        # type: (RequestHandler) -> None
         response = client.get('/string')
         assert not hasattr(response, 'json')
 
 
 class TestCustomContext:
     def test_check_default_context(self, client):
+        # type: (RequestHandler) -> None
         response = client.get('/context')
         assert response.json == {
             'context': {
@@ -34,6 +38,7 @@ def test_check_default_context(self, client):
         }
 
     def test_custom_context(self, client):
+        # type: (RequestHandler) -> None
         client.custom_context = {
             'authorizer': {'claims': {}},
         }