2020-09-26 安装jupyterlab2.2及各种Extension扩展插件的记录

2021-02-08补充

• jupyterlab最新版本为3.0.7 pip install -U jupyterlab 可以升级到最新版
• 章节索引插件3.0已经默认自带,且不存在cell中的章节目录只能获取到首个的bug
• 部分插件可能不支持3.0版本 如果你装的插件较多,请慎重考虑将lab从2.0迭代到3.0,而是再等等
• 后续插件可能逐渐会变得可以无需通过nodejs, 可以直接pip安装
• jupyterlab是支持gui式的debugger在cell内逐行调试的, 详见这里, 通过这位的方法成功用上了debug.
• 操作界面提供多语言支持,且已存在中文汉化包可通过whl安装试用详见这里, 测试安装也成功了
• 比较惊喜的是kite速度提升了, 从上次测试的等半天出不来补全,到这次变成最多1-2s已经基本可用了(当然我测试还是觉得比起jupyterlab原生的还是慢了太多, 有等待提示的时间, 自己手打也差不多了), https://www.kite.com/download/官网下载exe安装,然后pip install "jupyterlab-kite>=2.0.2"后重启lab就行了

以下内容为之前2.2.8版本安装记录，3.0版本详见上面的两个“详见这里”，有来自其他作者的详细文档，就不重复写了

JupyterLab安装

1. 2020-09-26
   jupyter官网上写的装法：pip install jupyterlab 或 conda install -c conda-forge jupyterlab。
   因为装了Anaconda，发现Anaconda最新2020-07的exe安装包貌似自带了2.1.5的jupyterlab
   搜了一下conda和pip目前最新的jupyterlab版本：conda search jupyterlab是2.2.6，pip search jupyterlab是2.2.8
   本想conda update -c conda-forge jupyterlab更新到2.2.6的，结果更新完执行jupyter lab -V居然还是2.1.5
2. 开始安装
   首先conda uninstall jupyterlab卸载Anaconda自带的旧版jupyterlab
   pip下载安装，下载慢的可以挂镜像pip install -i https://pypi.tuna.tsinghua.edu.cn/simple jupyterlab
   装完JupyterLab终于是最新2.2.8了
   之所以要折腾到最新版，是因为旧版装插件时候各种装不上各种问题，包括自动补全的kite插件都要求2.2以上的jupyterlab，所以还是装最新版吧

创建快捷方式

1. 普通的打开方法是：cmd>jupyter lab即可打开。但是在哪个目录下的命令行输入的jupyter lab，打开后lab的根目录就在哪，为了每次打开，lab目录在自己想要的位置，最好制作一个快捷方式。
2. 新建bat文件，输入你要指定的盘符和目录，然后保存。以后每次启动jupyterlab，直接双击bat文件即可。示例如下：
E: cd "E:\folder" jupyter lab
2022-11-17 补充
jupyterlab默认打开路径是可以修改的（实测jupyterlab3.4.4有效）：
命令行输入jupyter lab --generate-config，会在 C:\Users\用户名\.jupyter\jupyter_lab_config.py 创建一个配置文件，将文件中c.ServerApp.notebook_dir = 'E:/folder'把前面的“#”去掉并指定路径，下次打开JupyterLab时就会是指定的工作目录了。

行号

1. View > Show Line Numbers ，显示代码段行号，勾上，以后敲代码时报错调试找行方便（这个我一开始勾上了，后来因为看着不简洁又取消了，只在代码报错且行数太多的时候勾上就行了，平时用不上）

安装扩展

1. 启用扩展管理
   JupyterLab中点击Settings>EnableExtensionManage，jupyterLab左侧边栏最后一个图标就是扩展管理，点击，第一项是个WARNING第三方扩展风险警告，选Enable就可以启用扩展安装了
2. jupyter扩展需要node.js和npm支持
   node -v，npm -v查看是否安装及版本（写这篇文档时，-v看到的版本分别是12.18.4和6.14.6）。如果没有，去nodejs官网下载LTS版本exe安装包，安装即可。
3. 避免插件build编码问题
   打开C:\Users\L\anaconda3\Lib\site-packages\jupyterlab\commands.py，添加一行encoding="UTF-8"，避免插件安装后，build时出现’gbk’ codec can’t decode的问题。

   self.proc = self._create_process(
       cwd=cwd,
       env=env,
       stderr=subprocess.STDOUT,
       stdout=subprocess.PIPE,
       universal_newlines=True,
       encoding="UTF-8"   
   )
   

4. 安装扩展
   搜索插件名安装, 或cmd下用 jupyter labextension install 插件名安装都行
   1. @jupyterlab/toc 插件用于展示文档内章节索引。.md的文件还行，.ipynb的markdown格式cell貌似有问题，一个cell里只有第一个标题能被检测出来。所以我现在每个标题都是单独一个cell，倒也整齐。
   2. @lckr/jupyterlab_variableinspector 插件用于展示变量值，jupyter这种一个一个cell接力来回反复运行的，其实跟开了调试差不多，还是需要监测一下变量变动的。其他IDE比如Anaconda自带的Spyder也是有这种功能，装了还是比较方便的。插件开发者开发文档里有GIF图，用法直接看就行了很直观。
      
   3. jupyterlab-spreadsheet 插件用于直接预览Excel文件数据，做数据处理保存到excel之类的，直接看一眼还是挺方便的
   4. jupyterlab-execute-time (2020-10-06实测了几天还是关了，并非每个cell都需要统计耗时，开着文档看起来不够整洁，想要确认耗时的时候临时用一下%%time就行了)，插件会自动统计展示每个Cell代码块的执行耗时及最后执行日期时，装好后需要配置：Settings > Advanced Settings Editor > Notebook > User Preferences，加上{“recordTiming”: true}
   5. （此项无需安装）部分html文档暂时打不开，我以为是jupyterlab_html装不上的问题，看github issue里面作者说已经合并到**@jupyterlab/htmlviewer**（lab自带），那说明lab应该能直接开html文档才对，换个了html文件发现确实能开，再看一下之前打不开的文件，发现网页charset是gbk的，看来htmlviewer暂时仅支持utf-8格式的网页文档。
   6. @kiteco/jupyterlab-kite Kite 插件用于代码自动补全(2020-10-06实测了几天还是卸载了, 补全速度实在太慢了, 官方issue里面也有此类反馈, 所以暂时还是用lab自带的补全, 想要尝试的也可以参照装上试试)。最新版的lab不是没有自动补全，但是用惯了SublimeText3+Anaconda补全一上手lab感觉差了一些，好在kite支持了jupyterlab2.2以后的版本了，所以。安装kite桌面版，安装pip install jupyter-kite，最后插件管理中搜@kiteco/jupyterlab-kite安装插件。
   7. @jupyterlab/git，pip install -i https://pypi.tuna.tsinghua.edu.cn/simple --upgrade jupyterlab-git。Git管理就不细说了，说一下JupyterLab。其修改运行git仓库内文件时，会自动产生checkpoint之类的记录点备份文件，而git本身就是在做版本控制，没必要将Jupyter的备份传到仓库去，每次合并代码的时候一堆checkpoint也很烦。所以我会在仓库下增加.gitignore文件，过滤掉一些目录和文件（注意已经在追踪更新状态的文件，即使满足匹配条件，也是不过滤的。除非先删掉或移走，然后更新仓靠后，再将这些文件放回来就行了）。github给出了常见过滤规则在这里，常见匹配写法范例参看这里。最后贴一下我写的.gitignore文件。

      # python
      **/__pycache__/*
      *.py[cod]
      *$py.class
      # jupyter
      **/.ipynb_checkpoints/*
      **/.virtual_documents/*
      

5. 刚装完插件栏会蹦提示igrone或build可以先不用管。装完所有插件，点击build 或者cmd>jupyter lab build就行了。 cmd>jupyter labextension list可以查看已装、已卸、以及尚未build的扩展，已装里build过的插件后面会有ok的字样。

全部装完：