Python attrs 项目教程

最新推荐文章于 2024-10-17 13:10:58 发布

原创最新推荐文章于 2024-10-17 13:10:58 发布 · 398 阅读

7 ·

CC 4.0 BY-SA版权

Python attrs 项目教程

attrs Python Classes Without Boilerplate 项目地址: https://gitcode.com/gh_mirrors/at/attrs

1. 项目介绍

attrs 是一个 Python 包，旨在通过减少样板代码来简化类的定义。它允许开发者通过声明式的方式定义类的属性，从而避免手动编写大量的 dunder 方法（如 __init__、__repr__、__eq__ 等）。attrs 的目标是帮助开发者编写简洁且正确的代码，同时不会影响运行时性能。

attrs 的核心功能包括：

自动生成 __init__、__repr__、__eq__ 等方法。
支持类型注解和默认值。
提供灵活的属性定义方式，如使用 Factory 来初始化列表等复杂类型。

2. 项目快速启动

安装

首先，使用 pip 安装 attrs：

pip install attrs

基本使用

以下是一个简单的示例，展示了如何使用 attrs 定义一个类：

from attrs import define, field, Factory

@define
class Person:
    name: str
    age: int = field(default=18)
    hobbies: list[str] = Factory(list)

# 创建实例
p = Person(name="Alice", age=25, hobbies=["reading", "coding"])

# 打印实例
print(p)
# 输出: Person(name='Alice', age=25, hobbies=['reading', 'coding'])

# 比较实例
p2 = Person(name="Alice", age=25, hobbies=["reading", "coding"])
print(p == p2)
# 输出: True

高级用法

attrs 还支持更复杂的属性定义和自定义行为。例如，你可以使用 field 来定义属性的默认值和工厂函数：

from attrs import define, field, Factory

@define
class Book:
    title: str
    author: str
    pages: int = field(default=0)
    reviews: list[str] = Factory(list)

    @reviews.validator
    def check_reviews(self, attribute, value):
        if len(value) > 10:
            raise ValueError("Too many reviews!")

# 创建实例
b = Book(title="Python Tricks", author="Dan Bader")
b.reviews.append("Great book!")
print(b)
# 输出: Book(title='Python Tricks', author='Dan Bader', pages=0, reviews=['Great book!'])

3. 应用案例和最佳实践

应用案例

attrs 广泛应用于需要定义大量数据类的场景，如数据处理、API 响应处理等。以下是一个使用 attrs 处理 API 响应的示例：

import requests
from attrs import define, field

@define
class User:
    id: int
    name: str
    email: str

def fetch_user(user_id):
    response = requests.get(f"https://api.example.com/users/{user_id}")
    data = response.json()
    return User(**data)

# 获取用户信息
user = fetch_user(1)
print(user)
# 输出: User(id=1, name='John Doe', email='john.doe@example.com')