如何避免Pylance的reportUnnecessaryIsinstance类型检查警告

Pylance警告触发逻辑 #

Pylance给出该警告的逻辑很简单：当你给参数标注为int时，静态类型检查器默认所有调用方都会遵循类型约束，只会传入int类型的值，自然会认为isinstance(val, int)的判断永远为真，属于多余检查。但这个逻辑只覆盖了全链路开启严格静态类型检查的场景，Python本身是动态语言，未开启类型检查的调用方完全可能传入其他类型的参数，你要加运行时校验的需求是完全合理的。

几种方案的优劣分析 #

• 方案1：参数标注val: int + 保留isinstance检查
  语法合规，语义也最符合真实需求：既可以给IDE、静态检查器提供类型提示，正常拦截符合类型规范的调用方传入非法类型，又保留了运行时校验兼容动态调用场景。唯一问题就是会触发Pylance的警告。
• 方案2：不给参数加类型标注
  完全不推荐。一方面会丢失类型提示，其他开发者调用该setter时IDE不会给出参数类型提示，静态检查也无法提前拦截明显的非法传参；另一方面还会额外触发参数类型未知的警告，得不偿失。
• 方案3：参数标注val: Any + isinstance检查
  可以消除所有警告，但语义损失很大。标注为Any相当于直接告诉静态检查器不要校验该参数的类型，哪怕调用方明确传入字符串、列表等类型，静态检查也不会给出任何提示，相当于直接放弃了类型标注的核心价值，除非你确定该setter就是要接受任意类型输入再做校验，否则不建议这么用。

最优解决方案 #

不需要修改代码逻辑，也不要关闭全局的该类警告，只需要在触发警告的isinstance检查行添加局部忽略注释即可，示例如下：

@foo.setter
def foo(self, val: int):
    if not isinstance(val, int): # type: ignore[unnecessary-isinstance]
        raise ValueError()

这种做法既保留了类型标注的所有优势，又保留了运行时校验能力，同时只屏蔽了当前场景下的无效警告，不会影响其他代码的正常检查。

如果你能确保所有使用该类的场景都会开启严格的静态类型检查，也可以直接删掉isinstance检查，所有非法传参都会在静态检查阶段被拦截，完全不需要运行时校验，自然也不会触发警告。

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