Add mypy and start adding type hints

As a first step, go back to definining exposed and user_facing in all
app controllers rather than using importlib in the server to set
defaults. This is more repetitive, but sidesteps some typing
complications. Although importlib was valued at the time it was
implemented for cutting down on repetition, I'm more interested in
having things be more obvious and less magical.

.gitignore

@@ -24,3 +24,4 @@ venv
 cache
 node_modules
 .pytest_cache
+.mypy_cache

apps/applog/main.py

@@ -7,6 +7,8 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "App Log"
+    exposed = True
+    user_facing = True
 
     @staticmethod
     @cherrypy.tools.negotiable()

apps/azure/main.py

@@ -6,6 +6,7 @@
 class Controller:
     """Dispatch application requests based on HTTP verb."""
 
+    exposed = True
     user_facing = False
 
     @staticmethod

apps/bookmarklets/main.py

@@ -7,6 +7,8 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "Bookmarklets"
+    exposed = True
+    user_facing = True
 
     @staticmethod
     @cherrypy.tools.negotiable()

apps/bookmarks/main.py

@@ -7,6 +7,8 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "Bookmarks"
+    exposed = True
+    user_facing = True
 
     @staticmethod
     def check_wayback_availability(url):

apps/bounce/main.py

@@ -8,6 +8,8 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "Bounce"
+    exposed = True
+    user_facing = True
 
     common_names = {
         "dev",

apps/calls/main.py

@@ -7,6 +7,8 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "Calls"
+    exposed = True
+    user_facing = True
 
     @staticmethod
     @cherrypy.tools.negotiable()

apps/captures/main.py

@@ -7,6 +7,8 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "Captures"
+    exposed = True
+    user_facing = True
 
     @staticmethod
     @cherrypy.tools.negotiable()

apps/countries/main.py

@@ -6,6 +6,8 @@
 class Controller:
     """Dispatch application requests based on HTTP verb."""
 
+    exposed = True
+
     user_facing = False
 
     cache_key = "countries"

apps/coverage/main.py

@@ -7,6 +7,8 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "Coverage"
+    exposed = True
+    user_facing = True
 
     @staticmethod
     def GET():

apps/coverage/main_test.py

@@ -28,7 +28,7 @@ def tearDownClass(cls):
     def test_allow(self):
         """Verify the controller's supported HTTP methods"""
         response = self.request("/", method="HEAD")
-        self.assertAllowedMethods(response, ("GET",))
+        self.assert_allowed(response, ("GET",))
 
     @mock.patch("cherrypy.engine.publish")
     def test_redirect(self, publish_mock):

apps/geodb/main.py

@@ -6,6 +6,7 @@
 class Controller:
     """Dispatch application requests based on HTTP verb."""
 
+    exposed = True
     user_facing = False
 
     @staticmethod

apps/grids/main.py

@@ -10,6 +10,8 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "Grids"
+    exposed = True
+    user_facing = True
 
     @cherrypy.tools.negotiable()
     def GET(self, *_args, **kwargs):
@@ -72,7 +74,7 @@ def GET(self, *_args, **kwargs):
             "html": ("grids.jinja.html", {
                 "headers": headers,
                 "name": name,
-                "names": [key for key in grids.keys()],
+                "names": grids.keys(),
                 "options": options,
                 "rows": rows
             })

apps/headers/main.py

@@ -7,6 +7,8 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "Headers"
+    exposed = True
+    user_facing = True
 
     @staticmethod
     @cherrypy.tools.negotiable()

apps/headlines/main.py

@@ -8,6 +8,8 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "Headlines"
+    exposed = True
+    user_facing = True
 
     cache_key = "headlines"
 

apps/homepage/main.py

@@ -9,6 +9,8 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "Homepage"
+    exposed = True
+    user_facing = True
 
     @decorators.log_runtime
     def catalog_apps(self, apps):

apps/htmlhead/main.py

@@ -8,6 +8,8 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "HTML Head"
+    exposed = True
+    user_facing = True
 
     @staticmethod
     @cherrypy.tools.negotiable()

apps/ip/main.py

@@ -7,6 +7,8 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "IP"
+    exposed = True
+    user_facing = True
 
     cache_key = "ip:external"
 

apps/jenkins/main.py

@@ -29,6 +29,7 @@
 class Controller:
     """Dispatch application requests based on HTTP verb."""
 
+    exposed = True
     user_facing = False
 
     @cherrypy.tools.json_in()

apps/later/main.py

@@ -8,6 +8,8 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "Later"
+    exposed = True
+    user_facing = True
 
     @staticmethod
     @cherrypy.tools.negotiable()

apps/logindex/main.py

@@ -13,6 +13,8 @@ class Controller:
     @staticmethod
     def parse_log_date(val):
         """Convert a date string in either date or filename format
+exposed = True
+user_facing = True
         to a datetime.
 
         Date format is YYYY-mm-dd. Filename format is the same, but with

apps/maintenance/main.py

@@ -7,8 +7,10 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     user_facing = False
+    exposed = True
 
-    def POST(self, group):
+    @staticmethod
+    def POST(group=None):
         """
         Schedule maintenance operations.
         """

apps/maintenance/main_test.py

@@ -36,7 +36,7 @@ def test_group_required(self):
             "/",
             method="POST"
         )
-        self.assertEqual(response.code, 404)
+        self.assertEqual(response.code, 400)
 
     def test_group_valid(self):
         """The group parameter must be valid."""

apps/notification/main.py

@@ -7,6 +7,7 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     user_facing = False
+    exposed = True
 
     @staticmethod
     @cherrypy.tools.capture()

apps/phone/main.py

@@ -7,6 +7,8 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "Phone"
+    exposed = True
+    user_facing = True
 
     messages = {
         "invalid": "The number provided was invalid",

apps/redirect/main.py

@@ -7,7 +7,7 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "Redirect"
-
+    exposed = True
     user_facing = False
 
     @staticmethod

apps/registry/main.py

@@ -7,6 +7,8 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "Registry"
+    exposed = True
+    user_facing = True
 
     @staticmethod
     @cherrypy.tools.negotiable()

apps/reminder/main.py

@@ -10,6 +10,8 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "Reminder"
+    exposed = True
+    user_facing = True
 
     registry_key = "reminder:template"
 

apps/shared/main.py

@@ -7,6 +7,7 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     user_facing = False
+    exposed = True
 
     @staticmethod
     def GET(*_args, **_kwargs):

apps/speak/main.py

@@ -7,9 +7,12 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "Speak"
+    exposed = True
+    user_facing = True
 
+    @staticmethod
     @cherrypy.tools.negotiable()
-    def GET(self, *_args, **_kwargs):
+    def GET(*_args, **_kwargs):
         """Present an interface for on-demand and scheduled muting of the
         application.
 

apps/startpage/main.py

@@ -9,6 +9,8 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "Startpage"
+    exposed = True
+    user_facing = True
 
     default_page_name = "default"
 

apps/transform/main.py

@@ -9,6 +9,8 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "Transform"
+    exposed = True
+    user_facing = True
 
     transforms = {}
 

apps/visitors/main.py

@@ -15,6 +15,8 @@ class Controller:
     """
 
     name = "Visitors"
+    exposed = True
+    user_facing = True
 
     @cherrypy.tools.negotiable()
     def GET(self, *_args, **kwargs):

apps/wakeup/main.py

@@ -9,6 +9,8 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "Wakeup"
+    exposed = True
+    user_facing = True
 
     @staticmethod
     @cherrypy.tools.negotiable()

apps/weather/main.py

@@ -11,6 +11,8 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "Weather"
+    exposed = True
+    user_facing = True
 
     @cherrypy.tools.negotiable()
     def GET(self, *_args, **_kwargs):

apps/whois/main.py

@@ -11,6 +11,8 @@ class Controller:
     """Dispatch application requests based on HTTP verb."""
 
     name = "Whois"
+    exposed = True
+    user_facing = True
 
     @staticmethod
     @cherrypy.tools.negotiable()

medley.py

@@ -48,7 +48,7 @@
 
 # pylint: disable=too-many-statements
 @plugins.decorators.log_runtime
-def setup():
+def setup() -> None:
     """Configure and start the application server
 
     The application server is the backbone that individual
@@ -128,17 +128,6 @@ def setup():
 
         app_module = importlib.import_module(f"apps.{app}.main")
 
-        # Treat all controllers as exposed by default.
-        # This is a Cherrypy-ism.
-        if not hasattr(app_module.Controller, "exposed"):
-            app_module.Controller.exposed = True
-
-        # Treat all controllers as user-facing by default. This is a
-        # Medley-ism. Service apps should override this attribute
-        # locally.
-        if not hasattr(app_module.Controller, "user_facing"):
-            app_module.Controller.user_facing = True
-
         app_config = {
             "/": {
                 "request.dispatch": cherrypy.dispatch.MethodDispatcher()
@@ -186,7 +175,7 @@ def setup():
                 })
 
         cherrypy.tree.mount(
-            app_module.Controller(),
+            app_module.Controller(),  # type: ignore
             app_path,
             app_config
         )

mypy.ini

@@ -0,0 +1,6 @@
+[mypy]
+python_version = 3.7
+warn_return_any = True
+warn_unused_configs = True
+disallow_untyped_defs = True
+ignore_missing_imports = True

requirements-dev.txt

@@ -3,6 +3,7 @@ coverage==4.5.4
 flake8==3.7.8
 flake8-comprehensions==2.2.0
 mock==3.0.5
+mypy==0.740
 pylint==2.4.2
 pytest-cov==2.8.1
 pytest-timeout==1.3.3