如何为 Git 子模块配置独立的 Black 代码格式化参数(如不同行宽)

夏涛姑娘_2629

夏涛姑娘_2629

2026-11-01

643人浏览

原创

如何为 Git 子模块配置独立的 Black 代码格式化参数(如不同行宽)

VS Code 的 .vscode/settings.json 文件作用域仅限于当前工作区根目录,无法按子目录(如子模块)自动切换 Black 配置;需改用项目级配置文件(如 pyproject.toml)实现真正隔离的格式化规则。

vs code 的 `.vscode/settings.json` 文件作用域仅限于当前工作区根目录,无法按子目录(如子模块)自动切换 black 配置;需改用项目级配置文件(如 `pyproject.toml`)实现真正隔离的格式化规则。

在多子模块 Python 项目中,期望为每个子模块(如 subs/sub_01 和 subs/sub_02)应用不同的 Black 行宽(例如 --line-length=150 vs --line-length=100),仅靠 VS Code 的多层 .vscode/settings.json 是无效的——因为 VS Code 不支持基于文件路径动态加载不同工作区设置,所有打开的文件默认继承主工作区(即 main_repo/ 根目录)的 .vscode/settings.json,子目录下的同名设置文件会被忽略。

✅ 正确做法:使用 层级化 pyproject.toml 配置
Black(v22.3.0+)、Flake8 等主流工具均原生支持“就近读取”配置:它们会从当前文件所在路径向上查找最近的 pyproject.toml(或 pyproject.toml、setup.cfg 等),并以该配置为准。因此,你应在每个需要差异化配置的目录下放置独立的 pyproject.toml:

# main_repo/pyproject.toml
[tool.black]
line-length = 150
# main_repo/subs/sub_01/pyproject.toml
[tool.black]
line-length = 150
# main_repo/subs/sub_02/pyproject.toml
[tool.black]
line-length = 100

同时,确保 VS Code 的 Black 扩展(如 ms-python.black-formatter)已启用「自动检测配置」(默认开启),并在主工作区的 .vscode/settings.json 中移除硬编码的 black-formatter.args,仅保留基础行为声明:

{
  "[python]": {
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "ms-python.black-formatter"
  }
}

⚠️ 注意事项:

git提交前检查
git提交前检查

在代码提交 git 前,通过 git diff 对比修改内容,逐文件审查变更点,检测潜在 BUG、隐含风险与可优化项,输出结构化审查报告。当用户表达提交前检查、提交检查、commit 前检查、pre-commit review、提前审查代码、检查一下改动、看看能不能提交等意图时使用此技能。注意:此技能与「代码评审」不同——代码评审在开发完成后结合需求文档与概要设计进行完整度审查,提交前检查是轻量级的基于 git diff 的代码质量把关。

下载
  • 不要混用 black-formatter.args 和 pyproject.toml:命令行参数会覆盖配置文件,导致子模块配置失效;
  • 确保子模块目录是 Git 子模块且已正确检出(git submodule update --init),否则 VS Code 可能无法识别其为有效 Python 项目上下文;
  • 若使用 Pylance 或其他语言服务器,建议也在各 pyproject.toml 中统一指定 requires-python 或 dependencies,增强环境感知一致性。

总结:VS Code 的设置文件不具备路径感知能力,真正的配置隔离必须依赖工具链自身的分层配置机制(如 pyproject.toml)。这是跨编辑器(PyCharm、Vim + coc.nvim 等)通用的最佳实践,也符合 PEP 518 标准。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

git

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
自建git服务器
自建git服务器

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

2023.07.05

6919

9

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

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

2023.07.06

1940

6

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

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

2023.07.24

1154

5

git提交错误怎么撤回
git提交错误怎么撤回

git提交错误撤回的方法:git reset head^:撤回最后一次提交,恢复到提交前状态。git revert head:创建新提交,内容与之前提交相反。git reset :使用提交的 sha-1 哈希撤回指定提交。交互式舞台区:标记要撤回的特定更改,然后提交,排除已撤回更改。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.09

4497

7

git怎么对比两个版本的文件内容
git怎么对比两个版本的文件内容

要对比两个版本的 git 文件,请使用 git diff 命令:git diff 比较工作树和暂存区之间的差异。git diff 比较两个提交或标签之间的差异。git diff 输出显示差异块,其中 + 表示添加的行,- 表示删除的行, 表示修改的行。可使用 gitkraken、meld、beyond compare 等可视化工具更直观地查看差异。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.09

4341

6

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

2026.10.28

80

16

Vite 如何搭配 Vue.js
Vite 如何搭配 Vue.js

Vite搭配Vue.js专题汇集创建Vue 3项目、配置开发环境、路径别名、Vue插件、代理、多环境构建与调试的已审核文章,帮助读者完成从初始化到日常开发的配置。

2026.10.28

60

15

Vite 项目目录怎么看
Vite 项目目录怎么看

Vite项目目录专题汇集入口文件、src源码、public静态资源、路径别名、项目根目录和构建输出目录相关的已审核文章,帮助读者理解各文件夹的用途与引用方式。

2026.10.28

220

10

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

2026.10.22

140

11

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
vscode手册
vscode手册

共0课时 | 0人学习

Git 教程
Git 教程

共21课时 | 8.1万人学习

Git版本控制工具
Git版本控制工具

共8课时 | 1.9万人学习