Merge pull request #844 from krinsman/step4

parente · web-flow · commit 51317e6185cc · 2019-09-12T15:05:45.000-04:00
Step 4
diff --git a/nbviewer/providers/base.py b/nbviewer/providers/base.py
@@ -50,7 +50,6 @@
     pycurl = None
     class CurlError(Exception): pass
 
-date_fmt = "%a, %d %b %Y %H:%M:%S UTC"
 format_prefix = "/format/"
 
 
@@ -61,6 +60,7 @@ def initialize(self, format=None, format_prefix="", **handler_settings):
         self.format = format or self.default_format
         self.format_prefix = format_prefix
         self.http_client = httpclient.AsyncHTTPClient()
+        self.date_fmt = "%a, %d %b %Y %H:%M:%S UTC"
 
         for handler_setting in handler_settings:
             setattr(self, handler_setting, handler_settings[handler_setting])
@@ -259,10 +259,19 @@ def get_template(self, name):
         """Return the jinja template object for a given name"""
         return self.settings['jinja2_env'].get_template(name)
 
-    def render_template(self, name, **ns):
-        ns.update(self.template_namespace)
+    def render_template(self, name, **namespace):
+        namespace.update(self.template_namespace)
         template = self.get_template(name)
-        return template.render(**ns)
+        return template.render(**namespace)
+    
+    # Wrappers to facilitate custom rendering in subclasses without having to rewrite entire GET methods
+    # This would seem to mostly involve creating different template namespaces to enable custom logic in
+    # extended templates, but there might be other possibilities
+    def render_status_code_template(self, status_code, **namespace):
+        return self.render_template('%d.html' % status_code, **namespace)
+    
+    def render_error_template(self, **namespace):
+        return self.render_template('error.html', **namespace)
 
     @property
     def template_namespace(self):
@@ -415,7 +424,7 @@ def write_error(self, status_code, **kwargs):
                 status_message = reason
 
         # build template namespace
-        ns = dict(
+        namespace = dict(
             status_code=status_code,
             status_message=status_message,
             message=message,
@@ -424,9 +433,9 @@ def write_error(self, status_code, **kwargs):
 
         # render the template
         try:
-            html = self.render_template('%d.html' % status_code, **ns)
+            html = self.render_status_code_template(status_code, **namespace)
         except Exception as e:
-            html = self.render_template('error.html', **ns)
+            html = self.render_error_template(**namespace)
         self.set_header('Content-Type', 'text/html')
         self.write(html)
 
@@ -621,12 +630,26 @@ def filter_formats(self, nb, raw):
             except Exception as err:
                 app_log.info("failed to test %s: %s", self.request.uri, name)
 
+    # Wrappers to facilitate custom rendering in subclasses without having to rewrite entire GET methods
+    # This would seem to mostly involve creating different template namespaces to enable custom logic in
+    # extended templates, but there might be other possibilities
+    def render_notebook_template(self, body, nb, download_url, json_notebook, **namespace):
+        return self.render_template(
+            "formats/%s.html" % self.format,
+            body=body,
+            nb=nb,
+            download_url=download_url,
+            format=self.format,
+            default_format=self.default_format,
+            format_prefix=self.format_prefix,
+            formats=dict(self.filter_formats(nb, json_notebook)),
+            format_base=self.request.uri.replace(self.format_prefix, "").replace(self.base_url, '/'),
+            date=datetime.utcnow().strftime(self.date_fmt),
+            **namespace)
+                
     @gen.coroutine
-    def finish_notebook(self, json_notebook, download_url, provider_url=None,
-                        provider_icon=None, provider_label=None, msg=None,
-                        breadcrumbs=None, public=False, format=None, request=None,
-                        title=None, executor_url=None, executor_label=None,
-                        executor_icon=None):
+    def finish_notebook(self, json_notebook, download_url, msg=None,
+                        public=False, **namespace):
         """Renders a notebook from its JSON body.
 
         Parameters
@@ -679,7 +702,7 @@ def finish_notebook(self, json_notebook, download_url, provider_url=None,
                 app_log.info("Rendering %d B notebook from %s", len(json_notebook), download_url)
                 render_time = self.statsd.timer('rendering.nbrender.time').start()
                 nbhtml, config = yield self.pool.submit(render_notebook,
-                    self.formats[format], nb, download_url,
+                    self.formats[self.format], nb, download_url,
                     config=self.config,
                 )
                 render_time.stop()
@@ -696,30 +719,16 @@ def finish_notebook(self, json_notebook, download_url, provider_url=None,
             app_log.debug("Finished render of %s", download_url)
 
         html_time = self.statsd.timer('rendering.html.time').start()
-        html = self.render_template(
-            "formats/%s.html" % format,
+        html = self.render_notebook_template(
             body=nbhtml,
             nb=nb,
             download_url=download_url,
-            provider_url=provider_url,
-            provider_label=provider_label,
-            provider_icon=provider_icon,
-            executor_url=executor_url,
-            executor_label=executor_label,
-            executor_icon=executor_icon,
-            format=self.format,
-            default_format=self.default_format,
-            format_prefix=format_prefix,
-            formats=dict(self.filter_formats(nb, json_notebook)),
-            format_base=self.request.uri.replace(self.format_prefix, "").replace(self.base_url, '/'),
-            date=datetime.utcnow().strftime(date_fmt),
-            breadcrumbs=breadcrumbs,
-            title=title,
-            **config)
+            json_notebook=json_notebook,
+            **namespace)
         html_time.stop()
 
-        if 'content_type' in self.formats[format]:
-            self.set_header('Content-Type', self.formats[format]['content_type'])
+        if 'content_type' in self.formats[self.format]:
+            self.set_header('Content-Type', self.formats[self.format]['content_type'])
         yield self.cache_and_finish(html)
 
         # Index notebook
diff --git a/nbviewer/providers/gist/handlers.py b/nbviewer/providers/gist/handlers.py
@@ -23,19 +23,18 @@
 
 from .. import _load_handler_from_location
 
-PROVIDER_CTX = {
-    'provider_label': 'Gist',
-    'provider_icon': 'github-square',
-    'executor_label': 'Binder',
-    'executor_icon': 'icon-binder',
-}
-
-
-BINDER_TMPL = '{binder_base_url}/gist/{user}/{gist_id}/master'
-BINDER_PATH_TMPL = BINDER_TMPL+'?filepath={path}'
-
 
 class GistClientMixin(GithubClientMixin):
+    PROVIDER_CTX = {
+        'provider_label': 'Gist',
+        'provider_icon': 'github-square',
+        'executor_label': 'Binder',
+        'executor_icon': 'icon-binder',
+    }
+    
+    BINDER_TMPL = '{binder_base_url}/gist/{user}/{gist_id}/master'
+    BINDER_PATH_TMPL = BINDER_TMPL+'?filepath={path}'
+    
     def client_error_message(self, exc, url, body, msg=None):
         if exc.code == 403 and 'too big' in body.lower():
             return 400, "GitHub will not serve raw gists larger than 10MB"
@@ -50,9 +49,16 @@ class UserGistsHandler(GistClientMixin, BaseHandler):
 
     .ipynb file extension is required for listing (not for rendering).
     """
+    def render_usergists_template(self, entries, user, provider_url, prev_url,
+                                 next_url, **namespace):
+        return self.render_template("usergists.html", entries=entries, user=user,
+                                   provider_url=provider_url, prev_url=prev_url,
+                                   next_url=next_url, **self.PROVIDER_CTX,
+                                   **namespace)
+    
     @cached
     @gen.coroutine
-    def get(self, user):
+    def get(self, user, **namespace):
         page = self.get_argument("page", None)
         params = {}
         if page:
@@ -74,8 +80,8 @@ def get(self, user):
                     description=gist['description'] or '',
                 ))
         provider_url = u"https://gist.github.com/{user}".format(user=user)
-        html = self.render_template("usergists.html",
-            entries=entries, user=user, provider_url=provider_url, prev_url=prev_url, next_url=next_url, **PROVIDER_CTX
+        html = self.render_usergists_template(entries=entries, user=user, provider_url=provider_url, 
+                                              prev_url=prev_url, next_url=next_url, **namespace
         )
         yield self.cache_and_finish(html)
 
@@ -125,7 +131,7 @@ def get(self, user, gist_id, filename=''):
                 content = file['content']
 
             # Enable a binder navbar icon if a binder base URL is configured
-            executor_url = BINDER_PATH_TMPL.format(
+            executor_url = self.BINDER_PATH_TMPL.format(
                 binder_base_url=self.binder_base_url,
                 user=user.rstrip('/'),
                 gist_id=gist_id,
@@ -140,9 +146,7 @@ def get(self, user, gist_id, filename=''):
                     executor_url=executor_url,
                     msg="gist: %s" % gist_id,
                     public=gist['public'],
-                    format=self.format,
-                    request=self.request,
-                    **PROVIDER_CTX
+                    **self.PROVIDER_CTX
                 )
             else:
                 self.set_header('Content-Type', file.get('type') or 'text/plain')
@@ -178,7 +182,7 @@ def get(self, user, gist_id, filename=''):
             entries.extend(others)
 
             # Enable a binder navbar icon if a binder base URL is configured
-            executor_url = BINDER_TMPL.format(
+            executor_url = self.BINDER_TMPL.format(
                 binder_base_url=self.binder_base_url,
                 user=user.rstrip('/'),
                 gist_id=gist_id
@@ -192,7 +196,7 @@ def get(self, user, gist_id, filename=''):
                 user=user.rstrip('/'),
                 provider_url=gist['html_url'],
                 executor_url=executor_url,
-                **PROVIDER_CTX
+                **self.PROVIDER_CTX
             )
             yield self.cache_and_finish(html)
 
diff --git a/nbviewer/providers/github/handlers.py b/nbviewer/providers/github/handlers.py
@@ -35,22 +35,21 @@
 
 from .. import _load_handler_from_location
 
-PROVIDER_CTX = {
-    'provider_label': 'GitHub',
-    'provider_icon': 'github',
-    'executor_label': 'Binder',
-    'executor_icon': 'icon-binder',
-}
-
-
-BINDER_TMPL = '{binder_base_url}/gh/{org}/{repo}/{ref}'
-BINDER_PATH_TMPL = BINDER_TMPL+'?filepath={path}'
-
 
 def _github_url():
     return os.environ.get('GITHUB_URL') if os.environ.get('GITHUB_URL', '') else "https://github.com/"
 
 class GithubClientMixin(object):
+    PROVIDER_CTX = {
+        'provider_label': 'GitHub',
+        'provider_icon': 'github',
+        'executor_label': 'Binder',
+        'executor_icon': 'icon-binder',
+    }
+    
+    BINDER_TMPL = '{binder_base_url}/gh/{org}/{repo}/{ref}'
+    BINDER_PATH_TMPL = BINDER_TMPL+'?filepath={path}'
+    
     @property
     def github_client(self):
         """Create an upgraded github API client from the HTTP client"""
@@ -112,7 +111,7 @@ def get(self, user):
         html = self.render_template("userview.html",
             entries=entries, provider_url=provider_url, 
             next_url=next_url, prev_url=prev_url,
-            **PROVIDER_CTX
+            **self.PROVIDER_CTX
         )
         yield self.cache_and_finish(html)
 
@@ -127,9 +126,17 @@ def get(self, user, repo):
 
 class GitHubTreeHandler(GithubClientMixin, BaseHandler):
     """list files in a github repo (like github tree)"""
+    def render_treelist_template(self, entries, breadcrumbs, provider_url, user, repo, ref, path,
+                                 branches, tags, executor_url, **namespace):
+        return self.render_template("treelist.html", entries=entries, breadcrumbs=breadcrumbs,
+                                    provider_url=provider_url, user=user, repo=repo, ref=ref,
+                                    path=path, branches=branches, tags=tags, tree_type="github",
+                                    tree_label="repositories", executor_url=executor_url,
+                                    **self.PROVIDER_CTX, **namespace)
+    
     @cached
     @gen.coroutine
-    def get(self, user, repo, ref, path):
+    def get(self, user, repo, ref, path, **namespace):
         if not self.request.uri.endswith('/'):
             self.redirect(self.request.uri + '/')
             return
@@ -215,20 +222,17 @@ def get(self, user, repo, ref, path):
         entries.extend(others)
 
         # Enable a binder navbar icon if a binder base URL is configured
-        executor_url = BINDER_TMPL.format(
+        executor_url = self.BINDER_TMPL.format(
             binder_base_url=self.binder_base_url,
             org=user,
             repo=repo,
             ref=ref,
         ) if self.binder_base_url else None
 
-        html = self.render_template("treelist.html",
+        html = self.render_treelist_template(
             entries=entries, breadcrumbs=breadcrumbs, provider_url=provider_url,
-            user=user, repo=repo, ref=ref, path=path,
-            branches=branches, tags=tags, tree_type="github",
-            tree_label="repositories",
-            executor_url=executor_url,
-            **PROVIDER_CTX
+            user=user, repo=repo, ref=ref, path=path, branches=branches, tags=tags,
+            executor_url=executor_url, **namespace
         )
         yield self.cache_and_finish(html)
 
@@ -302,7 +306,7 @@ def get(self, user, repo, ref, path):
             breadcrumbs.extend(self.breadcrumbs(dir_path, base_url))
 
             # Enable a binder navbar icon if a binder base URL is configured
-            executor_url = BINDER_PATH_TMPL.format(
+            executor_url = self.BINDER_PATH_TMPL.format(
                 binder_base_url=self.binder_base_url,
                 org=user,
                 repo=repo,
@@ -325,9 +329,7 @@ def get(self, user, repo, ref, path):
                 breadcrumbs=breadcrumbs,
                 msg="file from GitHub: %s" % raw_url,
                 public=True,
-                format=self.format,
-                request=self.request,
-                **PROVIDER_CTX
+                **self.PROVIDER_CTX
             )
         else:
             mime, enc = mimetypes.guess_type(path)
diff --git a/nbviewer/providers/local/handlers.py b/nbviewer/providers/local/handlers.py
@@ -183,12 +183,20 @@ def get(self, path):
                                    download_url='?download',
                                    msg="file from localfile: %s" % path,
                                    public=False,
-                                   format=self.format,
-                                   request=self.request,
                                    breadcrumbs=self.breadcrumbs(path),
                                    title=os.path.basename(path))
 
-    def show_dir(self, fullpath, path):
+    # Make available to increase modularity for subclassing
+    # E.g. so subclasses can implement templates with custom logic
+    # without having to copy-paste the entire show_dir method
+    def render_dirview_template(self, entries, breadcrumbs, title, **namespace):
+
+         return self.render_template('dirview.html',
+                                    entries=entries, breadcrumbs=breadcrumbs,
+                                    title=title, **namespace)
+        
+        
+    def show_dir(self, fullpath, path, **namespace):
         """Render the directory view template for a given filesystem path.
 
         Parameters
@@ -251,10 +259,10 @@ def show_dir(self, fullpath, path):
         entries.extend(dirs)
         entries.extend(ipynbs)
 
-        html = self.render_template('dirview.html',
-                                    entries=entries,
-                                    breadcrumbs=self.breadcrumbs(path),
-                                    title=url_path_join(path, '/'))
+        html = self.render_dirview_template(entries=entries,
+                                            breadcrumbs=self.breadcrumbs(path),
+                                            title=url_path_join(path, '/'),
+                                            **namespace)
         return html
 
 
diff --git a/nbviewer/providers/url/handlers.py b/nbviewer/providers/url/handlers.py
@@ -86,8 +86,7 @@ def get(self, secure, netloc, url):
         yield self.finish_notebook(nbjson, download_url=remote_url,
                                    msg="file from url: %s" % remote_url,
                                    public=public,
-                                   request=self.request,
-                                   format=self.format)
+                                   request=self.request)
 
 
 def default_handlers(handlers=[], **handler_names):
