如何静态防范字符串与枚举类的错误比较？

Pyright 检测这类错误的方法 #

Pyright 本身就能检测这种类型不匹配的比较错误，无需额外工具。只要开启严格类型检查模式，它会在你把字符串和枚举实例直接比较时抛出提示。

配置方法：

• 在项目根目录创建 pyrightconfig.json，添加以下内容：

  {
    "strict": true
  }
  

• 或者在 VS Code 的设置中，将 Python > Pyright: Type Checking Mode 设置为 strict。

当你运行 pyright 检查时，它会识别到 status 是 str 类型，而 StatusValues.one 是 StatusValues 枚举实例，两者类型不兼容，从而在比较行抛出类似“无法将类型 "StatusValues" 与类型 "str" 进行比较”的错误提示。

防范这类错误的实用方法 #

1. 强制使用枚举类型作为参数类型
   直接将函数参数的类型标注为枚举类型，从源头避免传入字符串：

   import enum
   
   class StatusValues(enum.Enum):
       one = "one"
       two = "two"
   
   def status_is_one(status: StatusValues):
       return status == StatusValues.one
   

   这样如果调用函数时传入字符串，pyright 会提前报错，根本不会走到比较逻辑。

2. 在函数内先将字符串转换为枚举实例
   如果必须接收字符串参数，可以先把字符串转换为枚举实例再比较，同时还能校验输入的合法性：

   def status_is_one(status: str):
       try:
           return StatusValues(status) == StatusValues.one
       except ValueError:
           # 处理无效状态的情况
           return False
   

3. 坚持使用 .value 进行字符串比较
   如果你确实需要和字符串比较，记得始终使用枚举的 .value 属性，养成习惯后就能减少这类错误。配合 pyright 的类型检查，漏掉 .value 时能及时被发现。

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