setattr() 是什么？

setattr() 是 Python 的一个内置函数，它的全称是 "set attribute"（设置属性），它的作用是动态地为一个对象设置或添加一个新的属性。

你可以使用 setattr() 在程序运行时,根据变量或字符串来决定要给哪个对象的哪个属性赋值。

语法

setattr() 的语法非常简单：

setattr(object, name, value)

参数说明：

• object: 要设置属性的对象，可以是任何 Python 对象，比如实例、模块、类等。
• name: 字符串,表示要设置的属性名。
• value: 要赋给该属性的值。

返回值：setattr() 函数本身不返回任何值，它的返回值是 None。

工作原理

setattr() 的工作方式等价于以下操作：

object.name = value

setattr(my_object, 'x', 10) 完全等同于 my_object.x = 10。

使用示例

让我们通过几个例子来理解它的用法。

示例 1：在类的实例上动态添加属性

这是最常见的用法，我们可以在创建对象后,根据需要给它添加新的属性。

class Person:
    def __init__(self, name):
        self.name = name
# 创建一个 Person 实例
p = Person("Alice")
# 检查初始属性
print(f"初始属性: {p.name}")  # 输出: 初始属性: Alice
# 使用 setattr 动态添加 'age' 属性
setattr(p, 'age', 30)
# 这等同于 p.age = 30
# 检查新添加的属性
print(f"添加年龄后: {p.age}")  # 输出: 添加年龄后: 30
# 再添加一个 'city' 属性
setattr(p, 'city', 'New York')
print(f"所在城市: {p.city}")  # 输出: 所在城市: New York

示例 2：修改已存在的属性

setattr() 也可以用来修改一个对象已有的属性。

class Car:
    def __init__(self, model):
        self.model = model
        self.speed = 0
my_car = Car("Tesla Model S")
print(f"初始速度: {my_car.speed} km/h")  # 输出: 初始速度: 0 km/h
# 使用 setattr 修改 speed 属性
setattr(my_car, 'speed', 100)
# 这等同于 my_car.speed = 100
print(f"加速后速度: {my_car.speed} km/h")  # 输出: 加速后速度: 100 km/h

示例 3：在模块上动态添加属性

setattr() 不仅可以用于类的实例,还可以用于模块本身。

假设你有一个文件 my_module.py：

# my_module.py
version = "1.0"

然后在另一个文件中操作它：

import my_module
print(f"模块版本: {my_module.version}")  # 输出: 模块版本: 1.0
# 使用 setattr 给模块添加一个新属性 'author'
setattr(my_module, 'author', 'John Doe')
# 现在可以直接访问这个新属性
print(f"模块作者: {my_module.author}")  # 输出: 模块作者: John Doe

示例 4：与 getattr() 和 hasattr() 结合使用

setattr() 通常与 getattr()（获取属性）和 hasattr()（检查属性是否存在）一起使用,形成一个完整的动态属性操作组合。

• hasattr(object, name): 检查对象是否有某个属性。
• getattr(object, name, default): 获取对象的属性，如果属性不存在,可以返回一个默认值。
• setattr(object, name, value): 设置对象的属性。

class Config:
    debug = False
    port = 8080
config = Config()
# 使用 hasattr 检查属性是否存在
if hasattr(config, 'host'):
    print(f"主机地址: {config.host}")
else:
    print("配置中不存在 'host' 属性")
# 使用 setattr 动态设置 'host' 属性
setattr(config, 'host', 'localhost')
# 再次检查并使用 getattr 获取属性
if hasattr(config, 'host'):
    host_value = getattr(config, 'host')
    print(f"已设置主机地址: {host_value}")
# 获取一个可能不存在的属性，并提供默认值
timeout_value = getattr(config, 'timeout', 30)
print(f"超时时间: {timeout_value} (如果未设置，则使用默认值)")

高级用法：从字符串创建对象并设置属性

这是 setattr() 一个非常强大的功能,常用于根据配置文件或用户输入来动态创建和配置对象。

假设我们有一个配置字典：

config = {
    'class_name': 'Dog',
    'attributes': {
        'name': 'Buddy',
        'breed': 'Golden Retriever',
        'age': 5
    }
}
# 假设我们有一个 Animal 类和它的子类 Dog
class Animal:
    def __init__(self, name):
        self.name = name
    def speak(self):
        return "Some sound"
class Dog(Animal):
    def speak(self):
        return f"{self.name} says: Woof!"
# 动态创建对象
# 1. 获取类
animal_class = globals().get(config['class_name'])
if animal_class:
    # 2. 创建实例，传入 name
    my_dog = animal_class(name=config['attributes']['name'])
    # 3. 循环设置其他属性
    for attr_name, attr_value in config['attributes'].items():
        if attr_name != 'name': # 避免覆盖 __init__ 中已设置的 name
            setattr(my_dog, attr_name, attr_value)
    # 验证结果
    print(f"名字: {my_dog.name}")
    print(f"品种: {my_dog.breed}")
    print(f"年龄: {my_dog.age}")
    print(f"叫声: {my_dog.speak()}")
else:
    print(f"未找到名为 {config['class_name']} 的类")

输出:

名字: Buddy
品种: Golden Retriever
年龄: 5
叫声: Buddy says: Woof!

注意事项

1. 不存在的属性：object 本身没有 name 这个属性，setattr() 会添加一个新的属性,而不会报错。
2. 只读属性：如果对象的某个属性是只读的（通过 @property 装饰器定义且没有 setter 方法），那么尝试使用 setattr() 修改它会引发 AttributeError。
3. 安全性：由于 setattr() 非常灵活，它也带来了一定的安全风险，如果属性名来自不可信的外部输入（如用户提交的表单），攻击者可能会修改对象内部的关键属性，导致程序行为异常或安全漏洞，在这种情况下,应该对输入的属性名进行严格的校验。

setattr() 是 Python 动态语言特性的一个重要体现，它极大地增强了代码的灵活性和可扩展性，特别适用于需要高度动态配置的场景，如插件系统、配置解析、ORM（对象关系映射）等。