Merge pull request #1015 from martinRenou/upgrade-nbconvert

Upgrade nbconvert

Author: Carreau

.github/workflows/test.yaml

@@ -0,0 +1,48 @@
+name: test
+
+on:
+  push:
+    branches:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        python:
+          - "3.8"
+          - "3.9"
+          - "3.10"
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: install apt packages
+        # pycurl build requirements
+        run: |
+          sudo apt-get update && sudo apt-get -y install \
+              libcurl4-gnutls-dev \
+              libgnutls28-dev
+
+      - name: install
+        run: |
+          python3 -m pip install -r requirements.in -r requirements-dev.txt
+      - 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: |
+          python3 -m pip freeze
+
+      - name: run tests
+        run: |
+          pytest -v nbviewer/tests -s

.pre-commit-config.yaml

@@ -20,3 +20,5 @@ repos:
     exclude: ^helm-chart/nbviewer/templates/
   - id: check-case-conflict
   - id: check-executables-have-shebangs
+ci:
+  autofix_prs: false

README.md

@@ -139,7 +139,7 @@ Pass `-d` or `--debug` to `invoke less` to create a CSS sourcemap, useful for de
 
 ```shell
 $ cd <path to repo>
-$ python -m nbviewer --debug --no-cache
+$ python -m nbviewer --debug --no-cache --host=127.0.0.1
 ```
 
 This will automatically relaunch the server if a change is detected on a python file, and not cache any results. You can then just do the modifications you like to the source code and/or the templates then refresh the pages.

nbviewer/_version.py

@@ -11,6 +11,7 @@
 import re
 import subprocess
 import sys
+from typing import Dict
 
 
 def get_keywords():
@@ -48,7 +49,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 = {}
 
 
@@ -93,9 +94,7 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, env=
         if verbose:
             print("unable to find command, tried %s" % (commands,))
         return None, None
-    stdout = p.communicate()[0].strip()
-    if sys.version_info[0] >= 3:
-        stdout = stdout.decode()
+    stdout = p.communicate()[0].strip().decode()
     if p.returncode != 0:
         if verbose:
             print("unable to run %s (error)" % dispcmd)

nbviewer/app.py

@@ -10,13 +10,16 @@
 import os
 from concurrent.futures import ProcessPoolExecutor
 from concurrent.futures import ThreadPoolExecutor
+from functools import cached_property
 from html import escape
 from urllib.parse import urlparse
 
 import markdown
 from jinja2 import Environment
 from jinja2 import FileSystemLoader
-from nbconvert.exporters.export import exporter_map
+from jupyter_server.base.handlers import FileFindHandler as StaticFileHandler  # type: ignore
+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
@@ -50,13 +53,6 @@
 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 jupyter_server.base.handlers import FileFindHandler as StaticFileHandler
-
 # -----------------------------------------------------------------------------
 # Code
 # -----------------------------------------------------------------------------
@@ -67,16 +63,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()
 
@@ -89,7 +85,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",
@@ -128,7 +124,7 @@ class NBViewer(Application):
         }
     )
 
-    flags = Dict(
+    flags = Dict(  # type: ignore
         {
             "debug": (
                 {"Application": {"log_level": logging.DEBUG}},
@@ -468,7 +464,11 @@ def default_endpoint(self):
 
     @cached_property
     def env(self):
-        env = Environment(loader=FileSystemLoader(self.template_paths), autoescape=True)
+        loader = ExtensionTolerantLoader(FileSystemLoader(self.template_paths), ".j2")
+        env = Environment(
+            loader=loader,
+            autoescape=True,
+        )
         env.filters["markdown"] = markdown.markdown
         try:
             git_data = git_info(here)
@@ -528,7 +528,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
@@ -594,15 +594,15 @@ def configure_formats(self, formats=None):
             formats = default_formats()
 
         # This would be better defined in a class
-        self.config.HTMLExporter.template_file = "basic"
-        self.config.SlidesExporter.template_file = "slides_reveal"
+        # self.config.HTMLExporter.template_file = "base"
+        # self.config.SlidesExporter.template_file = "slides_reveal"
 
-        self.config.TemplateExporter.template_path = [
+        self.config.TemplateExporter.extra_template_basedirs = [
             os.path.join(os.path.dirname(__file__), "templates", "nbconvert")
         ]
 
         for key, format in formats.items():
-            exporter_cls = format.get("exporter", exporter_map[key])
+            exporter_cls = format.get("exporter", get_exporter(key))
             if self.processes:
                 # can't pickle exporter instances,
                 formats[key]["exporter"] = exporter_cls
@@ -793,7 +793,7 @@ def main(argv=None):
 
     http_server = httpserver.HTTPServer(app, xheaders=True, ssl_options=ssl_options)
     nbviewer.log.info(
-        "Listening on %s:%i, path %s",
+        "Listening on http://%s:%i, path %s",
         nbviewer.host,
         nbviewer.port,
         app.settings["base_url"],

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/formats.py

@@ -55,9 +55,9 @@ def test_slides(nb, json):
         return False
 
     return {
-        "html": {"nbconvert_template": "basic", "label": "Notebook", "icon": "book"},
+        "html": {"nbconvert_template": "lab", "label": "Notebook", "icon": "book"},
         "slides": {
-            "nbconvert_template": "slides_reveal",
+            # "nbconvert_template": "slides_reveal",
             "label": "Slides",
             "icon": "gift",
             "test": test_slides,

nbviewer/providers/base.py

@@ -11,15 +11,16 @@
 import time
 from contextlib import contextmanager
 from datetime import datetime
+from functools import wraps
 from html import escape
 from http.client import responses
 from urllib.parse import quote
 from urllib.parse import urlencode
 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
@@ -39,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
 
 
@@ -382,7 +383,7 @@ def reraise_client_error(self, exc):
 
         slim_body = escape(body[:300])
 
-        self.log.warn("Fetching %s failed with %s. Body=%s", url, msg, slim_body)
+        self.log.error("Fetching %s failed with %s. Body=%s", url, msg, slim_body)
         raise web.HTTPError(code, msg)
 
     @contextmanager
@@ -414,11 +415,12 @@ async def fetch(self, url, **overrides):
             response = await self.client.fetch(url, **kw)
         return response
 
-    def write_error(self, status_code, **kwargs):
+    def write_error(self, status_code: int, **kwargs):
         """render custom error pages"""
         exc_info = kwargs.get("exc_info")
-        message = ""
+        message: str = ""
         status_message = responses.get(status_code, "Unknown")
+        exception = None
         if exc_info:
             # get the custom message, if defined
             exception = exc_info[1]
@@ -529,6 +531,7 @@ def cached(method):
     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/client.py

@@ -16,6 +16,7 @@
 from ...utils import response_text
 from ...utils import url_path_join
 
+
 # -----------------------------------------------------------------------------
 # Async GitHub Client
 # -----------------------------------------------------------------------------