more work on settings

Author: echarles

examples/simple/README.md

@@ -29,7 +29,7 @@ jupyter server --ServerApp.jpserver_extensions="{'simple_ext1': True, 'simple_ex
 Optionally, you can copy `simple_ext1.json` and `simple_ext2.json` configuration to your env `etc` folder and start only Extension 1, which will also start Extension 2.
 
 ```bash
-pip uninstall -y simple_ext
+pip uninstall -y jupyter_simple_ext
 python setup.py install
 cp -r ./etc $(dirname $(which jupyter))/..
 # Start the jupyter server extension simple_ext1, it will also load simple_ext2 because of load_other_extensions = True..
@@ -100,9 +100,9 @@ Try with the above links to check that only Extension 2 is responding (Extension
 
 ## Extension 11 extending Extension 1
 
-`Extension 11` extends `Extension 1`.
+`Extension 11` extends `Extension 1` and brings a few more configs.
 
-It brings a few more configs. Run `jupyter simple-ext11 --generate-config && vi ~/.jupyter/jupyter_config.py`.
+Run `jupyter simple-ext11 --generate-config && vi ~/.jupyter/jupyter_config.py`.
 
 The generated configuration should contains the following.
 

examples/simple/jupyter_server_config.py

@@ -6,8 +6,3 @@
 
 ## The date format used by logging formatters for %(asctime)s
 c.Application.log_datefmt = '%Y-%m-%d %H:%M:%S Simple_Extensions'
-
-c.SimpleApp1.file = 'OK'
-c.SimpleApp2.file = 'OK'
-
-c.SimpleApp11.ignore_js = True

examples/simple/setup.py

@@ -23,7 +23,7 @@ def add_data_files(path):
     return data_files
 
 setuptools.setup(
-    name = 'simple_ext',
+    name = 'jupyter_simple_ext',
     version = VERSION,
     description = 'Jupyter Simple Extension',
     long_description = open('README.md').read(),

examples/simple/simple_ext1/application.py

@@ -1,4 +1,5 @@
 import os, jinja2
+from traitlets import Unicode
 from jupyter_server.extension.application import ExtensionApp
 from .handlers import (DefaultHandler, RedirectHandler, 
   ParameterHandler, TemplateHandler, TypescriptHandler, ErrorHandler)
@@ -27,6 +28,21 @@ class SimpleApp1(ExtensionApp):
         DEFAULT_TEMPLATE_FILES_PATH
     ]
 
+    file = Unicode('',
+        config=True,
+        help='File path'
+    )
+
+    app = Unicode('',
+        config=True,
+        help='File path'
+    )
+
+    cli = Unicode('',
+        config=True,
+        help='File path'
+    )
+
     def initialize_handlers(self):
         self.handlers.extend([
             (r'/{}/default'.format(self.extension_name), DefaultHandler),
@@ -48,14 +64,18 @@ def initialize_templates(self):
         self.settings.update(**template_settings)
 
     def get_conf(self, key):
-        return self.settings.get('config').get('SimpleApp1').get(key, None)
+        c = self.settings.get('config').get(type(self).__name__)
+        if c:
+            return c.get(key, None)
+        else:
+            return None
 
     def initialize_settings(self):
-        self.log.info('SimpleApp1.app {}'.format(self.get_conf('app')))
-        self.log.info('SimpleApp1.file {}'.format(self.get_conf('file')))
-        self.log.info('SimpleApp1.cli {}'.format(self.get_conf('cli')))
-        self.log.info('Complete Settings {}'.format(self.settings))
-        # TODO Check this setting/config handling... Updating does not look to be fine here...
+        self.log.info('333 {}'.format(self.config))
+#        self.log.info('SimpleApp1.app {}'.format(self.get_conf('app')))
+#        self.log.info('SimpleApp1.file {}'.format(self.get_conf('file')))
+#        self.log.info('SimpleApp1.cli {}'.format(self.get_conf('cli')))
+#        self.log.info('Complete Settings {}'.format(self.settings))
 #        self.settings.get('config').get(self.extension_name).update({'app': 'OK'})
 #        self.settings["{}_config".format(self.extension_name)].update(**self.settings.get('config').get('SimpleApp1'))
 

examples/simple/simple_ext1/handlers.py

@@ -3,14 +3,13 @@
 class DefaultHandler(ExtensionHandler):
     def get(self):
         # The ExtensionApp’s config object.
-        self.log.info("Settings: {}".format(self.settings))
-        self.log.info("Config: {}".format(self.config))
-        # TODO The ServerApp’s config object.
+#        self.log.info("Settings in {} Default Handler: {}".format(self.extension_name, self.settings))
+        self.log.info("Config in {} Default Handler: {}".format(self.extension_name, self.config))
         # self.log.info(self.server_config)
         # The name of the extension to which this handler is linked.
-        self.log.info("Extension Name: {}".format(self.extension_name))
+        self.log.info("Extension Name in {} Default Handler: {}".format(self.extension_name, self.extension_name))
         # A method for getting the url to static files (prefixed with /static/<extension_name>).
-        self.log.info("Static URL for /:".format(self.static_url(path='/')))
+        self.log.info("Static URL for / in simple_ext1 Default Handler:".format(self.static_url(path='/')))
         self.write('<h1>Hello Simple 1 - I am the default...</h1>')
 
 class RedirectHandler(ExtensionHandler):

examples/simple/simple_ext11/application.py

@@ -54,20 +54,18 @@ def _update_ignore_js(self, change):
     def simple11_dir_formatted(self):
         return "/" + self.simple11_dir
 
-    def get_conf(self, key):
-        return self.settings.get('config').get('SimpleApp11').get(key, None)
-
     def initialize_settings(self):
-        self.log.info('SimpleApp11.hello: {}'.format(self.get_conf('hello')))
+        self.log.info('SimpleApp11.hello: {}'.format(super().get_conf('hello')))
         self.log.info('hello: {}'.format(self.hello))
         if self.get_conf('hello') == True:
             self.log.info("Hello Simple11 - You have provided the --hello flag or defined 'c.SimpleApp1.hello == True' in jupyter_server_config.py")
         self.log.info('SimpleApp11.simple11_dir: {}'.format(self.get_conf('simple11_dir')))
         self.log.info('SimpleApp11.ignore_js: {}'.format(self.get_conf('ignore_js')))
         self.log.info('ignore_js: {}'.format(self.ignore_js))
-        # TODO Check this setting/config handling... Updating does not look to be fine here...
-        self.settings["{}_config".format(self.extension_name)].update(**self.settings.get('config').get('SimpleApp11'))
-        super().initialize_settings()
+        c = self.settings.get('config').get(type(self).__name__)
+        if c:
+            self.settings["{}_config".format(self.extension_name)].update(**c)
+#        super().initialize_settings()
 
 #-----------------------------------------------------------------------------
 # Main entry point