Sublime Text安装SublimeLinter-pydocstyle规范Python注释-sublime-PHP中文网

sublimelinter-pydocstyle 装不上需先确认系统已安装 pydocstyle，再在 sublimelinter 用户设置中启用并指定 executable 路径；文件须识别为 python 语法且含函数/类级 docstring 才触发检查，可与 flake8/pylint 共存但需避免规则冲突。

sublime text安装sublimelinter-pydocstyle规范python注释

SublimeLinter-pydocstyle 装不上？先确认 pydocstyle 是否已安装

SublimeLinter-pydocstyle 只是桥接层，真正干活的是系统级的 pydocstyle 命令。如果只装插件不装工具，它根本不会报错，但也不会显示任何注释检查结果——你编辑器里干干净净，其实只是“假装在检查”。

打开终端（不是 Sublime 控制台），运行：

pydocstyle --version

若提示 command not found 或 'pydocstyle' is not recognized，说明没装。此时必须执行：

pip install pydocstyle（推荐用 pip，不要用 conda，避免路径隔离问题）
确保 Python 环境和 pip 是你期望的那个（比如用 which python 和 which pip 在 macOS/Linux，或 where python 在 Windows 核对）
如果用了虚拟环境（venv / conda），得在该环境下装，否则 Sublime 找不到 pydocstyle

SublimeLinter 设置里怎么启用 pydocstyle

SublimeLinter 默认不启用 pydocstyle，即使插件已装、命令已存在。你得手动在用户设置中显式声明它。

进入 Preferences > Package Settings > SublimeLinter > Settings，在右侧用户配置中加入：

{
  "linters": {
    "pydocstyle": {
      "enable": true,
      "executable": "/path/to/pydocstyle",  // Linux/macOS 示例：/usr/local/bin/pydocstyle
      "args": ["--convention=numpy"]         // 可选：按 numpy 风格检查
    }
  }
}

关键点：

"enable": true 必须写，否则它被默认禁用
"executable" 路径要真实存在——用 which pydocstyle 查到的路径直接填进去，别手敲猜
Windows 用户注意路径分隔符，例如："C:\Python311\Scripts\pydocstyle.exe"（双反斜杠）
"args" 支持常见约定：--convention=google、--convention=numpy、--convention=pep257，不加则用默认 pep257

为什么改了设置还是不检查 .py 文件里的 docstring？

常见静默失效原因不是配置错，而是文件未被识别为 Python 上下文。

python-script-generator

快速生成专业的 Python 脚本和应用代码。一键创建完整项目结构，支持CLI、API、爬虫、Bot、Django等多种项目类型，包含完整的项目结构、配置文件、依赖管理、测试、README和文档。

下载

检查以下三点：

当前文件右下角是否显示 Python（而不是 Plain Text 或空）？如果不是，按 Ctrl+Shift+P → 输入 Set Syntax: Python 手动切换
文件是否已保存为 .py 后缀？SublimeLinter 默认只对有后缀且语法识别为 Python 的文件触发
是否在函数/类定义上方写了 docstring？pydocstyle 不检查模块级注释（"""Module docstring"""）除非加 --match='.*.py' 参数，但 SublimeLinter 不支持传这种全局参数；建议只检查函数/类级 docstring，更实用

验证是否生效：写一个明显违规的函数，比如：

def foo():
    return 42

它应该立刻标红并提示 D100: Missing docstring in public module 或类似信息。

和 flake8 / pylint 混用时要注意什么

pydocstyle 专注 docstring 规范，和 flake8（语法/PEP8）、pylint（逻辑/结构）职责不同，可以共存，但容易互相干扰。

典型冲突点：

多个 linter 同时报 D100，但只希望 pydocstyle 报——在 flake8 的 args 里加 --ignore=D，或在 pylint 中关掉 missing-docstring 检查项
性能拖慢：三个 linter 同时跑会卡顿，尤其大文件。可在 SublimeLinter 设置中限制触发时机："on_save": true（只保存时检查），而非默认的 "on_load" + "on_modified"
错误信息重叠：比如 D103: Missing docstring in public function 和 pylint 的 C0116 提示同一处，建议保留 pydocstyle（它专精此道），关掉其他工具的 docstring 检查