Merge branch 'master' into example

Author: echarles

CHANGELOG.md

@@ -0,0 +1,48 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+
+## [0.2.0] - 2019-12-19
+
+### Added
+- `extension` submodule ([#48](https://github.com/jupyter/jupyter_server/pull/48))
+    - ExtensionApp - configurable JupyterApp-subclass for server extensions
+        - Most useful for Jupyter frontends, like Notebook, JupyterLab, nteract, voila etc.
+        - Launch with entrypoints
+        - Configure from file or CLI
+        - Add custom templates, static assets, handlers, etc.
+        - Static assets are served behind a `/static/<extension_name>` endpoint.
+        - Run server extensions in "standalone mode" ([#70](https://github.com/jupyter/jupyter_server/pull/70) and [#76](https://github.com/jupyter/jupyter_server/pull/76))
+    - ExtensionHandler - tornado handlers for extensions.
+        - Finds static assets at `/static/<extension_name>`
+
+### Changed
+- `jupyter serverextension <command>` entrypoint has been changed to `jupyter server extension <command>`.
+- `toggle_jupyter_server` and `validate_jupyter_server` function no longer take a Logger object as an argument.
+- Changed testing framework from nosetests to pytest ([#152](https://github.com/jupyter/jupyter_server/pull/152))
+    - Depend on pytest-tornasync extension for handling tornado/asyncio eventloop
+    - Depend on pytest-console-scripts for testing CLI entrypoints
+- Added Github actions as a testing framework along side Travis and Azure ([#146](https://github.com/jupyter/jupyter_server/pull/146))
+
+### Removed
+- Removed the option to update `root_dir` trait in FileContentsManager and MappingKernelManager in ServerApp ([#135](https://github.com/jupyter/jupyter_server/pull/135))
+
+### Fixed
+- Synced Jupyter Server with Notebook PRs in batches (ended on 2019-09-27)
+    - [Batch 1](https://github.com/jupyter/jupyter_server/pull/95)
+    - [Batch 2](https://github.com/jupyter/jupyter_server/pull/97)
+    - [Batch 3](https://github.com/jupyter/jupyter_server/pull/98)
+    - [Batch 4](https://github.com/jupyter/jupyter_server/pull/99)
+    - [Batch 5](https://github.com/jupyter/jupyter_server/pull/103)
+    - [Batch 6](https://github.com/jupyter/jupyter_server/pull/104)
+    - [Batch 7](https://github.com/jupyter/jupyter_server/pull/105)
+    - [Batch 8](https://github.com/jupyter/jupyter_server/pull/106)
+
+### Security
+- Added a "secure_write to function for cookie/token saves ([#77](https://github.com/jupyter/jupyter_server/pull/77))

CONTRIBUTING.rst

@@ -69,7 +69,7 @@ To run the Python tests, use::
 
 If you want coverage statistics as well, you can run::
 
-    py.test --cov notebook -v --pyargs jupyter_server
+    py.test --cov notebook -v
 
 Building the Documentation
 --------------------------
@@ -82,7 +82,7 @@ containing all the necessary packages (except pandoc), use::
 
     conda env create -f docs/environment.yml
     source activate server_docs  # Linux and OS X
-    activate notebook_docs         # Windows
+    activate server_docs         # Windows
 
 .. _conda environment:
     https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-from-an-environment-yml-file

jupyter_server/extension/__init__.py

@@ -1,2 +0,0 @@
-from .application import ExtensionApp
-from .handler import ExtensionHandler

jupyter_server/extension/application.py

@@ -1,6 +1,8 @@
 import sys
 import re
 
+from jinja2 import Environment, FileSystemLoader
+
 from traitlets import (
     Unicode, 
     List, 
@@ -25,6 +27,9 @@
 except KeyError:
     pass
 
+#-----------------------------------------------------------------------------
+# Util functions and classes.
+#-----------------------------------------------------------------------------
 
 def _preparse_for_subcommand(Application, argv):
     """Preparse command line to look for subcommands.
@@ -81,11 +86,52 @@ def _preparse_for_stopping_flags(Application, argv):
         app.exit(0)
 
 
+class ExtensionAppJinjaMixin:
+    """Use Jinja templates for HTML templates on top of an ExtensionApp."""
+    
+    jinja2_options = Dict(
+        help=_("""Options to pass to the jinja2 environment for this
+        extension.
+        """)
+    ).tag(config=True)
+
+    def _prepare_templates(self):
+        # Add templates to web app settings if extension has templates.
+        if len(self.template_paths) > 0:
+            self.settings.update({
+                "{}_template_paths".format(self.extension_name): self.template_paths
+            })
+
+        # Create a jinja environment for logging html templates.
+        self.jinja2_env = Environment(
+            loader=FileSystemLoader(self.template_paths), 
+            extensions=['jinja2.ext.i18n'],
+            autoescape=True,
+            **self.jinja2_options
+        )
+
+        # Get templates defined in a subclass.
+        self.initialize_templates()
+
+        # Add the jinja2 environment for this extension to the tornado settings.
+        self.settings.update(
+            {
+                "{}_jinja2_env".format(self.extension_name): self.jinja2_env 
+            }
+        )
+
+#-----------------------------------------------------------------------------
+# Aliases and Flags
+#-----------------------------------------------------------------------------
+
 flags['no-browser']=(
     {'ExtensionApp' : {'open_browser' : True}},
     _("Prevent the opening of the default url in the browser.")
 )
 
+#-----------------------------------------------------------------------------
+# ExtensionApp
+#-----------------------------------------------------------------------------
 
 class ExtensionApp(JupyterApp):
     """Base class for configurable Jupyter Server Extension Applications.
@@ -98,6 +144,9 @@ class ExtensionApp(JupyterApp):
         class method. This method can be set as a entry_point in 
         the extensions setup.py
     """
+    # Subclasses should override this trait. Tells the server if
+    # this extension allows other other extensions to be loaded
+    # side-by-side when launched directly.
     load_other_extensions = True
 
     # Name of the extension
@@ -302,7 +351,6 @@ def _prepare_templates(self):
             self.settings.update({
                 "{}_template_paths".format(self.extension_name): self.template_paths
             })
-        self.initialize_templates()
 
     @staticmethod
     def initialize_server(argv=[], load_other_extensions=True, **kwargs):
@@ -370,7 +418,6 @@ def load_jupyter_server_extension(cls, serverapp, argv=[], **kwargs):
         extension.initialize(serverapp, argv=argv)
         return extension
 
-
     @classmethod
     def launch_instance(cls, argv=None, **kwargs):
         """Launch the extension like an application. Initializes+configs a stock server 
@@ -405,5 +452,4 @@ def launch_instance(cls, argv=None, **kwargs):
 
             extension = cls.load_jupyter_server_extension(serverapp, argv=args, **kwargs)
             # Start the ioloop.
-            extension.start()
-
+            extension.start()

jupyter_server/extension/handler.py

@@ -2,6 +2,16 @@
 from traitlets import Unicode, default
 
 
+class ExtensionHandlerJinjaMixin:
+    """Mixin class for ExtensionApp handlers that use jinja templating for 
+    template rendering.
+    """
+    def get_template(self, name):
+        """Return the jinja template object for a given name"""
+        env = '{}_jinja2_env'.format(self.extension_name)
+        return self.settings[env].get_template(name)
+
+
 class ExtensionHandler(JupyterHandler):
     """Base class for Jupyter server extension handlers.