import datetime from django import forms from django.db import models try: sorted except NameError: from django.utils.itercompat import sorted class Author(models.Model): name = models.CharField(max_length=100) class Meta: ordering = ('name',) def __unicode__(self): return self.name class BetterAuthor(Author): write_speed = models.IntegerField() class Book(models.Model): author = models.ForeignKey(Author) title = models.CharField(max_length=100) class Meta: unique_together = ( ('author', 'title'), ) ordering = ['id'] def __unicode__(self): return self.title class BookWithCustomPK(models.Model): my_pk = models.DecimalField(max_digits=5, decimal_places=0, primary_key=True) author = models.ForeignKey(Author) title = models.CharField(max_length=100) def __unicode__(self): return u'%s: %s' % (self.my_pk, self.title) class AlternateBook(Book): notes = models.CharField(max_length=100) def __unicode__(self): return u'%s - %s' % (self.title, self.notes) class AuthorMeeting(models.Model): name = models.CharField(max_length=100) authors = models.ManyToManyField(Author) created = models.DateField(editable=False) def __unicode__(self): return self.name class CustomPrimaryKey(models.Model): my_pk = models.CharField(max_length=10, primary_key=True) some_field = models.CharField(max_length=100) # models for inheritance tests. class Place(models.Model): name = models.CharField(max_length=50) city = models.CharField(max_length=50) def __unicode__(self): return self.name class Owner(models.Model): auto_id = models.AutoField(primary_key=True) name = models.CharField(max_length=100) place = models.ForeignKey(Place) def __unicode__(self): return "%s at %s" % (self.name, self.place) class Location(models.Model): place = models.ForeignKey(Place, unique=True) # this is purely for testing the data doesn't matter here :) lat = models.CharField(max_length=100) lon = models.CharField(max_length=100) class OwnerProfile(models.Model): owner = models.OneToOneField(Owner, primary_key=True) age = models.PositiveIntegerField() def __unicode__(self): return "%s is %d" % (self.owner.name, self.age) class Restaurant(Place): serves_pizza = models.BooleanField() def __unicode__(self): return self.name class Product(models.Model): slug = models.SlugField(unique=True) def __unicode__(self): return self.slug class Price(models.Model): price = models.DecimalField(max_digits=10, decimal_places=2) quantity = models.PositiveIntegerField() def __unicode__(self): return u"%s for %s" % (self.quantity, self.price) class Meta: unique_together = (('price', 'quantity'),) class MexicanRestaurant(Restaurant): serves_tacos = models.BooleanField() class ClassyMexicanRestaurant(MexicanRestaurant): restaurant = models.OneToOneField(MexicanRestaurant, parent_link=True, primary_key=True) tacos_are_yummy = models.BooleanField() # models for testing unique_together validation when a fk is involved and # using inlineformset_factory. class Repository(models.Model): name = models.CharField(max_length=25) def __unicode__(self): return self.name class Revision(models.Model): repository = models.ForeignKey(Repository) revision = models.CharField(max_length=40) class Meta: unique_together = (("repository", "revision"),) def __unicode__(self): return u"%s (%s)" % (self.revision, unicode(self.repository)) # models for testing callable defaults (see bug #7975). If you define a model # with a callable default value, you cannot rely on the initial value in a # form. class Person(models.Model): name = models.CharField(max_length=128) class Membership(models.Model): person = models.ForeignKey(Person) date_joined = models.DateTimeField(default=datetime.datetime.now) karma = models.IntegerField() # models for testing a null=True fk to a parent class Team(models.Model): name = models.CharField(max_length=100) class Player(models.Model): team = models.ForeignKey(Team, null=True) name = models.CharField(max_length=100) def __unicode__(self): return self.name # Models for testing custom ModelForm save methods in formsets and inline formsets class Poet(models.Model): name = models.CharField(max_length=100) def __unicode__(self): return self.name class Poem(models.Model): poet = models.ForeignKey(Poet) name = models.CharField(max_length=100) def __unicode__(self): return self.name class Post(models.Model): title = models.CharField(max_length=50, unique_for_date='posted', blank=True) slug = models.CharField(max_length=50, unique_for_year='posted', blank=True) subtitle = models.CharField(max_length=50, unique_for_month='posted', blank=True) posted = models.DateField() def __unicode__(self): return self.name __test__ = {'API_TESTS': """ >>> from datetime import date >>> from django.forms.models import modelformset_factory >>> qs = Author.objects.all() >>> AuthorFormSet = modelformset_factory(Author, extra=3) >>> formset = AuthorFormSet(queryset=qs) >>> for form in formset.forms: ... print form.as_p()
>>> data = { ... 'form-TOTAL_FORMS': '3', # the number of forms rendered ... 'form-INITIAL_FORMS': '0', # the number of forms with initial data ... 'form-MAX_NUM_FORMS': '0', # the max number of forms ... 'form-0-name': 'Charles Baudelaire', ... 'form-1-name': 'Arthur Rimbaud', ... 'form-2-name': '', ... } >>> formset = AuthorFormSet(data=data, queryset=qs) >>> formset.is_valid() True >>> formset.save() [
>>> data = { ... 'form-TOTAL_FORMS': '3', # the number of forms rendered ... 'form-INITIAL_FORMS': '2', # the number of forms with initial data ... 'form-MAX_NUM_FORMS': '0', # the max number of forms ... 'form-0-id': '2', ... 'form-0-name': 'Arthur Rimbaud', ... 'form-1-id': '1', ... 'form-1-name': 'Charles Baudelaire', ... 'form-2-name': 'Paul Verlaine', ... } >>> formset = AuthorFormSet(data=data, queryset=qs) >>> formset.is_valid() True # Only changed or new objects are returned from formset.save() >>> formset.save() [
>>> data = { ... 'form-TOTAL_FORMS': '4', # the number of forms rendered ... 'form-INITIAL_FORMS': '3', # the number of forms with initial data ... 'form-MAX_NUM_FORMS': '0', # the max number of forms ... 'form-0-id': '2', ... 'form-0-name': 'Arthur Rimbaud', ... 'form-1-id': '1', ... 'form-1-name': 'Charles Baudelaire', ... 'form-2-id': '3', ... 'form-2-name': 'Paul Verlaine', ... 'form-3-name': 'Walt Whitman', ... 'form-3-DELETE': 'on', ... } >>> formset = AuthorFormSet(data=data, queryset=qs) >>> formset.is_valid() True # No objects were changed or saved so nothing will come back. >>> formset.save() [] >>> for author in Author.objects.order_by('name'): ... print author.name Arthur Rimbaud Charles Baudelaire Paul Verlaine Let's edit a record to ensure save only returns that one record. >>> data = { ... 'form-TOTAL_FORMS': '4', # the number of forms rendered ... 'form-INITIAL_FORMS': '3', # the number of forms with initial data ... 'form-MAX_NUM_FORMS': '0', # the max number of forms ... 'form-0-id': '2', ... 'form-0-name': 'Walt Whitman', ... 'form-1-id': '1', ... 'form-1-name': 'Charles Baudelaire', ... 'form-2-id': '3', ... 'form-2-name': 'Paul Verlaine', ... 'form-3-name': '', ... 'form-3-DELETE': '', ... } >>> formset = AuthorFormSet(data=data, queryset=qs) >>> formset.is_valid() True # One record has changed. >>> formset.save() [
>>> data = { ... 'form-TOTAL_FORMS': '1', # the number of forms rendered ... 'form-INITIAL_FORMS': '0', # the number of forms with initial data ... 'form-MAX_NUM_FORMS': '0', # the max number of forms ... 'form-0-author_ptr': '', ... 'form-0-name': 'Ernest Hemingway', ... 'form-0-write_speed': '10', ... } >>> formset = BetterAuthorFormSet(data) >>> formset.is_valid() True >>> formset.save() [
>>> data = { ... 'form-TOTAL_FORMS': '2', # the number of forms rendered ... 'form-INITIAL_FORMS': '1', # the number of forms with initial data ... 'form-MAX_NUM_FORMS': '0', # the max number of forms ... 'form-0-author_ptr': hemingway_id, ... 'form-0-name': 'Ernest Hemingway', ... 'form-0-write_speed': '10', ... 'form-1-author_ptr': '', ... 'form-1-name': '', ... 'form-1-write_speed': '', ... } >>> formset = BetterAuthorFormSet(data) >>> formset.is_valid() True >>> formset.save() [] # Inline Formsets ############################################################ We can also create a formset that is tied to a parent model. This is how the admin system's edit inline functionality works. >>> from django.forms.models import inlineformset_factory >>> AuthorBooksFormSet = inlineformset_factory(Author, Book, can_delete=False, extra=3) >>> author = Author.objects.get(name='Charles Baudelaire') >>> formset = AuthorBooksFormSet(instance=author) >>> for form in formset.forms: ... print form.as_p()
>>> data = { ... 'book_set-TOTAL_FORMS': '3', # the number of forms rendered ... 'book_set-INITIAL_FORMS': '0', # the number of forms with initial data ... 'book_set-MAX_NUM_FORMS': '0', # the max number of forms ... 'book_set-0-title': 'Les Fleurs du Mal', ... 'book_set-1-title': '', ... 'book_set-2-title': '', ... } >>> formset = AuthorBooksFormSet(data, instance=author) >>> formset.is_valid() True >>> formset.save() [
>>> data = { ... 'book_set-TOTAL_FORMS': '3', # the number of forms rendered ... 'book_set-INITIAL_FORMS': '1', # the number of forms with initial data ... 'book_set-MAX_NUM_FORMS': '0', # the max number of forms ... 'book_set-0-id': '1', ... 'book_set-0-title': 'Les Fleurs du Mal', ... 'book_set-1-title': 'Les Paradis Artificiels', ... 'book_set-2-title': '', ... } >>> formset = AuthorBooksFormSet(data, instance=author) >>> formset.is_valid() True >>> formset.save() [
Test inline formsets where the inline-edited object has a custom primary key that is not the fk to the parent object. >>> AuthorBooksFormSet2 = inlineformset_factory(Author, BookWithCustomPK, can_delete=False, extra=1) >>> formset = AuthorBooksFormSet2(instance=author) >>> for form in formset.forms: ... print form.as_p()
>>> data = { ... 'bookwithcustompk_set-TOTAL_FORMS': '1', # the number of forms rendered ... 'bookwithcustompk_set-INITIAL_FORMS': '0', # the number of forms with initial data ... 'bookwithcustompk_set-MAX_NUM_FORMS': '0', # the max number of forms ... 'bookwithcustompk_set-0-my_pk': '77777', ... 'bookwithcustompk_set-0-title': 'Les Fleurs du Mal', ... } >>> formset = AuthorBooksFormSet2(data, instance=author) >>> formset.is_valid() True >>> formset.save() [
>>> data = { ... 'alternatebook_set-TOTAL_FORMS': '1', # the number of forms rendered ... 'alternatebook_set-INITIAL_FORMS': '0', # the number of forms with initial data ... 'alternatebook_set-MAX_NUM_FORMS': '0', # the max number of forms ... 'alternatebook_set-0-title': 'Flowers of Evil', ... 'alternatebook_set-0-notes': 'English translation of Les Fleurs du Mal' ... } >>> formset = AuthorBooksFormSet3(data, instance=author) >>> formset.is_valid() True >>> formset.save() [
>>> data = { ... 'book_set-TOTAL_FORMS': '5', # the number of forms rendered ... 'book_set-INITIAL_FORMS': '3', # the number of forms with initial data ... 'book_set-MAX_NUM_FORMS': '0', # the max number of forms ... 'book_set-0-id': '1', ... 'book_set-0-title': 'Les Fleurs du Mal', ... 'book_set-1-id': '2', ... 'book_set-1-title': 'Les Paradis Artificiels', ... 'book_set-2-id': '5', ... 'book_set-2-title': 'Flowers of Evil', ... 'book_set-3-title': 'Revue des deux mondes', ... 'book_set-4-title': '', ... } >>> formset = AuthorBooksFormSet(data, instance=author, queryset=custom_qs) >>> formset.is_valid() True >>> custom_qs = Book.objects.filter(title__startswith='F') >>> formset = AuthorBooksFormSet(instance=author, queryset=custom_qs) >>> for form in formset.forms: ... print form.as_p()
>>> data = { ... 'book_set-TOTAL_FORMS': '3', # the number of forms rendered ... 'book_set-INITIAL_FORMS': '1', # the number of forms with initial data ... 'book_set-MAX_NUM_FORMS': '0', # the max number of forms ... 'book_set-0-id': '5', ... 'book_set-0-title': 'Flowers of Evil', ... 'book_set-1-title': 'Revue des deux mondes', ... 'book_set-2-title': '', ... } >>> formset = AuthorBooksFormSet(data, instance=author, queryset=custom_qs) >>> formset.is_valid() True # Test a custom primary key ################################################### We need to ensure that it is displayed >>> CustomPrimaryKeyFormSet = modelformset_factory(CustomPrimaryKey) >>> formset = CustomPrimaryKeyFormSet() >>> for form in formset.forms: ... print form.as_p()
# Custom primary keys with ForeignKey, OneToOneField and AutoField ############ >>> place = Place(name=u'Giordanos', city=u'Chicago') >>> place.save() >>> FormSet = inlineformset_factory(Place, Owner, extra=2, can_delete=False) >>> formset = FormSet(instance=place) >>> for form in formset.forms: ... print form.as_p()
>>> data = { ... 'owner_set-TOTAL_FORMS': '2', ... 'owner_set-INITIAL_FORMS': '0', ... 'owner_set-MAX_NUM_FORMS': '0', ... 'owner_set-0-auto_id': '', ... 'owner_set-0-name': u'Joe Perry', ... 'owner_set-1-auto_id': '', ... 'owner_set-1-name': '', ... } >>> formset = FormSet(data, instance=place) >>> formset.is_valid() True >>> formset.save() [
>>> data = { ... 'owner_set-TOTAL_FORMS': '3', ... 'owner_set-INITIAL_FORMS': '1', ... 'owner_set-MAX_NUM_FORMS': '0', ... 'owner_set-0-auto_id': u'1', ... 'owner_set-0-name': u'Joe Perry', ... 'owner_set-1-auto_id': '', ... 'owner_set-1-name': u'Jack Berry', ... 'owner_set-2-auto_id': '', ... 'owner_set-2-name': '', ... } >>> formset = FormSet(data, instance=place) >>> formset.is_valid() True >>> formset.save() [
>>> owner = Owner.objects.get(name=u'Joe Perry') >>> FormSet = inlineformset_factory(Owner, OwnerProfile, max_num=1, can_delete=False) >>> FormSet.max_num 1 >>> formset = FormSet(instance=owner) >>> for form in formset.forms: ... print form.as_p()
>>> data = { ... 'ownerprofile-TOTAL_FORMS': '1', ... 'ownerprofile-INITIAL_FORMS': '0', ... 'ownerprofile-MAX_NUM_FORMS': '1', ... 'ownerprofile-0-owner': '', ... 'ownerprofile-0-age': u'54', ... } >>> formset = FormSet(data, instance=owner) >>> formset.is_valid() True >>> formset.save() [
>>> data = { ... 'ownerprofile-TOTAL_FORMS': '1', ... 'ownerprofile-INITIAL_FORMS': '1', ... 'ownerprofile-MAX_NUM_FORMS': '1', ... 'ownerprofile-0-owner': u'1', ... 'ownerprofile-0-age': u'55', ... } >>> formset = FormSet(data, instance=owner) >>> formset.is_valid() True >>> formset.save() [
# Foreign keys in parents ######################################## >>> from django.forms.models import _get_foreign_key >>> type(_get_foreign_key(Restaurant, Owner))
# test for validation with callable defaults. Validations rely on hidden fields >>> data = { ... 'membership_set-TOTAL_FORMS': '1', ... 'membership_set-INITIAL_FORMS': '0', ... 'membership_set-MAX_NUM_FORMS': '0', ... 'membership_set-0-date_joined': unicode(now.strftime('%Y-%m-%d %H:%M:%S')), ... 'initial-membership_set-0-date_joined': unicode(now.strftime('%Y-%m-%d %H:%M:%S')), ... 'membership_set-0-karma': '', ... } >>> formset = FormSet(data, instance=person) >>> formset.is_valid() True # now test for when the data changes >>> one_day_later = now + datetime.timedelta(days=1) >>> filled_data = { ... 'membership_set-TOTAL_FORMS': '1', ... 'membership_set-INITIAL_FORMS': '0', ... 'membership_set-MAX_NUM_FORMS': '0', ... 'membership_set-0-date_joined': unicode(one_day_later.strftime('%Y-%m-%d %H:%M:%S')), ... 'initial-membership_set-0-date_joined': unicode(now.strftime('%Y-%m-%d %H:%M:%S')), ... 'membership_set-0-karma': '', ... } >>> formset = FormSet(filled_data, instance=person) >>> formset.is_valid() False # now test with split datetime fields >>> class MembershipForm(forms.ModelForm): ... date_joined = forms.SplitDateTimeField(initial=now) ... class Meta: ... model = Membership ... def __init__(self, **kwargs): ... super(MembershipForm, self).__init__(**kwargs) ... self.fields['date_joined'].widget = forms.SplitDateTimeWidget() >>> FormSet = inlineformset_factory(Person, Membership, form=MembershipForm, can_delete=False, extra=1) >>> data = { ... 'membership_set-TOTAL_FORMS': '1', ... 'membership_set-INITIAL_FORMS': '0', ... 'membership_set-MAX_NUM_FORMS': '0', ... 'membership_set-0-date_joined_0': unicode(now.strftime('%Y-%m-%d')), ... 'membership_set-0-date_joined_1': unicode(now.strftime('%H:%M:%S')), ... 'initial-membership_set-0-date_joined': unicode(now.strftime('%Y-%m-%d %H:%M:%S')), ... 'membership_set-0-karma': '', ... } >>> formset = FormSet(data, instance=person) >>> formset.is_valid() True # inlineformset_factory tests with fk having null=True. see #9462. # create some data that will exbit the issue >>> team = Team.objects.create(name=u"Red Vipers") >>> Player(name="Timmy").save() >>> Player(name="Bobby", team=team).save() >>> PlayerInlineFormSet = inlineformset_factory(Team, Player) >>> formset = PlayerInlineFormSet() >>> formset.get_queryset() [] >>> formset = PlayerInlineFormSet(instance=team) >>> formset.get_queryset() [