factory_boy 技术文档

1. 安装指南

通过 PyPI 安装

你可以通过 pip 安装 factory_boy，这是最简单的方式：

pip install factory_boy

从源码安装

如果你需要从源码安装，可以按照以下步骤操作：

1. 克隆仓库：

   git clone git://github.com/FactoryBoy/factory_boy/
   

2. 安装项目：

   cd factory_boy
   python setup.py install
   

2. 项目的使用说明

定义工厂

factory_boy 允许你通过定义工厂类来生成复杂对象。每个工厂类需要指定一个 model 属性，表示该工厂生成的对象类型。

import factory
from . import models

class UserFactory(factory.Factory):
    class Meta:
        model = models.User

    first_name = 'John'
    last_name = 'Doe'
    admin = False

使用工厂

factory_boy 支持多种实例化策略，包括 build、create 和 stub。

• build()：返回一个未保存的实例。
• create()：返回一个已保存的实例。
• stub()：返回一个仅包含属性的对象。

# 返回一个未保存的 User 实例
user = UserFactory.build()

# 返回一个已保存的 User 实例
user = UserFactory.create()

# 返回一个仅包含属性的对象
obj = UserFactory.stub()

你也可以直接使用工厂类作为快捷方式：

# 等同于 UserFactory.create()
user = UserFactory()

覆盖属性

你可以通过传递关键字参数来覆盖工厂中定义的属性：

# 构建一个 User 实例并覆盖 first_name
user = UserFactory.build(first_name='Joe')
print(user.first_name)  # 输出: "Joe"

批量生成对象

factory_boy 支持一次性生成多个对象：

users = UserFactory.build_batch(10, first_name="Joe")
print(len(users))  # 输出: 10
print([user.first_name for user in users])  # 输出: ["Joe", "Joe", "Joe", "Joe", "Joe", "Joe", "Joe", "Joe", "Joe", "Joe"]

3. 项目 API 使用文档

工厂类

factory_boy 的核心是 factory.Factory 类，它允许你定义工厂并生成对象。

factory.Factory

• Meta.model：指定工厂生成的对象类型。
• build()：返回一个未保存的实例。
• create()：返回一个已保存的实例。
• stub()：返回一个仅包含属性的对象。

子工厂

SubFactory 用于处理复杂对象的关联关系：

class PostFactory(factory.Factory):
    class Meta:
        model = models.Post

    author = factory.SubFactory(UserFactory)

懒加载属性

LazyAttribute 和 LazyFunction 用于在生成对象时动态计算属性值：

class UserFactory(factory.Factory):
    class Meta:
        model = models.User

    first_name = 'Joe'
    last_name = 'Blow'
    email = factory.LazyAttribute(lambda a: '{}.{}@example.com'.format(a.first_name, a.last_name).lower())
    date_joined = factory.LazyFunction(datetime.now)

序列

Sequence 用于生成唯一值：

class UserFactory(factory.Factory):
    class Meta:
        model = models.User

    email = factory.Sequence(lambda n: 'person{}@example.com'.format(n))

4. 项目安装方式

通过 PyPI 安装

pip install factory_boy

从源码安装

git clone git://github.com/FactoryBoy/factory_boy/
cd factory_boy
python setup.py install

通过以上步骤，你可以轻松安装并使用 factory_boy 来简化复杂对象的生成和测试。