Python Academy · 课时

默认值和 field()

Q: 「默认值和 field()」这节课中我会学到什么？

设置默认值并使用 field() 选项 你通过在浏览器中直接运行的动手代码来练习 Python Academy，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

设置默认值并使用 field() 选项

默认值和 field() 是 CoddyKit 上的免费 Python Academy 课时。这是第 2 节课，共 4 节。你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。这是 Python Academy 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 Python Academy 课程共包含 4 节课。

为字段提供默认值

与函数参数一样，数据类字段也可以具有默认值。创建实例时，可以省略具有默认值的字段。

from dataclasses import dataclass

@dataclass
class Server:
    host: str
    port: int = 8080

print(Server('localhost'))
print(Server('example.com', 443))

顺序很重要

具有默认值的字段必须位于没有默认值的字段之后，这与函数参数完全相同。否则，Python 会在定义类时引发 TypeError。

from dataclasses import dataclass

@dataclass
class User:
    name: str       # required
    active: bool = True   # optional

print(User('Alice'))

可变默认值陷阱

不能直接使用列表或字典等可变对象作为默认值。否则所有实例都会共享同一个对象。Python 会检测到这一点，并引发 ValueError 来保护您。

from dataclasses import dataclass
from typing import List

# This raises ValueError at class definition time:
try:
    @dataclass
    class Bad:
        items: List[int] = []
except ValueError as e:
    print('Error:', e)

field(default_factory=...)

若要提供可变的默认值，请使用 field(default_factory=...)。该工厂函数会为每个新实例调用一次，因此每个实例都会获得自己的全新对象。

from dataclasses import dataclass, field
from typing import List

@dataclass
class Cart:
    items: List[str] = field(default_factory=list)

a = Cart()
a.items.append('apple')
b = Cart()
print(a.items, b.items)

default 与 default_factory

如果还需要使用其他 field() 选项，请对不可变值使用 field(default=...)。对于任何可变值，请使用 default_factory。两者不能同时传入。

from dataclasses import dataclass, field

@dataclass
class Config:
    retries: int = field(default=3)
    tags: list = field(default_factory=list)

print(Config())

从 repr 中排除字段

repr=False 选项会将字段从自动生成的 __repr__ 中隐藏。对于机密信息或大型内部缓冲区，这非常有用。

from dataclasses import dataclass, field

@dataclass
class Account:
    user: str
    token: str = field(repr=False, default='secret')

print(Account('alice'))

从比较中排除字段

使用 compare=False 后，自动生成的 __eq__（以及排序）会忽略该字段。即使该字段不同，两个实例仍然可以相等。

from dataclasses import dataclass, field

@dataclass
class Event:
    name: str
    timestamp: float = field(compare=False, default=0.0)

print(Event('login', 1.0) == Event('login', 99.0))

init=False 字段

设置 init=False 会使字段不出现在 __init__ 中。通常需要同时为它提供默认值，或在 __post_init__ 中设置它。

from dataclasses import dataclass, field

@dataclass
class Circle:
    radius: float
    area: float = field(init=False, default=0.0)

c = Circle(2.0)
print(c)

使用 __post_init__ 计算派生值

定义 __post_init__，即可在自动生成的 __init__ 刚刚运行完后执行代码。这里是根据其他字段计算派生字段的自然位置。

from dataclasses import dataclass, field

@dataclass
class Circle:
    radius: float
    area: float = field(init=False, default=0.0)

    def __post_init__(self):
        self.area = 3.14159 * self.radius ** 2

print(Circle(2.0))

存储元数据

metadata 参数会为字段附加任意映射。Python 会忽略它，但工具和您自己的代码可以读取它，用于提供文档或验证提示。

from dataclasses import dataclass, field, fields

@dataclass
class Product:
    price: float = field(metadata={'unit': 'USD'})

for f in fields(Product):
    print(f.name, f.metadata)

组合 field() 选项

这些选项可以叠加使用。单个字段可以同时从 repr 中隐藏、排除在比较之外，并携带默认值。

from dataclasses import dataclass, field

@dataclass
class Session:
    user: str
    token: str = field(default='x', repr=False, compare=False)

print(Session('alice'))
print(Session('alice') == Session('alice', token='different'))

快速检查

应该如何为数据类字段提供一个默认的空列表？

回顾

您学会了设置默认值并使用 field() 选项。

具有默认值的字段位于必需字段之后。
对可变默认值使用 default_factory。
使用 repr、compare、init 和 metadata 调整每个字段。
__post_init__ 用于计算派生值。

常见问题解答

「默认值和 field()」课时是免费的吗？

是的 — 「默认值和 field()」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 Python Academy 课程的其余内容，请升级到 CoddyKit PRO。 Python Academy 课程共包含 4 节课。

「默认值和 field()」这节课中我会学到什么？

设置默认值并使用 field() 选项你通过在浏览器中直接运行的动手代码来练习 Python Academy，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 Python Academy 需要有经验吗？

无需任何先前经验。CoddyKit 上的 Python Academy 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。这是第 2 节课，共 4 节。

「默认值和 field()」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 Python Academy 课中编写并运行代码吗？

能。每节 Python Academy 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

← 返回 Python Academy