more examples related to settings and extension

Author: echarles

examples/simple/README.md

@@ -7,9 +7,9 @@ This folder contains an example of 2 simple extensions on top of Jupyter Server.
 You need `python3` to build and run the server extensions.
 
 ```bash
-conda create -y -n jext python=3.7
-conda activate jext
-pip install -e .
+conda create -y -n jext python=3.7 && \
+  conda activate jext && \
+  pip install -e .
 ```
 
 **OPTIONAL** If you want to build the Typescript code, you need `npm` on your local env. Compiled javascript is provided as artifact in this repository, so this Typescript build step is optional. The Typescript source and configuration has been taken from https://github.com/markellekelly/jupyter-server-example.
@@ -36,21 +36,14 @@ cp -r ./etc $(dirname $(which jupyter))/..
 jupyter simple-ext1
 ```
 
-Now you can render Server content in your browser.
+Now you can render Extension 1 Server content in your browser.
 
 ```bash
-# Default server page should redirect to `/static/simple_ext1/favicon.ico`.
-open http://localhost:8888
-```
-
-Render Extension 1 Server content in your browser.
-x
-```bash
-# Jupyter Server Home Page
+# Jupyter Server Home Page.
 open http://localhost:8888/
-# TODO Fix Default URL.
-# Home page as defined by default_url = '/template1/home'.
-open http://localhost:8888/simple_ext1/
+# TODO Fix Default URL, it does not show on startup.
+# Home page as defined by default_url = '/default'.
+open http://localhost:8888/simple_ext1/default
 # HTML static page.
 open http://localhost:8888/static/simple_ext1/test.html
 # Content from Handlers.
@@ -67,7 +60,7 @@ open http://localhost:8888/simple_ext1/redirect
 open http://localhost:8888/static/simple_ext1/favicon.ico
 ```
 
-Render Extension 2 Server content in your browser.
+You can also render Extension 2 Server content in your browser.
 
 ```bash
 # HTML static page.
@@ -76,8 +69,25 @@ open http://localhost:8888/static/simple_ext2/test.html
 open http://localhost:8888/simple_ext2/params/test?var1=foo
 ```
 
-## Start only Extension 2
+## Settings
+
+Start with additional settings.
+
+```bash
+jupyter server --ServerApp.jpserver_extensions="{'simple_ext1': True, 'simple_ext2': True}" --SimpleApp1.cli=OK
+```
+
+Check the log, it should return on startup something like the following base on the trait you have defined in the CLI and in the `jupyter_server_config.py`.
 
+```
+[SimpleApp1] SimpleApp1.app OK
+[SimpleApp1] SimpleApp1.file OK
+[SimpleApp1] SimpleApp1.cli OK
+[SimpleApp1] Complete Settings {'simple_ext1_config': {}, 'simple_ext1_template_paths': ['/home/datalayer/repos/jupyter-server/examples/simple/simple_ext1/templates'], 'simple_ext1_jinja2_env': <jinja2.environment.Environment object at 0x105ed7438>, 'log_function': <function log_request at 0x105e2d950>, 'base_url': '/', 'default_url': '/', 'template_path': ['/opt/datalayer/opt/miniconda3/envs/datalayer/lib/python3.7/site-packages/jupyter_server', '/opt/datalayer/opt/miniconda3/envs/datalayer/lib/python3.7/site-packages/jupyter_server/templates'], 'static_path': ['/opt/datalayer/opt/miniconda3/envs/datalayer/lib/python3.7/site-packages/jupyter_server/static'], 'static_custom_path': ['/home/datalayer/.jupyter/custom', '/opt/datalayer/opt/miniconda3/envs/datalayer/lib/python3.7/site-packages/jupyter_server/static/custom'], 'static_handler_class': <class 'jupyter_server.base.handlers.FileFindHandler'>, 'static_url_prefix': ...
+```
+
+## Start only Extension 2
+`
 Now stop the server and start again with only Extension 2.
 
 ```bash
@@ -86,3 +96,33 @@ jupyter simple-ext2
 ```
 
 Try with the above links to check that only Extension 2 is responding (Extension 1 URLs should give you an 404 error).
+
+## Extension 11 extending Extension 1
+
+```bash
+jupyter simple-ext11
+# or...
+jupyter server --ServerApp.jpserver_extensions="{'simple_ext11': True}"
+```
+
+```bash
+# Jupyter Server Home Page.
+open http://localhost:8888/
+# TODO Fix Default URL, it does not show on startup.
+# Home page as defined by default_url = '/default'.
+open http://localhost:8888/simple_ext11/default
+# HTML static page.
+open http://localhost:8888/static/simple_ext11/test.html
+# Content from Handlers.
+open http://localhost:8888/simple_ext11/params/test?var1=foo
+# Content from Template.
+open http://localhost:8888/simple_ext11/template1/test
+# Content from Template with Typescript.
+open http://localhost:8888/simple_ext11/typescript
+# Error content.
+open http://localhost:8888/simple_ext11/nope
+# Redirect.
+open http://localhost:8888/simple_ext11/redirect
+# Favicon static content.
+open http://localhost:8888/static/simple_ext11/favicon.ico
+```

examples/simple/etc/jupyter/jupyter_server_config.d/simple_ext11.json

@@ -0,0 +1,7 @@
+{
+    "ServerApp": {
+        "jpserver_extensions": {
+            "simple_ext11": true
+        }
+    }
+}

examples/simple/jupyter_server_config.py

@@ -0,0 +1,11 @@
+# Configuration file for jupyter-server extensions.
+
+#------------------------------------------------------------------------------
+# Application(SingletonConfigurable) configuration
+#------------------------------------------------------------------------------
+
+## 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'

examples/simple/setup.py

@@ -13,7 +13,7 @@ def add_data_files(path):
         for (dirpath, dirnames, filenames) in os.walk(path):
             if filenames:
                 data_files.append((dirpath, [os.path.join(dirpath, filename) for filename in filenames]))
-    # Add all the templates
+    # Add all static and templates folders.
     add_data_files('simple_ext1/static')
     add_data_files('simple_ext1/templates')
     add_data_files('simple_ext2/static')
@@ -40,6 +40,7 @@ def add_data_files(path):
     entry_points = {
         'console_scripts': [
              'jupyter-simple-ext1 = simple_ext1.application:main',
+             'jupyter-simple-ext11 = simple_ext11.application:main',
              'jupyter-simple-ext2 = simple_ext2.application:main'
         ]
     },

examples/simple/simple_ext1/application.py

@@ -1,17 +1,18 @@
 import os, jinja2
 from jupyter_server.extension.application import ExtensionApp
-from .handlers import RedirectHandler, ParameterHandler, TemplateHandler, TypescriptHandler, ErrorHandler
+from .handlers import (DefaultHandler, RedirectHandler, ParameterHandler, 
+  TemplateHandler, TypescriptHandler, ErrorHandler)
 
 DEFAULT_STATIC_FILES_PATH = os.path.join(os.path.dirname(__file__), "static")
 DEFAULT_TEMPLATE_FILES_PATH = os.path.join(os.path.dirname(__file__), "templates")
 
 class SimpleApp1(ExtensionApp):
 
-    # The name of the extension
+    # The name of the extension.
     extension_name = "simple_ext1"
 
     # Te url that your extension will serve its homepage.
-    default_url = '/template/home'
+    default_url = '/default'
 
     # Should your extension expose other server extensions when launched directly?
     load_other_extensions = True
@@ -28,11 +29,12 @@ class SimpleApp1(ExtensionApp):
 
     def initialize_handlers(self):
         self.handlers.extend([
-            (r'/simple_ext1/params/(.+)$', ParameterHandler),
-            (r'/simple_ext1/template1/(.*)$', TemplateHandler),
-            (r'/simple_ext1/redirect', RedirectHandler),
-            (r'/simple_ext1/typescript/?', TypescriptHandler),
-            (r'/simple_ext1/(.*)', ErrorHandler)
+            (r'/{}/default'.format(self.extension_name), DefaultHandler),
+            (r'/{}/params/(.+)$'.format(self.extension_name), ParameterHandler),
+            (r'/{}/template1/(.*)$'.format(self.extension_name), TemplateHandler),
+            (r'/{}/redirect'.format(self.extension_name), RedirectHandler),
+            (r'/{}/typescript/?'.format(self.extension_name), TypescriptHandler),
+            (r'/{}/(.*)', ErrorHandler)
         ])
 
     def initialize_templates(self):
@@ -45,8 +47,15 @@ def initialize_templates(self):
         template_settings = {"simple_ext1_jinja2_env": env}
         self.settings.update(**template_settings)
 
+    def get_conf(self, key):
+        return self.settings.get('config').get('SimpleApp1').get(key, None)
+
     def initialize_settings(self):
-        pass
+        self.settings.get('config').get('SimpleApp1').update({'app': 'OK'})
+        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))
 
 #-----------------------------------------------------------------------------
 # Main entry point

examples/simple/simple_ext1/handlers.py

@@ -1,11 +1,23 @@
 from jupyter_server.extension.handler import ExtensionHandler
 
+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(self.server_config)
+        # The name of the extension to which this handler is linked.
+        self.log.info("Extension Name: {}".format(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.write('<h1>Hello Simple 1 - I am the default...</h1>')
+
 class RedirectHandler(ExtensionHandler):
     def get(self):
-        self.redirect("/static/simple_ext1/favicon.ico")
+        self.redirect("/static/{}/favicon.ico".format(self.extension_name))
 
-class ParameterHandler(ExtensionHandler):
-    
+class ParameterHandler(ExtensionHandler):    
     def get(self, matched_part=None, *args, **kwargs):
         var1 = self.get_argument('var1', default=None)
         components = [x for x in self.request.path.split("/") if x]
@@ -15,23 +27,19 @@ def get(self, matched_part=None, *args, **kwargs):
         self.write('<p>components: {}</p>'.format(components))
 
 class BaseTemplateHandler(ExtensionHandler):
-
     def get_template(self, path):
         """Return the jinja template object for a given name"""
         return self.settings['simple_ext1_jinja2_env'].get_template(path)
 
 class TypescriptHandler(BaseTemplateHandler):
-    
     def get(self):
         self.write(self.render_template("typescript.html"))
 
 class TemplateHandler(BaseTemplateHandler):
-    
     def get(self, path):
 #        print(self.get_template('simple1.html'))
         self.write(self.render_template('simple1.html', path=path))
 
 class ErrorHandler(BaseTemplateHandler):
-    
     def get(self, path):
         self.write(self.render_template('error.html', path=path))

examples/simple/simple_ext11/__init__.py

@@ -0,0 +1,8 @@
+from .application import SimpleApp1
+
+def _jupyter_server_extension_paths():
+    return [
+        {'module': 'simple_ext1'}
+    ]
+
+load_jupyter_server_extension = SimpleApp1.load_jupyter_server_extension

examples/simple/simple_ext11/application.py

@@ -0,0 +1,35 @@
+import os
+from simple_ext1.application import SimpleApp1
+
+DEFAULT_STATIC_FILES_PATH = os.path.join(os.path.dirname(__file__), "./../simple_ext1/static")
+DEFAULT_TEMPLATE_FILES_PATH = os.path.join(os.path.dirname(__file__), "./../simple_ext1/templates")
+
+class SimpleApp11(SimpleApp1):
+    
+    # The name of the extension.
+    extension_name = "simple_ext11"
+
+    # Local path to static files directory.
+    static_paths = [
+        DEFAULT_STATIC_FILES_PATH
+    ]
+
+    # Local path to templates directory.
+    template_paths = [
+        DEFAULT_TEMPLATE_FILES_PATH
+    ]
+
+    def initialize_handlers(self):
+        super().initialize_handlers()
+
+    def initialize_templates(self):
+        super().initialize_templates()
+
+    def initialize_settings(self):
+        super().initialize_templates()
+
+#-----------------------------------------------------------------------------
+# Main entry point
+#-----------------------------------------------------------------------------
+
+main = launch_new_instance = SimpleApp11.launch_instance

examples/simple/simple_ext2/application.py

@@ -7,7 +7,7 @@
 
 class SimpleApp2(ExtensionApp):
 
-    # The name of the extension
+    # The name of the extension.
     extension_name = "simple_ext2"
 
     # Te url that your extension will serve its homepage.

examples/simple/simple_ext2/handlers.py

@@ -1,7 +1,6 @@
 from jupyter_server.extension.handler import ExtensionHandler
 
 class ParameterHandler(ExtensionHandler):
-    
     def get(self, matched_part=None, *args, **kwargs):
         var1 = self.get_argument('var1', default=None)
         components = [x for x in self.request.path.split("/") if x]
@@ -11,23 +10,19 @@ def get(self, matched_part=None, *args, **kwargs):
         self.write('<p>components: {}</p>'.format(components))
 
 class BaseTemplateHandler(ExtensionHandler):
-
     def get_template(self, name):
         """Return the jinja template object for a given name"""
         return self.settings['simple_ext2_jinja2_env'].get_template(name)
 
 class IndexHandler(BaseTemplateHandler):
-    
     def get(self):
         self.write(self.render_template("index.html"))
 
 class TemplateHandler(BaseTemplateHandler):
-    
     def get(self, path):
         print(self.get_template('simple_ext2.html'))
         self.write(self.render_template('simple_ext2.html', path=path))
 
 class ErrorHandler(BaseTemplateHandler):
-    
     def get(self, path):
         self.write(self.render_template('error.html'))