Skip to main content

A model instances generator for Django

Project description

https://travis-ci.org/fcurella/django-fakery.svg?branch=master https://coveralls.io/repos/fcurella/django-fakery/badge.svg?branch=master&service=github

An easy-to-use implementation of Creation Methods (aka Object Factory) for Django, backed by Faker.

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

Installation

Install with:

$ pip install django-fakery

QuickStart

from django_fakery 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 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 = factory.make(
    '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 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 = factory.make(
    '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 import factory

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 import factory

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 import factory, 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 import factory, Lazy

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

Blueprints

from django_fakery import factory

user = factory.blueprint('auth.User')

user.make(quantity=10)

Blueprints can refer other blueprints:

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

Seeding the faker

from django_fakery import factory

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

Credits

The API is heavily inspired by model_mommy.

License

This software is released under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-fakery-1.0.2.tar.gz (7.2 kB view details)

Uploaded Source

Built Distribution

django_fakery-1.0.2-py2.py3-none-any.whl (11.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-fakery-1.0.2.tar.gz.

File metadata

File hashes

Hashes for django-fakery-1.0.2.tar.gz
Algorithm Hash digest
SHA256 dc78792147778110b88cf3d53eb10da98e88cd4827cadad7df10c27a785e508a
MD5 7db460b3c29c90cac5312fdb71a4fe14
BLAKE2b-256 cb983f3a99912e8afcb8f981e3558e5ed94109a187ff3aa9f64dd7e3e311f8ea

See more details on using hashes here.

Provenance

File details

Details for the file django_fakery-1.0.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_fakery-1.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 41774b8f868d010b51a3e91dd7de4df33e9fb8bb95d3f120d7f5708735eaedd9
MD5 994846e10ad02e4e871a5cb151120af5
BLAKE2b-256 b1057e16c1edd4b80452ce28f46f28bedff65ccb5c8a5b3cc3e7f4d299cebdec

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page