如何将Jupyter Notebook连接至IPython.kernel_embed()启动的外部IPython内核？

我完全懂你遇到的这个痛点——用IPython.kernel_embed()在Jupyter Notebook服务器之外启动的内核，能轻松被jupyter console --existing或jupyter qtconsole --existing连上，但Notebook本身偏没有这个--existing参数。正如你了解的，这不是技术上做不到，而是UI层面为了易用性做的取舍，不过咱们可以通过手动操作绕开这个限制，下面给你两种可行的方法：

方法1：手动通过开发者工具连接内核 #

当你用IPython.kernel_embed()启动内核时，终端里会输出类似这样的提示：

To connect another client to this kernel, use: --existing kernel-12345.json

这个kernel-12345.json就是内核的连接文件，通常存放在~/.local/share/jupyter/runtime/目录下（不同系统可能略有不同）。你可以按以下步骤操作：

1. 先把这个连接文件的完整路径记下来；
2. 正常启动Jupyter Notebook服务器，打开一个空白的Notebook；
3. 按下F12打开浏览器的开发者工具，切换到「Console」标签页；
4. 把下面的代码粘贴进去，替换成你的连接文件路径，然后回车执行：

   // 替换成你的内核连接文件路径
   const connectionFile = '/home/your-username/.local/share/jupyter/runtime/kernel-12345.json';
   fetch(connectionFile)
     .then(res => res.json())
     .then(kernelInfo => {
       Jupyter.notebook.session.restart({
         kernel_name: 'python3', // 换成你实际使用的内核名称
         kernel_id: kernelInfo.id,
         connection_file: connectionFile
       });
     });
   

   执行完成后，当前Notebook就会自动连接到你外部启动的那个内核了，变量、已加载的模块都会同步过来。

方法2：给Notebook添加「连接现有内核」的UI按钮 #

如果经常需要做这个操作，手动敲代码太麻烦，咱们可以给Notebook界面加个按钮，一步到位：

1. 首先生成Jupyter配置文件（如果还没生成过）：

   jupyter notebook --generate-config
   

2. 打开生成的配置文件（默认路径是~/.jupyter/jupyter_notebook_config.py），在文件末尾添加以下代码：

   from notebook.utils import url_path_join
   from notebook.base.handlers import IPythonHandler
   import json
   import os
   
   class ExistingKernelHandler(IPythonHandler):
       def get(self):
           kernel_file = self.get_argument('kernel_file')
           # 确保路径安全，避免任意文件读取
           if not os.path.abspath(kernel_file).startswith(os.path.expanduser('~/.local/share/jupyter/runtime/')):
               self.set_status(403)
               self.finish("Invalid kernel file path")
               return
           with open(kernel_file) as f:
               kernel_info = json.load(f)
           self.finish(json.dumps({
               'kernel_id': kernel_info['id'],
               'connection_file': kernel_file
           }))
   
   def load_jupyter_server_extension(nbapp):
       web_app = nbapp.web_app
       host_pattern = '.*$'
       route_pattern = url_path_join(web_app.settings['base_url'], '/existing-kernel')
       web_app.add_handlers(host_pattern, [(route_pattern, ExistingKernelHandler)])
   
   c.NotebookApp.server_extensions.append('__main__')
   

3. 创建自定义JS文件（路径~/.jupyter/custom/custom.js，如果没有这个目录就先创建），添加以下代码：

   $(document).ready(function() {
       // 在Notebook顶部工具栏添加按钮
       $('<button>')
           .text('连接现有内核')
           .addClass('btn btn-default')
           .click(function() {
               const kernelFile = prompt('请输入内核连接文件的完整路径：');
               if (kernelFile) {
                   fetch(`/existing-kernel?kernel_file=${encodeURIComponent(kernelFile)}`)
                       .then(res => res.json())
                       .then(data => {
                           Jupyter.notebook.session.restart({
                               kernel_name: 'python3',
                               kernel_id: data.kernel_id,
                               connection_file: data.connection_file
                           });
                           alert('已成功连接到现有内核！');
                       })
                       .catch(err => {
                           alert('连接失败：' + err.message);
                       });
               }
           })
           .appendTo('.header-bar .pull-right');
   });
   

4. 重启Jupyter Notebook服务器，你会发现界面右上角多了一个「连接现有内核」的按钮，点击后输入连接文件路径就能快速连接了。

一些注意事项 #

• 确保Notebook服务器和外部内核运行在同一台机器上，如果是远程服务器，需要把连接文件复制到Notebook服务器能访问的路径下；
• 连接后，Notebook的所有操作都会在外部内核上执行，关闭外部内核的话，Notebook也会失去连接；
• 方法2里的代码加了路径安全校验，只允许访问Jupyter默认的runtime目录下的文件，避免安全风险。

内容的提问来源于stack exchange，提问作者user2323999