跳转到主要内容

一个用于检测未使用文件的pytest插件

项目描述

pytest-filecov

概述

这是一个pytest插件,用于在测试运行时监控文件访问,然后输出一个报告,列出文件及其是否被访问

$ py.test --filecov tests
============================= test session starts ==============================
platform linux -- Python 3.9.5, pytest-6.2.4, py-1.10.0, pluggy-0.13.1
filecov: tests
rootdir: /home/rohan/src/pytest-filecov
plugins: cov-2.12.1, filecov-0.1.0
collected 3 items

tests/test_plugin.py ...                                                 [100%]

============================ pytest-filecov report =============================
Filename                 Covered?
--------                 --------
tests/__init__.py        0
tests/fakecmd.py         1
tests/test_plugin.py     1
tests/some-file          1
tests/other-file         0
============================== 3 passed in 0.13s ===============================

用法

先决条件

  • Linux
  • inotifywait (尝试安装 inotify-tools 包)

安装插件

pip install pytest-filecov

运行测试套件时,添加 --filecov <path> 指定您希望生成报告的目录树

py.test --filecov somedir

为什么?

此插件针对以下场景

  • 您有一个大型、复杂的测试套件。
  • 您有一些测试依赖于存储在文件中的外部数据。
  • 经过一些重构后,您预计一些测试数据文件现在未使用,并且您想要清理它们,但您没有可靠的方法来确定哪些是或不是使用的。

正如 pytest-cov 可以在重构后帮助您寻找并销毁无效的Python代码,pytest-filecov 也可以对无效/未使用的数据文件执行相同的操作。

注意事项和缺失的功能

此插件非常基础,缺少许多功能。

  • 报告程序的格式不可配置。
  • 报告中包含的文件列表来自 git ls-files,且不可配置。
  • .py 文件可能因各种原因(例如,使用了 .pyc 文件;或者文件在监控开始之前已导入)而被列为未覆盖。

欢迎为改进上述任何内容做出贡献。

许可证

本程序是免费软件:您可以在自由软件基金会发布的GNU通用公共许可证的条款下重新分发和/或修改它,许可证版本为3或更高版本(根据您的选择)。

项目详情


下载文件

下载适用于您平台的应用程序。如果您不确定选择哪个,请了解更多关于安装包的信息。

源代码分布

pytest-filecov-0.1.2.tar.gz (17.1 kB 查看哈希值)

上传时间 源代码

构建分布

pytest_filecov-0.1.2-py3-none-any.whl (18.2 kB 查看哈希值)

上传时间 Python 3