0

0

Python black + isort + autoflake 的 pre-commit 链

舞夢輝影

舞夢輝影

发布时间:2026-02-15 17:39:10

|

128人浏览过

|

来源于php中文网

原创

正确顺序只能是:autoflake → isort → black,因autoflake删未用代码、isort重排import、black统一格式,顺序颠倒会导致重复操作或语法错误。

python black + isort + autoflake 的 pre-commit 链

pre-commit 配置里 black、isort、autoflake 的执行顺序为什么重要

三者都改代码格式,但改的不是同一层:autoflake 删未用 import 和变量,isort 重排 import 顺序,black 统一缩进/换行/空格。如果顺序反了,比如 isort 在 autoflake 前跑,就可能把 autoflake 即将删掉的 import 又按规则排一遍,白忙活;更糟的是 black 可能格式化完,autoflake 又删掉某行导致语法错误(比如删了唯一引用的 from typing import Optional 后,Optional[str] 报错)。

正确顺序只能是:autoflake → isort → black。pre-commit 按配置文件中 hooks 的书写顺序执行,所以必须严格按这个顺序写。

  • autoflake 要加 --in-place --remove-all-unused-imports --remove-unused-variables,否则默认只打印不修改
  • isort 需显式指定 profile: black 或等效配置(如 multi_line_output: 3),否则和 black 冲突
  • black 不需要额外参数,但注意它默认不处理 .pyi 文件,如有需求得加 types: [python, pyi]

autoflake 报错 “No module named 'autoflake'” 却已 pip install

pre-commit 自带独立虚拟环境,不复用你当前 shell 的 Python 环境。即使你在全局或 venv 里装了 autoflake,pre-commit 还是会自己拉一个干净环境并只装它配置里声明的依赖。

所以必须在 .pre-commit-config.yaml 的对应 hook 下,明确写上 additional_dependencies

立即学习Python免费学习笔记(深入)”;

repos:
  - repo: https://github.com/myint/autoflake
    rev: v2.2.1
    hooks:
      - id: autoflake
        args: [--in-place, --remove-all-unused-imports, --remove-unused-variables]
        additional_dependencies: [autoflake==2.2.1]

漏掉 additional_dependencies 是最常见原因。版本号建议锁死,避免某天 CI 突然失败。

  • black 和 isort 同理,也要各自配 additional_dependencies,哪怕它们的 repo 地址本身带依赖声明
  • pre-commit install 之后,可用 pre-commit run --all-files 手动触发一次,看是否还报 import 错误
  • 如果用 pyproject.toml 管理依赖,pre-commit 仍不会自动读取,必须显式声明

isort 和 black 在 type hint 上打架怎么办

典型现象:isort 把 from __future__ import annotations 排到 import 块最顶,black 却认为它该单独成块、前面空两行——结果 pre-commit 死循环:一次提交后 isort 动了,下一次 black 又动,再下一次 isort 又动……

PpcyAI
PpcyAI

泡泡次元AI-游戏美术AI创作平台,低门槛上手,高度可控,让你的创意秒速落地

下载

根本原因是 isort 默认不识别 from __future__ 的特殊性,而 black 的格式规则又和 isort 的 import 分组逻辑不一致。

  • 在 isort 配置里加 known_future_library: ["__future__"],让 isort 把它当一类特殊 import 处理
  • 同时设 force_sort_within_sections: true,避免 isort 因“不同 section”拒绝重排
  • black 侧无需改,但它要求 isort 输出必须兼容 PEP 8 + PEP 484,所以 isort 的 profile: black 不能省

如果项目用 pyproject.toml,isort 配置应放在 [tool.isort] 下,并确保 multi_line_output = 3(即 black 风格的 hanging grid)。

pre-commit hook 运行太慢,尤其 autoflake 扫全量文件

autoflake 默认扫描所有 .py 文件,包括 tests/、migrations/、venv/ 甚至 .git/ 下的 Python 片段,既慢又可能误删(比如某些生成的 migration 文件里有看似未用实则必需的 import)。

关键是缩小作用范围,而不是关掉它:

  • types_or: [python] 替代默认的 types: [python],避免匹配到 .pyi/.pyw 等边缘类型
  • exclude: '^((tests|venv|\.git|migrations)/|.*__pycache__.*$)',正则排除高频干扰目录
  • autoflake 本身支持 --exclude,但 pre-commit 的 exclude 是更前置的过滤,优先级更高、更省 CPU
  • 如果团队接受,可考虑去掉 --remove-unused-variables —— 它比删 import 更容易误伤(比如动态属性、debug 变量),且 black/isort 不处理它

实际测过:对 500+ 文件的项目,加 exclude 后单次 hook 从 8 秒降到 1.2 秒。慢不是预提交的宿命,是没筛干净。

复杂点在于,exclude 规则要和团队 IDE 设置、CI 路径保持一致;最容易被忽略的是 migrations/ 目录——Django 用户几乎必踩这个坑。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
Python Web 框架 Django 深度开发
Python Web 框架 Django 深度开发

本专题系统讲解 Python Django 框架的核心功能与进阶开发技巧,包括 Django 项目结构、数据库模型与迁移、视图与模板渲染、表单与认证管理、RESTful API 开发、Django 中间件与缓存优化、部署与性能调优。通过实战案例,帮助学习者掌握 使用 Django 快速构建功能全面的 Web 应用与全栈开发能力。

60

2026.02.04

pip安装使用方法
pip安装使用方法

安装步骤:1、确保Python已经正确安装在您的计算机上;2、下载“get-pip.py”脚本;3、按下Win + R键,然后输入cmd并按下Enter键来打开命令行窗口;4、在命令行窗口中,使用cd命令切换到“get-pip.py”所在的目录;5、执行安装命令;6、验证安装结果即可。大家可以访问本专题下的文章,了解pip安装使用方法的更多内容。

348

2023.10.09

更新pip版本
更新pip版本

更新pip版本方法有使用pip自身更新、使用操作系统自带的包管理工具、使用python包管理工具、手动安装最新版本。想了解更多相关的内容,请阅读专题下面的文章。

425

2024.12.20

pip设置清华源
pip设置清华源

设置方法:1、打开终端或命令提示符窗口;2、运行“touch ~/.pip/pip.conf”命令创建一个名为pip的配置文件;3、打开pip.conf文件,然后添加“[global];index-url = https://pypi.tuna.tsinghua.edu.cn/simple”内容,这将把pip的镜像源设置为清华大学的镜像源;4、保存并关闭文件即可。

785

2024.12.23

python升级pip
python升级pip

本专题整合了python升级pip相关教程,阅读下面的文章了解更多详细内容。

356

2025.07.23

自建git服务器
自建git服务器

git服务器是目前流行的分布式版本控制系统之一,可以让多人协同开发同一个项目。本专题为大家提供自建git服务器相关的各种文章、以及下载和课程。

831

2023.07.05

git和svn的区别
git和svn的区别

git和svn的区别:1、定义不同;2、模型类型不同;3、存储单元不同;4、是否拥有全局版本号;5、内容完整性不同;6、版本库不同;7、克隆目录速度不同;8、分支不同。php中文网为大家带来了git和svn的相关知识、以及相关文章等内容。

573

2023.07.06

git撤销提交的commit
git撤销提交的commit

Git是一个强大的版本控制系统,它提供了很多功能帮助开发人员有效地管理和控制代码的变更,本专题为大家提供git 撤销提交的commit相关的各种文章内容,供大家免费下载体验。

273

2023.07.24

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

139

2026.02.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.4万人学习

Django 教程
Django 教程

共28课时 | 4.3万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.6万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号