Django Coverage Plugin 项目使用教程

1. 项目目录结构及介绍

Django Coverage Plugin 是一个用于测量 Django 模板执行测试覆盖率的插件。项目的目录结构如下：

• .github/: 存放 GitHub 工作流文件，用于自动化测试、构建等流程。
• tests/: 包含项目的单元测试文件。
• .editorconfig: EditorConfig 配置文件，用于统一不同编辑器的编码风格。
• .gitignore: Git 忽略文件，用于指定不需要提交到版本库的文件。
• AUTHORS.txt: 项目贡献者名单。
• LICENSE.txt: 项目许可证文件，本项目采用 Apache-2.0 许可。
• MANIFEST.in: 打包时包含的文件列表。
• Makefile: Makefile 文件，用于定义项目的构建规则。
• NOTICE.txt: 项目声明文件。
• README.rst: 项目说明文件，包含项目的简介、安装和使用方法等。
• howto.txt: 使用说明文件，提供项目的详细使用步骤。
• requirements.txt: 项目依赖文件，列出了项目所需的第三方库。
• setup.cfg: 项目设置文件，用于定义打包和分发时的配置。
• setup.py: 项目打包脚本，用于构建和发布项目。
• tox.ini: tox 配置文件，用于自动化测试。

2. 项目的启动文件介绍

项目的启动主要是通过 setup.py 脚本实现的。该脚本定义了项目的元数据和安装依赖。使用以下命令安装项目：

python3 -m pip install django_coverage_plugin

安装完成后，你可以在 Django 项目的 .coveragerc 配置文件中添加以下设置来启用插件：

[run]
plugins = django_coverage_plugin

然后运行你的测试，coverage.py 会测量你的模板和 Python 模块的测试覆盖率。

3. 项目的配置文件介绍

项目的配置主要通过 .coveragerc 文件进行。以下是一个基本的配置示例：

[run]
plugins = django_coverage_plugin

[django_coverage_plugin]
template_extensions = html, htm, txt

在 [django_coverage_plugin] 部分，你可以指定要包括在覆盖率报告中的模板文件扩展名。默认情况下，插件会查找扩展名为 .html、.htm 或 .txt 的文件。

确保在 Django 设置中启用了模板调试，这通常在 settings.py 文件中设置如下：

TEMPLATES = [
    {
        ...
        'OPTIONS': {
            'debug': True,
        },
    },
]

如果没有启用模板调试，插件将无法正确测量模板的覆盖率，并会抛出异常。确保正确配置后，就可以运行测试并查看覆盖率报告了。