讲师中心 微信公众号
AI工具推荐 视频效率加速

如何为Python项目配置代码格式化工具_集成Black与Isort到环境

酷萱姑娘_9740

酷萱姑娘_9740

发布时间:2026-04-15 09:43:58

|

732人浏览过

|

来源于php中文网

原创

完全可以,而且推荐一起用——Black负责代码整体格式化,isort专注导入排序与分组;需配置isort使用profile = "black"并统一line_length=88,确保顺序为isort先运行、Black后运行。

如何为python项目配置代码格式化工具_集成black与isort到环境

Black 和 Isort 能不能一起用?

完全可以,而且推荐一起用——Black 负责代码结构和换行、空格、引号等“视觉格式”,isort 专注导入语句的排序与分组。两者职责不重叠,配合使用能覆盖绝大多数 PEP 8 格式问题。

但要注意:必须让 isort 在 Black 之前运行,否则 Black 可能会把 isort 整理好的 import 块重新拆开(比如把 from ... import ... 拆成多行后破坏 import 分组)。实际流程应为:isort . → black .。

如何避免 isort 和 Black 冲突?

关键在配置对齐。默认 isort 会把 import 拆成多行并加括号,而 Black 偏好单行或更紧凑的换行风格。需强制 isort 输出 Black 兼容格式:

  • 在 pyproject.toml 中添加 [tool.isort] 配置段,并设 profile = "black"
  • 或显式启用兼容项:multi_line_output = 3(即 Vertical Hanging Indent),line_length = 88(与 Black 默认一致)
  • 禁用 isort 自动插入空行干扰:lines_after_imports = 2 改为 lines_after_imports = 1,避免和 Black 的空行规则打架

示例片段:

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

[tool.isort]
profile = "black"
line_length = 88
skip_gitignore = true

怎样一键同时运行 isort 和 Black?

用 pre-commit 是最稳妥的自动化方式,比写 shell 脚本或 Makefile 更可靠、易维护,且支持 Git 提交前自动触发:

python-script-generator
python-script-generator

快速生成专业的 Python 脚本和应用代码。一键创建完整项目结构,支持CLI、API、爬虫、Bot、Django等多种项目类型,包含完整的项目结构、配置文件、依赖管理、测试、README和文档。

下载
  • 安装:pip install pre-commit
  • 在项目根目录创建 .pre-commit-config.yaml,内容包含两个 hook:
repos:
  - repo: https://github.com/pycqa/isort
    rev: 5.12.0
    hooks: [{id: isort}]
  - repo: https://github.com/psf/black
    rev: 24.4.2
    hooks: [{id: black}]

然后运行 pre-commit install。后续每次 git commit,都会先跑 isort 再跑 black,顺序和配置都由 pre-commit 保证。

如果只想手动执行,可定义一个 alias:alias fmt='isort . && black .',但注意它不会跳过已格式化文件,也不感知 Git 暂存区 —— 这点容易被忽略。

为什么 pyproject.toml 里要统一 line_length?

Black 默认按 88 字符折行,isort 默认是 79;若不统一,isort 生成的 import 行可能被 Black 再次拆分,导致重复修改或格式抖动。尤其在 CI 环境中,这种不一致会引发“本地格式化后 CI 报告 diff”的问题。

除了 line_length,还需同步以下几项:

  • skip = ["migrations", "__pycache__"]:两边跳过相同路径,避免一方处理、另一方忽略
  • src_paths = ["src", "tests"]:限定作用范围,防止误格式化 venv 或第三方包
  • known_first_party = ["myproject"]:让 isort 正确识别本地模块,否则可能把 from myproject import x 错判为 third-party

配置分散在不同文件(如 setup.cfg + pyproject.toml)时,Black 会忽略 isort 配置,务必只用 pyproject.toml 单一来源。

热门AI工具

更多
讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

1711

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

4324

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1689

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

25157

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3067

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3087

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

1163

2023.08.11

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

596

2023.08.10

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

40

2026.10.10

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn