[TOOLSLIBS-387] Adds type hinting (#193)

* adds type annotations to automation module

* adds type annotations for custom_events module

* fixes for circular import

* adds type hinting

* adds hinting

* bug fixes and typing

* adds type hints

* adds type hints to devices module

* adds typing to experiments module

* adds typing to push module

* adds requests typing

* removes test for removed exception case

* adds types-six

* adds typing to common and core

* adds typing to reports module

* adds typing to push init

* mypy cleanup

* circular import fixes

* rm re type for 36 compat

* adds mypy to test run build script

* adds mypy

* adds mypy pre-commit hook

* merge conflict issues

* review cleanup

Author: aschuman0

.github/workflows/test_runner.yaml

@@ -21,6 +21,9 @@ jobs:
           python -m pip install --upgrade pip
           pip install flake8 pytest
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+      - name: Run mypy checks
+        run: |
+          mypy urbanairship/
       - name: Test with pytest
         run: |
           nosetests -v --with-doctest

.pre-commit-config.yaml

@@ -15,3 +15,7 @@ repos:
     rev: v2.1.0
     hooks:
       - id: codespell
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v0.931
+  hooks:
+    - id: mypy

requirements.txt

@@ -1,6 +1,10 @@
 requests>=1.2
+types-requests
 six
+types-six
 nose
 mock
 sphinx-rtd-theme
-backoff>=1.11
+mypy
+mypy-extensions
+backoff>=1.11

tests/devices/test_sms.py

@@ -165,7 +165,11 @@ def setUp(self):
     def test_payload(self):
         self.assertEqual(
             self.interaction.payload,
-            {"keyword": self.keyword, "sender_ids": self.sender_ids},
+            {
+                "keyword": self.keyword,
+                "sender_ids": self.sender_ids,
+                "timestamp": "2014-10-08T12:00:00",
+            },
         )
 
     def test_url(self):

tests/devices/test_tags.py

@@ -25,7 +25,7 @@ def setUp(self):
         ua.Airship._request.side_effect = [self.mock_response]
 
     def test_ios_audience(self):
-        self.channel_tags.set_audience("ios_audience")
+        self.channel_tags.set_audience(ios="ios_audience")
         self.channel_tags.add("group_name", "tag1")
         result = self.channel_tags.send()
 

tests/push/test_template.py

@@ -416,31 +416,6 @@ def test_create_template_requires_push(self):
 
         self.assertRaises(ValueError, template.create)
 
-    def test_create_template_no_message(self):
-        airship = ua.Airship(TEST_KEY, TEST_SECRET)
-        template = ua.Template(airship)
-        template.name = "Cat sound"
-        template.description = "The cat says..."
-        template.variables = [
-            {
-                "key": "SOUND",
-                "name": "Sound",
-                "description": "A sound",
-                "default_value": "Meow",
-            }
-        ]
-        # Set message center (not allowed)
-        template.push = {
-            "notification": {"alert": "The cat says {{SOUND}}"},
-            "message": {
-                "title": "Message title",
-                "body": "Message body",
-                "content_type": "text/html",
-            },
-        }
-
-        self.assertRaises(ValueError, template.create)
-
     def test_update_template(self):
         template_id = "ef34a8d9-0ad7-491c-86b0-aea74da15161"
         name = "Goodbye Message"
@@ -467,22 +442,6 @@ def test_update_template(self):
 
             self.assertEqual(template.template_id, template_id)
 
-    def test_update_template_no_message(self):
-        airship = ua.Airship(TEST_KEY, TEST_SECRET)
-        template_id = "ef34a8d9-0ad7-491c-86b0-aea74da15161"
-        template = ua.Template(airship)
-        # Set message center (not allowed)
-        template.push = {
-            "notification": {"alert": "The cat says {{SOUND}}"},
-            "message": {
-                "title": "Message title",
-                "body": "Message body",
-                "content_type": "text/html",
-            },
-        }
-
-        self.assertRaises(ValueError, template.update, template_id)
-
     def test_update_template_needs_something(self):
         airship = ua.Airship(TEST_KEY, TEST_SECRET)
         template_id = "ef34a8d9-0ad7-491c-86b0-aea74da15161"

urbanairship/__init__.py

@@ -1,9 +1,10 @@
 """Python package for using the Airship API"""
 import logging
+from typing import Any, List
 
+from .core import Airship
 from .automation import Automation, Pipeline
 from .common import AirshipFailure, Unauthorized
-from .core import Airship
 from .custom_events import CustomEvent
 from .devices import (
     APIDList,
@@ -110,7 +111,7 @@
     WebResponseReport,
 )
 
-__all__ = [
+__all__: List[Any] = [
     Airship,
     AirshipFailure,
     Unauthorized,

urbanairship/automation/core.py

@@ -1,4 +1,9 @@
 import json
+from typing import List, Union, Optional
+
+from urbanairship import Airship
+from urbanairship.automation.pipeline import Pipeline
+from requests import Response
 
 
 class Automation(object):
@@ -9,10 +14,10 @@ class Automation(object):
          to use.
     """
 
-    def __init__(self, airship):
+    def __init__(self, airship: Airship) -> None:
         self.airship = airship
 
-    def create(self, pipelines):
+    def create(self, pipelines: Union[Pipeline, List[Pipeline]]) -> Response:
         """Create an automation with one or more Pipeline payloads
 
         :keyword pipelines: A single Pipeline payload or list of Pipeline payloads
@@ -29,7 +34,7 @@ def create(self, pipelines):
 
         return response
 
-    def validate(self, pipelines):
+    def validate(self, pipelines: Union[Pipeline, List[Pipeline]]) -> Response:
         """Validate a Pipeline payloads
 
         :keyword pipelines: A single Pipeline payload or list of Pipeline payloads
@@ -46,7 +51,7 @@ def validate(self, pipelines):
 
         return response
 
-    def update(self, pipeline_id, pipeline):
+    def update(self, pipeline_id: str, pipeline: Pipeline) -> Response:
         """Update an existing Automation Pipeline
 
         :keyword pipeline_id: A Pipeline ID
@@ -60,7 +65,7 @@ def update(self, pipeline_id, pipeline):
 
         return response
 
-    def delete(self, pipeline_id):
+    def delete(self, pipeline_id: str) -> Response:
         """Delete an existing Automation Pipeline
 
         :keyword pipeline_id: A Pipeline ID
@@ -70,7 +75,7 @@ def delete(self, pipeline_id):
 
         return response
 
-    def lookup(self, pipeline_id):
+    def lookup(self, pipeline_id: str) -> Response:
         """Lookup an Automation Pipeline
 
         :keyword pipeline_id: A Pipeline ID
@@ -80,7 +85,9 @@ def lookup(self, pipeline_id):
 
         return response
 
-    def list_automations(self, limit=None, enabled=False):
+    def list_automations(
+        self, limit: Optional[int] = None, enabled: bool = False
+    ) -> Response:
         """List active Automations
 
         :keyword limit: Optional, maximum pipelines to return
@@ -100,7 +107,7 @@ def list_automations(self, limit=None, enabled=False):
 
         return response
 
-    def list_deleted_automations(self, start=None):
+    def list_deleted_automations(self, start: Optional[str] = None) -> Response:
         """List deleted Automation Pipelines
 
         :keyword start: Optional starting timestamp for limiting results in ISO-8601