预览

Ruff 包含一个可选择加入的预览模式，以便为社区反馈提供机会，并在为所有人启用更改之前，增加对更改产生净收益的信心。

预览模式启用了一系列不稳定的功能，例如新的 lint 规则和修复、格式化程序样式更改、界面更新等等。使用预览模式时，有关已弃用功能的警告可能会变成错误。

启用预览模式本身不会启用所有预览规则。有关选择预览规则的详细信息，请参见规则部分。

启用预览模式

可以使用 CLI 上的 --preview 标志启用预览模式，或在 Ruff 配置文件中设置 preview = true。

可以分别为 linting 和格式化配置预览模式。要启用预览 lint 规则而不启用预览样式格式化

pyproject.tomlruff.tomlCLI

[tool.ruff.lint]
preview = true

[lint]
preview = true

ruff check --preview

要启用预览样式格式化而不启用任何预览 lint 规则

pyproject.tomlruff.tomlCLI

[tool.ruff.format]
preview = true

[format]
preview = true

ruff format --preview

如果规则标记为预览，则只有在启用预览模式后才能选择它。例如，考虑一个假设的规则 HYP001。如果 HYP001 处于预览状态，则通过将其添加到所选规则集中，不会启用它。

pyproject.tomlruff.tomlCLI

[tool.ruff.lint]
extend-select = ["HYP001"]

[lint]
extend-select = ["HYP001"]

ruff check --extend-select HYP001

通过选择 HYP 类别也不会启用它，如下所示

pyproject.tomlruff.tomlCLI

[tool.ruff.lint]
extend-select = ["HYP"]

[lint]
extend-select = ["HYP"]

ruff check --extend-select HYP

同样，通过 ALL 选择器也不会启用它

pyproject.tomlruff.tomlCLI

[tool.ruff.lint]
select = ["ALL"]

[lint]
select = ["ALL"]

ruff check --select ALL

但是，如果在上述任何一种情况下启用预览模式，则会启用它

pyproject.tomlruff.tomlCLI

[tool.ruff.lint]
extend-select = ["HYP"]
preview = true

[lint]
extend-select = ["HYP"]
preview = true

ruff check --extend-select HYP --preview

要查看当前处于预览状态的规则，请访问规则参考。

启用预览模式后，选择规则类别或前缀将包括所有匹配的预览规则。如果您希望单独选择每个预览规则，则可以在配置文件中切换 explicit-preview-rules 设置

pyproject.tomlruff.toml

[tool.ruff.lint]
preview = true
explicit-preview-rules = true

[lint]
preview = true
explicit-preview-rules = true

在我们之前的示例中，使用 ALL HYP、HYP0 或 HYP00 的 --select 将不会启用 HYP001。每个预览规则都需要使用其确切代码进行选择：例如，--select ALL,HYP001。

如果未启用预览模式，则此设置无效。

启用预览模式后，将禁用已弃用的规则。如果显式选择已弃用的规则，则会引发错误。如果通过规则类别或前缀选择，则不会包含已弃用的规则。