SuperAPI AI 工具集

jupytext

通用与其它

查看项目

更新于 10-16 01:38

技能介绍

用途:帮助用户以纯 Python 脚本形式编写 Jupyter Notebook,借助 Jupytext 完成 .py ↔ .ipynb 双向转换与同步。触发场景包括新建 notebook、提到 jupytext、paired notebook、py:percent、# %% cell 格式、notebook 版本控制,或想把现有 notebook 转成纯 Python 脚本。

主要能力:支持生成 .py(percent format)文件,含 YAML front matter 声明 formats 与 metadata filter;支持生成传统 .ipynb;提供转换为 notebook、反向转 py:percent、设置 paired notebook、同步、round-trip 测试、结合 black 格式化、设置 kernel 等命令行操作。percent format 使用 # %% 标记代码 cell,# %% [markdown] 标记 Markdown cell,Markdown 可用三引号包裹。还支持 light format(# + / # -),但通用性较弱,一般不推荐。

必要用法:安装使用 pip install jupytext;转换命令如 jupytext --to notebook script.py、jupytext --to py:percent notebook.ipynb;启用双向同步先加 front matter 再执行 jupytext --sync script.py;在 JupyterLab 中可通过右键 Open With → Notebook 打开 .py(需安装 jupytext 扩展)。可在 jupytext.toml 或 pyproject.toml 的 [tool.jupytext] 中配置默认格式与 cell_markers。

适用场景:需要 Git diff 友好、便于 code review 的 notebook 开发;偏好纯编辑器(VS Code、PyCharm、Spyder)开发;希望同步维护脚本与 notebook。

限制与注意:应先在 .py 与 .ipynb 间确认用户格式偏好,而非默认代替决定;.py 中不要混用 percent 与 light 分隔符;三引号 Markdown 需在 front matter 或配置中声明 cell_markers。资料未提供具体收费、性能数据或平台兼容性细节。