使用预提交排除一些运行黑色的文件

Question

我想在预提交中配置黑色并从检查任何迁移文件夹中排除预提交。

我的 pyproject.toml 看起来像这样

[tool.black]
line-length = 79
target-version = ['py37']
include = '\.pyi?$'
exclude = '''

(
  /(
      \.eggs
    | \.git
    | \.hg
    | \.mypy_cache
    | \.tox
    | \.venv
    | _build
    | buck-out
    | build
    | dist
  )/
  | ^migrations/
'''

我还配置了预提交。但是在运行pre-commit run --all-files 黑色格式迁移文件夹时，我如何配置黑色

Answer 1

这个问题的black问题跟踪概括您的具体问题

pre-commit找到所有 python 文件，然后应用pre-commit的排除，然后将该文件列表传递给底层工具（在这种情况下black）

black当前（在撰写本文时）将格式化命令行上列出的所有文件——独立于black的exclude模式

建议是使用pre-commit's 排除（通过您的.pre-commit-config.yaml），以便这些文件永远不会传递给黑色：

-   id: black
    exclude: ^migrations/

注：不像黑，预先承诺其签入到您的git仓库将只皮棉文件，因此排除在清单上没有必要在这里（.git/ .mypy_cache/等）

免责声明：我是作者 pre-commit

Answer 2

目前，您可以使用black选项--force-exclude。如文档中所示：

--force-exclude TEXT 与 --exclude 类似，但匹配此正则表达式的文件和目录将被排除，即使它们作为参数显式传递也是如此。

因此，在您pyproject.toml更改exclude为force-exclude.