什么是setdefault方法？

setdefault()是Python字典(Dictionary)的一个内置方法，用于获取指定键的值。如果键不存在于字典中，它会添加该键并设置默认值。这个方法在需要初始化字典值或避免键错误时特别有用。

方法语法

dict.setdefault(key, default_value)

• key - 要查找的键（必需）
• default_value - 键不存在时设置的默认值（可选，默认为None）

返回值

这个方法返回：

• 如果键存在，返回对应的值
• 如果键不存在，返回设置的默认值（如果提供了）或None

基础用法示例

# 键存在时，返回对应的值
person = {"name": "Alice", "age": 30}

# 获取存在的键
name = person.setdefault("name", "Unknown")
print(name)  # 输出: Alice

# 键不存在时，添加键值对并返回默认值
person = {"name": "Alice", "age": 30}

# 获取不存在的键
email = person.setdefault("email", "alice@example.com")
print(email)  # 输出: alice@example.com
print(person) # 输出: {'name': 'Alice', 'age': 30, 'email': 'alice@example.com'}

# 不提供默认值时，使用None
person = {"name": "Alice", "age": 30}

# 获取不存在的键，不提供默认值
address = person.setdefault("address")
print(address)  # 输出: None
print(person)   # 输出: {'name': 'Alice', 'age': 30, 'address': None}

实际应用场景

# 使用setdefault对数据进行分组
data = [
    ("fruit", "apple"),
    ("animal", "dog"),
    ("fruit", "banana"),
    ("animal", "cat"),
    ("fruit", "orange"),
]

grouped = {}
for category, item in data:
    # 如果category键不存在，创建一个空列表
    grouped.setdefault(category, []).append(item)

print(grouped)
# 输出: {'fruit': ['apple', 'banana', 'orange'], 'animal': ['dog', 'cat']}

# 使用setdefault实现计数器
text = "apple banana apple orange banana apple"
words = text.split()

word_count = {}
for word in words:
    # 如果word键不存在，初始化为0
    word_count.setdefault(word, 0)
    word_count[word] += 1

print(word_count)
# 输出: {'apple': 3, 'banana': 2, 'orange': 1}

# 使用setdefault避免键不存在时的KeyError
config = {"theme": "dark", "language": "en"}

# 安全获取可能不存在的配置项
font_size = config.setdefault("font_size", 14)
print(f"字体大小: {font_size}px")  # 输出: 字体大小: 14px

与类似方法的比较

from collections import defaultdict

# 使用defaultdict实现分组功能
grouped = defaultdict(list)
for category, item in data:
    grouped[category].append(item)
    
print(dict(grouped))

注意事项

• setdefault()会修改原始字典
• 当使用可变对象（如列表、字典）作为默认值时，每次调用都会使用相同的对象
• 对于复杂的默认值逻辑，使用collections.defaultdict可能更高效
• 在循环中使用时，确保默认值的创建不会成为性能瓶颈

# 不正确的使用方式
d = {}
d.setdefault('key', []).append(1)  # 正确
d.setdefault('key', []).append(2)  # 正确

# 错误：每次调用都创建新列表
for i in range(3):
    # 每次循环都创建新列表，效率低
    d.setdefault('list', []).append(i)
    
# 更高效的方式
if 'list' not in d:
    d['list'] = []
d['list'].append(i)

总结

setdefault()是Python字典中一个非常有用的方法，特别适合以下场景：

• 需要安全地获取字典值，避免KeyError异常
• 初始化字典中的值（特别是当值为可变对象时）
• 对数据进行分组或计数操作
• 简化需要先检查键是否存在的代码逻辑

虽然setdefault()非常方便，但在性能关键的代码中，考虑使用collections.defaultdict或显式检查键是否存在可能更高效。