django-fakery 0.0.9

A model instances generator for Django

An easy-to-use implementation of Creation Methods for Django, backed by Faker.

django_fakery will try to guess the field’s value based on the field’s name and type.

QuickStart

from django_fakery.factory import factory

factory.make(
    'app.Model',
    fields={
        'field': 'value',
    }
)

The value of a field can be any python object, a callable, or a lambda:

from django_fakery.factory import factory
from django.utils import timezone

factory.make(
    'app.Model',
    fields={
        'created': timezone.now
    }
)

When using a lambda, it will receive two arguments: n is the iteration number, and f is an instance of faker:

user = Blueprint(
    'auth.User',
    fields={
        'username': lambda n, f: 'user_{}'.format(n),
    }
)

You can create multiple objects by using the quantity parameter: .. code-block:: python

from django_fakery.factory import factory

factory.make(‘app.Model’, quantity=4)

For convenience, when the value of a field is a string, it will be interpolated with the iteration number:

user = Blueprint(
    'auth.User',
    fields={
        'username': 'user_{}',
    },
    quantity=4
)

Pre-save and Post-save hooks

You can define functions to be called right before the instance is saved or right after:

from django_fakery.lazy import Lazy

factory.make(
    'auth.User',
    fields={
        'username': 'username',
    },
    pre_save=[
        lambda i: i.set_password('password')
    ]
)

Since settings a user’s password is such a common case, we special-cased that scenario, so you can just pass it as a field:

from django_fakery.lazy import Lazy

factory.make(
    'auth.User',
    fields={
        'username': 'username',
        'password': 'password',
    }
)

Lazies

You can refer to the created instance’s own attributes or method by using Lazy objects.

For example, if you’d like to create user with email as username, and have them always match, you could do:

from django_fakery.lazy import Lazy

factory.make(
    'auth.User',
    fields={
        'username': Lazy('email'),
    }
)

If you want to assign a value returned by a method on the instance, you can pass the method’s arguments to the Lazy object:

from django_fakery.lazy import Lazy

factory.make(
    'myapp.Model',
    fields={
        'myfield': Lazy('model_method', 'argument', keyword='keyword value'),
    }
)

Blueprints

from django_fakery.blueprint import Blueprint

user = Blueprint('auth.User')

user.make(quantity=10)

Blueprints can refer other blueprints:

pizza = Blueprint(
    'food.Pizza',
    fields={
        'chef': user,
    }
)

Seeding the faker

from django_fakery.factory import Factory

factory = Factory()

factory.seed(1234)

factory.make('auth.User', fields={
    'username': 'regularuser'
}, seed=1234, quantity=4)

from django_fakery.factory import factory

factory.make('auth.User', fields={
    'username': 'regularuser'
}, seed=1234, quantity=4)

TODO

• self-referencing models

License

This software is released under the MIT License.