nbclick - 将Jupyter笔记本转换为命令行应用程序

nbclick 允许您从命令行修改和运行Jupyter笔记本。它建立在 nbparameterise 之上，后者允许以编程方式提取和修改Jupyter笔记本的参数。

安装

nbclick 可以使用 pip 进行安装

python -m pip install nbclick

您也可以使用 pipx 在安装之前运行 nbclick

pipx run --system-site-packages nbclick

请注意，如果您的笔记本依赖于任何非标准的Python包库，则 --system-site-packages 标志绝对必要。

运行nbclick

安装后，您可以使用命令行运行 nbclick

nbclick

最重要的参数是 NOTEBOOK 参数。对于给定的笔记本，您可以使用 --help 再次显示配置选项

nbclick mynotebook.ipynb --help

使用nbclick准备笔记本以进行执行

nbclick 依赖于 nbparameterise 从您的Jupyter笔记本中提取命令行选项。指定可定制参数的最佳方法是将它们放置在笔记本的第一个代码单元中作为简单的赋值

num_samples = 1000      # The number of samples to draw
outfile = "output.csv"  # The filename to store the results

对于上述情况，nbclick notebook.ipynb --help 的输出将如下

Usage: nbclick notebook.ipynb [OPTIONS]

Options:
  --num_samples INTEGER  The number of samples to draw  [default: 1000]
  --outfile TEXT         The filename to store the results  [default:
                         output.csv]
  --help                 Show this message and exit.

限制

有一些已知的限制，这些限制来自上游项目，我目前不计划为 nbclick 修复这些问题

• 识别的参数类型数量相当少。已知 nbclick 与 int、float、bool、str、list（同质和异质类型）一起工作。最值得注意的是，nbparameterise 不支持 tuple。
• 列表参数限制为固定长度（由其默认值定义）。这是由于 click 自愿选择不提供可变长度列表参数，因为这会引入解析器的歧义。