Ruff PT006 规则深度解析pytest.mark.parametrize参数名类型检查与未知 argvalues场景下的修复抑制【免费下载链接】ruffAn extremely fast Python linter and code formatter, written in Rust.项目地址: https://gitcode.com/GitHub_Trending/ru/ruff导读本文围绕 RuffRust 编写的高性能 Python 代码检查器中flake8-pytest-style插件家族的PT006规则展开。以仓库内 mdtest 回归用例 pytest-parametrize-names-wrong-type.md 为引子讲解 Ruff 如何检查传给pytest.mark.parametrize的参数名容器类型、parametrize-names-type配置如何影响诊断与自动修复以及为什么当argvalues中出现无法静态确定取值如变量引用的元素时Ruff 会保留诊断但抑制修复。读完本文你将理解 PT006 的完整判定逻辑、自动修复的语义前提以及一条真实 bugissue #24715被回归测试锁定的设计取舍。一、规则定位argnames的三种合法形态与 PT006 的检查目标pytest.mark.parametrize(argnames, argvalues)的第一个参数argnames在 pytest 文档中允许是字符串或字符串序列单个参数名直接用字符串例如param多个参数名可以是逗号分隔的字符串CSV例如param1,param2也可以是显式的元组或列表例如(param1, param2)或[param1, param2]。这种灵活性给了编码风格混乱的空间。Ruff 规则PT006PytestParametrizeNamesWrongType的职责正是检查传给argnames的容器类型是否符合项目约定的风格。其源码 docstring 位于 parametrize.rs明确了两条期望单一参数一律期望使用字符串如param不应写成(param,)或[param]多参数期望遵循配置项lint.flake8-pytest-style.parametrize-names-type指定的风格元组、列表或 CSV 字符串之一。该规则的 Violation 定义声明于 parametrize.rs#L68-L120属于Category::Pedanticpedantic 类别需显式开启自v0.0.208起稳定其FixAvailability为Sometimes——即不是所有诊断都附带可自动应用的修复这一点正是本文第 4 节回归用例的核心。判定示例来自规则 docstringimport pytest # 违规单一参数却用单元素元组期望改写成字符串 pytest.mark.parametrize((param,), [1, 2, 3]) def test_foo(param): ... # 违规多个参数使用了列表而配置期望元组风格 pytest.mark.parametrize([param1, param2], [(1, 2), (3, 4)]) def test_bar(param1, param2): ...二、如何启用与配置 PT006启用规则在pyproject.toml或ruff.toml中通过select显式选择。回归文档给出了最小配置[lint] select [PT006]由于 PT006 属于 pedantic 类别默认的规则集合不会包含它需要像上面这样显式select或加入extend-select。关键配置项parametrize-names-type规则同时受lint.flake8-pytest-style.parametrize-names-type约束。该配置在 settings.rs 中挂接到插件的Settings结构其可选值与默认值定义在 types.rs#L7-L28取值含义Display输出期望的多参数风格csvstring of comma-separated valuesparam1,param2tuple默认tuple(param1, param2)listlist[param1, param2]需要注意默认值是tuple#[default]标注于Tuple变体上而非 CSV。也就是说在默认配置下pytest.mark.parametrize(param1,param2, ...)这种 CSV 写法同样会被 PT006 提示改写成元组风格。参考配置写法[tool.ruff.lint.flake8-pytest-style] parametrize-names-type csv # 或 tuple / list从源码结构看PT006 的判定入口位于 check_names它会先读取该配置再按argnames表达式的实际形态分支处理字符串字面量Expr::StringLiteral用 split_names 按逗号切分。若切分出多个名字且配置期望tuple/list报告诊断并提供改写修复CSV 风格下则不报单元素元组或单元素列表进入handle_single_name特殊路径见第 3 节期望退化为纯字符串这正是回归用例覆盖的场景多元素元组/列表与配置风格比对元组→列表、列表→元组、多元素→CSV 均可触发诊断并按需提供转换修复其中转 CSV 的修复依赖elts_to_csv仅在所有元素都是字符串字面量时才生成见 parametrize.rs#L305-L328。规则诊断消息文本按单一参数 / 多参数呈现两种变体parametrize.rs#L79-L99单一参数Wrong type passed to first argument of pytest.mark.parametrize; expected str多参数且期望 CSVexpected a string of comma-separated values多参数且期望 tuple/listexpected tuple/expected list。修复标题则统一为Use a string for the first argument/Use tuple for the first argument等parametrize.rs#L101-L119。三、自动修复不是改个括号那么简单单参数的解包语义如果仅仅把(param,)改写为parampytest 在运行时对argvalues的展开方式可能会变化。规则实现者因此在handle_single_name中遵循一条重要原则要么同时解开argnames与argvalues要么一个都不改。以源码注释 parametrize.rs#L703-L736 中的例子说明pytest.mark.parametrize((x,), [(1,), (2,)]) def test_foo(x): assert isinstance(x, int)这段代码中argnames是单元素元组、argvalues的每一行也都是单元素序列安全的改写需要同时进行pytest.mark.parametrize(x, [1, 2]) def test_foo(x): assert isinstance(x, int)如果只解开argnames而保留每一行的元组pytest.mark.parametrize(x, [(1,), (2,)]) def test_foo(x): assert isinstance(x, int) # 失败x 变成了 tuple 而不是 int原因在于当argnames是单元素序列时pytest 会把argvalues中的每个元素整体当作该参数的值解开argnames后每个元素会被当作单元素行进一步解包。若某一行是(1,)值就从(1,)变成1测试行为随之改变。因此修复必须成对出现——argnames改写成字符串的同时把argvalues中每个单元素的行外层也一并剥掉。实现上handle_single_nameparametrize.rs#L695-L753先报告诊断再调用unpack_single_element_itemsparametrize.rs#L760-L788为argvalues生成解包编辑。只有所有元素都能解包时才挂接修复此外如果这些编辑范围与任何注释区间相交修复会被降级标记为 unsafe见 parametrize.rs#L741-L752。四、回归用例拆解argvalues中出现未知变量时诊断保留而修复抑制用例原文完整保留mdtest 回归文档 pytest-parametrize-names-wrong-type.md 记录了针对 GitHub issue #24715 的回归测试import pytest variable (2,) pytest.mark.parametrize((param,), [(1,), variable]) # snapshot: pytest-parametrize-names-wrong-type def test_single_element_tuple_and_variable_mix(param): ...对应期望快照error[PT006]: Wrong type passed to first argument of pytest.mark.parametrize; expected str -- src/mdtest_snippet.py:5:26 | 5 | pytest.mark.parametrize((param,), [(1,), variable]) # snapshot: pytest-parametrize-names-wrong-type | ^^^^^^^^^^ help: Use a string for the first argument为什么此前直接改成字符串是危险的这段代码里argnames是单元素元组(param,)按 PT006 的规则应当改写成字符串param。但注意argvalues [(1,), variable]第一个元素是单元素元组字面量第二个元素却是变量引用variable此处其值恰好是(2,)但静态分析无法假设它永远是单元素序列——它也可能是任意元组甚至更复杂的对象。如果无条件执行只把(param,)改成param的修复pytest 对行内元素的展开语义将发生变化可能导致测试传入的值与修复前不一致静默改变行为。这正是 issue #24715 暴露的问题针对未知argvalues的修复是不安全的。实现侧如何抑制修复对照 unpack_single_element_items 的代码可以精确复现判定链argvalues必须是列表或元组字面量否则直接返回None遍历每个元素要求每个元素本身也是列表或元组字面量每个元素还必须恰好包含一个元素let [elt] elts.as_slice() else { return None; }若该唯一元素是Starred星号表达式同样返回None放弃解包。在回归用例中variable是一个Name表达式而不是字面量序列第 2 步即返回None。于是 handle_single_name 中的let Some(argvalues_edits) unpack_single_element_items(...) else { return; }提前返回——诊断照常上报但不会挂接任何修复。快照文本因此只包含error[PT006]与help提示而没有通常出现在修复规则快照中的ℹ Safe fix段落。mdtest 文档中那行# snapshot: pytest-parametrize-names-wrong-type标记则指示文档测试框架为这段代码生成并比对快照从工具链层面长期锁定该行为防止未来回归。五、调用链纵深从装饰器识别到编辑构造为了更完整地理解 PT006可以顺着调用链在 parametrize.rs 中追溯它的上游与相邻逻辑装饰器识别入口函数parametrize(checker, call)首先用 is_pytest_parametrize 判断当前调用是否为pytest.mark.parametrize(...)会排除被 import 遮蔽的别名情况确保不误伤同名函数实参定位通过call.arguments.find_argument_value(argnames, 0)与find_argument_value(argvalues, 1)按关键字或位置取得两个参数PT006 分支要求两者同时存在才检查——因为handle_single_name需要argvalues来判定可否安全修复这从规则结构上就注定了它对只给 argnames 不给 argvalues的调用无能为力范围精确定位对形如(x)的带括号表达式用get_parametrize_name_rangeparametrize.rs#L342-L344配合parenthesized_range计算高亮区间使诊断箭头^^^^^^^^^^能恰好覆盖装饰器中第一参数的实际范围如回归快照中的5:26起相邻规则同一文件还承载了 PT007argvalues顶层容器与行容器类型检查默认期望 list-of-tuple与 PT014重复测试用例检测。它们共享同一入口parametrize()但各自的check_values/check_duplicates逻辑独立其中 PT007 的修复标记为Always可用、PT014 的修复为 unsafe——与 PT006 的视情况修复形成对照便于理解 Ruff 对不同修复安全性的分级safe / unsafe / sometimes。关于 PT006 在各配置组合下的行为仓库同时维护了旧的 fixture 快照测试可作为交叉验证夹具代码见 PT006_and_PT007.py快照见 PT006_default.snap、PT006_csv.snap 与 PT006_list.snap分别对应默认 tuple、csv、list 三种parametrize-names-type取值。六、本地复现与验证你可以基于本仓库的 Ruff 直接在本地验证第 4 节的场景。构造一个最小示例文件example.pyimport pytest variable (2,) pytest.mark.parametrize((param,), [(1,), variable]) def test_single_element_tuple_and_variable_mix(param): ...然后运行ruff check example.py --select PT006 --no-cache预期输出与 mdtest 快照一致报告error[PT006]: Wrong type passed to first argument of pytest.mark.parametrize; expected str给出help: Use a string for the first argument但不附带任何可应用的 fix。作为对照组把variable换成一个内联的单元素元组字面量pytest.mark.parametrize((param,), [(1,), (2,)]) def test_foo(param): ...此时argvalues的每个元素都是可静态解包的字面量Ruff 会同时生成两处编辑解开(param,)为param、把每一行的(1,)/(2,)变为1/2。用ruff check --fix即可观察到行为等价改写。七、要点回顾PT006PytestParametrizeNamesWrongType检查pytest.mark.parametrize第一参数argnames的容器形态单参数应使用字符串多参数应匹配lint.flake8-pytest-style.parametrize-names-type默认tuple可选csv/list规则报告诊断相对直接但自动修复牵涉 pytest 的运行期解包语义单参数场景要求argnames与argvalues成对解包缺一不可当argvalues包含变量引用、星号表达式等无法静态确认的元素时unpack_single_element_items 返回Nonehandle_single_name据此只报诊断、抑制修复——这是对 issue #24715 的安全设计回应该行为已由 mdtest 回归文档 pytest-parametrize-names-wrong-type.md 及其内嵌快照长期锁定任何重新引入不安全修复的改动都会被测试拦截。【免费下载链接】ruffAn extremely fast Python linter and code formatter, written in Rust.项目地址: https://gitcode.com/GitHub_Trending/ru/ruff创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考