Merge pull request #888 from krinsman/step7_8

Step7_8 (Add ability to write default config file)

Author: krinsman

README.md

@@ -193,9 +193,13 @@ publishing, and we'd love to hear from you.
 
 #### Config file
 
-Newer versions of NBViewer will be configurable using a config file, `nbviewer_config.py`. In the directory where you run the command `python -m nbviewer` to start NBViewer, also add a file `nbviewer_config.py` which uses [the standard configuration syntax for Jupyter projects](https://traitlets.readthedocs.io/en/stable/config.html). 
+NBViewer is configurable using a config file, by default called `nbviewer_config.py`. You can modify the name and location of the config file that NBViewer looks for using the `--config-file` command line flag. (The location is always a relative path, i.e. relative to where the command `python -m nbviewer` is run, and never an absolute path.) 
 
-For example, to configure the value of a configurable `foo`, add the line `c.NBViewer.foo = 'bar'` to the `nbviewer_config.py` file located where you run `python -m nbviewer`. Again, currently very few features of NBViewer are configurable this way, but we hope to steadily increase the number of configurable characteristics of NBViewer in future releases.
+If you don't know which attributes of NBViewer you can configure using the config file, run `python -m nbviewer --generate-config` (or `python -m nbviewer --generate-config --config-file="my_custom_name.py"`) to write a default config file which has all of the configurable options commented out and set to their default values. To change a configurable option to a new value, uncomment the corresponding line and change the default value to the new value.
+
+The config file uses [the standard configuration syntax for Jupyter projects](https://traitlets.readthedocs.io/en/stable/config.html).
+
+One thing this allows you to do, for example, is to write your custom implementations of any of the standard page rendering [handlers](https://www.tornadoweb.org/en/stable/guide/structure.html#subclassing-requesthandler) included in NBViewer, e.g. by subclassing the original handlers to include custom logic along with custom output possibilities, and then have these custom handlers always loaded by default, by modifying the corresponding lines in the config file. This is effectively another way to extend NBViewer.
 
 ## Securing the Notebook Viewer
 

nbviewer/app.py

@@ -77,8 +77,6 @@ class NBViewer(Application):
 
     name = Unicode('nbviewer')
 
-    config_file = Unicode('nbviewer_config.py', help="The config file to load").tag(config=True)
-
     # Use this to insert custom configuration of handlers for NBViewer extensions
     handler_settings = Dict().tag(config=True)
 
@@ -335,9 +333,47 @@ def init_tornado_application(self):
         # create the app
         self.tornado_application = web.Application(handlers, debug=options.debug, **settings)
 
+    # Mostly copied from JupyterHub because if it isn't broken then don't fix it
+    def write_config_file(self):
+        """Write our default config to a .py config file"""
+        config_file_dir = os.path.dirname(os.path.abspath(options.config_file))
+        if not os.path.isdir(config_file_dir):
+            self.exit("{} does not exist. The destination directory must exist before generating config file.".format(config_file_dir))
+        if os.path.exists(options.config_file) and not options.answer_yes:
+            answer = ''
+
+            def ask():
+                prompt = "Overwrite %s with default config? [y/N]" % options.config_file
+                try:
+                    return input(prompt).lower() or 'n'
+                except KeyboardInterrupt:
+                    print('')  # empty line
+                    return 'n'
+
+            answer = ask()
+            while not answer.startswith(('y', 'n')):
+                print("Please answer 'yes' or 'no'")
+                answer = ask()
+            if answer.startswith('n'):
+                self.exit("Not overwriting config file with default.")
+
+        # Inherited method from traitlets.Application
+        config_text = self.generate_config_file()
+        if isinstance(config_text, bytes):
+            config_text = config_text.decode('utf8')
+        print("Writing default config to: %s" % options.config_file)
+        with open(options.config_file, mode='w') as f:
+            f.write(config_text)
+        self.exit("Wrote default config file.")
+
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        self.load_config_file(self.config_file)
+
+        if options.generate_config:
+            self.write_config_file()
+
+        # Inherited method from traitlets.Application
+        self.load_config_file(options.config_file)
         self.init_tornado_application()
 
 def init_options():
@@ -353,14 +389,17 @@ def init_options():
     else:
         default_host, default_port = '0.0.0.0', 5000
 
+    define("answer_yes", default=False, help="Answer yes to any questions (e.g. confirm overwrite).", type=bool)
     define("base_url", default='/', help='URL base for the server')
     define("binder_base_url", default="https://mybinder.org/v2", help="URL base for binder notebook execution service", type=str)
     define("cache_expiry_max", default=2*60*60, help="maximum cache expiry (seconds)", type=int)
     define("cache_expiry_min", default=10*60, help="minimum cache expiry (seconds)", type=int)
+    define("config_file", default='nbviewer_config.py', help="The config file to load", type=str)
     define("content_security_policy", default="connect-src 'none';", help="Content-Security-Policy header setting", type=str)
     define("debug", default=False, help="run in debug mode", type=bool)
     define("default_format", default="html", help="format to use for legacy / URLs", type=str)
     define("frontpage", default=FRONTPAGE_JSON, help="path to json file containing frontpage content", type=str)
+    define("generate_config", default=False, help="Generate default config file and then stop.", type=bool)
     define("host", default=default_host, help="run on the given interface", type=str)
     define("ipywidgets_base_url", default="https://unpkg.com/", help="URL base for ipywidgets JS package", type=str)
     define("jupyter_js_widgets_version", default="*", help="Version specifier for jupyter-js-widgets JS package", type=str)

nbviewer/tests/test_app.py

@@ -0,0 +1,40 @@
+import os
+import sys
+
+from tempfile import NamedTemporaryFile
+from subprocess import PIPE
+from subprocess import Popen
+
+# Also copied mostly from JupyterHub since again -- if not broken, don't fix.
+def test_generate_config():
+    with NamedTemporaryFile(prefix='nbviewer_config', suffix='.py') as tf:
+        cfg_file = tf.name
+    with open(cfg_file, 'w') as f:
+        f.write("c.A = 5")
+    p = Popen(
+        [sys.executable, '-m', 'nbviewer', '--generate-config', '--config-file={}'.format(cfg_file)],
+        stdout=PIPE,
+        stdin=PIPE,
+    )
+    out, _ = p.communicate(b'n')
+    out = out.decode('utf8', 'replace')
+    assert os.path.exists(cfg_file)
+    with open(cfg_file) as f:
+        cfg_text = f.read()
+    assert cfg_text == 'c.A = 5'
+
+    p = Popen(
+        [sys.executable, '-m', 'nbviewer', '--generate-config', '--config-file={}'.format(cfg_file)],
+        stdout=PIPE,
+        stdin=PIPE,
+    )
+    out, _ = p.communicate(b'x\ny')
+    out = out.decode('utf8', 'replace')
+    assert os.path.exists(cfg_file)
+    with open(cfg_file) as f:
+        cfg_text = f.read()
+    os.remove(cfg_file)
+    assert cfg_file in out
+    assert 'NBViewer.name' not in cfg_text # This shouldn't be configurable
+    assert 'NBViewer.local_handler' in cfg_text
+    assert 'NBViewer.static_path' in cfg_text