如何键入提示 getter 只允许 dict 的键？

Question

我想知道如何使这个 getter 更类型安全：

VALUES = {
   '1': 'One',
   '2': 'Two',
   '3': 'Three'
}


def get(key : str) -> str:
    return VALUES[key]

我希望拥有一个keyof VALUES和type(VALUES[key])类型，而不是str类型。

get('4')应该抛出一个无效类型警告，因为这个键不存在。 不确定这是否可以用 Python 实现，因为我确实生活在 TypeScript 仙境中...... :-)

TypeScript 应该是这样的：

get<K extends keyof VALUES>(key : K): typeof K
{
    return VALUES[key];
}

Answer 1

一般情况下您不能这样做。 但是，在这种特殊情况下，您可以使用typing.Literal完成您想要的typing.Literal ：

import typing
def get(key: typing.Literal['1','2','3']) -> str:
    return VALUES[key]

Answer 2

正如评论中所建议的， enum模块在这里提供了一个很好的解决方案。 通过将str与enum.Enum混合，我们可以创建一个与str完全向后兼容的Enum （即，可以在需要str类型的任何地方使用。

from enum import Enum

# The mixin type has to come first if you're combining
# enum.Enum with other types 
class Values(str, Enum):
    N1 = 'One'
    N2 = 'Two'
    N3 = 'Three'

如果我们将此定义输入到交互式控制台中，我们将看到该类具有以下行为：

>>> Values['N1']
<Values.N1: 'One'>
>>> Values('One')
<Values.N1: 'One'>
>>> Values.N1
<Values.N1: 'One'>
>>> Values('One') is Values.N1 is Values['N1']
True
>>> Values.N1.name
'N1'
>>> Values.N1.value
'One'
>>> Values.N1 == 'One'
True
>>> Values.N1 is 'One'
False
>>> Values.N1.startswith('On')
True
>>> type(Values.N1)
<enum 'Values'>
>>> for key in Values:
...     print(key)
...
Values.N1
Values.N2
Values.N3
>>> list(Values)
[Values.N1, Values.N2, Values.N3]

如您所见，我们定义了一个新类型：

• 提供对成员的动态字典式访问，以及更多类型安全的访问形式。
• 与str完全向后兼容——它可以自由地与str对象进行比较，并且可以对其成员使用str方法。
• 可以在类型提示中用作typing.Literal的替代typing.Literal 。 如果我有这样的功能：

def do_something(some_string):
    if some_string not in ('One', 'Two', 'Three'):
        raise Exception('NO.')

然后我可以像这样注释它：

from typing import Literal

def do_something(some_string: Literal['One', 'Two', 'Three']) -> None:
   ...

或者像这样（在这种情况下，您必须传入Values枚举的成员而不是普通字符串，否则类型检查器将引发错误）：

# Values enum as defined above 
def do_something(some_string: Values) -> None:
   ...

这里有一个更详细的指导蟒的复杂性Enum Ş这里。