功能

能够做到

  • 关联 ipynb 和 script 文件
  • 保存执行结果到 ipynb
  • 对 script 版本控制

不能做到

  • 外部 IDE 编辑 script, ipynb 更新输出

    • 需要手动在 jupyter notebook -> scrit.py

      1. 刷新
      2. 执行新加或修改的代码块

IDE

能做到的

  • 编辑 script 代码
  • 重构等

不能做到的

  • 执行 script 代码

特殊执行方案

参考： jupytext/formats.md at main · mwouts/jupytext · GitHub

  • IDE 执行 percent 格式

    • vscode
    • pycharm professional
    • emacs, code-cells 包

创建

普通方法（手动）

  1. 创建 script 脚本文件

    • 创建流程

      • File -> New Text Notebook -> Python Scrit in [markdown, python file]

    • script 文件

      • markdown: *.md

        • 适合文字内容多
      • python: *.py

    • 多种注释风格

      • light
      • percent
      • hydrogen

      • sphinx

        • 只适合 python 文件

  2. 建立关联 *.ipynb 文件

    • 建立流程

      • File -> Jupytext -> Pair notebook with ipynb document
    • 之后保存 script 文件即可

  3. jupyter 命令

    1. Ctrl + Shift + C
    2. 输入 pair
    3. 找到想要关联的文件类型

自动关联 ipynb 和 script 文件

通过 jupytext.toml 配置文件

特点：

  • 位置

    • local
    • global

ipynb 文件作用

  1. 存储 cell 的输出内容

  2. 编辑的同步

    • script 修改，保存后

    • 在 ipynb 文件刷新

      • 注意：

        • ipynb 虽然可以执行
        • 但是，在保存时，会提醒是否覆盖
        • 选择重新加载（reload）即可