Merge pull request #81 from minrk/kernelspec-remove

add `jupyter kernelspec remove`

Author: minrk

jupyter_client/kernelspec.py

@@ -12,7 +12,7 @@
 pjoin = os.path.join
 
 from ipython_genutils.py3compat import PY3
-from traitlets import HasTraits, List, Unicode, Dict, Set, Type
+from traitlets import HasTraits, List, Unicode, Dict, Set, Bool, Type
 from traitlets.config import LoggingConfigurable
 
 from jupyter_core.paths import jupyter_data_dir, jupyter_path, SYSTEM_JUPYTER_PATH
@@ -80,6 +80,12 @@ class KernelSpecManager(LoggingConfigurable):
         """
     )
 
+    ensure_native_kernel = Bool(True, config=True,
+        help="""If there is no Python kernelspec registered and the IPython
+        kernel is available, ensure it is added to the spec list.
+        """
+    )
+
     data_dir = Unicode()
     def _data_dir_default(self):
         return jupyter_data_dir()
@@ -123,7 +129,7 @@ def find_kernel_specs(self):
                     self.log.debug("Found kernel %s in %s", kname, kernel_dir)
                     d[kname] = spec
 
-        if NATIVE_KERNEL_NAME not in d:
+        if self.ensure_native_kernel and NATIVE_KERNEL_NAME not in d:
             try:
                 from ipykernel.kernelspec import RESOURCES
                 self.log.debug("Native kernel (%s) available from %s",
@@ -176,6 +182,25 @@ def get_all_specs(self):
                 "spec": self._get_kernel_spec_by_name(kname, d[kname]).to_dict()
                 } for kname in d}
 
+    def remove_kernel_spec(self, name):
+        """Remove a kernel spec directory by name.
+        
+        Returns the path that was deleted.
+        """
+        save_native = self.ensure_native_kernel
+        try:
+            self.ensure_native_kernel = False
+            specs = self.find_kernel_specs()
+        finally:
+            self.ensure_native_kernel = save_native
+        spec_dir = specs[name]
+        self.log.debug("Removing %s", spec_dir)
+        if os.path.islink(spec_dir):
+            os.remove(spec_dir)
+        else:
+            shutil.rmtree(spec_dir)
+        return spec_dir
+
     def _get_destination_dir(self, kernel_name, user=False, prefix=None):
         if user:
             return os.path.join(self.user_kernel_dir, kernel_name)

jupyter_client/kernelspecapp.py

@@ -13,11 +13,17 @@
 from jupyter_core.application import (
     JupyterApp, base_flags, base_aliases
 )
-from traitlets import Instance, Dict, Unicode, Bool
+from traitlets import Instance, Dict, Unicode, Bool, List
 
 from . import __version__
 from .kernelspec import KernelSpecManager
 
+try:
+    raw_input
+except NameError:
+    # py3
+    raw_input = input
+
 class ListKernelSpecs(JupyterApp):
     version = __version__
     description = """List installed kernel specifications."""
@@ -145,6 +151,61 @@ def start(self):
                 self.exit(1)
             raise
 
+class RemoveKernelSpec(JupyterApp):
+    version = __version__
+    description = """Remove one or more Jupyter kernelspecs by name."""
+    examples = """jupyter kernelspec remove python2 [my_kernel ...]"""
+    
+    force = Bool(False, config=True,
+        help="""Force removal, don't prompt for confirmation."""
+    )
+    spec_names = List(Unicode())
+    
+    kernel_spec_manager = Instance(KernelSpecManager)
+    def _kernel_spec_manager_default(self):
+        return KernelSpecManager(data_dir=self.data_dir, parent=self)
+    
+    flags = {
+        'f': ({'RemoveKernelSpec': {'force': True}}, force.get_metadata('help')),
+    }
+    flags.update(JupyterApp.flags)
+    
+    def parse_command_line(self, argv):
+        super(RemoveKernelSpec, self).parse_command_line(argv)
+        # accept positional arg as profile name
+        if self.extra_args:
+            self.spec_names = sorted(set(self.extra_args)) # remove duplicates
+        else:
+            self.exit("No kernelspec specified.")
+    
+    def start(self):
+        self.kernel_spec_manager.ensure_native_kernel = False
+        spec_paths = self.kernel_spec_manager.find_kernel_specs()
+        missing = set(self.spec_names).difference(set(spec_paths))
+        if missing:
+            self.exit("Couldn't find kernel spec(s): %s" % ', '.join(missing))
+        
+        if not self.force:
+            print("Kernel specs to remove:")
+            for name in self.spec_names:
+                print("  %s\t%s" % (name.ljust(20), spec_paths[name]))
+            answer = raw_input("Remove %i kernel specs [y/N]: " % len(self.spec_names))
+            if not answer.lower().startswith('y'):
+                return
+        
+        for kernel_name in self.spec_names:
+            try:
+                path = self.kernel_spec_manager.remove_kernel_spec(kernel_name)
+            except OSError as e:
+                if e.errno == errno.EACCES:
+                    print(e, file=sys.stderr)
+                    print("Perhaps you want sudo?", file=sys.stderr)
+                    self.exit(1)
+                else:
+                    raise
+            self.log.info("Removed %s", path)
+
+
 class InstallNativeKernelSpec(JupyterApp):
     version = __version__
     description = """[DEPRECATED] Install the IPython kernel spec directory for this Python."""
@@ -189,6 +250,8 @@ class KernelSpecApp(Application):
     subcommands = Dict({
         'list': (ListKernelSpecs, ListKernelSpecs.description.splitlines()[0]),
         'install': (InstallKernelSpec, InstallKernelSpec.description.splitlines()[0]),
+        'uninstall': (RemoveKernelSpec, "Alias for remove"),
+        'remove': (RemoveKernelSpec, RemoveKernelSpec.description.splitlines()[0]),
         'install-self': (InstallNativeKernelSpec, InstallNativeKernelSpec.description.splitlines()[0]),
     })
 

jupyter_client/tests/test_kernelspec.py

@@ -3,6 +3,8 @@
 from logging import StreamHandler
 import os
 from os.path import join as pjoin
+from subprocess import Popen, PIPE, STDOUT
+import sys
 import unittest
 
 try:
@@ -27,7 +29,7 @@ class KernelSpecTests(unittest.TestCase):
 
     def _install_sample_kernel(self, kernels_dir):
         """install a sample kernel in a kernels directory"""
-        sample_kernel_dir = pjoin(kernels_dir, 'Sample')
+        sample_kernel_dir = pjoin(kernels_dir, 'sample')
         os.makedirs(sample_kernel_dir)
         json_file = pjoin(sample_kernel_dir, 'kernel.json')
         with open(json_file, 'w') as f:
@@ -40,6 +42,7 @@ def setUp(self):
             'JUPYTER_CONFIG_DIR': pjoin(td.name, 'jupyter'),
             'JUPYTER_DATA_DIR': pjoin(td.name, 'jupyter_data'),
             'JUPYTER_RUNTIME_DIR': pjoin(td.name, 'jupyter_runtime'),
+            'IPYTHONDIR': pjoin(td.name, 'ipython'),
         })
         self.env_patch.start()
         self.addCleanup(td.cleanup)
@@ -130,3 +133,16 @@ def test_cant_install_kernel_spec(self):
             self.ksm.install_kernel_spec(self.installable_kernel,
                                          kernel_name='tstinstalled',
                                          user=False)
+
+    def test_remove_kernel_spec(self):
+        path = self.ksm.remove_kernel_spec('sample')
+        self.assertEqual(path, self.sample_kernel_dir)
+
+    def test_remove_kernel_spec_app(self):
+        p = Popen(
+            [sys.executable, '-m', 'jupyter_client.kernelspecapp', 'remove', 'sample', '-f'],
+            stdout=PIPE, stderr=STDOUT,
+            env=os.environ,
+        )
+        out, _ = p.communicate()
+        self.assertEqual(p.returncode, 0, out.decode('utf8', 'replace'))