Add KernelSpecManager.whitelist

minrk · minrk · commit 233aefaf6835 · 2015-02-02T17:01:08.000-08:00
set of allowed kernels by name

Mainly useful for excluding the 'native' python2/3 kernel,
but it's generic.
diff --git a/IPython/html/notebookapp.py b/IPython/html/notebookapp.py
@@ -345,6 +345,7 @@ class NotebookApp(BaseIPythonApplication):
     classes = [
         KernelManager, ProfileDir, Session, MappingKernelManager,
         ContentsManager, FileContentsManager, NotebookNotary,
+        KernelSpecManager,
     ]
     flags = Dict(flags)
     aliases = Dict(aliases)
@@ -650,9 +651,6 @@ def _mathjax_url_changed(self, name, old, new):
 
     kernel_spec_manager = Instance(KernelSpecManager)
 
-    def _kernel_spec_manager_default(self):
-        return KernelSpecManager(ipython_dir=self.ipython_dir)
-
     kernel_spec_manager_class = Type(
         default_value=KernelSpecManager,
         config=True,
@@ -766,6 +764,7 @@ def init_configurables(self):
         default_secure(self.config)
 
         self.kernel_spec_manager = self.kernel_spec_manager_class(
+            parent=self,
             ipython_dir=self.ipython_dir,
         )
         self.kernel_manager = self.kernel_manager_class(
diff --git a/IPython/kernel/kernelspec.py b/IPython/kernel/kernelspec.py
@@ -8,7 +8,8 @@
 
 from IPython.utils.path import get_ipython_dir
 from IPython.utils.py3compat import PY3
-from IPython.utils.traitlets import HasTraits, List, Unicode, Dict, Any
+from IPython.utils.traitlets import HasTraits, List, Unicode, Dict, Any, Set
+from IPython.config import Configurable
 from .launcher import make_ipkernel_cmd
 
 if os.name == 'nt':
@@ -81,7 +82,7 @@ class NoSuchKernel(KeyError):
     def __init__(self, name):
         self.name = name
 
-class KernelSpecManager(HasTraits):
+class KernelSpecManager(Configurable):
     ipython_dir = Unicode()
     def _ipython_dir_default(self):
         return get_ipython_dir()
@@ -94,9 +95,15 @@ def _user_kernel_dir_default(self):
     def env_kernel_dir(self):
         return pjoin(sys.prefix, 'share', 'jupyter', 'kernels')
     
+    whitelist = Set(config=True,
+        help="""Whitelist of allowed kernel names.
+        
+        By default, all installed kernels are allowed.
+        """
+    )
     kernel_dirs = List(
         help="List of kernel directories to search. Later ones take priority over earlier."    
-    )    
+    )
     def _kernel_dirs_default(self):
         dirs = SYSTEM_KERNEL_DIRS[:]
         if self.env_kernel_dir not in dirs:
@@ -128,6 +135,9 @@ def find_kernel_specs(self):
             d.update(_list_kernels_in(kernel_dir))
 
         d[NATIVE_KERNEL_NAME] = self._native_kernel_resource_dir
+        if self.whitelist:
+            # filter if there's a whitelist
+            d = {name:spec for name,spec in d.items() if name in self.whitelist}
         return d
         # TODO: Caching?
 
@@ -136,7 +146,8 @@ def get_kernel_spec(self, kernel_name):
         
         Raises :exc:`NoSuchKernel` if the given kernel name is not found.
         """
-        if kernel_name in {'python', NATIVE_KERNEL_NAME}:
+        if kernel_name in {'python', NATIVE_KERNEL_NAME} and \
+            (not self.whitelist or kernel_name in self.whitelist):
             return KernelSpec(resource_dir=self._native_kernel_resource_dir,
                               **self._native_kernel_dict)
 
diff --git a/IPython/kernel/kernelspecapp.py b/IPython/kernel/kernelspecapp.py
@@ -22,7 +22,7 @@ class ListKernelSpecs(BaseIPythonApplication):
     flags = {'debug': base_flags['debug'],}
 
     def _kernel_spec_manager_default(self):
-        return KernelSpecManager(ipython_dir=self.ipython_dir)
+        return KernelSpecManager(parent=self, ipython_dir=self.ipython_dir)
 
     def start(self):
         print("Available kernels:")
