Merge pull request #5 from mariobuikhuizen/jupyter-data-dirs

feat: use jupyter data dirs to load snippets

Author: jtpio

README.md

@@ -22,15 +22,11 @@ jupyter lab build
 
 ## Usage
 
-In `jupyter_notebook_config.py`:
-
-```python
-c.JupyterLabCodeSnippets.snippet_dir = "/path/to/snippets"
-```
+Add snippets in `[jupyter_data_dir]/code_snippets` (see: https://jupyter.readthedocs.io/en/latest/projects/jupyter-directories.html#id2)
 
 In JupyterLab, use the "Code Snippets" menu to select the snippet:
 
-![screenshot](./screenshot.png)
+<img width="398" alt="Schermafbeelding 2020-03-26 om 13 16 34" src="https://user-images.githubusercontent.com/46192475/77646139-40a21c00-6f64-11ea-9073-fe2d1052928f.png">
 
 
 ## Troubleshoot

jupyterlab-code-snippets/__init__.py

@@ -16,8 +16,6 @@ def load_jupyter_server_extension(nb_app):
     nb_app: notebook.notebookapp.NotebookApp
         Notebook application instance
     """
-    snippet_dir = nb_app.config.get('JupyterLabCodeSnippets', {}).get('snippet_dir', '')
-    # TODO: add snippets from jupyter paths?
 
-    loader = SnippetsLoader(snippet_dir)
+    loader = SnippetsLoader()
     setup_handlers(nb_app.web_app, loader)

jupyterlab-code-snippets/loader.py

@@ -2,29 +2,40 @@
 
 from pathlib import PurePath
 
+from jupyter_core.paths import jupyter_path
+
+import tornado
+
 
 class SnippetsLoader:
-    def __init__(self, snippet_dir):
-        self.snippet_dir = snippet_dir
+    def __init__(self):
+        self.snippet_paths = jupyter_path("code_snippets")
 
     def collect_snippets(self):
-        # TODO: handle multiple directories
-        root = self.snippet_dir
         snippets = []
-        for dirpath, dirnames, filenames in os.walk(root):
-            for f in filenames:
-                fullpath = PurePath(dirpath).relative_to(root).joinpath(f)
-                snippets.append(fullpath.parts)
+        for root_path in self.snippet_paths:
+            for dirpath, dirnames, filenames in os.walk(root_path):
+                for f in filenames:
+                    fullpath = PurePath(dirpath).relative_to(root_path).joinpath(f)
+
+                    if fullpath.parts not in snippets:
+                        snippets.append(fullpath.parts)
+
         snippets.sort()
         return snippets
 
     def get_snippet_content(self, snippet):
         try:
-            path = os.path.join(self.snippet_dir, *snippet)
-            with open(path) as f:
-                content = f.read()
-        except:
-            content = ''
+            for root_path in self.snippet_paths:
+                path = os.path.join(root_path, *snippet)
+
+                # Prevent access to the entire file system when the path contains '..'
+                accessible = os.path.realpath(path).startswith(root_path)
 
-        return content
+                if accessible and os.path.isfile(path):
+                    with open(path) as f:
+                        return f.read()
+        except:
+            raise tornado.web.HTTPError(status_code=500)
 
+        raise tornado.web.HTTPError(status_code=404)

package.json

@@ -37,12 +37,12 @@
     "watch": "tsc -w"
   },
   "dependencies": {
-    "@jupyterlab/application": "^2.0.0-rc.0",
-    "@jupyterlab/apputils": "^2.0.0-rc.0",
-    "@jupyterlab/coreutils": "^4.0.0-rc.0",
-    "@jupyterlab/mainmenu": "^2.0.0-rc.0",
-    "@jupyterlab/notebook": "^2.0.0-rc.0",
-    "@jupyterlab/services": "^5.0.0-rc.0",
+    "@jupyterlab/application": "^2.0.2",
+    "@jupyterlab/apputils": "^2.0.2",
+    "@jupyterlab/coreutils": "^4.0.2",
+    "@jupyterlab/mainmenu": "^2.0.2",
+    "@jupyterlab/notebook": "^2.0.2",
+    "@jupyterlab/services": "^5.0.2",
     "@lumino/commands": "^1.9.2",
     "@lumino/widgets": "^1.10.0"
   },

screenshot.png

@@ -24,7 +24,7 @@
 
 # Representative files that should exist after a successful build
 jstargets = [
-    os.path.join(HERE, "lib", "jupyterlab-code-snippets.js"),
+    os.path.join(HERE, "lib", "snippets.js"),
 ]
 
 package_data_spec = {

setup.py

@@ -11,7 +11,13 @@ import { INotebookTracker, NotebookActions } from "@jupyterlab/notebook";
 
 import { CommandRegistry } from '@lumino/commands';
 
-import { Menu } from '@lumino/widgets';
+import {
+  MenuSvg,
+  pythonIcon,
+  terminalIcon,
+  textEditorIcon,
+  folderIcon,
+} from '@jupyterlab/ui-components';
 
 import { listSnippets, Snippet, fetchSnippet } from "./snippets";
 
@@ -52,7 +58,7 @@ function toTree(snippets: Snippet[]) {
  * @param path The current path in the tree.
  */
 function createMenu(commands: CommandRegistry , tree: Tree, path: string[] = []) {
-  const menu = new Menu({ commands });
+  const menu = new MenuSvg({ commands });
   for (const [name, map] of tree.entries()) {
     const fullpath = path.concat(name);
     if (map.size === 0) {
@@ -63,6 +69,7 @@ function createMenu(commands: CommandRegistry , tree: Tree, path: string[] = [])
     } else {
       const submenu = createMenu(commands, map, path.concat(name));
       submenu.title.label = name;
+      submenu.title.icon = folderIcon;
       menu.addItem({type: 'submenu', submenu});
     }
   }
@@ -91,9 +98,16 @@ const extension: JupyterFrontEndPlugin<void> = {
     }
 
     commands.addCommand(CommandIDs.open, {
-      label: args => {
-        const label = args['label'] as string;
-        return PathExt.basename(label, PathExt.extname(label));
+      label: args => args['label'] as string,
+      icon: args => {
+        const ext = PathExt.extname(args['label'] as string);
+        if (ext === '.py') {
+          return pythonIcon;
+        }
+        if (ext === '.sh') {
+          return terminalIcon;
+        }
+        return textEditorIcon;
       },
       execute: async args => {
         const path = args['path'] as string[];