ModelChoiceField does not provide value of invalid choice when raising ValidationError

[Aaron Wiegel]

Compared with ChoiceField and others, ModelChoiceField does not show the value of the invalid choice when raising a validation error. Passing in parameters with the invalid value and modifying the default error message for the code invalid_choice should fix this.

From source code:

class ModelMultipleChoiceField(ModelChoiceField):
    """A MultipleChoiceField whose choices are a model QuerySet."""
    widget = SelectMultiple
    hidden_widget = MultipleHiddenInput
    default_error_messages = {
        'invalid_list': _('Enter a list of values.'),
        'invalid_choice': _('Select a valid choice. %(value)s is not one of the'
                            ' available choices.'),
        'invalid_pk_value': _('“%(pk)s” is not a valid value.')
    }
    ...

class ModelChoiceField(ChoiceField):
    """A ChoiceField whose choices are a model QuerySet."""
    # This class is a subclass of ChoiceField for purity, but it doesn't
    # actually use any of ChoiceField's implementation.
    default_error_messages = {
        'invalid_choice': _('Select a valid choice. That choice is not one of'
                            ' the available choices.'),
    }
    ...

[Carlton Gibson]

This message has been the same literally forever b2b6fc8e3c78671c8b6af2709358c3213c84d119.

​Given that ChoiceField passes the value when raising the error, if you set ​error_messages you should be able to get the result you want.

[Aaron Wiegel]

Replying to Carlton Gibson:

This message has been the same literally forever b2b6fc8e3c78671c8b6af2709358c3213c84d119.

​Given that ChoiceField passes the value when raising the error, if you set ​error_messages you should be able to get the result you want.

That is ChoiceField. ModelChoiceField ​does not pass the value to the validation error. So, when the invalid value error is raised, you can't display the offending value even if you override the defaults.

[Carlton Gibson]

OK, if you want to look at submitting a PR we can see if any objections come up in review. Thanks.

[Jerin Peter George]

PR: ​https://github.com/django/django/pull/13933

[Mariusz Felisiak <felisiak.mariusz@…>]

In 1adc0906:

Fixed #32347 -- Made ModelChoiceField include the value in ValidationError for invalid_choice.