Skip to main content

无效的测试名称检查器,flake8 的插件

项目描述

构建状态 覆盖状态

Flake8的扩展,以确保测试函数名称遵循给定的约定

Flake8 插件

当同时安装 Flake8 和flake8-test-name时,插件会在显示flake8的版本时显示:

$ flake8 --version
3.6.0 (flake8-test-name: 0.1.2, […]

参数

该模块可以通过 2 种方式配置:–test-func-name-validator-module={path_to_a_python_file} 或 –test-func-name-validator-regex={regex_pattern}

例如使用正则表达式:

$ flake8 myproject/tests/sample.py --test-func-name-validator-regex="test_funky_convention_.*" --select=TN101

>>myproject/tests/sample.py:14:1: TN101 test function name does not match the convention (test_invalid_method_sample)

例如使用模块:: 由于正则表达式并不适合所有用例,因此您还可以将自己的验证器作为 python 文件提供,其中包含名为“test_function_name_validator”的函数。

假设你有一个 funky_validator.py 文件,其内容如下:

def test_function_name_validator(func_name: str):
    return func_name.startswith("test_funkyconvention")

然后,您可以使用以下方式配置插件:

$ flake8 myproject/tests/sample.py --test-func-name-validator-module=./funky_validator.py --select=TN101

>>myproject/tests/sample.py:14:1: TN101 test function name does not match the convention (test_invalid_method_sample)

错误代码

此插件使用以下错误代码:

测试函数名称验证

TN101

TN101 测试函数名称不符合约定

手术

该插件将遍历所有文件,查找以test_开头的文件,并根据您的验证器检查以test_开头的任何函数或方法。

变化

0.1.4 - 2021-03-21

  • 小的重构和文档改进

0.1.1 - 2021-03-19

  • 初始发行

项目详情


下载文件

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

源分布

flake8-test-name-0.1.5.tar.gz (7.8 kB 查看哈希

已上传 source

内置分布

flake8_test_name-0.1.5-py2.py3-none-any.whl (5.1 kB 查看哈希

已上传 py2 py3