如何在pre-commit-config.yaml中通过正则排除Django自动生成文件

配置失效常见原因 #

• pre-commit的exclude规则匹配的是Git仓库内文件的相对路径，仅匹配文件名、不带路径前缀的正则无法命中目标
• pre-commit内部统一使用正斜杠作为路径分隔符，针对反斜杠编写的匹配规则在绝大多数环境下不生效
• 若将排除规则写在pylint自身配置文件而非pre-commit的钩子配置块中，pre-commit仍会将文件传入pylint进程，导致规则不生效

可用配置方案 #

方案1：排除整个migrations目录（推荐） #

迁移文件为Django自动生成，本身不需要做静态代码校验，直接排除整个目录是维护成本最低的方案。
打开项目根目录的.pre-commit-config.yaml，找到pylint对应的钩子配置段，添加exclude规则：

- repo: local # 替换为你实际引用pylint的仓库配置
  hooks:
    - id: pylint
      name: pylint
      entry: pylint
      language: system
      types: [python]
      exclude: ^.*/migrations/.*

上述正则会匹配所有路径中包含/migrations/段的文件，无论migrations文件夹嵌套在哪个app目录下都可命中，跨Windows、macOS、Linux平台生效。

方案2：仅排除自动生成的序号命名迁移文件 #

如果需要保留migrations目录下手写脚本（如自定义数据迁移、__init__.py）的校验，可使用更精准的匹配规则：

exclude: ^.*/migrations/[\w-]+\d+[^/]*\.py$

规则说明：

• 前缀^.*/migrations/限定仅匹配migrations目录下的文件，避免误命中其他目录带数字命名的py文件
• 将原正则中的[^\\]替换为[^/]适配pre-commit的路径分隔符规则
• 对.py的点做转义，末尾加$做全路径匹配，避免误命中.pyc、.pyx等后缀相似的文件

生效验证 #

配置修改完成后，执行命令验证规则是否生效：

# 将路径替换为你项目中实际存在的迁移文件路径
pre-commit run pylint --files myapp/migrations/0001_initial.py

如果命令返回Skipped标识，说明排除规则已正常生效。如果存在旧缓存干扰，可先执行pre-commit clean清理缓存后重试。

内容的提问来源于stack exchange，提问作者Andreas L.