CODEWITHSUNDEEP
djangodjango-forms
j0ker
j0ker

Reputation: 4139

Django ModelForms: Display ManyToMany field as single-select

In a Django app, I'm having a model Bet which contains a ManyToMany relation with the User model of Django:

class Bet(models.Model):
    ...
    participants = models.ManyToManyField(User)

User should be able to start new bets using a form. Until now, bets have exactly two participants, one of which is the user who creates the bet himself. That means in the form for the new bet you have to chose exactly one participant. The bet creator is added as participant upon saving of the form data.

I'm using a ModelForm for my NewBetForm:

class NewBetForm(forms.ModelForm):
    class Meta:
        model = Bet
        widgets = {
            'participants': forms.Select()
        }

    def save(self, user):
        ... # save user as participant

Notice the redefined widget for the participants field which makes sure you can only choose one participant.

However, this gives me a validation error:

Enter a list of values.

I'm not really sure where this comes from. If I look at the POST data in the developer tools, it seems to be exactly the same as if I use the default widget and choose only one participant. However, it seems like the to_python() method of the ManyToManyField has its problems with this data. At least there is no User object created if I enable the Select widget.

I know I could work around this problem by excluding the participants field from the form and define it myself but it would be a lot nicer if the ModelForm's capacities could still be used (after all, it's only a widget change). Maybe I could manipulate the passed data in some way if I knew how.

Can anyone tell me what the problem is exactly and if there is a good way to solve it?

Thanks in advance!

Edit

As suggested in the comments: the (relevant) code of the view.

def new_bet(request):
    if request.method == 'POST':
        form = NewBetForm(request.POST)
        if form.is_valid():
            form.save(request.user)
            ... # success message and redirect
    else:
        form = NewBetForm()
    return render(request, 'bets/new.html', {'form': form})

Upvotes: 5

Views: 5790

Answers (6)

eInyzant
eInyzant

Reputation: 309

I found an easyer way to do this inspired by @Ryan Currah: You just have to override "allow_multiple_selected" attribut from SelectMultiple class

class M2MSelect(forms.SelectMultiple):
    allow_multiple_selected = False


class NewBetForm(forms.ModelForm):
    class Meta:
        model = Bet

    participants = forms.ModelMultipleChoiceField(widget=M2MSelect, required=True, queryset=User.objects.all())

Upvotes: 1

michael
michael

Reputation: 682

Inspired by @Ryan Currah I found this to be working out of the box:

class M2MSelect(forms.SelectMultiple):
    def render(self, name, value, attrs=None, choices=()):
        rendered = super(M2MSelect, self).render(name, value=value, attrs=attrs, choices=choices)
        return rendered.replace(u'multiple="multiple"', u'')

The first one of the many to many is displayed and when saved only the selected value is left.

Upvotes: 0

Ryan Currah
Ryan Currah

Reputation: 1105

I don't mean to revive a resolved question but I was working a solution like this and thought I would share my code to help others.

In j0ker's answer he lists two methods to get this to work. I used method 1. In which I borrowed the 'value_from_datadict' method from the SelectMultiple widget.

forms.py

from django.utils.datastructures import MultiValueDict, MergeDict

class M2MSelect(forms.Select):
    def value_from_datadict(self, data, files, name):
        if isinstance(data, (MultiValueDict, MergeDict)):
            return data.getlist(name)
        return data.get(name, None)    

class WindowsSubnetForm(forms.ModelForm):
    port_group = forms.ModelMultipleChoiceField(widget=M2MSelect, required=True, queryset=PortGroup.objects.all())
    class Meta:
        model = Subnet

Upvotes: 3

j0ker
j0ker

Reputation: 4139

After digging in the Django code, I can answer my own question.

The problem is that Django's ModelForm maps ManyToManyFields in the model to ModelMultipleChoiceFields of the form. This kind of form field expects the widget object to return a sequence from its value_from_datadict() method. The default widget for ModelMultipleChoiceField (which is SelectMultiple) overrides value_from_datadict() to return a list from the user supplied data. But if I use the Select widget, the default value_from_datadict() method of the superclass is used, which simply returns a string. ModelMultipleChoiceField doesn't like that at all, hence the validation error.

To solutions I could think of:

  1. Overriding the value_from_datadict() of Select either via inheritance or some class decorator.
  2. Handling the m2m field manually by creating a new form field and adjusting the save() method of the ModelForm to save its data in the m2m relation.

The seconds solution seems to be less verbose, so that's what I will be going with.

Upvotes: 3

dokkaebi
dokkaebi

Reputation: 9190

You can modify the submitted value before (during) validation in Form.clean_field_name. You could use this method to wrap the select's single value in a list.

class NewBetForm(forms.ModelForm):
    class Meta:
        model = Bet
        widgets = {
            'participants': forms.Select()
        }

    def save(self, user):
        ... # save user as participant

    def clean_participants(self):
        data = self.cleaned_data['participants']
        return [data]

I'm actually just guessing what the value proivded by the select looks like, so this might need a bit of tweaking, but I think it will work.

Here are the docs.

Upvotes: 0

Daniel Roseman
Daniel Roseman

Reputation: 599450

The problem is that ManyToMany is the wrong data type for this relationship.

In a sense, the bet itself is the many-to-many relationship. It makes no sense to have the participants as a manytomanyfield. What you need is two ForeignKeys, both to User: one for the creator, one for the other user ('acceptor'?)

Upvotes: 2

Related Questions