FactoryBoy 高级使用技巧与最佳实践

FactoryBoy 高级使用技巧与最佳实践

factory_boy A test fixtures replacement for Python 项目地址: https://gitcode.com/gh_mirrors/fa/factory_boy

FactoryBoy 是一个强大的 Python 测试数据生成库，特别适合与 Django 等 ORM 框架配合使用。本文将深入探讨 FactoryBoy 的高级使用技巧和常见场景的最佳实践。

外键关系处理

在模型存在外键关系时，使用 SubFactory 是最佳选择：

class UserFactory(factory.django.DjangoModelFactory):
    class Meta:
        model = models.User
    
    first_name = factory.Sequence(lambda n: "Agent %03d" % n)
    group = factory.SubFactory(GroupFactory)  # 自动创建关联的 Group 对象

从已有数据中选择外键

当外键需要从预填充的表中随机选择时，使用 Iterator：

class UserFactory(factory.django.DjangoModelFactory):
    language = factory.Iterator(models.Language.objects.all())

这种方法只在第一次调用工厂时查询数据库，避免在导入时就执行查询。

反向外键关系处理

对于反向外键关系（如一对多关系的"多"方），使用 RelatedFactory：

class UserFactory(factory.django.DjangoModelFactory):
    log = factory.RelatedFactory(
        UserLogFactory,
        factory_related_name='user',
        action=models.UserLog.ACTION_CREATE,
    )

创建 User 实例时，会自动调用 UserLogFactory 创建关联的日志记录。

Django Profile 示例

对于 Django 的 Profile 模式（一对一关系），需要注意信号处理：

@factory.django.mute_signals(post_save)
class ProfileFactory(factory.django.DjangoModelFactory):
    user = factory.SubFactory('app.factories.UserFactory', profile=None)

@factory.django.mute_signals(post_save)
class UserFactory(factory.django.DjangoModelFactory):
    profile = factory.RelatedFactory(ProfileFactory, factory_related_name='user')

使用 mute_signals 装饰器可以避免信号干扰工厂的创建过程。

多对多关系处理

FactoryBoy 没有为多对多关系提供内置解决方案，但可以通过 post_generation 钩子实现：

class UserFactory(factory.django.DjangoModelFactory):
    @factory.post_generation
    def groups(self, create, extracted, **kwargs):
        if not create or not extracted:
            return
        self.groups.add(*extracted)  # 批量添加关联的组

使用时可以这样调用：UserFactory.create(groups=(group1, group2, group3))

带中间表的多对多关系

对于有中间表的多对多关系，可以使用多个 RelatedFactory：

class UserWith2GroupsFactory(UserFactory):
    membership1 = factory.RelatedFactory(
        GroupLevelFactory,
        factory_related_name='user',
        group__name='Group1',
    )
    membership2 = factory.RelatedFactory(
        GroupLevelFactory,
        factory_related_name='user',
        group__name='Group2',
    )

字段值传递技巧

子工厂继承父工厂字段值

使用 SelfAttribute 可以让子工厂继承父工厂的字段值：

class UserFactory(factory.django.DjangoModelFactory):
    lang = factory.SelfAttribute('country.lang')  # 继承国家的语言

class CompanyFactory(factory.django.DjangoModelFactory):
    owner = factory.SubFactory(UserFactory, country=factory.SelfAttribute('..country'))

复杂字段值派生

对于需要复杂计算的字段值，使用 LazyAttribute：

owner = factory.SubFactory(UserFactory,
    country=factory.LazyAttribute(lambda o: get_random_neighbor(o.factory_parent.country))

序列计数器控制

FactoryBoy 提供了多种控制序列计数器的方式：

1. 单次调用指定序列号：

AccountFactory(name="John", __sequence=10)  # 强制使用序列号10

2. 全局重置序列号：

AccountFactory.reset_sequence(10)  # 重置并从10开始

3. 自定义初始序列号：

@classmethod
def _setup_next_sequence(cls):
    return models.Account.objects.latest('uid').uid + 1

随机数据管理

为避免测试因随机数据变得不稳定，可以控制随机种子：

import factory.random
factory.random.reseed_random('my project')  # 固定随机种子

或者保存和恢复随机状态：

state = factory.random.get_random_state()
# 保存为 base64 编码
encoded = base64.b64encode(pickle.dumps(state))
# 恢复
factory.random.set_random_state(pickle.loads(base64.b64decode(encoded)))

实用技巧

将工厂输出转为字典

对于 API 测试，可以将工厂输出转为字典：

factory.build(dict, FACTORY_CLASS=UserFactory)

重用模型字段的选择项

status = factory.fuzzy.FuzzyChoice(
    [x[0] for x in MyModel.STATUS_CHOICES]
)

通过掌握这些高级技巧，你可以更高效地使用 FactoryBoy 创建复杂的测试数据场景，使测试代码更加简洁可靠。

factory_boy A test fixtures replacement for Python 项目地址: https://gitcode.com/gh_mirrors/fa/factory_boy