Python中的仅关键字字段是什么？何时应当使用它们？

什么是仅关键字字段？ #

在Python函数调用中，仅关键字参数指必须通过参数名=值的形式传递的参数，不能按位置顺序传递。Python 3.10开始，dataclass支持生成带仅关键字字段的__init__方法，有多种方式指定这类字段。

核心作用 #

• 避免参数顺序错误：当dataclass字段较多或含义相近时，按位置传参很容易搞混顺序，用关键字传参能明确对应关系。
• 提升代码可读性：调用时一眼就能看到每个参数对应的字段，不用回头查类定义的字段顺序。
• 增强向后兼容性：后续给dataclass新增字段时，只要给新字段设置默认值，旧的关键字调用代码无需修改就能正常运行。

适用场景 #

• 字段数量较多的dataclass（比如用户信息、订单详情类）。
• 存在含义相近字段的场景（比如width/height、start_date/end_date）。
• 需要后续扩展字段的dataclass，避免新增字段破坏原有调用逻辑。

示例演示 #

方式1：全局设置所有字段为仅关键字 #

通过@dataclass(kw_only=True)让类中所有字段都必须用关键字传参：

from dataclasses import dataclass
from datetime import date

@dataclass(kw_only=True)
class Birthday:
    name: str
    birthday: date

# 正确调用：必须用关键字传参
b = Birthday(name="Alice", birthday=date(1990, 1, 1))

# 错误调用：按位置传参直接报错
# b = Birthday("Alice", date(1990, 1, 1))

方式2：单个字段设置为仅关键字 #

用field(kw_only=True)指定单个字段为仅关键字，其他字段仍支持位置传参：

from dataclasses import dataclass, field
from datetime import date

@dataclass
class Birthday:
    name: str  # 支持位置/关键字两种传参方式
    birthday: date = field(kw_only=True)  # 必须用关键字传参

# 正确调用：name可以按位置或关键字传，birthday必须关键字
b1 = Birthday("Bob", birthday=date(1995, 5, 5))
b2 = Birthday(name="Charlie", birthday=date(2000, 10, 10))

# 错误调用：birthday按位置传参报错
# b3 = Birthday("Dave", date(2000, 10, 10))

方式3：混合使用（部分字段仅关键字） #

可以指定某几个字段为仅关键字，适合需要保留部分位置传参便利性的场景：

from dataclasses import dataclass, field
from datetime import date

@dataclass
class User:
    name: str
    age: int
    email: str = field(kw_only=True)
    phone: str = field(kw_only=True, default="")  # 带默认值的仅关键字字段

# 正确调用：前两个字段可位置传，后两个必须关键字
u = User("Eve", 25, email="eve@example.com")
# 全部用关键字传参也支持
u2 = User(name="Frank", age=35, email="frank@example.com", phone="1234567890")

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