如何在VSCode集成测试中程序化设置默认Jupyter内核？

我们正在开发一款与Jupyter Notebook交互的VSCode扩展，需要在CI/CD流程中运行集成测试。当前采用vscode/test-electron执行测试，流程为：打开Notebook文件→执行单元格，但测试会因等待手动选择Jupyter内核而挂起，导致CI/CD超时；但手动选择测试内核后，测试可正常成功。

已尝试的程序化配置方式 #

我们试过两种自动设置默认内核的方法，但均未解决问题：

1. Notebook元数据注入：直接在Notebook文件中写入内核规格元数据

{
  "metadata": {
    "kernelspec": {
      "name": "test-kernel",
      "display_name": "Python (Test Environment)",
      "language": "python"
    }
  }
}

2. VSCode工作区配置：创建工作区专属配置文件，指定Jupyter扩展相关设置

{
  "python.defaultInterpreterPath": "/path/to/test-venv/bin/python",
  "jupyter.jupyterServerType": "local",
  "jupyter.kernels.default": "test-kernel",
  "jupyter.alwaysTrustNotebooks": true
}

疑问 #

1. 为何集成测试环境中Jupyter Notebook无法像个人VSCode实例那样直接使用默认内核？
2. 是否存在其他程序化选择Jupyter Notebook内核的方法？

问题1解答 #

集成测试环境和个人日常使用的VSCode实例存在几个关键差异，导致默认内核无法自动生效：

• 无用户缓存记录：个人实例通常有历史内核选择的缓存，会自动复用之前的选择；但CI/CD中的测试是全新的无头VSCode实例，没有任何用户状态缓存，无法自动关联内核。
• 无头模式的内核发现逻辑差异：Jupyter扩展在无头（无UI）模式下的内核扫描、注册逻辑和正常UI模式不同，可能不会自动完成内核识别，导致打开Notebook时无法找到预设的默认内核。
• 配置加载时机问题：测试代码可能在VSCode工作区配置、Jupyter扩展设置完全生效前就打开了Notebook，此时配置还未被读取，无法触发默认内核选择。
• 测试内核未完成注册：如果测试环境中的test-kernel是刚创建的虚拟环境，Jupyter扩展可能还未完成内核扫描和注册流程，此时打开Notebook会触发手动选择提示。

问题2解答 #

除了你尝试的两种方法，还有以下几种程序化选择内核的可行方案：

• 通过VSCode API直接设置内核：在测试代码中，打开Notebook后调用VSCode的Notebook API修改元数据，或者调用Jupyter扩展提供的命令选择内核：

  // 示例：通过命令API选择指定内核
  await vscode.commands.executeCommand('jupyter.selectKernel', {
    notebookUri: notebookUri,
    kernelId: 'test-kernel'
  });
  

• 预注册测试内核：在CI环境初始化阶段，用ipython kernel install命令将测试虚拟环境的Python注册为Jupyter内核，确保Jupyter能提前识别到test-kernel：

  /path/to/test-venv/bin/python -m ipykernel install --name test-kernel --display-name "Python (Test Environment)"
  

• 等待内核扫描完成：在测试代码中监听Jupyter扩展的jupyter.kernelsChanged事件，确认目标内核已被扫描到后，再打开Notebook文件，避免因内核未就绪触发选择提示。
• 直接指定Jupyter服务器内核：启动Jupyter服务器时通过--kernel test-kernel参数指定默认内核，在测试代码中配置Jupyter扩展使用该服务器。

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