如何在VSCode中设置Python项目的忽略文件清单

胖浩吖_9909

胖浩吖_9909

2026-06-30

642人浏览

原创

vscode需协同配置.gitignore、settings.json中的files.exclude/search.exclude及python.analysis.exclude三类规则:.gitignore仅影响git提交和资源管理器折叠,files.exclude控制侧边栏显示,search.exclude决定全局搜索是否扫描,python.analysis.exclude则影响代码跳转与类型检查,三者缺一不可。

如何在vscode中设置python项目的忽略文件清单

VSCode 本身不直接“设置忽略文件清单”,它依赖三类配置协同生效:Git 的 .gitignore、工作区的 settings.json(控制显示/搜索/分析)、以及 Python 扩展自身的 python.analysis.exclude。漏掉任意一类,都可能出现“文件还在侧边栏”“搜索仍命中”“代码跳转误入第三方库”等问题。

Git 忽略只管提交,不管 VSCode 显示

.gitignore 是 Git 的规则,VSCode 只是读取它并“顺便”用于文件资源管理器的折叠(前提是启用了 files.exclude 的自动同步)。但这个行为不可靠,尤其在 Windows 或未重启时容易失效。

  • 必须写全路径模式:/venv/ 比 venv/ 更安全,前者只匹配项目根下的 venv/ 目录;后者可能误匹配 my_venv/
  • 常见漏项:__pycache__/、*.pyc、.pytest_cache/、.mypy_cache/ —— 这些不写进 .gitignore,Git 就会把它们当普通文件追踪
  • 已提交过的文件(如历史遗留的 .vscode/)需手动清除缓存:git rm -r --cached .vscode,再 commit

settings.json 控制文件是否出现在资源管理器和搜索中

真正让 VSCode “看不见”某些目录的是 files.exclude 和 search.exclude。它们必须写在工作区 .vscode/settings.json 里(不是用户全局设置),否则团队协作时别人看不到效果。

python-code-analyz
python-code-analyz

专业Python代码分析与优化,支持语法检查、安全扫描、性能评估、复杂度分析及重构后优化代码生成。

下载
  • "files.exclude" 决定左侧文件树是否展开该目录;"search.exclude" 决定 Ctrl+Shift+F 全局搜索是否扫描它 —— 两者规则写法一致,但作用域不同
  • 通配符 **/ 表示递归匹配子目录,比如 "**/fastsam": true 会隐藏所有层级下的 fastsam 文件夹
  • 注意斜杠结尾:"**/__pycache__/": true 正确;"**/__pycache__": true 会同时匹配 __pycache__ 目录和名为 __pycache__ 的文件(极少有这种文件,但逻辑上存在)

Python 扩展的 analysis.exclude 影响代码智能提示

即使文件被 files.exclude 隐藏了,Python 扩展默认仍会分析所有 .py 文件。结果就是:跳转定义(F12)可能跳进 venv/ 里的包源码,或类型检查报一堆第三方库的警告。

  • 必须显式配置 python.analysis.exclude 数组,路径用字符串,不支持布尔值:["**/venv", "**/.venv", "examples"]
  • 该配置只对 Pylance / Microsoft Python 扩展生效;如果你用 pylsp 或 pyright,需查对应插件文档,规则位置和字段名不同
  • 路径是相对于工作区根目录的,不能写绝对路径;${workspaceFolder} 在这里无效

为什么 .vscode/settings.json 里写了 python.pythonPath 却不生效

因为 Python 解释器路径和忽略规则无关,但它常和忽略配置放在一起,容易让人误以为“只要写了 settings.json 就全生效”。实际是:解释器路径变更后必须重启 VSCode 窗口(不是重载),否则 Python 扩展仍用旧环境加载分析器,导致 analysis.exclude 被忽略或部分失效。

  • 验证是否生效:打开命令面板(Ctrl+Shift+P),输入 Python: Select Interpreter,看右下角状态栏显示的路径是否与 settings.json 中一致
  • 如果使用 .env 设置 PYTHONPATH,记得在 settings.json 中声明:"python.envFile": "${workspaceFolder}/.vscode/.env"
  • 多个 Python 项目混用时,务必确认当前打开的是“文件夹”而非“单个文件”——只有文件夹模式才会读取 .vscode/settings.json

最易被忽略的是三类配置的生效边界:Git 忽略影响提交、files.exclude 影响 UI 展示、python.analysis.exclude 影响语言服务。它们互不替代,也无继承关系。改完任一配置,都建议关掉窗口重开一次,避免缓存导致行为不一致。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

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

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

下载

相关标签:

vscode python

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

相关专题

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

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

2023.07.20

1671

4

python能做什么
python能做什么

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

2023.07.25

4144

7

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

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

2023.07.31

1669

3

python教程
python教程

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

2023.08.03

23957

23

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

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

2023.08.04

2927

5

python eval
python eval

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

2023.08.04

2967

5

scratch和python区别
scratch和python区别

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

2023.08.11

1143

5

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

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

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2303

5

热门下载

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

精品课程

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