With kernel templates, also copy any other files in the kernel dir

- This copies logo files that may exist
- This copies the kernel.js that exists in irkernel
- This replaces the previous custom Python logo handling.

Author: rkdarst

envkernel.py

@@ -128,6 +128,7 @@ def setup(self):
         else:
             self.prefix = args.prefix
         self.replace = args.replace
+        self.copy_files = { }
 
         # Setting the kernel.  Go through least-specific to
         # most-specific, updating self.kernel with the latest (most
@@ -140,6 +141,8 @@ def setup(self):
         if args.kernel_template:
             import jupyter_client.kernelspec
             template = jupyter_client.kernelspec.KernelSpecManager().get_kernel_spec(args.kernel_template)
+            template_dir = template.resource_dir
+            self.copy_files.update({x: pjoin(template_dir, x) for x in os.listdir(template_dir)})
             self.kernel = json.loads(template.to_json())
         # --kernel which sets to default well-known kernels.
         if args.kernel is None and 'argv' not in self.kernel:
@@ -169,7 +172,10 @@ def setup(self):
                 import ipykernel
                 ipykernel_dir = os.path.dirname(ipykernel.__file__)
                 logos = glob.glob(pjoin(ipykernel_dir, 'resources', '*'))
-                self.logos = logos
+                for fullpath in logos:
+                    fname = os.path.basename(fullpath)
+                    if fname not in self.copy_files:
+                        self.copy_files[fname] = fullpath
             except ImportError:
                 LOG.debug("Could not automatically find ipykernel logos")
         # env
@@ -206,14 +212,13 @@ def install_kernel(self, kernel, name, user=False, replace=None, prefix=None, lo
             umask = os.umask(0)
             os.umask(umask)  # Restore previous, this is just how it works...
             os.chmod(kernel_dir, 0o777& (~umask))
-            #
+            # Copy files from template.  This also copies kernel.json,
+            # but we will overwrite that next.
+            for fname, fullpath in self.copy_files.items():
+                shutil.copy(fullpath, pjoin(kernel_dir, fname))
+            # Write kernel.json
             open(pjoin(kernel_dir, 'kernel.json'), 'w').write(
                 json.dumps(kernel, sort_keys=True, indent=1))
-            if self.logos:
-                if isinstance(self.logos, str) and os.path.isdir(self.logos):
-                    self.logos = os.listdir(self.logos)
-                for logo in self.logos:
-                    shutil.copy(logo, kernel_dir)
             jupyter_client.kernelspec.KernelSpecManager().install_kernel_spec(
                 kernel_dir, kernel_name=name,
                 user=user, replace=replace, prefix=prefix)

test_envkernel.py

@@ -96,12 +96,23 @@ def test_display_name(d, mode):
 
 @all_modes(['conda'])
 def test_template(d, mode):
+    os.environ['JUPYTER_PATH'] = pjoin(d, 'share/jupyter')
     subprocess.call("python -m ipykernel install --name=aaa-ipy --display-name=BBB --prefix=%s"%d, shell=True)
     #os.environ['ENVKERNEL_TESTPATH'] = os.path.join(d, 'share/jupyter/kernels')
-    os.environ['JUPYTER_PATH'] = pjoin(d, 'share/jupyter')
     kern = install(d, "%s --kernel-template aaa-ipy MOD1"%mode)
     assert kern['kernel']['display_name'] == 'BBB'
 
+@all_modes(['conda'])
+def test_template_copyfiles(d, mode):
+    os.environ['JUPYTER_PATH'] = pjoin(d, 'share/jupyter')
+    subprocess.call("python -m ipykernel install --name=aaa-ipy --display-name=BBB --prefix=%s"%d, shell=True)
+    f = open(pjoin(d, 'share/jupyter/kernels/', 'aaa-ipy', 'A.txt'), 'w')
+    f.write('LMNO')
+    f.close()
+    kern = install(d, "%s --kernel-template aaa-ipy MOD1"%mode)
+    assert os.path.exists(pjoin(kern['dir'], 'A.txt'))
+    assert open(pjoin(kern['dir'], 'A.txt')).read() == 'LMNO'
+
 def test_help():
     """Test that the global -h option works and prints module names"""
     p = subprocess.Popen("python -m envkernel -h", shell=True, stdout=subprocess.PIPE)