Pylint Missing Module Docstring警告无法禁用,有无全局生效方案?
Pylint全局禁用缺失模块文档字符串警告解决方案
你之前配置不生效的核心原因大概率是VS Code的Pylint插件已经升级为独立扩展,旧的python.linting.pylintArgs配置项已被弃用,无法被识别。
排查前置问题
- 检查VS Code是否安装了微软官方的Pylint扩展,如果已安装,旧的
python.linting相关配置全部失效,需使用新的配置项 - 你之前配置中的
--errors-only参数会强制Pylint仅输出错误级别的提示,所有警告本应默认不展示,如果仍能看到警告,说明配置完全未被加载
全局生效配置方案
方案1:VS Code全局生效(仅适用于VS Code环境)
打开VS Code全局settings.json:按下Ctrl+,(Windows)/Cmd+,(Mac)打开设置面板,搜索「settings.json」,点击「在settings.json中编辑」,添加如下配置:
{ "pylint.args": [ "--load-plugins=pylint_django", "--disable=C0114" ] }
如果需要同时禁用类、函数的缺失文档字符串警告,可以修改disable参数为--disable=C0114,C0115,C0116。保存后重启VS Code即可对所有项目生效。
方案2:Pylint全局配置(适用于所有编辑器、终端调用Pylint的场景)
直接在系统用户目录下创建全局Pylint配置文件,无需每个项目单独配置:
- 根据系统创建配置文件:
- Windows:路径为
C:\Users\你的用户名\.pylintrc - Mac/Linux:路径为
~/.pylintrc
- Windows:路径为
- 配置文件写入以下内容:
[MASTER] disable= C0114, # missing-module-docstring 缺失模块文档字符串 C0115, # missing-class-docstring 缺失类文档字符串 C0116 # missing-function-docstring 缺失函数文档字符串
- 终端执行
pylint --show-config | grep "C0114",如果输出中包含C0114说明配置已生效。
验证效果
新建空白Python文件,无需添加任何头部注释,查看是否还会弹出如下警告:
如果警告消失则配置生效。
内容的提问来源于stack exchange,提问作者Bogdan Mind
相关产品推荐
相关产品推荐

