解决 Anaconda 安装 nb_conda_kernels 后 Jupyter Lab 启动报错且无法安装插件的问题

1. 问题

• 问题1
• Config option kernel_spec_manager_class not recognized by LabApp.
• Config option kernel_spec_manager_class not recognized by NotebookApp.

这是安装 nb_conda_kernels 后，启动 Jupter Lab 时出现的问题

• 问题2
• Config option kernel_spec_manager_class not recognized by InstallLabExtensionApp.

这是进入 Jupyter Lab 后，安装插件时遇到的问题

2. 原因分析

根据 jupyter/notebook 项目中 Issues 中的一篇帖子 kernel_spec_manager_class not recognized Issue #5855。导致问题出现的原因是，NotebookApp.kernel_spec_manager_class 默认会调用 jupyter_client.kernelspec.KernelSpecManager，nb_conda_kernels 安装后修改了 jupyter_client.kernelspec.KernelSpecManager 的默认设置。

以上情况是 Jupyter Notebook 中的情况，在 Jupyter Lab 中原因是一样的，只是名称有所不同。

在 Jupyter Lab中，是 c.ServerApp.kernel_spec_manager_class 调用 jupyter_client.kernelspec.KernelSpecManager，因此 nb_conda_kernels 安装后修改的是 jupyter_client.kernelspec.KernelSpecManager，的默认设置。

• Jupyter Lab 生成配置文件的命令为：

jupyter lab --generate-config

3. 解决方案

按照前面的分析，问题处理的思路十分简单，只要将 jupyter_client.kernelspec.KernelSpecManager 重新设置即可。

• 3.1 查找 jupyter_client.kernelspec.KernelSpecManager 配置文件的路径

 jupyter trust --debug

• 3.2 修改找到的配置文件

修改前

   {
     "JupyterApp": {
       "kernel_spec_manager_class": "nb_conda_kernels.CondaKernelSpecManager"
     }
   }

修改后

{
  "CondaKernelSpecManager": {
    "kernelspec_path": "--user",
    "name_format": "{kernel} ({environment})"
  }
}

4. 效果

• 4.1 启动效果
  

• 4.2 安装插件效果
  

• 4.3 多环境呈现效果
  

5. 补充

• 5.1 关于修改配置后原有内核被清空的问题
  我个人的看法是内核实际上并未清空，只是首次修改后jupyter lab的内核检测机制可能“抽风”，因为最开始实际上并没有这个问题，某个版本后这一现象才开始出现。我也遇到过，其实解决起来十分简单，只要重新生成一下jupyter lab的匹置文件，让jupyter lab重新按照之前修改的配置文件检测并加载内核即可。

jupyter lab --generate-config

• 5.2 关于内核被清空的进一步探讨（仅在 Mac 中测试）
  之前虽然进行了一些探讨，也给出解决方案，可是大家反馈还是存在一些问题。就个人的经验来看，这个问题可能与 jupyter notebook 向 jupyter lab 转换导致参数引用发生发生改变有关。首先，nb_conda_kernels 最早是针对 jupyter notebook 开发的，在 jupyter lab 开发早期，其对 jupyter notebook 支持较好，多数参数是兼容的，而后期 jupyter lab 的参数系统逐渐完善、自成体系，也就导致该问题的出现。其次，从参数的角度来看，最大的改变莫过于 jupyter lab 的参数体系将 jupyter notebook 参数体系中的 JupyterApp 全面替换为 ServerApp ，其他方面改动不大，这样带来的后果便是在 jupyter notebook 中使用 nb_conda_kernels 并不会出现问题，而在 jupyter lab 中使用 nb_conda_kernels 则会出现许多意想不到的问题。最后，根据这一思路，解决这一问题的方法其实十分简单，jupyter lab 与 jupyter notebook 的参数本质并无不同，只是引用的名字发生改变，因此只要将 nb_conda_kernels 中导致问题出现的涉及的 jupyter notebook 的参数改为 jupyter lab 中的相应参数即可，也就是将 JupyterApp 改为 ServerApp。
  

{
  "ServerApp": {
    "kernel_spec_manager_class": "nb_conda_kernels.CondaKernelSpecManager"
  }
}

参考文献

[1] kernel_spec_manager_class not recognized Issue
[2] 关于jupyter notebook启动时一些报错
[3] Conda environments in Jupyter ecosystem without pain