Python中TypedDict功能实例讲解

# 😩 传统做法：宽泛的类型注解
user_data: dict[str, object] = {
    "user_id": 1001,
    "name": "Alice",
    "is_active": True
}

print(user_data["name"])        # IDE 无法推断具体类型，无代码提示
print(user_data["user_idd"])    # 键名拼写错误，运行时才会报错 (KeyError)
print(user_data["user_Id"])     # 键名大小写写错，IDE 毫无反应

from typing import TypedDict

class UserDict(TypedDict):
    user_id: int
    name: str
    is_active: bool

# ✅ 结构清晰，IDE 完美提示
user_data: UserDict = {
    "user_id": 1001,
    "name": "Alice",
    "is_active": True
}

print(user_data["name"])  # IDE 明确知道这是 str，提供字符串方法提示

from typing import TypedDict

class Movie(TypedDict):
    title: str
    year: int

movie: Movie = {"title": "Inception", "year": 2010}

# ✅ 正确的访问方式
print(movie["title"])  

# ❌ 错误的访问方式：TypedDict 不支持点号访问
# print(movie.title)  # AttributeError!

# ✅ 运行时验证：它依然是普通的 dict
print(type(movie))       # <class 'dict'>
print(isinstance(movie, dict))  # True

from typing import TypedDict, NotRequired

class UserProfile(TypedDict):
    user_id: int
    name: str
    email: NotRequired[str]  # 标记为可选

# ✅ 合法：省略了可选的 email
profile1: UserProfile = {"user_id": 1, "name": "Alice"}

# ✅ 合法：提供了 email
profile2: UserProfile = {"user_id": 2, "name": "Bob", "email": "bob@example.com"}

# ❌ 非法：缺少必填的 name（IDE/类型检查器会报错）
# profile3: UserProfile = {"user_id": 3}

from typing import TypedDict

class Address(TypedDict):
    city: str
    zipcode: str

class Contact(TypedDict):
    phone: str
    address: Address  # 嵌套另一个 TypedDict

class Person(TypedDict):
    name: str
    contacts: Contact

person: Person = {
    "name": "Charlie",
    "contacts": {
        "phone": "123-456-7890",
        "address": {
            "city": "Beijing",
            "zipcode": "100000"
        }
    }
}

# ✅ 享受多层级的智能提示
print(person["contacts"]["address"]["city"])  # Beijing

from typing import TypedDict

class User(TypedDict):
    name: str

user: User = {"name": "Alice"}

# ✅ 推荐：使用 [] 访问
# 类型检查器知道 "name" 是必填的，所以推断类型为 str
name1 = user["name"]  

# ⚠️ 谨慎：使用 .get() 访问
# .get() 的语义是“可能不存在”，所以即使 name 是必填的，
# 类型检查器也会将推断类型变为 str | None
name2 = user.get("name") 

from typing import TypedDict, NotRequired, Unpack  # Python 3.11+ 原生支持
# Python 3.8-3.10 需要：from typing_extensions import NotRequired, Unpack

class InitArgs(TypedDict):
    host: str
    port: int
    debug: NotRequired[bool]  # 可选参数

class Server:
    # 使用 Unpack 将 TypedDict 的键“解包”为关键字参数
    def __init__(self, **kwargs: Unpack[InitArgs]):
        self.host = kwargs["host"]
        self.port = kwargs["port"]
        self.debug = kwargs.get("debug", False)

# ✅ IDE 完美提示：输入 Server( 后，会提示需要 host, port（debug 为可选）
server = Server(host="localhost", port=8080, debug=True)
server2 = Server(host="localhost", port=8080)

# ❌ 传入未声明的参数，类型检查器会报错
# Server(host="localhost", port=8080, timeout=30)