More cleanup, + mypy

Replace ImportError with ModuleNotFoundError, and cleanup a number of
types

Author: Carreau

.github/workflows/test.yaml

@@ -35,6 +35,9 @@ jobs:
       - name: install mypy
         run: |
           python3 -m pip install mypy types-pycurl types-requests types-Markdown
+      - name: run mypy
+        run: |
+          mypy nbviewer
 
       - name: pip freeze
         run: |

nbviewer/app.py

@@ -16,8 +16,8 @@
 import markdown
 from jinja2 import Environment
 from jinja2 import FileSystemLoader
-from nbconvert import get_exporter
-from nbconvert.exporters.templateexporter import ExtensionTolerantLoader
+from nbconvert import get_exporter #type: ignore
+from nbconvert.exporters.templateexporter import ExtensionTolerantLoader #type: ignore
 from tornado import httpserver
 from tornado import ioloop
 from tornado import web
@@ -51,12 +51,9 @@
 from .utils import jupyter_info
 from .utils import url_path_join
 
-try:  # Python 3.8
-    from functools import cached_property
-except ImportError:
-    from .utils import cached_property
+from functools import cached_property
 
-from jupyter_server.base.handlers import FileFindHandler as StaticFileHandler
+from jupyter_server.base.handlers import FileFindHandler as StaticFileHandler #type: ignore
 
 # -----------------------------------------------------------------------------
 # Code
@@ -68,16 +65,16 @@
 
 def nrhead():
     try:
-        import newrelic.agent
-    except ImportError:
+        import newrelic.agent #type: ignore
+    except ModuleNotFoundError:
         return ""
     return newrelic.agent.get_browser_timing_header()
 
 
 def nrfoot():
     try:
         import newrelic.agent
-    except ImportError:
+    except ModuleNotFoundError:
         return ""
     return newrelic.agent.get_browser_timing_footer()
 
@@ -90,7 +87,7 @@ class NBViewer(Application):
 
     name = Unicode("NBViewer")
 
-    aliases = Dict(
+    aliases = Dict( #type: ignore
         {
             "base-url": "NBViewer.base_url",
             "binder-base-url": "NBViewer.binder_base_url",
@@ -129,7 +126,7 @@ class NBViewer(Application):
         }
     )
 
-    flags = Dict(
+    flags = Dict( #type: ignore
         {
             "debug": (
                 {"Application": {"log_level": logging.DEBUG}},
@@ -533,7 +530,7 @@ def frontpage_setup(self):
 
     # Attribute inherited from traitlets.config.Application, automatically used to style logs
     # https://github.com/ipython/traitlets/blob/master/traitlets/config/application.py#L191
-    _log_formatter_cls = LogFormatter
+    _log_formatter_cls = LogFormatter #type: ignore
     # Need Tornado LogFormatter for color logs, keys 'color' and 'end_color' in log_format
 
     # Observed traitlet inherited again from traitlets.config.Application

nbviewer/cache.py

@@ -13,9 +13,9 @@
 from tornado.log import app_log
 
 try:
-    import pylibmc
-except ImportError:
-    pylibmc = None
+    import pylibmc #type: ignore
+except ModuleNotFoundError:
+    pylibmc = None #type: ignore
 
 # -----------------------------------------------------------------------------
 # Code

nbviewer/providers/base.py

@@ -19,8 +19,8 @@
 from urllib.parse import urlparse
 from urllib.parse import urlunparse
 
-import statsd
-from nbformat import current_nbformat
+import statsd #type: ignore
+from nbformat import current_nbformat #type:ignore
 from nbformat import reads
 from tornado import httpclient
 from tornado import web
@@ -40,10 +40,10 @@
 try:
     import pycurl
     from tornado.curl_httpclient import CurlError
-except ImportError:
-    pycurl = None
+except ModuleNotFoundError:
+    pycurl = None #type: ignore
 
-    class CurlError(Exception):
+    class CurlError(Exception): #type: ignore
         pass
 
 
@@ -415,12 +415,12 @@ async def fetch(self, url, **overrides):
             response = await self.client.fetch(url, **kw)
         return response
 
-    def write_error(self, status_code: int, exc_info, **kwargs):
+    def write_error(self, status_code: int, **kwargs):
         """render custom error pages"""
-        message = ""
+        exc_info = kwargs.get('exc_info', None)
+        message:str = ""
         status_message = responses.get(status_code, "Unknown")
         exception = None
-        message = None
         if exc_info:
             # get the custom message, if defined
             exception = exc_info[1]

nbviewer/providers/github/handlers.py

@@ -215,7 +215,7 @@ async def get(self, user: str, repo: str, ref, path):
         assert isinstance(repo, str)
         assert isinstance(ref, str)
         assert isinstance(path, str)
-        if not self.request.uri.endswith("/"):
+        if isinstance(self.request.uri, str) and not self.request.uri.endswith("/"):
             self.redirect(self.request.uri + "/")
             return
         path = path.rstrip("/")

nbviewer/render.py

@@ -4,7 +4,7 @@
 #  Distributed under the terms of the BSD License.  The full license is in
 #  the file COPYING, distributed as part of this software.
 # -----------------------------------------------------------------------------
-from nbconvert.exporters import Exporter
+from nbconvert.exporters import Exporter #type: ignore
 from tornado.log import app_log
 
 # -----------------------------------------------------------------------------

nbviewer/tests/test_json.py

@@ -3,7 +3,7 @@
 from typing import Optional
 from unittest import TestCase
 
-from jsonschema import validate
+from jsonschema import validate #type: ignore
 
 
 ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), "..", ".."))

nbviewer/utils.py

@@ -199,7 +199,7 @@ def git_info(path, force_git=False):
 
 def jupyter_info():
     """Get Jupyter info dict"""
-    import nbconvert
+    import nbconvert #type: ignore
 
     return dict(nbconvert_version=nbconvert.__version__)
 
@@ -241,7 +241,3 @@ def time_block(message, logger, debug_limit=1):
     dt = time.time() - tic
     log = logger.info if dt > debug_limit else logger.debug
     log("%s in %.2f ms", message, 1e3 * dt)
-
-
-def cached_property(method):
-    return property(lru_cache(1)(method))