attrs，一个了不起的 Python 库！

更多资料获取

📚 个人网站：ipengtao.com

---

大家好，今天为大家分享一个了不起的 Python 库 - attrs。

Github地址：https://github.com/python-attrs/attrs

在 Python 编程中，使用 attrs 库可以显著简化类的定义和管理。attrs 提供了一种声明式的方式来定义类，使得代码更加清晰、简洁，并提供了许多方便的功能。本文将深入探讨 attrs 库的各个方面，并通过丰富的示例代码演示其用法。

安装 attrs

首先，确保已经安装了 attrs 库。如果没有安装，可以使用以下命令进行安装：

pip install attrs

基本用法

使用 attrs 声明类非常简单。下面是一个基本的示例：

import attr

@attr.s
class Person:
    name = attr.ib()
    age = attr.ib()

# 创建对象
person = Person(name="John", age=30)

# 输出对象信息
print(person)

通过 @attr.s 装饰器，就定义了一个包含 name 和 age 属性的 Person 类。attr.ib() 用于定义属性。这样一来，我们就不再需要显式编写 __init__、__repr__ 等方法。

默认值和验证

attrs 还可以为属性设置默认值和验证规则：

import attr

@attr.s
class Book:
    title = attr.ib(default="Unknown", validator=attr.validators.instance_of(str))
    pages = attr.ib(default=0, validator=attr.validators.instance_of(int))

# 创建对象
book = Book(title="The Python Book", pages=200)

# 输出对象信息
print(book)

在上述示例中，为 title 设置了默认值 “Unknown”，并使用 validator 进行类型验证。

不可变实例

通过设置 frozen=True，可以创建不可变的实例：

import attr

@attr.s(frozen=True)
class Point:
    x = attr.ib()
    y = attr.ib()

# 创建不可变对象
point = Point(x=1, y=2)

# 尝试修改将引发异常
# point.x = 3  # 会抛出 AttributeError

这对于创建不可变的值对象（Value Object）非常有用，以确保对象的不可变性。

描述元数据

attrs 还支持在类和属性上添加元数据：

import attr

@attr.s
class Product:
    name = attr.ib(metadata={"description": "Product name"})
    price = attr.ib(metadata={"description": "Product price"})

# 获取属性的元数据
name_description = Product.name.metadata["description"]
print(f"Name description: {name_description}")

通过这种方式，可以为类和属性添加更多的信息，使代码更加自文档化。

使用装饰器扩展功能

attrs 还支持使用装饰器扩展类的功能，例如，使用 @attr.s(slots=True) 可以启用 __slots__ 特性：

import attr

@attr.s(slots=True)
class Person:
    name = attr.ib()
    age = attr.ib()

这对于节省内存并提高属性访问速度很有帮助。

使用属性转换器

attrs 还提供了属性转换器（converter）的功能，可以在属性赋值时进行自定义转换：

import attr

def convert_to_upper(value, _):
    return value.upper()

@attr.s
class Person:
    name = attr.ib(converter=convert_to_upper)

# 创建对象
person = Person(name="John")

# 输出对象信息
print(person.name)  # 输出 "JOHN"

在这个例子中，定义了一个转换器函数 convert_to_upper，用于将传入的字符串属性值转换为大写形式。通过将这个转换器函数应用于属性，可以在赋值时自动执行转换。

使用预定义的验证器

attrs 提供了多种预定义的验证器，方便进行常见的验证操作。例如，使用 attr.validators.in_() 可以限定属性值必须是特定集合中的一个：

import attr

@attr.s
class TrafficLight:
    color = attr.ib(validator=attr.validators.in_({"red", "yellow", "green"}))

# 创建对象
traffic_light = TrafficLight(color="red")

# 修改属性值（会引发异常）
# traffic_light.color = "blue"  # 会抛出 ValueError

这有助于确保属性值的合法性，提高代码的稳健性。

嵌套使用 attrs

attrs 还支持在一个类中嵌套使用另一个带有 @attr.s 装饰器的类。这使得构建复杂对象结构变得简单：

import attr

@attr.s
class Address:
    street = attr.ib()
    city = attr.ib()

@attr.s
class Person:
    name = attr.ib()
    age = attr.ib()
    address = attr.ib(factory=Address)

# 创建对象
person = Person(name="John", age=30, address={"street": "123 Main St", "city": "Anytown"})

# 输出对象信息
print(person)

在这个例子中，Person 类包含一个嵌套的 Address 类对象。通过使用 factory 参数，可以为 address 属性提供一个默认工厂函数，使得在创建 Person 对象时不必手动创建 Address 对象。

使用 attrs 的默认值工厂

attrs 还提供了默认值工厂的功能，允许我们根据其他属性的值动态计算默认值：

import attr

@attr.s
class Circle:
    radius = attr.ib()
    area = attr.ib(default=attr.Factory(lambda self: 3.14 * (self.radius ** 2)))

# 创建对象
circle = Circle(radius=5)

# 输出对象信息
print(circle.area)  # 输出 78.5

在这个例子中，area 属性的默认值使用了一个工厂函数，该函数根据 radius 属性的值进行计算。这使得我们可以更灵活地设置属性的默认值。

总结

attrs 是一个在 Python 类定义中提供简洁、强大功能的库。通过声明式的语法，attrs 简化了类的定义，大大减少了样板代码的编写。本文深入介绍了 attrs 的多个方面，包括基本用法、验证器、不可变实例、元数据、装饰器扩展、属性转换器等。通过这些功能，能够更清晰地表达类的结构、提高代码的可读性，并减少了常见错误的发生。attrs 不仅支持简单的类定义，还能处理复杂的对象结构，使得在构建和管理大规模项目时更加便捷。

在实际应用中，attrs 的灵活性和强大功能为开发者提供了更多选择，帮助大家更高效地编写清晰、健壮的代码。通过学习和运用 attrs，能够在 Python 开发中取得更高的生产力，写出更具表达力和可维护性的代码。

---

Python学习路线

更多资料获取

📚 个人网站：ipengtao.com

如果还想要领取更多更丰富的资料，可以点击文章下方名片，回复【优质资料】，即可获取 全方位学习资料包。

点击文章下方链接卡片，回复【优质资料】，可直接领取资料大礼包。