假设我有一些代码
def get_x(d: dict) -> int:
d["x"]
但是,我想告诉 mypyd
应该只包含某些键(例如只有“x”键)。这样,如果我在尝试引用无效键的代码中犯了错误d
,mypy 将触发错误。
我的问题是:
- 这可能吗?mypy 可以验证字典键吗?
- 如果是,这是如何完成的?如果没有,是否有首选的解决方法?
假设我有一些代码
def get_x(d: dict) -> int:
d["x"]
但是,我想告诉 mypyd
应该只包含某些键(例如只有“x”键)。这样,如果我在尝试引用无效键的代码中犯了错误d
,mypy 将触发错误。
我的问题是:
在尝试围绕 AWS API Gateway/Lambda 集成进行一些输入时也遇到了这个问题。
正如@Michael0x2a 在评论中指出的那样,TypedDict似乎是要走的路,特别是因为它在传递给函数之前不需要自己进行任何转换(API 响应的要求,就像你提到的那样)。
from mypy_extensions import TypedDict
DictWithOnlyX = TypedDict('DictWithOnlyX', {"x": str})
# error: Extra key 'y' for TypedDict "DictWithOnlyX@58"
dx1: DictWithOnlyX = { "y": 123 }
# error: Incompatible types (expression has type "int",
# TypedDict item "x" has type "str")
dx2: DictWithOnlyX = { "x": 123 }
# GOOD!
dx3: DictWithOnlyX = { "x": "123" }
还应该注意,如果依赖关系在生产和开发/测试之间分离,那么这会mypy
产生生产依赖。
有几种方法并假设您的数据结构只能具有相同的属性,但它们不使用字典。
dict
您可以使用命名元组,而不是传入a 。使用命名元组,您可以将其视为对象,但也不能添加新字段。
from collections import namedtuple
A = namedtuple("A", ["x", "y", "z"])
def get_x(d: A) -> int:
d.x
另一种方法是创建一个类并使用__slot__
属性。这也使得不会意外插入新属性。
class A:
__slot__ = ["x", "y", "z"]
def __init__(self, x, y, z):
self.x = x
self.y = y
self.z = z
使用上述方法,您必须在一开始就定义字段。