Mypy分支赋值提示类型不兼容问题咨询

问题背景 #

在使用PyVisa结合Mypy做类型检查时，出现了Incompatible types in assignment错误，尽管VSCode能正确识别self.instance为TCPIPInstrument | GPIBInstrument联合类型。使用环境为Python 3.11.3 + Mypy 1.2.0。

初始代码 #

from typing import cast

import pyvisa
from pyvisa.constants import InterfaceType
from pyvisa.resources import GPIBInstrument, TCPIPInstrument


class Instrument:
    resource_manager = pyvisa.ResourceManager()

    def __init__(self, resource: str):
        self.resource = self.resource_manager.open_resource(resource_name=resource)
        if self.resource.interface_type == InterfaceType.tcpip:
            self.instance: TCPIPInstrument = cast(TCPIPInstrument, resource)
        elif self.resource.interface_type == InterfaceType.gpib:
            self.instance: GPIBInstrument = cast(GPIBInstrument, resource)
        else:
            raise TypeError(f"Unsupported resource interface type: {self.resource.interface_type}")

报错信息 #

Incompatible types in assignment (expression has type "GPIBInstrument", variable has type "TCPIPInstrument")

修正后仍报错的代码 #

from typing import cast

import pyvisa
from pyvisa.constants import InterfaceType
from pyvisa.resources import GPIBInstrument, TCPIPInstrument


class Instrument:
    resource_manager = pyvisa.ResourceManager()

    def __init__(self, resource_name: str):
        self.resource = self.resource_manager.open_resource(resource_name=resource_name)
        if self.resource.interface_type == InterfaceType.tcpip:
            self.instance = cast(TCPIPInstrument, self.resource)
        elif self.resource.interface_type == InterfaceType.gpib:
            self.instance = cast(GPIBInstrument, self.resource)
        else:
            raise TypeError(f"Unsupported resource interface type: {self.resource.interface_type}")

错误原因 #

1. 初始代码的低级失误：第一个版本里，你把字符串参数resource传给了cast，但实际需要类型转换的是self.resource（PyVisa返回的资源对象），这直接导致类型不匹配。
2. Mypy的类型推断限制：即使修正了cast的目标，Mypy无法自动将self.resource.interface_type的检查结果与self.resource的实际类型建立关联。它不知道当interface_type为tcpip时，self.resource必然是TCPIPInstrument类型，因此会判定两个分支的赋值存在类型冲突。

解决方法 #

方法1：显式声明联合类型 #

在类级别或__init__方法开头，给self.instance标注明确的联合类型，让Mypy明确该变量允许的类型范围：

from typing import cast, Union

import pyvisa
from pyvisa.constants import InterfaceType
from pyvisa.resources import GPIBInstrument, TCPIPInstrument


class Instrument:
    resource_manager = pyvisa.ResourceManager()
    instance: Union[TCPIPInstrument, GPIBInstrument]  # 类级别类型标注

    def __init__(self, resource_name: str):
        self.resource = self.resource_manager.open_resource(resource_name=resource_name)
        if self.resource.interface_type == InterfaceType.tcpip:
            self.instance = cast(TCPIPInstrument, self.resource)
        elif self.resource.interface_type == InterfaceType.gpib:
            self.instance = cast(GPIBInstrument, self.resource)
        else:
            raise TypeError(f"Unsupported resource interface type: {self.resource.interface_type}")

方法2：使用自定义类型守卫 #

定义类型守卫函数，让Mypy能识别self.resource的类型与interface_type的对应关系：

from typing import TypeGuard

import pyvisa
from pyvisa.constants import InterfaceType
from pyvisa.resources import GPIBInstrument, TCPIPInstrument, Resource


def is_tcpip_resource(res: Resource) -> TypeGuard[TCPIPInstrument]:
    return res.interface_type == InterfaceType.tcpip

def is_gpib_resource(res: Resource) -> TypeGuard[GPIBInstrument]:
    return res.interface_type == InterfaceType.gpib


class Instrument:
    resource_manager = pyvisa.ResourceManager()

    def __init__(self, resource_name: str):
        self.resource = self.resource_manager.open_resource(resource_name=resource_name)
        if is_tcpip_resource(self.resource):
            self.instance = self.resource  # 无需cast，类型守卫已确认类型
        elif is_gpib_resource(self.resource):
            self.instance = self.resource
        else:
            raise TypeError(f"Unsupported resource interface type: {self.resource.interface_type}")

这种方式无需手动cast，类型守卫会直接告诉Mypy分支内变量的具体类型，更符合类型检查的最佳实践。

方法3：用assert辅助类型缩小 #

在分支中添加assert语句，明确告知Mypy当前分支的变量类型：

import pyvisa
from pyvisa.constants import InterfaceType
from pyvisa.resources import GPIBInstrument, TCPIPInstrument


class Instrument:
    resource_manager = pyvisa.ResourceManager()

    def __init__(self, resource_name: str):
        self.resource = self.resource_manager.open_resource(resource_name=resource_name)
        if self.resource.interface_type == InterfaceType.tcpip:
            assert isinstance(self.resource, TCPIPInstrument)
            self.instance = self.resource
        elif self.resource.interface_type == InterfaceType.gpib:
            assert isinstance(self.resource, GPIBInstrument)
            self.instance = self.resource
        else:
            raise TypeError(f"Unsupported resource interface type: {self.resource.interface_type}")

assert isinstance会让Mypy在对应分支中自动将self.resource的类型缩小到指定子类。

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