Django ModelForm for Many-to-Many fields

by

I guess you would have here to add a new ModelMultipleChoiceField to your PizzaForm, and manually link that form field with the model field, as Django won’t do that automatically for you.

The following snippet might be helpful :

class PizzaForm(forms.ModelForm):
    class Meta:
        model = Pizza

    # Representing the many to many related field in Pizza
    toppings = forms.ModelMultipleChoiceField(queryset=Topping.objects.all())

    # Overriding __init__ here allows us to provide initial
    # data for 'toppings' field
    def __init__(self, *args, **kwargs):
        # Only in case we build the form from an instance
        # (otherwise, 'toppings' list should be empty)
        if kwargs.get('instance'):
            # We get the 'initial' keyword argument or initialize it
            # as a dict if it didn't exist.                
            initial = kwargs.setdefault('initial', {})
            # The widget for a ModelMultipleChoiceField expects
            # a list of primary key for the selected data.
            initial['toppings'] = [t.pk for t in kwargs['instance'].topping_set.all()]

        forms.ModelForm.__init__(self, *args, **kwargs)

    # Overriding save allows us to process the value of 'toppings' field    
    def save(self, commit=True):
        # Get the unsave Pizza instance
        instance = forms.ModelForm.save(self, False)

        # Prepare a 'save_m2m' method for the form,
        old_save_m2m = self.save_m2m
        def save_m2m():
           old_save_m2m()
           # This is where we actually link the pizza with toppings
           instance.topping_set.clear()
           instance.topping_set.add(*self.cleaned_data['toppings'])
        self.save_m2m = save_m2m

        # Do we need to save all changes now?
        if commit:
            instance.save()
            self.save_m2m()

        return instance

This PizzaForm can then be used everywhere, even in the admin :

# yourapp/admin.py
from django.contrib.admin import site, ModelAdmin
from yourapp.models import Pizza
from yourapp.forms import PizzaForm

class PizzaAdmin(ModelAdmin):
  form = PizzaForm

site.register(Pizza, PizzaAdmin)

Note

The save() method might be a bit too verbose, but you can simplify it if you don’t need to support the commit=False situation, it will then be like that :

def save(self):
    instance = forms.ModelForm.save(self)
    instance.topping_set.clear()
    instance.topping_set.add(*self.cleaned_data['toppings'])
    return instance

More Related Contents:

  1. How do I filter ForeignKey choices in a Django ModelForm?
  2. Django set default form values
  3. Creating a dynamic choice field
  4. dynamically add field to a form
  5. Django Passing Custom Form Parameters to Formset
  6. How can I build multiple submit buttons django form?
  7. Django: multiple models in one template using forms [closed]
  8. Django reverse lookup of foreign keys
  9. Multiple Models in a single django ModelForm?
  10. Django-Registration & Django-Profile, using your own custom form
  11. Define css class in django Forms
  12. Django formsets: make first required?
  13. How does Django Know the Order to Render Form Fields?
  14. How do I add a placeholder on a CharField in Django?
  15. How to create a UserProfile form in Django with first_name, last_name modifications?
  16. Change Django ModelChoiceField to show users’ full names rather than usernames
  17. Django: adding an “Add new” button for a ForeignKey in a ModelForm
  18. Using request.user with Django ModelForm
  19. Overriding the save method in Django ModelForm
  20. What’s the best way to store a phone number in Django models?
  21. How to change the file name of an uploaded file in Django?
  22. Customize/remove Django select box blank option
  23. Pre-populate an inline FormSet?
  24. Django – form.save() is not creating ModelForm
  25. How do I filter values in a Django form using ModelForm?
  26. Change a Django form field to a hidden field
  27. Django form.as_p DateField not showing input type as date
  28. Django – Working with multiple forms
  29. CSRF Token missing or incorrect
  30. Django ModelForm to have a hidden input

Leave a Comment