Debug and typing

Author: Carreau

nbviewer/_version.py

@@ -12,6 +12,8 @@
 import subprocess
 import sys
 
+from typing import Dict
+
 
 def get_keywords():
     """Get the keywords needed to look up the version information."""
@@ -48,7 +50,7 @@ class NotThisMethod(Exception):
     """Exception raised if a method is not valid for the current scenario."""
 
 
-LONG_VERSION_PY = {}
+LONG_VERSION_PY: Dict[str, str] = {}
 HANDLERS = {}
 
 

nbviewer/providers/base.py

@@ -17,6 +17,7 @@
 from urllib.parse import urlencode
 from urllib.parse import urlparse
 from urllib.parse import urlunparse
+from functools import wraps
 
 import statsd
 from nbformat import current_nbformat
@@ -529,7 +530,7 @@ def cached(method):
     This only handles getting from the cache, not writing to it.
     Writing to the cache must be handled in the decorated method.
     """
-
+    @wraps(method)
     async def cached_method(self, *args, **kwargs):
         uri = self.request.path
         short_url = self.truncate(uri)

nbviewer/providers/github/handlers.py

@@ -233,10 +233,16 @@ async def get(self, user, repo, ref, path):
         # Account for possibility that GitHub API redirects us to get more accurate breadcrumbs
         # See: https://github.com/jupyter/nbviewer/issues/324
         example_file_url = contents[0]["html_url"]
-        user, repo = re.match(
+        match_group = re.match(
             r"^" + self.github_url + r"(?P<user>[^\/]+)/(?P<repo>[^\/]+)/.*",
             example_file_url,
-        ).group("user", "repo")
+        )
+
+        if match_group is None:
+            raise ValueError(
+                f"Could not extract user/repo fromexample_file_url={example_file_url}"
+            )
+        user, repo = match_group.group("user", "repo")
 
         base_url = "/github/{user}/{repo}/tree/{ref}".format(
             user=user, repo=repo, ref=ref

nbviewer/tests/base.py

@@ -23,13 +23,15 @@
 from nbviewer.providers.github.client import AsyncGitHubClient
 from nbviewer.utils import url_path_join
 
+from typing import Dict
+
 
 class NBViewerTestCase(TestCase):
     """A base class for tests that need a running nbviewer server."""
 
     port = 12341
 
-    environment_variables = {}
+    environment_variables:Dict[str, str] = {}
 
     def assertIn(self, observed, expected, *args, **kwargs):
         return super().assertIn(

nbviewer/tests/test_index.py

@@ -5,7 +5,7 @@
 
 
 class ElasticSearchTestCase(NBViewerTestCase):
-    @skip
+    @skip("unconditionally skip")
     @classmethod
     def test_finish_notebook(self):
         pass

nbviewer/tests/test_json.py

@@ -9,8 +9,8 @@
 
 
 class JSONTestCase(TestCase):
-    json = None
-    schema = None
+    json: str
+    schema: str
 
     def test_json(self):
         if not self.json: