Missing module docstring pylint

原创 已于 2023-07-08 15:03:15 修改 · 3k 阅读 · 6 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#vscode #python

于 2023-07-08 15:01:37 首次发布
文章介绍了在VSCode中遇到pylint插件导致代码出现波浪线问题的解决方案。可以通过禁用或卸载pylint插件，或者修改settings.json文件，添加特定参数来禁用特定警告，如missing-module-docstring等。
部署运行你感兴趣的模型镜像

Missing module docstring pylint

在 VSCode 中，遇到代码经常会出现波浪线的问题，影响美观和心情。如图：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-wSXOwSjF-1688799523275)(Missing module docstring pylint.assets/image-20230708115542084.png)]

发现是 pylint 的问题。

pylint 作用：日常开发中，不同开发人员会写下不同风格的代码，导致代码可维护性变差，为了解决风格不一致问题，可以制定代码规范。pylint 可以自动检查代码，识别并自动修改部分错误，自动补齐，使得代码更加规范。

有以下两种解决方法：

  • 禁用或卸载 pylint 插件。
  • 修改 settings.json 文件，此时仍然使用 pylint 插件。

禁用或卸载 pylint 插件

  1. 选择左侧的 拓展 (Extensions) 按钮
  2. 搜索框输入 pylint
  3. 选择 禁用 (Disable) 或者 卸载 (Uninstall)
  4. 最后，点击 重新加载 (Reload Required)

在这里插入图片描述

修改 settings.json 文件

  1. 打开命令面板：Mac 快捷键 Command + Shift + P ，Windows 快捷键 Ctrl + Shift + P 。

  2. 输入 setting ，选择 Prefernce: Open User Settings(JSON) ：

在这里插入图片描述

  1. 在 JSON 文件中加入如下代码：
    "python.linting.pylintArgs": [
        "--disable=missing-module-docstring",
        "--disable=missing-class-docstring",
        "--disable=missing-function-docstring"
    ],

如图：

然后保存即可。

您可能感兴趣的与本文相关的镜像

HunyuanVideo-Foley

HunyuanVideo-Foley

语音合成

HunyuanVideo-Foley是由腾讯混元2025年8月28日宣布开源端到端视频音效生成模型，用户只需输入视频和文字，就能为视频匹配电影级音效

三毛呀
关注
git+pylint实现python提交代码格式校验
sinat_28371057的博客
03-31 739
环境：win10(64)，python3.7.1，git2.7.2，pylint-2.3.1，git_pylint_commit_hook-2.5.1 以上为当期搭建所用到的版本，有异常时方便查找问题。 安装pylint，pylint是一个单独可以对python文件进行格式校验的模块，https://www.pylint.org/官网地址有各个电脑环境的安装说明，Windows下，使用： pip install pylint 安装完成之后，就可以直接使用pylint对python文件进行格式的检.
Python｜PyLint 常见问题文档
长行
01-09 6043
Pylint 常见问题文档
Pylint代码分析工具使用详解，并集成到Pycharm步骤
04-17 2937
Pylint 是一个 Python 代码分析工具，它分析 Python 代码中的语法错误，是否遵守编码风格标准、潜在的问题等，Pylint 是一个 Python 工具，除了平常代码分析工具的作用之外，它提供了更多的功能：如检查一行代码的长度，变量名是否符合命名标准，是否有导入但未使用的模块，如果运行两次 Pylint，它会同时显示出当前和上次的运行结果，从而可以看出代码质量是否得到了改进。支持自定义配置：例如显示或隐藏特定的警告，并且可以通过编写插件来添加功能；
VSCode 配置使用 PyLint 语法检查器
热门推荐
jianghuixin
06-12 1万+
1. 首先安装 "Python" 插件 2. 安装 `pylint` 语法检查器 推荐安装在当前的 Python 环境中 3. 启用 `pylint` 语法检查器 4. 配置 `pylint` 语法检查器 创建 .pylintrc 文件, pylint --generate-rcfile > .pylintrc 5. 禁用某些检查项 - 代码处添加注释,# pylint: disable=missing-module-docstring - 修改 pylint 的运行参数 - 修改 .pylintrc 文件
Python之Missing function or method docstringPylint
PlutoZuo的博客
11-13 956
Python之Missing function or method docstringPylint
vscode中pylint不能显示错误
sanra123的博客
06-17 2519
检查是否为 User中的配置覆盖了 remote中的配置 https://www.thinbug.com/q/49795638 不知道是不是这个起作用了，shell中直接运行 pylint --generate-rcfile > ~/.pylintrc
Downloads\checklist.py:1:0: C0114: Missing module docstring (missing-module-docstring) Downloads\checklist.py:86:0: C0115: Missing class docstring (missing-class-docstring)
最新发布
06-01
# pylint: disable=missing-module-docstring ``` 2. **修改配置文件** 在`.pylintrc`中调整规则： ```ini [MESSAGES CONTROL] disable=C0114,C0115 # 完全禁用检查 [BASIC] docstring-min-length=10 # ...
如何解决missing module docstring警告
04-21
可以通过在代码中添加文档字符串来解决 missing module docstring 警告。文档字符串应该包括对该模块的简要描述及其接口的说明。另外，可以使用特定的工具，如 PyLint 或 Flake8，来检查并提示缺失文档字符串的模块...
C:\Users\ckyang>pylint C:\Users\ckyang\Downloads\检查表.py ************* Module 检查表 Downloads\检查表.py:90:0: C0303: Trailing whitespace (trailing-whitespace) Downloads\检查表.py:161:0: C0304: Final newline missing (missing-final-newline) Downloads\检查表.py:1:0: C0114: Missing module docstring (missing-module-docstring) Downloads\检查表.py:1:0: W2402: File name "检查表" contains a non-ASCII character. PEP 3131 only allows non-ascii identifiers, not file names. (non-ascii-file-name) Downloads\检查表.py:85:0: C0115: Missing class docstring (missing-class-docstring) Downloads\检查表.py:3:0: C0411: standard import "import os" should be placed before "import pandas as pd" (wrong-import-order)
05-31
C0114 missing-module-docstring表示模块缺少文档字符串，需要添加模块级别的注释。W2402 non-ascii-file-name警告文件名包含非ASCII字符，建议用户更改为ASCII字符的文件名以避免兼容性问题。C0115 missing-class-...
Missing module docstringPylint(C0114:missing-module-docstring)
04-29
这是 Pylint 给出的警告，意思是模块缺少了文档字符串。文档字符串是 Python 中的一种特殊注释，...当你运行 Pylint 时，它会检查你的代码，并给出类似 "C0114:missing-module-docstring" 的警告，帮助你提高代码质量。
关于pycharm中一直提示缺少docstring,以及关闭该提示
qq_44621608的博客
02-26 1748
如图我们可以看到一直提示缺少docstring,每次创建一个新的py文件,上方总是如此提示,但网上资料很少有提示该如何关闭这个警告.我们点击右边的齿轮还是黄色的小灯泡都没有办法关闭.首先点击文件选项->设置选项->编辑器->代码样式->检查->python,如图所示。之后我们在创建新页面便没有烦人的提示.我们具体看看该怎么关闭.
缺失或空docstring是什么鬼？
2301_79698214的博客
07-02 770
经常看到“缺失或空docstring”这样的错误提示。那么，缺失或空docstring是什么鬼？我们看完了示例之后，就明白：是在定义函数时，缺失了关于函数的说明，或者是说明内容为空。您需要提供一些有关所生成模板中的形参的详细信息。报告缺失的和空的 docstring。缺失 docstring 的示例。空 docstring 的示例。
怎样关闭“缺失或 空docstring”的警告信息？
2301_79698214的博客
07-02 434
依次打开“文件”、“设置”、“编辑器”、“代码样式”、“检查“、”python”，然后找到这个地方。编辑python文档时，经常有“缺失或空docstring”的提示信息。把右边的复选框取消勾选，再点击右下角的确定即可。来一张全屏的截图看看，找找上面两个截图的位置。这样设置之后，就没有那个警告信息提示出现了。
python中的docstring用法_在python模块docstring中放什么？
weixin_39858124的博客
11-26 494
想想有人在交互式解释器的提示下做help(yourmodule)-他们想知道什么？（其他提取和显示信息的方法在信息量方面大致相当于help）。因此，如果您在x.py中有："""This module does blah blah."""class Blah(object):"""This class does blah blah."""然后：>>> import x; help(x)显示：Help...
VS Code报错Module 'xx' has no 'xx' member pylint(no-member)
wanttifa的博客
06-28 3408
贼鸡儿好用的vscode有一个很令人蛋疼的地方，就是在写python程序的时候经常会出现报错，提示Module ‘torch’ has no ‘rand’ member pylint(no-member)等等这些话。 一看就知道是pylint报错的这句话，pylint是什么呢/ pylint就是vscode的python语法检查器，pylint是静态检查，在用第三方库的时候有些成员只有在运行代码的...
python代码风格检查工具_[技术博客]使用pylint实现django项目的代码风格检查
weixin_39717692的博客
11-25 700
使用pylint实现django项目的代码风格检查前言?一个项目大多都是由一个团队来完成，如果没有统一的代码规范，那么每个人的代码的风格必定会有很大的差别。且不说会存在多个人同时开发同一模块的情况，即使是分工十分明晰的项目，等到要整合代码的时候也会非常头疼（亲身体会）。大多数情况下，并非程序中有复杂的算法或是复杂的逻辑，而是由于风格的不同，去读别人的代码实在是一件痛苦的事情。统一的风格使得代码可读...
Pylint静态代码检查使用指南
humanhaunt的博客
09-10 2908
前言 初学编码标准? Pylint可以作为您的向导，揭示幕后真正发生了什么，并帮助您成为一名更有见识的程序员。 如果人们发现你的代码难以使用或理解，你的良好意图可能不会得到预期的结果。Python社区已经正式确定了一些推荐的编程风格，以帮助每个人以一种对共享代码最有意义的共同的、商定的风格编写代码。这种风格在PEP 8中被捕获，即“Python代码的风格指南”。：Pylint是一种快速而简单的方法，可以查看您的代码是否捕获了PEP 8的精髓，因此对其他潜在用户是友好的。 简单一句话就是Pylint可以让你的
Python代码规范：代码规范整改和编码技巧-pylint扫描问题整改
SteveRocket's-Blog
04-05 3410
1. 遵循PEP8规范，确保代码的格式和风格一致性。这可以通过编辑器或工具来自动化。 2. 将代码拆分为小的、易于维护和重用的函数、类和模块。 3. 使用注释来解释代码的目的和功能。 4. 使用有意义的函数和变量名称，这将使代码更易于理解。 5. 避免使用全局变量和魔术数字。 6. 对于大量或复杂的代码块，使用代码注释或文档字符串。 7. 使用异常处理来减少程序崩溃的可能性，并提供有意义的错误消息。 8. 使用工具或库来自动化常见任务，并减少犯错的可能性。 9. 最好结合团队成员的意见和审查来进行整改。
Python 代码检查之Pylint
三丰的专栏
03-31 8036
Pylint是什么 pylint是一个python代码检查工具 Pylint能干什么 这里列出了很多，单是我想前三种应该是最有用的 检查python代码符不符合PEP8规范 检查代码中的错误 提供重构建议 下面就用一个例子来展开说明 如何安装 pip install pylint 如何使用 pylint python file # or pylint python package 例子： import logging logging.basicConfig(le
评论 1
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值