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.

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, 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 import factory, 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 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.0.tar.gz (7.2 kB view details)

Uploaded Source

Built Distribution

django_fakery-1.0.0-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.0.tar.gz.

File metadata

File hashes

Hashes for django-fakery-1.0.0.tar.gz
Algorithm Hash digest
SHA256 d73a3bcc0a1232e148a51ceb82c55867e24260b066a88a662ce63aaa17bd957b
MD5 4ca1dca388704111d47f8d9fe8497f54
BLAKE2b-256 99d02669062085f27dd9d3bce93568bc54728bdec8b6dd1ef67ea80f52dcc3e8

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for django_fakery-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 56516d2aed026c1385ae6cc90121ed50aca5e6dca603d0a6688dcb3e44edc9f7
MD5 743c97900c3fb54f8729774a189998a6
BLAKE2b-256 2b967486f0bbe697adc6a6c97669f1ec608cd1e04154233887b44de292643e6c

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