将字符串联合用作可能的字典键

Question

我有一些 Python 3.7 代码，我正在尝试向其中添加类型。 我要添加的类型之一实际上是几个可能字符串的Union ：

from typing import Union, Optional, Dict

PossibleKey = Union["fruits", "cars", "vegetables"]
PossibleType = Dict[PossibleKey, str]

def some_function(target: Optional[PossibleType] = None):
  if target:
    all_fruits = target["fruits"]
    print(f"I have {all_fruits}")

这里的问题是 Pyright 抱怨PossibleKey密钥。 它说：

“水果没有定义”

我想让 Pyright/Pylance 工作。

我已经从另一个 SO 答案检查了from enum import Enum模块，但是如果我尝试这样做，我最终会遇到更多问题，因为我实际上是在处理Dict[str, Any]而不是Enum 。

表示我的类型的正确 Pythonic 方式是什么？

Answer 1

"fruits"不是类型（提示），但Literal["fruits"]是。

from typing import Union, Literal

PossibleKey = Union[Literal["fruits"], Literal["cars"], Literal["vegetables"]]

或者更短的版本，

PossibleKey = Literal["fruits", "cars", "vegetables"]

或者，正如您所提到的，定义一个由三个值填充的Enum 。

from enum import Enum


class Key(Enum):
    Fruits = "fruits"
    Cars = "cars"
    Vegetables = "vegetables"


def some_function(target: Optional[PossibleType] = None):
    if target:
        all_fruits = target[Key.Fruits]
        print(f"I have {all_fruits}")

（然而，仅仅因为target不是None并不一定意味着它实际上有"fruits"作为键，只是没有Key.Fruits 、 Key.Cars或Key.Vegetables以外的键。）

Answer 2

如果您将PossibleKey定义为Enum ，则Pyright错误消失，如下所示。 这仅需要对原始代码进行一行更改。 如果使用 Enum 存在一些问题，请详细说明。

from typing import Union, Optional, Dict
from enum import Enum

PossibleKey = Enum("PossibleKey", ["fruits", "cars", "vegetables"])
PossibleType = Dict[PossibleKey, str]

def some_function(target: Optional[PossibleType] = None):
  if target:
    all_fruits = target["fruits"]
    print(f"I have {all_fruits}")