You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

使用wemake-python-styleguide时,如何禁用flake8-docstrings关闭文档字符串检查?

如何在wemake-python-styleguide中关闭所有文档字符串检查(无需逐个禁用错误码)

我在项目中使用wemake-python-styleguide作为代码检查工具,当前项目级setup.cfg的配置如下:

[flake8]
# Base flake8 configuration:
format = wemake
show-source = True
statistics = True
doctests = False
# Plugins:
min-name-length = 1
max-returns = 2
max-arguments = 4
max-complexity = 6
max-line-length = 80
# Self settings:
max-imports = 16
# Excluding some directories:
exclude = .git __pycache__ .venv .eggs *.egg .idea
# Exclude some violation checks globally:
ignore =
    # WPS305: Found `f` string
    WPS305
    # WPS336 Found explicit string concat
    WPS336
    # Q000 Remove bad quotes -> ""
    Q000
    # WPS421 Found wrong function call
    WPS421

我希望关闭所有文档字符串检查,虽然知道可以通过逐个添加错误码来禁用,但对应的错误码列表太长了。请问是否可以直接关闭特定的flake8插件(即flake8-docstrings)?我觉得可能无法在setup.cfg中实现,有没有可行的方案?


可行解决方案

好消息,你完全可以在setup.cfg中实现关闭所有文档字符串检查,而且有两种简单的方案,不用逐个列冗长的错误码:

1. 批量忽略所有文档字符串相关错误码

flake8-docstrings插件产出的所有错误码都是以D开头的(比如D100、D101这类),所以你只需要在ignore列表里加一个D,就能一次性忽略所有这类检查:

[flake8]
# ... 保留你原有的所有配置 ...
ignore =
    # 一次性忽略所有文档字符串检查(匹配所有D开头的错误码)
    D
    # 你原本需要忽略的项
    WPS305
    WPS336
    Q000
    WPS421

这种方式最省心,不需要改动插件加载逻辑,直接通过错误码前缀批量屏蔽。

2. 直接禁用flake8-docstrings插件

如果你想从根源上关掉这个插件,也可以在setup.cfg的[flake8]区块里添加disable-plugins配置,指定要禁用的插件名称:

[flake8]
# ... 保留你原有的所有配置 ...
# 直接禁用flake8-docstrings插件
disable-plugins = flake8-docstrings
# ... 其他配置 ...

需要注意的是,wemake-python-styleguide默认可能依赖了flake8-docstrings,但只要你的目标是彻底关闭文档字符串检查,这种方式完全没问题,不会影响其他检查逻辑。

两种方案的区别

  • 第一种是“屏蔽结果”:插件依然会运行文档字符串检查,但所有结果都会被忽略。
  • 第二种是“停止运行”:插件根本不会被加载,也就不会执行任何文档字符串检查。

你可以根据自己的需求选择,两种都能在项目级配置中完成,不需要额外的命令行操作。

内容的提问来源于stack exchange,提问作者baduker

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.05.09 09:17:51