Merge pull request #96 from captainsafia/add-kernelspec-to-connection-file

Add kernel spec name to connection file

Author: minrk

jupyter_client/connect.py

@@ -33,7 +33,7 @@
 
 def write_connection_file(fname=None, shell_port=0, iopub_port=0, stdin_port=0, hb_port=0,
                          control_port=0, ip='', key=b'', transport='tcp',
-                         signature_scheme='hmac-sha256',
+                         signature_scheme='hmac-sha256', kernel_name=''
                          ):
     """Generates a JSON config file, including the selection of random ports.
 
@@ -72,6 +72,8 @@ def write_connection_file(fname=None, shell_port=0, iopub_port=0, stdin_port=0,
         Currently, 'hmac' is the only supported digest scheme,
         and 'sha256' is the default hash function.
 
+    kernel_name : str, optional
+        The name of the kernel currently connected to.
     """
     if not ip:
         ip = localhost()
@@ -127,6 +129,7 @@ def write_connection_file(fname=None, shell_port=0, iopub_port=0, stdin_port=0,
     cfg['key'] = bytes_to_str(key)
     cfg['transport'] = transport
     cfg['signature_scheme'] = signature_scheme
+    cfg['kernel_name'] = kernel_name
 
     with open(fname, 'w') as f:
         f.write(json.dumps(cfg, indent=2))
@@ -379,6 +382,7 @@ def write_connection_file(self):
             shell_port=self.shell_port, hb_port=self.hb_port,
             control_port=self.control_port,
             signature_scheme=self.session.signature_scheme,
+            kernel_name=self.kernel_name
         )
         # write_connection_file also sets default ports:
         for name in port_names:

jupyter_client/tests/test_connect.py

@@ -24,7 +24,12 @@ def initialize(self, argv=[]):
 
 sample_info = dict(ip='1.2.3.4', transport='ipc',
         shell_port=1, hb_port=2, iopub_port=3, stdin_port=4, control_port=5,
-        key=b'abc123', signature_scheme='hmac-md5',
+        key=b'abc123', signature_scheme='hmac-md5', kernel_name='python'
+    )
+
+sample_info_kn = dict(ip='1.2.3.4', transport='ipc',
+        shell_port=1, hb_port=2, iopub_port=3, stdin_port=4, control_port=5,
+        key=b'abc123', signature_scheme='hmac-md5', kernel_name='test'
     )
 
 def test_write_connection_file():
@@ -55,6 +60,23 @@ def test_load_connection_file_session():
     nt.assert_equal(session.signature_scheme, sample_info['signature_scheme'])
 
 
+def test_load_connection_file_session_with_kn():
+    """test load_connection_file() after """
+    session = Session()
+    app = DummyConsoleApp(session=Session())
+    app.initialize(argv=[])
+    session = app.session
+
+    with TemporaryDirectory() as d:
+        cf = os.path.join(d, 'kernel.json')
+        connect.write_connection_file(cf, **sample_info_kn)
+        app.connection_file = cf
+        app.load_connection_file()
+
+    nt.assert_equal(session.key, sample_info_kn['key'])
+    nt.assert_equal(session.signature_scheme, sample_info_kn['signature_scheme'])
+
+
 def test_app_load_connection_file():
     """test `ipython console --existing` loads a connection file"""
     with TemporaryDirectory() as d: