wagtail-factories

What it is and what it does

wagtail-factories is a testing utility that extends factory-boy to generate Wagtail CMS objects—pages, content blocks, and StreamField values—for use in unit and integration tests. It provides pre-built factory classes for common Wagtail types (PageFactory, StructBlockFactory, ListBlockFactory, ImageChooserBlockFactory) and allows you to compose them declaratively to build complex nested content structures on the fly, eliminating the need to manually construct test data in your test suite.

The package is designed for developers writing tests against Wagtail-based applications. Instead of creating pages and blocks by hand in test setup, you define factory subclasses that mirror your model structure, then instantiate them with minimal parameters. It handles the boilerplate of populating required fields, nesting blocks, and managing relationships, making test code more readable and maintainable.

Use it for:

• Generate realistic Wagtail page hierarchies and StreamField content for testing page rendering and query logic.
• Create factory classes for custom block types to populate test data with nested structures like carousels or galleries.
• Build parameterized test fixtures that vary content structure and field values without duplicating setup code.
• Test Wagtail page chooser blocks and other relational fields by auto-generating linked pages.
• Simplify integration tests that require a populated Wagtail page tree with specific content blocks.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides factory-boy classes for generating test fixtures and mock data for Wagtail CMS models, pages, and content blocks.

Yes. wagtail-factories is actively maintained, has no known vulnerabilities, low install friction, and a permissive license. It directly solves a common pain point in Wagtail testing by reducing boilerplate. Install it if you write tests for Wagtail applications and want cleaner, more maintainable test fixtures.

Install

wagtail-factories on PyPI

pip install wagtail-factories

uv add wagtail-factories

poetry add wagtail-factories

Installing wagtail-factories

Before you install

Low friction install with just two runtime dependencies (factory-boy and wagtail). Actively maintained with a recent release and steady commit activity.

License in practice

MIT license permits unrestricted use, modification, and distribution with minimal restrictions—suitable for both open-source and proprietary projects.

Quickstart

pip install wagtail-factories

import wagtail_factories
from factory import SubFactory

class MyPageFactory(wagtail_factories.PageFactory):
    body = wagtail_factories.StreamFieldFactory({
        'text': SubFactory(wagtail_factories.CharBlockFactory),
    })
    class Meta:
        model = MyPage

page = MyPageFactory(title="Test Page")

Requires Python 3.10 or later; wagtail and factory-boy must be installed.

Verify before relying

• Whether the package supports Wagtail versions beyond 7, given the classifier lists only Wagtail :: 7.
• Whether nested StreamBlock factories work reliably in all use cases, as the documentation notes this was added in version 3.0.

Package facts

Evidence: wagtail_factories-4.5.0-py3-none-any.whl

Tags

More Testing packages