fix type annotations

Author: rmorshea

.github/workflows/test.yml

@@ -25,4 +25,4 @@ jobs:
       - name: Install Python Dependencies
         run: pip install -r requirements/test-run.txt
       - name: Run Tests
-        run: HEADLESS_BROWSER=1 nox
+        run: HEADLESS=1 nox

docs/source/installation.rst

@@ -101,7 +101,7 @@ If you prefer to run the tests using a headless browser:
 
 .. code-block:: bash
 
-    HEADLESS_BROWSER=1 nox
+    HEADLESS=1 nox
 
 
 Building The Documentation

idom/dialect.py

@@ -5,7 +5,7 @@
 from pyalect import DialectError, Dialect
 
 
-class HtmlDialectTranspiler(Dialect, name="html"):  # type: ignore
+class HtmlDialectTranspiler(Dialect, name="html"):
     """An HTML dialect transpiler for Python."""
 
     def __init__(self, filename: Optional[str] = None):

idom/server/flask.py

@@ -5,7 +5,7 @@
 from asyncio import Queue as AsyncQueue
 from threading import Event as ThreadEvent, Thread
 from queue import Queue as ThreadQueue
-from typing import Union, Tuple, Dict, Any, Optional, Callable, NamedTuple
+from typing import Union, Tuple, Dict, Any, Optional, Callable, NamedTuple, Type, cast
 
 from typing_extensions import TypedDict
 from flask import Flask, Blueprint, send_from_directory, redirect, url_for
@@ -17,7 +17,7 @@
 
 import idom
 from idom.client.manage import BUILD_DIR
-from idom.core.layout import LayoutEvent, Layout
+from idom.core.layout import LayoutEvent, Layout, LayoutUpdate
 from idom.core.dispatcher import AbstractDispatcher, SingleViewDispatcher
 
 from .base import AbstractRenderServer
@@ -36,7 +36,7 @@ class Config(TypedDict, total=False):
 class FlaskRenderServer(AbstractRenderServer[Flask, Config]):
     """Base class for render servers which use Flask"""
 
-    _dispatcher_type: AbstractDispatcher
+    _dispatcher_type: Type[AbstractDispatcher]
     _wsgi_server: pywsgi.WSGIServer
 
     def stop(self, timeout: Optional[float] = None) -> None:
@@ -56,10 +56,8 @@ def _create_config(self, config: Optional[Config]) -> Config:
             "cors": False,
             "serve_static_files": True,
             "redirect_root_to_index": True,
+            **(config or {}),  # type: ignore
         }
-        if config is not None:
-            # BUG: https://github.com/python/mypy/issues/6462
-            new_config.update(config)  # type: ignore
         return new_config
 
     def _default_application(self, config: Config) -> Flask:
@@ -79,12 +77,12 @@ def _setup_application(self, config: Config, app: Flask) -> None:
 
         sockets = Sockets(app)
 
-        @sockets.route(urljoin(config["url_prefix"], "/stream"))
+        @sockets.route(urljoin(config["url_prefix"], "/stream"))  # type: ignore
         def model_stream(ws: WebSocket) -> None:
             def send(value: Any) -> None:
                 ws.send(json.dumps(value))
 
-            def recv() -> LayoutEvent:
+            def recv() -> Optional[LayoutEvent]:
                 event = ws.receive()
                 if event is not None:
                     return LayoutEvent(**json.loads(event))
@@ -104,20 +102,20 @@ def _setup_blueprint_routes(self, config: Config, blueprint: Blueprint) -> None:
         if config["serve_static_files"]:
 
             @blueprint.route("/client/<path:path>")
-            def send_build_dir(path):
+            def send_build_dir(path: str) -> Any:
                 return send_from_directory(str(BUILD_DIR), path)
 
             if config["redirect_root_to_index"]:
 
                 @blueprint.route("/")
-                def redirect_to_index():
+                def redirect_to_index() -> Any:
                     return redirect(url_for("idom.send_build_dir", path="index.html"))
 
     def _setup_application_did_start_event(
         self, config: Config, app: Flask, event: ThreadEvent
     ) -> None:
         @app.before_first_request
-        def server_did_start():
+        def server_did_start() -> None:
             event.set()
 
     def _run_application(
@@ -149,8 +147,8 @@ def _generic_run_application(
         port: int = 5000,
         debug: bool = False,
         *args: Any,
-        **kwargs,
-    ):
+        **kwargs: Any,
+    ) -> None:
         if debug:
             logging.basicConfig(level=logging.DEBUG)  # pragma: no cover
         logging.debug("Starting server...")
@@ -180,20 +178,20 @@ def run_dispatcher_in_thread(
     dispatch_thread_info_created = ThreadEvent()
     dispatch_thread_info_ref: idom.Ref[Optional[_DispatcherThreadInfo]] = idom.Ref(None)
 
-    def run_dispatcher():
+    def run_dispatcher() -> None:
         loop = asyncio.new_event_loop()
         asyncio.set_event_loop(loop)
 
-        thread_send_queue = ThreadQueue()
-        async_recv_queue = AsyncQueue()
+        thread_send_queue: "ThreadQueue[LayoutUpdate]" = ThreadQueue()
+        async_recv_queue: "AsyncQueue[LayoutEvent]" = AsyncQueue()
 
         async def send_coro(value: Any) -> None:
             thread_send_queue.put(value)
 
         async def recv_coro() -> Any:
             return await async_recv_queue.get()
 
-        async def main():
+        async def main() -> None:
             async with make_dispatcher() as dispatcher:
                 await dispatcher.run(send_coro, recv_coro, context)
 
@@ -212,12 +210,12 @@ async def main():
     Thread(target=run_dispatcher, daemon=True).start()
 
     dispatch_thread_info_created.wait()
-    dispatch_thread_info = dispatch_thread_info_ref.current
+    dispatch_thread_info = cast(_DispatcherThreadInfo, dispatch_thread_info_ref.current)
     assert dispatch_thread_info is not None
 
     stop = ThreadEvent()
 
-    def run_send():
+    def run_send() -> None:
         while not stop.is_set():
             send(dispatch_thread_info.thread_send_queue.get())
 
@@ -242,17 +240,19 @@ def run_send():
 
 class _DispatcherThreadInfo(NamedTuple):
     dispatch_loop: asyncio.AbstractEventLoop
-    dispatch_future: asyncio.Future
-    thread_send_queue: ThreadQueue
-    async_recv_queue: AsyncQueue
+    dispatch_future: "asyncio.Future[Any]"
+    thread_send_queue: "ThreadQueue[LayoutUpdate]"
+    async_recv_queue: "AsyncQueue[LayoutEvent]"
 
 
-class _StartCallbackWSGIServer(pywsgi.WSGIServer):
-    def __init__(self, before_first_request: Callable[[], None], *args, **kwargs):
+class _StartCallbackWSGIServer(pywsgi.WSGIServer):  # type: ignore
+    def __init__(
+        self, before_first_request: Callable[[], None], *args: Any, **kwargs: Any
+    ) -> None:
         self._before_first_request_callback = before_first_request
         super().__init__(*args, **kwargs)
 
-    def update_environ(self):
+    def update_environ(self) -> None:
         """
         Called before the first request is handled to fill in WSGI environment values.
 

idom/server/sanic.py

@@ -48,9 +48,8 @@ def _create_config(self, config: Optional[Config]) -> Config:
             "url_prefix": "",
             "serve_static_files": True,
             "redirect_root_to_index": True,
+            **(config or {}),  # type: ignore
         }
-        if config is not None:
-            new_config.update(config)
         return new_config
 
     def _default_application(self, config: Config) -> Sanic:

idom/server/tornado.py

@@ -3,7 +3,7 @@
 from threading import Event as ThreadEvent
 from urllib.parse import urljoin
 from asyncio import Queue as AsyncQueue
-from typing import Optional, Type, Any, List, Tuple, Dict
+from typing import Optional, Type, Any, List, Tuple, Dict, Union
 
 from tornado.web import Application, StaticFileHandler, RedirectHandler, RequestHandler
 from tornado.websocket import WebSocketHandler
@@ -49,9 +49,8 @@ def _create_config(self, config: Optional[Config]) -> Config:
             "base_url": "",
             "serve_static_files": True,
             "redirect_root_to_index": True,
+            **(config or {}),  # type: ignore
         }
-        if config is not None:
-            new_config.update(config)
         return new_config
 
     def _default_application(self, config: Config) -> Application:
@@ -66,7 +65,7 @@ def _setup_application(
         app.add_handlers(
             r".*",
             [
-                (urljoin(base_url, route_pattern),) + tuple(handler_info)
+                (urljoin(base_url, route_pattern),) + tuple(handler_info)  # type: ignore
                 for route_pattern, *handler_info in self._create_route_handlers(config)
             ],
         )
@@ -122,7 +121,7 @@ def _run_application_in_thread(
         self._run_application(config, app, host, port, args, kwargs)
 
 
-class PerClientStateModelStreamHandler(WebSocketHandler):  # type: ignore
+class PerClientStateModelStreamHandler(WebSocketHandler):
     """A web-socket handler that serves up a new model stream to each new client"""
 
     _dispatcher_type: Type[AbstractDispatcher] = SingleViewDispatcher
@@ -132,7 +131,7 @@ class PerClientStateModelStreamHandler(WebSocketHandler):  # type: ignore
     def initialize(self, component_constructor: ComponentConstructor) -> None:
         self._component_constructor = component_constructor
 
-    async def open(self) -> None:
+    async def open(self, *args: str, **kwargs: str) -> None:
         message_queue: "AsyncQueue[str]" = AsyncQueue()
         query_params = {k: v[0].decode() for k, v in self.request.arguments.items()}
         dispatcher = self._dispatcher_type(
@@ -154,8 +153,10 @@ async def run() -> None:
         self._dispatcher_inst = dispatcher
         self._message_queue = message_queue
 
-    async def on_message(self, message: str) -> None:
-        await self._message_queue.put(message)
+    async def on_message(self, message: Union[str, bytes]) -> None:
+        await self._message_queue.put(
+            message if isinstance(message, str) else message.decode()
+        )
 
     def on_close(self) -> None:
         asyncio.ensure_future(self._dispatcher_inst.__aexit__(None, None, None))

noxfile.py

@@ -5,7 +5,7 @@
 from nox.sessions import Session
 
 
-HEADLESS_BROWSER = bool(int(os.environ.get("HEADLESS_BROWSER", "0")))
+HEADLESS = bool(int(os.environ.get("HEADLESS", "0")))
 BLACK_DEFAULT_EXCLUDE = r"\.eggs|\.git|\.hg|\.mypy_cache|\.nox|\.tox|\.venv|\.svn|_build|buck-out|build|dist"
 
 
@@ -26,10 +26,8 @@ def test_with_coverage(session: Session) -> None:
 @nox.session
 def check_types(session: Session) -> None:
     session.install("-r", "requirements/check-types.txt")
-    session.log("Check Packages (strict)")
+    session.install(".[all]")
     session.run("mypy", "--strict", "idom")
-    session.log("Check Tests (lenient)")
-    session.run("mypy", "tests")
 
 
 @nox.session
@@ -60,7 +58,7 @@ def _test_setup(session: Session) -> None:
 
 def _test_run(session: Session, extra_args: Iterable[str] = ()) -> None:
     args = ["pytest", "tests"]
-    if HEADLESS_BROWSER:
+    if HEADLESS:
         args.append("--headless")
     args.extend(extra_args)
     session.run(*args)

tests/driver_utils.py

@@ -15,4 +15,4 @@ def no_such_element(driver: WebDriver, method: str, param: Any) -> bool:
     except NoSuchElementException:
         return True
     else:
-        raise False
+        return False