代码重构后Pylance中的类型注解功能失效问题

我们将原本内联的brokerageInstance空值判断与异常抛出逻辑，重构到checkBrokerageInstanceExistence类方法后，尽管该方法会在实例为空时直接抛出ValueError，但Pylance的类型检查器无法识别这个方法内的逻辑，依然会在调用cls.brokerageInstance.getExpiryList(spotInst)时提示类型错误（因为brokerageInstance的类型标注为typing.Optional[IInfoProvider]）。

相关代码 #

import typing
from datetime import date
from typing import List, Optional

# 假设已定义IInfoProvider和SpotInstrument接口/类
class IInfoProvider:
    def getExpiryList(self, spotInst) -> List[date]:
        pass

class SpotInstrument:
    pass

class InfoProvider:

    brokerageInstance: typing.Optional[IInfoProvider] = None

    @classmethod
    def setBrokerageInstance(cls, brokerageInstance: IInfoProvider):
        """Set instance of brokerage

        Args:
            brokerageInstance (IInfoProvider): _description_
        """
        cls.brokerageInstance = brokerageInstance

    @classmethod
    def checkBrokerageInstanceExistence(cls):
        if cls.brokerageInstance is None:
            raise ValueError("Brokerage instance has not been initialized")

    @classmethod
    def getExpiryList(cls, spotInst: SpotInstrument):
        """func to return expiry list of given spot

        Args:
            spotInst (SpotInstrument): spotInstrument

        Returns:
            List[datetime.date]: expiryList
        """
        cls.checkBrokerageInstanceExistence()

        return cls.brokerageInstance.getExpiryList(spotInst)  # Pylance会提示类型错误

解决方法 #

1. 添加类型断言

在调用检查方法后，用assert明确告知Pylance此时brokerageInstance不可能为None：

@classmethod
def getExpiryList(cls, spotInst: SpotInstrument):
    cls.checkBrokerageInstanceExistence()
    assert cls.brokerageInstance is not None
    return cls.brokerageInstance.getExpiryList(spotInst)

或者使用typing.cast进行类型转换：

from typing import cast

@classmethod
def getExpiryList(cls, spotInst: SpotInstrument):
    cls.checkBrokerageInstanceExistence()
    brokerage = cast(IInfoProvider, cls.brokerageInstance)
    return brokerage.getExpiryList(spotInst)

2. 给检查方法标注NoReturn类型

通过标注checkBrokerageInstanceExistence的返回类型为NoReturn，告诉类型检查器：当brokerageInstance为空时，该方法不会正常返回（直接抛出异常），从而推断后续代码中brokerageInstance一定非空：

from typing import NoReturn

@classmethod
def checkBrokerageInstanceExistence(cls) -> NoReturn:
    if cls.brokerageInstance is None:
        raise ValueError("Brokerage instance has not been initialized")

注意：该方法必须在触发异常的分支不会返回，否则会引发新的类型错误。

3. 使用typing.assert_never（Python 3.10+）

如果使用Python 3.10及以上版本，可以用assert_never来强化类型推断，确保brokerageInstance的类型被正确识别：

from typing import assert_never

@classmethod
def checkBrokerageInstanceExistence(cls):
    if cls.brokerageInstance is None:
        raise ValueError("Brokerage instance has not been initialized")
    assert_never(cls.brokerageInstance)

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