Merge branch 'master' into example

Author: echarles

docs/source/extending/handlers.rst

@@ -115,7 +115,7 @@ following:
         Called when the extension is loaded.
 
         Args:
-            nb_server_app (NotebookWebApplication): handle to the Notebook webserver instance.
+            nb_server_app: handle to the Notebook webserver instance.
         """
         web_app = nb_server_app.web_app
         host_pattern = '.*$'

jupyter_server/extension/application.py

@@ -4,7 +4,8 @@
 from traitlets import (
     Unicode, 
     List, 
-    Dict, 
+    Dict,
+    Bool,
     default, 
     validate
 )
@@ -80,6 +81,12 @@ def _preparse_for_stopping_flags(Application, argv):
         app.exit(0)
 
 
+flags['no-browser']=(
+    {'ExtensionApp' : {'open_browser' : True}},
+    _("Prevent the opening of the default url in the browser.")
+)
+
+
 class ExtensionApp(JupyterApp):
     """Base class for configurable Jupyter Server Extension Applications.
 
@@ -95,21 +102,20 @@ class method. This method can be set as a entry_point in
 
     # Name of the extension
     extension_name = Unicode(
-        "",
         help="Name of extension."
     )
 
-    @default("extension_name")
-    def _default_extension_name(self):
+    def _extension_name_default(self):
         try:
             return self.name
         except AttributeError:
             raise ValueError("The extension must be given a `name`.")
 
     INVALID_EXTENSION_NAME_CHARS = [' ', '.', '+', '/']
 
-    def _validate_extension_name(self):
-        value = self.extension_name
+    @validate('extension_name')
+    def _validate_extension_name(self, value):
+        #value = self.extension_name
         if isinstance(value, str):
             # Validate that extension_name doesn't contain any invalid characters.
             for c in ExtensionApp.INVALID_EXTENSION_NAME_CHARS:
@@ -157,10 +163,31 @@ def static_url_prefix(self):
         help=_("""Handlers appended to the server.""")
     ).tag(config=True)
 
+    def _config_dir_default(self):
+        """Point the config directory at the server's config_dir by default."""
+        try:
+            return self.serverapp.config_dir
+        except AttributeError:
+            raise AttributeError(
+                "The ExtensionApp has not ServerApp "
+                "initialized. Try `.initialize_server()`."
+            )
+
+    def _config_file_name_default(self):
+        """The default config file name."""
+        if not self.extension_name:
+            return ''
+        return 'jupyter_{}_config'.format(self.extension_name.replace('-','_'))
+
     default_url = Unicode('/', config=True,
         help=_("The default URL to redirect to from `/`")
     )
 
+    open_browser = Bool(
+        True,
+        help=_("Should the extension open a browser window?")
+    )
+
     custom_display_url = Unicode(u'', config=True,
         help=_("""Override URL shown to users.
 
@@ -298,10 +325,11 @@ def initialize(self, serverapp, argv=[]):
         - Passes settings to webapp
         - Appends handlers to webapp.
         """
-        self._validate_extension_name()
+        # Initialize ServerApp.
+        self.serverapp = serverapp
+        
         # Initialize the extension application
         super(ExtensionApp, self).initialize(argv=argv)
-        self.serverapp = serverapp
 
         # Initialize config, settings, templates, and handlers.
         self._prepare_config()
@@ -319,7 +347,7 @@ def start(self):
         # Override the server's display url to show extension's display URL.
         self.serverapp.custom_display_url = self.custom_display_url
         # Override the server's default option and open a broswer window.
-        self.serverapp.open_browser = True
+        self.serverapp.open_browser = self.open_browser
         # Hijack the server's browser-open file to land on
         # the extensions home page.
         self.serverapp._write_browser_open_file = self._write_browser_open_file

jupyter_server/serverapp.py

@@ -1124,6 +1124,16 @@ def _update_pylab(self, change):
         )
         self.exit(1)
 
+    notebook_dir = Unicode(
+        config=True,
+        help=_("DEPRECATED, use root_dir.")
+    )
+
+    @observe('notebook_dir')
+    def _update_notebook_dir(self, change):
+        self.log.warning(_("notebook_dir is deprecated, use root_dir"))
+        self.root_dir = change['new']
+
     root_dir = Unicode(config=True,
         help=_("The directory to use for notebooks and kernels.")
     )
@@ -1151,14 +1161,6 @@ def _root_dir_validate(self, proposal):
             raise TraitError(trans.gettext("No such notebook dir: '%r'") % value)
         return value
 
-    @observe('root_dir')
-    def _update_root_dir(self, change):
-        """Do a bit of validation of the notebook dir."""
-        # setting App.root_dir implies setting notebook and kernel dirs as well
-        new = change['new']
-        self.config.FileContentsManager.root_dir = new
-        self.config.MappingKernelManager.root_dir = new
-
     @observe('server_extensions')
     def _update_server_extensions(self, change):
         self.log.warning(_("server_extensions is deprecated, use jpserver_extensions"))
@@ -1209,6 +1211,7 @@ def _update_server_extensions(self, change):
          """))
 
     def parse_command_line(self, argv=None):
+
         super(ServerApp, self).parse_command_line(argv)
 
         if self.extra_args:
@@ -1504,7 +1507,7 @@ def init_server_extensions(self):
                         # Add debug log for loaded extensions.
                         self.log.debug("%s is enabled and loaded." % modulename)
                     else:
-                        self.log.warning("%s is enabled but no `load_jupyter_server_extension` function was found")
+                        self.log.warning("%s is enabled but no `load_jupyter_server_extension` function was found" % modulename)
                 except Exception:
                     if self.reraise_server_extension_failures:
                         raise

tests/extension/conftest.py

@@ -20,6 +20,13 @@ def initialize_handlers(self):
         self.handlers.append(('/mock', MockExtensionHandler))
 
 
+@pytest.fixture
+def config_file(config_dir):
+    f = config_dir.joinpath('jupyter_mock_config.py')
+    f.write_text("c.MockExtension.mock_trait ='config from file'")
+    return f
+
+
 @pytest.fixture
 def extended_serverapp(serverapp):
     m = MockExtension()

tests/extension/test_app.py

@@ -49,11 +49,18 @@ def test_instance_creation_with_instance_args(trait_name, trait_value):
 def test_instance_creation_with_argv(serverapp, trait_name, trait_value):
     kwarg = {}
     kwarg.setdefault(trait_name, trait_value)
-
     argv = [
         '--MockExtension.{name}={value}'.format(name=trait_name, value=trait_value)
     ]
-
     mock_extension = MockExtension()
     mock_extension.initialize(serverapp, argv=argv)
     assert getattr(mock_extension, trait_name) == trait_value
+
+
+def test_extensionapp_load_config_file(config_file, serverapp, extended_serverapp):
+    # Assert default config_file_paths is the same in the app and extension.
+    assert extended_serverapp.config_file_paths == serverapp.config_file_paths
+    assert extended_serverapp.config_file_name == 'jupyter_mock_config'
+    assert extended_serverapp.config_dir == serverapp.config_dir
+    # Assert that the trait is updated by config file
+    assert extended_serverapp.mock_trait == 'config from file'