崇高 - 忽略 pep257 D100 警告?

Sublime - ignore pep257 D100 warning?

我正在寻找如何忽略特定警告,但找不到具体的禁用方法。

我试过这个(在 SublimeLinter 设置中):

        "flake8": {
            "@disable": false,
            "args": [],
            "builtins": "",
            "excludes": [],
            "executable": "",
            "ignore": "D100",
            "jobs": "1",
            "max-complexity": 10,
            "max-line-length": null,
            "select": "",
            "show-code": false
        },

然后这个:

        "pep257": {
            "@disable": false,
            "add-ignore": "",
            "args": [],
            "excludes": [],
            "ignore": "D100"
        },

还有这个:

        "pep257_ignore": [
            "D100"
        ],

但我仍然收到该警告。那么我应该在哪里禁用它呢?

由于 pep257 已重命名为 pydocstyle,我正在写如何为 pydocstyle.

忽略 error/warning 的答案

似乎以前指定 sublime linter 配置的方法(例如忽略一些 errors/warnings)是不好的做法并且不再支持(在较新的版本上)它现在打算在 sublime 之外使用配置文件本身。

pydocstyle 文档说您需要提供配置文件,您可以在其中提供要忽略的错误列表,例如(可以使用 setup.cfg 名称):

[pydocstyle]
ignore = D100

虽然目前它仍然不起作用,因为如果没有在 sublimelinter 或项目设置中明确指定,sublimelinter-pydocstyle 不会按层次结构扫描文件 (https://github.com/SublimeLinter/SublimeLinter-pydocstyle/issues/24#issuecomment-412329010)

因此您需要指定文件的路径,例如(例如在 sublime linter 设置中):

{
    "linters": {
        "pydocstyle": {
            "config": "/your/path/to/setup.cfg"
        }
    }
}

P.S。请注意,例如 flake8 sublime linter 不需要指定配置路径,它会向上扫描并在找到时使用(比如如果将 setup.cfg 放在某个父文件夹中)。

我在这里写了一个忽略 Sublime Linter 错误的简短指南:https://hightower.space/thoughts/sublime-linter-ignore-guide/

基本要点是您的 Sublime Linter 设置(位于 首选项 > 包设置 > SublimeLinter > 设置)应该类似于:

// SublimeLinter Settings - User
{
    "lint_mode": "load_save",
    "linters": {
        "pydocstyle": {
            "ignore": "D100,D101,D102,D103,D104,D105",
        },
        "pep8": {
            "ignore": "E501"
        },
        "flake8": {
            "args": ["--ignore=E501"],
        }
    }
}]

我的guide中有更多解释,但这给出了基本思路。在 "linters" 键下,您可以给出特定 linter 的名称以及您希望应用于该 linter 的设置。正如@Andrius 指出的那样, pep257 包已重命名为 pydocstyle.