如何让Pylint忽略@task装饰器函数首个未用参数的W0613告警？

以下是几种不用全局关闭规则、也无需让Pylint解析所有装饰器的解决办法：

方法1：重命名参数为下划线开头 #

Pylint默认会忽略以单下划线_开头的未使用参数，直接把ctx改成_ctx即可：

from invoke import task

@task
def my_task(_ctx):
    # 这里不需要使用_ctx参数
    print("执行任务")

这个方法最简洁，无需额外配置或注释。

方法2：局部禁用特定函数的告警 #

在函数定义行添加注释，仅对该函数禁用W0613告警：

from invoke import task

@task
def my_task(ctx):  # pylint: disable=unused-argument
    print("执行任务")

或者在函数内部第一行添加注释，作用范围同样仅限当前函数：

@task
def my_task(ctx):
    # pylint: disable=unused-argument
    print("执行任务")

方法3：通过Pylint配置针对@task装饰器做例外 #

如果你有多个这类函数，不想逐个加注释，可以修改Pylint配置文件（比如pylintrc或pyproject.toml），指定被@task装饰的函数允许第一个参数未使用：

对于pylintrc文件： #

[TYPECHECK]
# 指定名为ctx的未使用参数可被忽略，匹配PyInvoke的要求
ignored-argument-names=^ctx$

对于pyproject.toml： #

[tool.pylint.typecheck]
ignored-argument-names = "^ctx$"

这个配置会全局忽略名为ctx的未使用参数，刚好适配PyInvoke的场景，不会影响其他函数的参数检查。

内容的提问来源于stack exchange，提问作者red888