Jupyter Notebook 验证工具 nbval 的使用教程

Jupyter Notebook 验证工具 nbval 的使用教程

nbval A py.test plugin to validate Jupyter notebooks 项目地址: https://gitcode.com/gh_mirrors/nb/nbval

1. 项目的目录结构及介绍

nbval 是一个开源项目，它为 py.test 测试框架提供了一个插件，用于验证 Jupyter 笔记本的执行结果是否与预期一致。以下是项目的目录结构及各部分的作用：

• nbval/：项目的根目录，包含了主要的 Python 包和模块。
  • __init__.py：初始化 Python 包，使得目录被识别为一个 Python 包。
  • nbval.py：包含了 nbval 插件的核心逻辑。
• tests/：测试目录，包含了项目的单元测试代码。
• docs/：文档目录，包含了项目文档的源文件。
  • source/：文档源文件目录。
  • build/：构建后的文档目录。
• .github/：GitHub 的工作流文件，用于自动化项目的某些操作，例如发布等。
• setup.py：项目的设置文件，用于定义包的属性和安装依赖。
• README.md：项目的说明文件，包含了项目的简介、安装方式和基本使用方法。
• LICENSE：项目的许可证文件，定义了项目的开源协议。
• INSTALL：安装说明文件，提供了项目安装的详细步骤。
• CONTRIBUTORS：贡献者列表文件，记录了对项目有贡献的开发者。

2. 项目的启动文件介绍

在 nbval 项目中，并没有一个所谓的“启动文件”，因为它是一个作为 py.test 插件存在的项目。用户通过在命令行中使用 py.test 命令并带上 --nbval 参数来调用这个插件。

例如，要运行当前目录下的所有 Jupyter 笔记本文件作为测试，可以使用以下命令：

py.test --nbval

如果要指定一个特定的笔记本文件进行测试，可以使用：

py.test --nbval my_notebook.ipynb

3. 项目的配置文件介绍

nbval 插件使用 ConfigParser 库来读取配置文件，该文件用于定义输出结果的清理规则，例如去除或替换输出中的某些敏感信息。配置文件通常是一个简单的 INI 格式文件，其结构如下：

[Section1]
regex: [a-z]*
replace: abcd
regex: [1-9]*
replace: 0000

[Section2]
regex: foo
replace: bar

在上面的配置文件中，regex 键定义了要匹配的正则表达式，replace 键定义了用于替换匹配到的内容的字符串。每个 [Section] 部分都是独立的，但 nbval 插件会合并所有定义的替换规则。

使用配置文件时，需要通过 --nbval-sanitize-with 参数指定配置文件的路径：

py.test --nbval my_notebook.ipynb --nbval-sanitize-with path/to/my_sanitize_file

以上就是 nbval 项目的目录结构介绍、启动方法以及配置文件的基本使用。通过这些信息，用户可以更好地理解和使用这个开源项目。

nbval A py.test plugin to validate Jupyter notebooks 项目地址: https://gitcode.com/gh_mirrors/nb/nbval