model-mommy 1.2

Model Relationships

Mommy also handles relationships. Say the kid has a dog:

class Dog(models.Model):
    owner = models.ForeignKey('Kid')

when you ask Mommy:

from model_mommy import mommy

rex = mommy.make('family.Dog')

She will also create the Kid, automagically.

Defining some attributes

Of course it’s possible to explicitly set values for attributes.

from model_mommy import mommy

another_kid = mommy.make('family.Kid', age=3)

Related objects attributes are also reachable:

from model_mommy import mommy

bobs_dog = mommy.make('family.Dog', owner__name='Bob')

Non persistent objects

If don’t need a persisted object, Mommy can handle this for you as well:

from model_mommy import mommy

kid = mommy.prepare('family.Kid')

It works like make, but it doesn’t persist the instance.

More than one instance

If you need to create more than one instance of the model, you can use the _quantity parameter for it:

from model_mommy import mommy

kids = mommy.make('family.Kid', _quantity=3)
assert len(kids) == 3

It also works with prepare:

from model_mommy import mommy

kids = mommy.prepare('family.Kid', _quantity=3)
assert len(kids) == 3

When shouldn’t you let mommy generate things for you?

If you have fields with special validation, you should set their values by yourself.

Model-mommy should handle fields that:

1. don’t matter for the test you’re writing;

2. don’t require special validation (like unique, etc);

3. are required to create the object.

Currently supported fields

• BooleanField, IntegerField, BigIntegerField, SmallIntegerField, PositiveIntegerField, PositiveSmallIntegerField, FloatField, DecimalField

• CharField, TextField, SlugField, URLField, EmailField

• ForeignKey, OneToOneField, ManyToManyField (even with through model)

• DateField, DateTimeField, TimeField

• FileField, ImageField

Custom fields

Model-mommy allows you to define generators methods for your custom fields or overrides its default generators. This could be achieved by specifing a dict on settings that its keys are the field paths and the values their generators functions, as the example bellow:

# on your settings.py file:
def gen_func():
    return 'value'

MOMMY_CUSTOM_FIELDS_GEN = {
    'test.generic.fields.CustomField': gen_func,
}

Recipes with foreign keys

You can define foreign_key relations:

from model_mommy.recipe import Recipe, foreign_key
from family.models import Person, Dog


person = Recipe(Person,
    name = 'John Doe',
    nickname = 'joe',
    age = 18,
    birthday = date.today(),
    appointment = datetime.now()
)

dog = Recipe(Dog,
    breed = 'Pug',
    owner = foreign_key(person)
)

Notice that person is a recipe.

You may be thinking: “I can put the Person model instance directly in the owner field”. That’s not recommended.

Using the foreign_key is important for 2 reasons:

• Semantics. You’ll know that attribute is a foreign key when you’re reading;

• The associated instance will be created only when you call make_recipe and not during recipe definition;

Recipes with callables

It’s possible to use callables as recipe’s attribute value.

from datetime import date
from model_mommy.recipe import Recipe
from family.models import Person

person = Recipe(Person,
    birthday = date.today,
)

When you call make_recipe, Mommy will set the attribute to the value returned by the callable.

Sequences in recipes

Sometimes, you have a field with an unique value and using make can cause random errors. Also, passing an attribute value just to avoid uniqueness validation problems can be tedious. To solve this you can define a sequence with seq

from model_mommy.recipe import Recipe, seq
from family.models import Person

person = Recipe(Person,
    name = seq('Joe'),
    age = seq(15)
)

p = mommy.make_recipe('myapp.person')
p.name
>>> 'Joe1'
p.age
>>> 16

p = mommy.make_recipe('myapp.person')
p.name
>>> 'Joe2'
p.age
>>> 17

This will append a counter to strings to avoid uniqueness problems and it will sum the counter with numerical values.

You can also provide an optional increment_by argument which will modify incrementing behaviour. This can be an integer, float or Decimal.

person = Recipe(Person,
    age = seq(15, increment_by=3)
    height_ft = seq(5.5, increment_by=.25)
)

p = mommy.make_recipe('myapp.person')
p.age
>>> 18
p.height_ft
>>> 5.75

p = mommy.make_recipe('myapp.person')
p.age
>>> 21
p.height_ft
>>> 6.0

Overriding recipe definitions

Passing values when calling make_recipe or prepare_recipe will override the recipe rule.

from model_mommy import mommy

mommy.make_recipe('model_mommy.person', name='Peter Parker')

This is useful when you have to create multiple objects and you have some unique field, for instance.